Docs » Integrations Guide » Integrations Reference » Interface

image0 Interface

Metadata associated with the Interface plugin for collectd can be found here. The relevant code for the plugin can be found here.

DESCRIPTION

From collectdwiki:

The Interface plugin collects information about the traffic (octets per second), packets per second and errors of interfaces (of course number of errors during one second). If you’re not interested in all interfaces but want to exclude some, or only collect information of some selected interfaces, you can select the interesting interfaces using the plugin’s configuration.

REQUIREMENTS AND DEPENDENCIES

This plugin requires:

Software Version
collectd 1.0+

INSTALLATION

If you are using the new Smart Agent, see the docs for thecollectd/interfacemonitor for more information. The configuration documentation below may be helpful as well, but consult the Smart Agent repo’s docs for the exact schema.

Installation and initial configuration options are available as part of the SignalFx collectdagent.

CONFIGURATION

Optional configuration

The following configuration options are optional. You may specify them in the configuration file in order to override default values provided by the plugin.

configuration option definition default value
Interface Include specific Interface(s) “lo” “sit0”
IgnoreSelected Ignore the designation of specific Disks true

USAGE

The primary use of this plugin is to track the I/O of system interfaces. This is not only valuable data to understand the workloads on specific systems but can be combined with other system and application metrics to identify issues related to network and data I/O traffic.

The SignalFx collectd plugin computes aggregated utilization metrics based on the output of this plugin you can learn more by looking at the metrics for the plugin.

METRICS

Below is a list of all metrics.

Metric Name Brief Type
if_errors.rx Count of receive errors on the interface cumulative_counter
if_errors.tx Count of transmit errors on the interface cumulative_counter
if_octets.rx Count of bytes (octets) received on the interface cumulative_counter
if_octets.tx Count of bytes (octets) transmitted by the interface cumulative_counter
if_packets.rx Count of packets received on the interface cumulative_counter
if_packets.tx Count of packets transmitted by the interface cumulative_counter

if_errors.rx

cumulative_counter

Count of receive errors on the interface.

Errors happen due to various reasons. Some reasons are explainedhere

Rate/sec rollup provides the current rate of receive errors on the interface in errors/sec.

Max rollup provides total number of receive errors since the beginning. Note that since this is a
cumulative counter, its value will periodically restart from zero when the
maximum possible value of the counter is exceeded.

if_errors.tx

cumulative_counter

Count of transmit errors on the interface.

Errors happen due to various reasons. Some reasons are explainedhere

Rate/sec rollup provides the current rate of transmit errors on the interface in errors/sec.

Max rollup provides total number of transmit errors since the beginning. Note that since this is a
cumulative counter, its value will periodically restart from zero when the
maximum possible value of the counter is exceeded.

if_octets.rx

cumulative_counter

Count of bytes received by the interface.

You can view this metric as a Rate/sec or a cumulative count (Max).

Rate/sec: Provides the current traffic level on the interface in bytes/sec.

Max: Provides the cumulative count of bytes received. Note that since this metric is a
cumulative counter, its value will periodically restart from zero when the
maximum possible value of the counter is exceeded.

if_octets.tx

cumulative_counter

Count of bytes transmitted by the interface.

You can view this metric as a Rate/sec or a cumulative count (Max).

Rate/sec: Provides the current traffic level on the interface in bytes/sec.

Max: Provides the cumulative count of bytes transmitted. Note that since this metric is a
cumulative counter, its value will periodically restart from zero when the
maximum possible value of the counter is exceeded.

if_packets.rx

cumulative_counter

Count of packets received by the interface.

You can view this metric as a Rate/sec or a cumulative count (Max).

Rate/sec: Provides the current traffic level on the interface in bytes/sec.

Max: Provides the cumulative count of packets received. Note that since this metric is a
cumulative counter, its value will periodically restart from zero when the
maximum possible value of the counter is exceeded.

if_packets.tx

cumulative_counter

Count of packets transmitted by the interface.

You can view this metric as a Rate/sec or a cumulative count (Max).

Rate/sec: Provides the current traffic level on the interface in packets/sec.

Max: Provides the cumulative count of packets transmitted. Note that since this metric is a
cumulative counter, its value will periodically restart from zero when the
maximum possible value of the counter is exceeded.