getifaddrs
Plugin: freebsd.plugin Module: getifaddrs
Overview
Collect traffic and link information per network interface and expose the network-interfaces Function table. Unavailable link readings appear as unknown or null.
The plugin uses getifaddrs for interface and address counters and SIOCGIFMEDIA for validated media state. Media fields may be unavailable for some interfaces.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration.
Default Behavior
Auto-Detection
This integration doesn't support auto-detection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
Prerequisites
No action required.
Configuration
Options
Config options
| Option | 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 |
| speed for all interfaces | Enable speed charts where the active media and line rate are available. | auto | no |
| duplex for all interfaces | Enable duplex state charts. Unknown is shown when the media does not report duplex. | auto | no |
| operstate for all interfaces | Enable operational state charts derived from administrative and link state. | auto | no |
| carrier for all interfaces | Enable physical link state charts where the kernel reports a known link state. | auto | no |
| mtu for all interfaces | Enable interface MTU charts where the kernel reports an MTU. | auto | no |
| disable by default interfaces matching | Do not display data for intterfaces listed. | lo* | no |
| set physical interfaces for system.net | Include matching interfaces in the physical-interface aggregates and classify them as physical in the network-interfaces Function. | igb* ix* cxl* em* ixl* ixlv* bge* ixgbe* vtnet* vmx* re* igc* dwc* | no |
via 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
Examples
There are no configuration examples.
Alerts
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| interface_speed | net.net | Network interface ${label:device} current speed |
| 1m_received_traffic_overflow | net.net | Average inbound utilization for the network interface ${label:device} over the last minute |
| 1m_sent_traffic_overflow | net.net | Average outbound utilization for the network interface ${label:device} over the last minute |
| net_interface_inbound_packets | net.packets | Received packets for the network interface ${label:device} in the last 10 minutes |
| net_interface_outbound_packets | net.packets | Sent packets for the network interface ${label:device} in the last 10 minutes |
| 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 |
| 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 |
| 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 |
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 | Description | Dimensions | Unit |
|---|---|---|---|
| system.net | Network Traffic | received, sent | kilobits/s |
| system.packets | Network Packets | received, sent, multicast_received, multicast_sent | packets/s |
| system.ipv4 | IPv4 Bandwidth | received, sent | kilobits/s |
| system.ipv6 | IPv6 Bandwidth | received, sent | kilobits/s |
Per network device
Labels:
| Label | Description |
|---|---|
| interface_type | real when the interface matches the configured physical-interface pattern; otherwise unknown. |
| device | The network interface name. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| net.net | Bandwidth | received, sent | kilobits/s |
| net.packets | Packets | received, sent, multicast_received, multicast_sent | packets/s |
| net.errors | Interface Errors | inbound, outbound | errors/s |
| net.drops | Interface Drops | inbound, outbound | drops/s |
| net.events | Network Interface Events | collisions | events/s |
| net.speed | Interface Speed, available only with valid active media and a reported line rate | speed | kilobits/s |
| net.duplex | Interface Duplex State | full, half, unknown | state |
| net.operstate | Interface Operational State. FreeBSD reports only up, down, or unknown; the additional Linux states are not emitted | up, down, unknown | state |
| net.carrier | Interface Physical Link State, available only for a known kernel link state | up, down | state |
| net.mtu | Interface MTU | mtu | octets |
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.