Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 3.78 KB

collectd-interface.md

File metadata and controls

88 lines (59 loc) · 3.78 KB
Raw

collectd/interface

Monitor Type: collectd/interface (Source)

Accepts Endpoints: No

Multiple Instances Allowed: No

Overview

Collectd stats about network interfaces on the system by using the collectd interface plugin.

See the integrations doc for more information.

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: collectd/interface
   ...  # Additional config

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

Config option Required Type Description
excludedInterfaces no list of strings List of interface names to exclude from monitoring (default: `[/^lo\d*$/ /^docker.*/ /^t(un
includedInterfaces no list of strings List of all the interfaces you want to monitor, all others will be ignored. If you set both included and excludedInterfaces, only includedInterfaces will be honored.

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

Non-default metrics (version 4.7.0+)

The following information applies to the agent version 4.7.0+ that has enableBuiltInFiltering: true set on the top level of the agent config.

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.

Legacy non-default metrics (version < 4.7.0)

The following information only applies to agent version older than 4.7.0. If you have a newer agent and have set enableBuiltInFiltering: true at the top level of your agent config, see the section above. See upgrade instructions in Old-style whitelist filtering.

If you have a reference to the whitelist.json in your agent's top-level metricsToExclude config option, and you want to emit metrics that are not in that whitelist, then you need to add an item to the top-level metricsToInclude config option to override that whitelist (see Inclusion filtering. Or you can just copy the whitelist.json, modify it, and reference that in metricsToExclude.