> For the complete documentation index, see [llms.txt](https://docs.nxcframework.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nxcframework.net/nexus-core-docs/running-your-server/health.md).

# Checking health

> **Partly available.** `nxc_status`, `nxc_config_status`, `nxc_zones_status`, and `nxc_target_status` report on the console today. There is no aggregated health endpoint and no monitoring integration.

## What health reports

Each resource reports whether it has started, registered its configuration, satisfied its dependencies, and reached a serviceable state.

These are distinct. A resource that started but never registered its configuration is running on defaults, which is a different problem from one that failed to start.

## Startup

Resources start in dependency order. Startup validation identifies a missing dependency and **fails with a structured error** rather than starting successfully and failing later at an unrelated point.

A missing dependency reported at startup is a five-second diagnosis. The same fault surfacing during a player transaction is an hour of confusion.

## Optional dependencies

Several resources depend on services arriving in later phases. Health distinguishes:

| State       | Meaning                                     |
| ----------- | ------------------------------------------- |
| Serviceable | Working fully                               |
| Degraded    | Working, with an optional dependency absent |
| Failed      | Not working                                 |

**Degraded is normal, not an alarm.** A resource reporting degraded because a Phase 5 dependency does not exist yet is behaving correctly.

## After a restart

Each resource reconciles on start: in-flight operations resolve or fail cleanly, orphaned entities are matched against records, and stale registrations are cleared.

Resources that registered with others — target options, zones, configuration schemas — have those registrations removed when they stop and re-created when they start.

## Where to look

Health is queryable through the development tools and administrative surfaces. Development tools are gated by capability and are not available to unauthorized production players.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nxcframework.net/nexus-core-docs/running-your-server/health.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.