Skip to content

NATS

Auto-Discovery
Health Check
Metrics
Logs

To enable metrics gathering, you need to enable the NATS monitoring endpoint on your server, see NATS Server Monitoring for details.

By default, the agent assumes that the monitoring endpoint is enabled on port 8222, if your server uses another port, you can change it in the configuration.

If some auto-detected parameters are wrong, you can manually override them by adding the following to /etc/glouton/conf.d/99-local.conf:

service:
[...]
# For a NATS running outside a container
- type: "nats"
address: "127.0.0.1"
port: 4222
stats_port: 8222
# For an additional NATS running outside a container
- type: "nats"
instance: "NAME_ASSOCIATED_WITH_YOUR_ADDITIONAL_SERVICE"
address: "127.0.0.1"
port: 4222
stats_port: 8222
# For a NATS running in a Docker container
- type: "nats"
instance: "CONTAINER_NAME"
port: 4222
stats_port: 8222

The following metrics are gathered:

Metric Description
service_status Status of NATS
nats_uptime Time since the NATS server is started in nanoseconds
nats_routes Number of registered routes
nats_slow_consumers Number of slow consumers
nats_subscriptions Number of active subscriptions
nats_in_bytes Amount of incoming bytes
nats_out_bytes Amount of outgoing bytes
nats_in_msgs Number of incoming messages
nats_out_msgs Number of outgoing messages
nats_connections Number of currently active clients
nats_total_connections Total number of created clients