telegraf/plugins/inputs/nats
Sven Rebhan 5bb0002948
docs(inputs): Add plugin metadata and update description for n* (#16692)
2025-04-08 10:27:01 +01:00
..
README.md docs(inputs): Add plugin metadata and update description for n* (#16692) 2025-04-08 10:27:01 +01:00
nats.go chore: Fix linter findings for `revive:exported` in `plugins/inputs/n*` (#16205) 2024-11-25 11:23:17 +01:00
nats_freebsd.go chore: Remove deprecated build tags (#11867) 2022-09-22 13:25:31 -05:00
nats_test.go chore(linters): Fix findings found by `testifylint`: `go-require` for handlers for `plugins/inputs/[n-z]` (#16098) 2024-10-30 12:11:55 +01:00
sample.conf chore: Specify distro support (part 3) (#12792) 2023-03-06 12:18:43 +01:00

README.md

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

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