Back to Telegraf

Network Connection Statistics Input Plugin

plugins/inputs/netstat/README.md

1.38.31.5 KB
Original Source

Network Connection Statistics Input Plugin

This plugin collects statistics about TCP connection states and UDP socket counts.

⭐ Telegraf v0.2.0 🏷️ network 💻 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
# Read TCP metrics such as established, time wait and sockets counts.
[[inputs.netstat]]
  # no configuration

Metrics

Supported TCP Connection states are follows.

  • established
  • syn_sent
  • syn_recv
  • fin_wait1
  • fin_wait2
  • time_wait
  • close
  • close_wait
  • last_ack
  • listen
  • closing
  • none

TCP Connection State measurements

Meta:

  • units: counts

Measurement names:

  • tcp_established
  • tcp_syn_sent
  • tcp_syn_recv
  • tcp_fin_wait1
  • tcp_fin_wait2
  • tcp_time_wait
  • tcp_close
  • tcp_close_wait
  • tcp_last_ack
  • tcp_listen
  • tcp_closing
  • tcp_none

If there are no connection on the state, the metric is not counted.

UDP socket counts measurements

Meta:

  • units: counts

Measurement names:

  • udp_socket

Example Output

text
netstat tcp_close=0i,tcp_close_wait=0i,tcp_closing=0i,tcp_established=14i,tcp_fin_wait1=0i,tcp_fin_wait2=0i,tcp_last_ack=0i,tcp_listen=1i,tcp_none=46i,tcp_syn_recv=0i,tcp_syn_sent=0i,tcp_time_wait=0i,udp_socket=10i 1668520568000000000