netdata/collectors/freebsd.plugin/integrations/getifaddrs.md

getifaddrs

Plugin: freebsd.plugin Module: getifaddrs

Overview

Collect traffic per network interface.

The plugin calls getifaddrs function to collect necessary data.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per getifaddrs instance

General overview about network traffic.

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
system.net	received, sent	kilobits/s
system.packets	received, sent, multicast_received, multicast_sent	packets/s
system.ipv4	received, sent	kilobits/s
system.ipv6	received, sent	kilobits/s

Per network device

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
net.net	received, sent	kilobits/s
net.packets	received, sent, multicast_received, multicast_sent	packets/s
net.errors	inbound, outbound	errors/s
net.drops	inbound, outbound	drops/s
net.events	collisions	events/s

Alerts

The following alerts are available:

Alert name	On metric	Description
interface_speed	net.net	network interface ${label:device} current speed
inbound_packets_dropped_ratio	net.drops	ratio of inbound dropped packets for the network interface ${label:device} over the last 10 minutes
outbound_packets_dropped_ratio	net.drops	ratio of outbound dropped packets for the network interface ${label:device} over the last 10 minutes
1m_received_packets_rate	net.packets	average number of packets received by the network interface ${label:device} over the last minute
10s_received_packets_storm	net.packets	ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute
interface_inbound_errors	net.errors	number of inbound errors for the network interface ${label:device} in the last 10 minutes
interface_outbound_errors	net.errors	number of outbound errors for the network interface ${label:device} in the last 10 minutes

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:freebsd:getifaddrs] section within that file.

The file format is a modified INI syntax. The general structure is:

[section1]
    option1 = some value
    option2 = some other value

[section2]
    option3 = some third value

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf

Options

Config options

| Name | Description | Default | Required | |:----|:-----------|:-------|:--------:| | enable new interfaces detected at runtime | Enable or disable possibility to discover new interface after plugin starts. | auto | no | | total bandwidth for physical interfaces | Enable or disable total bandwidth for physical interfaces metric. | auto | no | | total packets for physical interfaces | Enable or disable total packets for physical interfaces metric. | auto | no | | total bandwidth for ipv4 interface | Enable or disable total bandwidth for IPv4 interface metric. | auto | no | | total bandwidth for ipv6 interfaces | Enable or disable total bandwidth for ipv6 interfaces metric. | auto | no | | bandwidth for all interfaces | Enable or disable bandwidth for all interfaces metric. | auto | no | | packets for all interfaces | Enable or disable packets for all interfaces metric. | auto | no | | errors for all interfaces | Enable or disable errors for all interfaces metric. | auto | no | | drops for all interfaces | Enable or disable drops for all interfaces metric. | auto | no | | collisions for all interface | Enable or disable collisions for all interface metric. | auto | no | | disable by default interfaces matching | Do not display data for intterfaces listed. | lo* | no | | set physical interfaces for system.net | Do not show network traffic for listed interfaces. | igb* ix* cxl* em* ixl* ixlv* bge* ixgbe* vtnet* vmx* re* igc* dwc* | no |

Examples

There are no configuration examples.