Network check

Overview

The network check collects TCP and IP network metrics from the agent’s host.

Configuration

The network check is enabled by default. If you would like to make any changes to the check, rename network.yaml.default to network.yaml and edit:

init_config:

instances:
  # Network check only supports one configured instance
  - collect_connection_state: false
    excluded_interfaces:
      - lo
      - lo0
    # Optionally completely ignore any network interface
    # matching the given regex:
    # excluded_interface_re: my-network-interface.*

Metrics

system.net.bytes_rcvd
(gauge)
The number of bytes received on a device per second.
shown as byte/second
system.net.bytes_sent
(gauge)
The number of bytes sent from a device per second.
shown as byte/second
system.net.packets_in.count
(gauge)
The number of packets of data received by the interface.
shown as packet/second
system.net.packets_in.error
(gauge)
The number of packet receive errors detected by the device driver.
shown as error/second
system.net.packets_out.count
(gauge)
The number of packets of data transmitted by the interface.
shown as packet/second
system.net.packets_out.error
(gauge)
The number of packet transmit errors detected by the device driver.
shown as error/second
system.net.tcp.in_segs
(gauge)
The number of TCP segments received.
shown as segment/second
system.net.tcp.out_segs
(gauge)
The number of TCP segments transmitted.
shown as segment/second
system.net.tcp.rcv_packs
(gauge)
The number of TCP packets received.
shown as packet/second
system.net.tcp.retrans_packs
(gauge)
The number of TCP packets retransmitted.
shown as packet/second
system.net.tcp.retrans_segs
(gauge)
The number of TCP segments retransmitted.
shown as segment/second
system.net.tcp.sent_packs
(gauge)
The number of TCP packets transmitted.
shown as packet/second
system.net.tcp.rtt
(gauge every 10 seconds)
The TCP round trip time.
shown as millisecond
system.net.tcp.rtt.avg
(gauge every 10 seconds)
The average TCP round trip time as typically computed by the TCP stack.
shown as millisecond
system.net.tcp.rtt.jitter
(gauge every 10 seconds)
The TCP round trip time jitter.
shown as millisecond
system.net.udp.in_datagrams
(gauge)
The rate of UDP datagrams delivered to UDP users.
shown as datagram/second
system.net.udp.in_errors
(gauge)
The rate of received UDP datagrams that could not be delivered for reasons other than the lack of an application at the destination port.
shown as datagram/second
system.net.udp.no_ports
(gauge)
The rate of received UDP datagrams for which there was no application at the destination port.
shown as datagram/second
system.net.udp.out_datagrams
(gauge)
The rate of UDP datagrams sent from this entity.
shown as datagram/second
system.net.udp.rcv_buf_errors
(gauge)
The rate of UDP datagrams lost because there was no room in the receive buffer.
shown as error/second
system.net.udp.snd_buf_errors
(gauge)
The rate of UDP datagrams lost because there was no room in the send buffer.
shown as error/second