Skip to main content

HealthStatus

Point-in-time snapshot of gateway health and its broker connection.

deploymentstringrequired

Stable identity of this deployment (DEPLOYMENT_ID). Distinguishes a sandbox deployment from the primary gateway when both report environment=production; asserted by the sandbox boot check.

Example: sandbox
environmentstringrequired

Deployment environment: development, staging or production.

Example: production
key_modestringrequired

Which API-key mode segment this deployment accepts: any, live or test (GATEWAY_KEY_MODE). A sandbox reports test.

Example: any
nats_connectedbooleanrequired

Whether the gateway currently holds a NATS JetStream connection. When false, accepted events are buffered rather than published.

servicestringrequired

Service identifier, useful when several Nervly components sit behind one load balancer.

Example: nervly-gateway
statusstringrequired

OK while the process is accepting work, DRAINING once a termination signal has been received and the in-flight drain has begun.

Example: OK
uptime_secondsinteger<int64>required

Seconds since this process finished booting.

Possible values: >= 0

Example: 86400
versionstringrequired

Semantic version of the running binary, taken from Cargo.toml.

Example: 0.1.0
HealthStatus
{
"deployment": "sandbox",
"environment": "production",
"key_mode": "any",
"nats_connected": true,
"service": "nervly-gateway",
"status": "OK",
"uptime_seconds": 86400,
"version": "0.1.0"
}