Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.

Latest commit

 

History

History
84 lines (55 loc) · 3.18 KB

net-io.md

File metadata and controls

84 lines (55 loc) · 3.18 KB
Raw

net-io

Monitor Type: net-io (Source)

Accepts Endpoints: No

Multiple Instances Allowed: Yes

Overview

This monitor reports I/O metrics about network interfaces.

On Linux hosts, this monitor relies on the /proc filesystem. If the underlying host's /proc file system is mounted somewhere other than /proc please specify the path using the top level configuration procPath.

procPath: /proc
monitors:
 - type: net-io

Configuration

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: net-io
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
interfaces no list of strings The network interfaces to send metrics about. This is an overridable set. (default: `[* !/^lo\d*$/ !/^docker.*/ !/^t(un

Metrics

These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.

  • if_dropped.rx (cumulative)
    Count of received packets dropped by the interface
  • if_dropped.tx (cumulative)
    Count of transmitted packets dropped by the interface
  • if_errors.rx (cumulative)
    Count of receive errors on the interface
  • if_errors.tx (cumulative)
    Count of transmit errors on the interface
  • if_octets.rx (cumulative)
    Count of bytes (octets) received on the interface
  • if_octets.tx (cumulative)
    Count of bytes (octets) transmitted by the interface
  • if_packets.rx (cumulative)
    Count of packets received on the interface
  • if_packets.tx (cumulative)
    Count of packets transmitted by the interface
  • network.total (cumulative)
    Total amount of inbound and outbound network traffic on this host, in bytes.

Non-default metrics (version 4.7.0+)

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.

Dimensions

The following dimensions may occur on metrics emitted by this monitor. Some dimensions may be specific to certain metrics.

Name Description
interface The name of the network interface (e.g. eth0)