NATS

Auto-Detection

Built-in Metrics

Bleemeo monitors the NATS messaging server through automatic service detection and built-in metrics gathered from the monitoring endpoint.

Auto-Detection

Glouton automatically detects NATS instances running on the host. To enable metrics collection, you must enable the NATS monitoring endpoint. See NATS Server Monitoring for details.

By default, Glouton assumes the monitoring endpoint runs on port 8222. If the auto-detected parameters are incorrect, you can override them manually.

Linux
Windows

sudo tee /etc/glouton/conf.d/99-nats.conf > /dev/null << 'EOF'
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
EOF

Create or edit C:\ProgramData\glouton\conf.d\99-nats.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

Built-in Metrics

Metric	Description
`service_status`	Status of NATS
`nats_uptime`	Time since the NATS server 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