Back to Telegraf

NATS Server Monitoring Input Plugin

plugins/inputs/nats/README.md

1.38.31.7 KB
Original Source

NATS Server Monitoring Input Plugin

This plugin gathers metrics of a NATS server instance using its monitoring endpoints.

⭐ Telegraf v1.6.0 🏷️ server 💻 all

Global configuration options <!-- @/docs/includes/plugin_config.md -->

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See CONFIGURATION.md for more details.

Configuration

toml
# Provides metrics about the state of a NATS server
# This plugin does NOT support FreeBSD
[[inputs.nats]]
  ## The address of the monitoring endpoint of the NATS server
  server = "http://localhost:8222"

  ## Maximum time to receive response
  # response_timeout = "5s"

Metrics

  • nats
    • tags
      • server
    • fields:
      • uptime (integer, nanoseconds)
      • mem (integer, bytes)
      • subscriptions (integer, count)
      • out_bytes (integer, bytes)
      • connections (integer, count)
      • in_msgs (integer, bytes)
      • total_connections (integer, count)
      • cores (integer, count)
      • cpu (integer, count)
      • slow_consumers (integer, count)
      • routes (integer, count)
      • remotes (integer, count)
      • out_msgs (integer, count)
      • in_bytes (integer, bytes)

Example Output

text
nats,server=http://localhost:8222 uptime=117158348682i,mem=6647808i,subscriptions=0i,out_bytes=0i,connections=0i,in_msgs=0i,total_connections=0i,cores=2i,cpu=0,slow_consumers=0i,routes=0i,remotes=0i,out_msgs=0i,in_bytes=0i 1517015107000000000