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

2.2 KiB

description menu tags introduced os_support related
Telegraf plugin for collecting metrics from Network Connection Statistics
telegraf_v1_ref
parent name identifier
input_plugins_reference Network Connection Statistics input-netstat
Network Connection Statistics
input-plugins
configuration
network
v0.2.0 freebsd, linux, macos, solaris, windows
/telegraf/v1/configure_plugins/
https://github.com/influxdata/telegraf/tree/v1.36.1/plugins/inputs/netstat/README.md, Network Connection Statistics Plugin Source

Network Connection Statistics Input Plugin

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

Introduced in: Telegraf v0.2.0 Tags: network 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

# 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

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