| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/getifaddrs.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml" |
| 4 | sidebar_label: "getifaddrs" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Networking" |
| 7 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 8 | endmeta--> |
| 9 | |
| 10 | # getifaddrs |
| 11 | |
| 12 | |
| 13 | <img src="https://netdata.cloud/img/network.svg" width="150"/> |
| 14 | |
| 15 | |
| 16 | Plugin: freebsd.plugin |
| 17 | Module: getifaddrs |
| 18 | |
| 19 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 20 | |
| 21 | ## Overview |
| 22 | |
| 23 | Collect traffic per network interface. |
| 24 | |
| 25 | The plugin calls `getifaddrs` function to collect necessary data. |
| 26 | |
| 27 | This collector is supported on all platforms. |
| 28 | |
| 29 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 30 | |
| 31 | |
| 32 | ### Default Behavior |
| 33 | |
| 34 | #### Auto-Detection |
| 35 | |
| 36 | This integration doesn't support auto-detection. |
| 37 | |
| 38 | #### Limits |
| 39 | |
| 40 | The default configuration for this integration does not impose any limits on data collection. |
| 41 | |
| 42 | #### Performance Impact |
| 43 | |
| 44 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 45 | |
| 46 | ## Setup |
| 47 | |
| 48 | |
| 49 | ### Prerequisites |
| 50 | |
| 51 | No action required. |
| 52 | |
| 53 | ### Configuration |
| 54 | |
| 55 | #### Options |
| 56 | |
| 57 | |
| 58 | |
| 59 | <details open><summary>Config options</summary> |
| 60 | |
| 61 | |
| 62 | |
| 63 | | Option | Description | Default | Required | |
| 64 | |:-----|:------------|:--------|:---------:| |
| 65 | | enable new interfaces detected at runtime | Enable or disable possibility to discover new interface after plugin starts. | auto | no | |
| 66 | | total bandwidth for physical interfaces | Enable or disable total bandwidth for physical interfaces metric. | auto | no | |
| 67 | | total packets for physical interfaces | Enable or disable total packets for physical interfaces metric. | auto | no | |
| 68 | | total bandwidth for ipv4 interface | Enable or disable total bandwidth for IPv4 interface metric. | auto | no | |
| 69 | | total bandwidth for ipv6 interfaces | Enable or disable total bandwidth for ipv6 interfaces metric. | auto | no | |
| 70 | | bandwidth for all interfaces | Enable or disable bandwidth for all interfaces metric. | auto | no | |
| 71 | | packets for all interfaces | Enable or disable packets for all interfaces metric. | auto | no | |
| 72 | | errors for all interfaces | Enable or disable errors for all interfaces metric. | auto | no | |
| 73 | | drops for all interfaces | Enable or disable drops for all interfaces metric. | auto | no | |
| 74 | | collisions for all interface | Enable or disable collisions for all interface metric. | auto | no | |
| 75 | | disable by default interfaces matching | Do not display data for intterfaces listed. | lo* | no | |
| 76 | | 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 | |
| 77 | |
| 78 | |
| 79 | </details> |
| 80 | |
| 81 | |
| 82 | |
| 83 | #### via File |
| 84 | |
| 85 | The configuration file name for this integration is `netdata.conf`. |
| 86 | Configuration for this specific integration is located in the `[plugin:freebsd:getifaddrs]` section within that file. |
| 87 | |
| 88 | The file format is a modified INI syntax. The general structure is: |
| 89 | |
| 90 | ```ini |
| 91 | [section1] |
| 92 | option1 = some value |
| 93 | option2 = some other value |
| 94 | |
| 95 | [section2] |
| 96 | option3 = some third value |
| 97 | ``` |
| 98 | You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the |
| 99 | Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory). |
| 100 | |
| 101 | ```bash |
| 102 | cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata |
| 103 | sudo ./edit-config netdata.conf |
| 104 | ``` |
| 105 | |
| 106 | ##### Examples |
| 107 | There are no configuration examples. |
| 108 | |
| 109 | |
| 110 | |
| 111 | ## Alerts |
| 112 | |
| 113 | |
| 114 | The following alerts are available: |
| 115 | |
| 116 | | Alert name | On metric | Description | |
| 117 | |:------------|:----------|:------------| |
| 118 | | [ interface_speed ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.net | network interface ${label:device} current speed | |
| 119 | | [ inbound_packets_dropped_ratio ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.drops | ratio of inbound dropped packets for the network interface ${label:device} over the last 10 minutes | |
| 120 | | [ outbound_packets_dropped_ratio ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.drops | ratio of outbound dropped packets for the network interface ${label:device} over the last 10 minutes | |
| 121 | | [ 1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.packets | average number of packets received by the network interface ${label:device} over the last minute | |
| 122 | | [ 10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | 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 | |
| 123 | | [ interface_inbound_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.errors | number of inbound errors for the network interface ${label:device} in the last 10 minutes | |
| 124 | | [ interface_outbound_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.errors | number of outbound errors for the network interface ${label:device} in the last 10 minutes | |
| 125 | |
| 126 | |
| 127 | ## Metrics |
| 128 | |
| 129 | Metrics grouped by *scope*. |
| 130 | |
| 131 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 132 | |
| 133 | |
| 134 | |
| 135 | ### Per getifaddrs instance |
| 136 | |
| 137 | General overview about network traffic. |
| 138 | |
| 139 | This scope has no labels. |
| 140 | |
| 141 | Metrics: |
| 142 | |
| 143 | | Metric | Dimensions | Unit | |
| 144 | |:------|:----------|:----| |
| 145 | | system.net | received, sent | kilobits/s | |
| 146 | | system.packets | received, sent, multicast_received, multicast_sent | packets/s | |
| 147 | | system.ipv4 | received, sent | kilobits/s | |
| 148 | | system.ipv6 | received, sent | kilobits/s | |
| 149 | |
| 150 | ### Per network device |
| 151 | |
| 152 | |
| 153 | |
| 154 | This scope has no labels. |
| 155 | |
| 156 | Metrics: |
| 157 | |
| 158 | | Metric | Dimensions | Unit | |
| 159 | |:------|:----------|:----| |
| 160 | | net.net | received, sent | kilobits/s | |
| 161 | | net.packets | received, sent, multicast_received, multicast_sent | packets/s | |
| 162 | | net.errors | inbound, outbound | errors/s | |
| 163 | | net.drops | inbound, outbound | drops/s | |
| 164 | | net.events | collisions | events/s | |
| 165 | |
| 166 |