Network

Agent Check

Overview

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

Setup

Follow the instructions below to install and configure this check for an Agent running on a host.

Installation

The network check is included in the Datadog Agent package, so you don’t need to install anything else on your server.

To collect metrics with this integration, make sure the conntrack module is activated on your host. If it’s not the case, run:

sudo modprobe nf_conntrack
sudo modprobe nf_conntrack_ipv4
sudo modprobe nf_conntrack_ipv6

Note: You may need to install the conntrack binary in the Agent image.

Configuration

1. The Agent enables the network check by default, but if you want to configure the check yourself, edit file network.d/conf.yaml, in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample network.d/conf.yaml for all available configuration options:

   init_config:
   
   instances:
     ## @param collect_connection_state - boolean - required
     ## Set to true to collect connection states for your interfaces
     ## Note: this will require either the command `ss` from system package `iproute2` or
     ## the command `netstat` from the system package `net-tools` to be installed
     #
     - collect_connection_state: false
   
     ## @param collect_connection_queues - boolean - optional
     ## Set to true to enable connection queues collection
     ## Note: connection queues collections require both
     ## `collect_connection_state` and `collect_connection_queues` to be true
     ## because it also requires the command `ss` from system package `iproute2` or
     ## the command `netstat` from the system package `net-tools` to be installed
     #
     - collect_connection_queues: false
   

2. Restart the Agent to effect any configuration changes.

Note:

Some conntrack metrics require running conntrack with privileged access to be retrieved.

Linux: Configure the following sudoers rule for this to work:

dd-agent ALL=NOPASSWD: /usr/sbin/conntrack -S

Kubernetes: Conntrack metrics are available by default in Kubernetes < v1.11 or when using the host networking mode in Kubernetes v1.11+.

Validation

Run the Agent’s status subcommand and look for network under the Checks section.

Data Collected

Metrics

Note: system.net.conntrack metrics are available with Agent v6.12+. See the CHANGELOG for details.

Events

The Network check does not include any events.

Service Checks

The Network check does not include any service checks.

Troubleshooting

• How to send TCP/UDP host metrics via the Datadog API

Further Reading

• Build a network monitor on an HTTP check