Skip to content

Info

License: Free — part of the universal collection tier.

NATS Server

The nats probe monitors a NATS Server via its HTTP management API (/varz, /routez, /jsz), reporting connections, subscriptions, message throughput, cluster routes and JetStream stream and consumer health. No external dependencies — uses the stdlib HTTP client.

Quick start

probes:
  - name: nats
    type: nats
    params:
      endpoint: http://localhost:8222

Parameters

Parameter Default Description
endpoint http://localhost:8222 NATS management HTTP API base URL

Metrics

Metric Unit Description
senhub.nats.up 1 1 when /varz responds with HTTP 200
nats.connections.count {connection} Current active client connections
nats.connections.total {connection} Total connections since server start
nats.subscriptions.count {subscription} Active subscriptions
nats.messages.received {message} Messages received since start
nats.messages.sent {message} Messages sent to subscribers since start
nats.bytes.received By Bytes received since start
nats.bytes.sent By Bytes sent since start
nats.slow_consumers {consumer} Connections flagged as slow consumers
nats.route.connections {connection} Active cluster route connections
nats.jetstream.streams {stream} JetStream stream count
nats.jetstream.consumers {consumer} JetStream consumer count
nats.jetstream.messages {message} Messages stored in JetStream
nats.jetstream.bytes By Bytes stored in JetStream

Operational notes

  • The management HTTP API is separate from the NATS client port (4222). Ensure it is enabled in the NATS server configuration: http: 8222 or http_port: 8222.
  • JetStream metrics are only emitted when JetStream is enabled on the server.