docs-v2/content/telegraf/v1/input-plugins/nats/_index.md

2.4 KiB

description menu tags introduced os_support related
Telegraf plugin for collecting metrics from NATS Server Monitoring
telegraf_v1_ref
parent name identifier
input_plugins_reference NATS Server Monitoring input-nats
NATS Server Monitoring
input-plugins
configuration
server
v1.6.0 freebsd, linux, macos, solaris, windows
/telegraf/v1/configure_plugins/
https://github.com/influxdata/telegraf/tree/v1.36.1/plugins/inputs/nats/README.md, NATS Server Monitoring Plugin Source

NATS Server Monitoring Input Plugin

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

Introduced in: Telegraf v1.6.0 Tags: server OS support: all

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# 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

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