Network check

Network Dashboard

Overview

The network check collects TCP/IP stats from the host operating system.

Setup

Installation

The network check is packaged with the Agent, so simply install the Agent on any host. If you need the newest version of the check, install the dd-check-network package.

Configuration

The Agent enables the network check by default, but if you want to configure the check yourself, create a file network.yaml in the Agent’s conf.d directory. See the sample network.yaml for all available configuration options:

init_config:

instances:
  # Network check only supports one configured instance
  - collect_connection_state: false # set to true to collect TCP connection state metrics, e.g. SYN_SENT, ESTABLISHED
    excluded_interfaces: # the check will collect metrics on all other interfaces
      - lo
      - lo0
# ignore any network interface matching the given regex:
#   excluded_interface_re: eth1.*

Restart the Agent to effect any configuration changes.

Validation

Run the Agent’s info subcommand and look for network under the Checks section:

  Checks
  ======
    [...]

    network
    -------
      - instance #0 [OK]
      - Collected 26 metrics, 0 events & 0 service checks

    [...]

Compatibility

The network check is compatible with all major platforms.

Data Collected

Metrics

system.net.bytes_rcvd
(gauge)
The number of bytes received on a device per second.
shown as byte
system.net.bytes_sent
(gauge)
The number of bytes sent from a device per second.
shown as byte
system.net.packets_in.count
(gauge)
The number of packets of data received by the interface.
shown as packet
system.net.packets_in.error
(gauge)
The number of packet receive errors detected by the device driver.
shown as error
system.net.packets_out.count
(gauge)
The number of packets of data transmitted by the interface.
shown as packet
system.net.packets_out.error
(gauge)
The number of packet transmit errors detected by the device driver.
shown as error
system.net.tcp.in_segs
(gauge)
The number of TCP segments received.
shown as segment
system.net.tcp.out_segs
(gauge)
The number of TCP segments transmitted.
shown as segment
system.net.tcp.rcv_packs
(gauge)
The number of TCP packets received.
shown as packet
system.net.tcp.retrans_packs
(gauge)
The number of TCP packets retransmitted.
shown as packet
system.net.tcp.retrans_segs
(gauge)
The number of TCP segments retransmitted.
shown as segment
system.net.tcp.sent_packs
(gauge)
The number of TCP packets transmitted.
shown as packet
system.net.tcp.listen_overflows
(gauge)
The number of times connections have overflowed the accept buffer. Available since Agent v5.14.0.
shown as
system.net.tcp.listen_drops
(gauge)
The number of times connections have dropped out of listen. Available since Agent v5.14.0.
shown as
system.net.tcp.backlog_drops
(gauge)
The number of packets dropped because there wasn't room in the TCP backlog. Available since Agent v5.14.0.
shown as packet
system.net.tcp4.closing
(gauge)
The number of TCP IPv4 closing connections.
shown as connection
system.net.tcp4.established
(gauge)
The number of TCP IPv4 closing connections.
shown as connection
system.net.tcp4.listening
(gauge)
The number of TCP IPv4 listening connections.
shown as connection
system.net.tcp4.opening
(gauge)
The number of TCP IPv4 opening connections.
shown as connection
system.net.tcp6.closing
(gauge)
The number of TCP IPv6 closing connections.
shown as connection
system.net.tcp6.established
(gauge)
The number of TCP IPv6 closing connections.
shown as connection
system.net.tcp6.listening
(gauge)
The number of TCP IPv6 listening connections.
shown as connection
system.net.tcp6.opening
(gauge)
The number of TCP IPv6 opening connections.
shown as connection
system.net.udp.in_datagrams
(gauge)
The rate of UDP datagrams delivered to UDP users.
shown as datagram
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
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
system.net.udp.out_datagrams
(gauge)
The rate of UDP datagrams sent from this entity.
shown as datagram
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
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

Events

The Network check does not include any event at this time.

Service Checks

The Network check does not include any service check at this time.

Troubleshooting

Need help? Contact Datadog Support.

Further Reading

Datadog Blog

Learn more about infrastructure monitoring and all our integrations on our blog

Knowledge Base