master
md 140 lines 4.92 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/integrations/network_interfaces.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml"
4 sidebar_label: "Network interfaces"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Networking"
7 keywords: ['network interfaces']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 endmeta-->
10
11 # Network interfaces
12
13
14 <img src="https://netdata.cloud/img/network-wired.svg" width="150"/>
15
16
17 Plugin: proc.plugin
18 Module: /proc/net/dev
19
20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22 ## Overview
23
24 Monitor network interface metrics about bandwidth, state, errors and more.
25
26
27
28 This collector is supported on all platforms.
29
30 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
31
32
33 ### Default Behavior
34
35 #### Auto-Detection
36
37 This integration doesn't support auto-detection.
38
39 #### Limits
40
41 The default configuration for this integration does not impose any limits on data collection.
42
43 #### Performance Impact
44
45 The default configuration for this integration is not expected to impose a significant performance impact on the system.
46
47 ## Setup
48
49
50 ### Prerequisites
51
52 No action required.
53
54 ### Configuration
55
56 #### Options
57
58
59
60 There are no configuration options.
61
62
63
64 #### via File
65
66 There is no configuration file.
67
68 ##### Examples
69 There are no configuration examples.
70
71
72
73 ## Alerts
74
75
76 The following alerts are available:
77
78 | Alert name | On metric | Description |
79 |:------------|:----------|:------------|
80 | [ interface_speed ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.net | network interface ${label:device} current speed |
81 | [ 1m_received_traffic_overflow ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.net | average inbound utilization for the network interface ${label:device} over the last minute |
82 | [ 1m_sent_traffic_overflow ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.net | average outbound utilization for the network interface ${label:device} over the last minute |
83 | [ 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 |
84 | [ 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 |
85 | [ wifi_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 |
86 | [ wifi_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 |
87 | [ 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 |
88 | [ 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 |
89 | [ 10min_fifo_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.fifo | number of FIFO errors for the network interface ${label:device} in the last 10 minutes |
90
91
92 ## Metrics
93
94 Metrics grouped by *scope*.
95
96 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
97
98
99
100 ### Per Network interfaces instance
101
102
103
104 This scope has no labels.
105
106 Metrics:
107
108 | Metric | Dimensions | Unit |
109 |:------|:----------|:----|
110 | system.net | received, sent | kilobits/s |
111
112 ### Per network device
113
114
115
116 Labels:
117
118 | Label | Description |
119 |:-----------|:----------------|
120 | interface_type | TBD |
121 | device | TBD |
122
123 Metrics:
124
125 | Metric | Dimensions | Unit |
126 |:------|:----------|:----|
127 | net.net | received, sent | kilobits/s |
128 | net.speed | speed | kilobits/s |
129 | net.duplex | full, half, unknown | state |
130 | net.operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 | net.carrier | up, down | state |
132 | net.mtu | mtu | octets |
133 | net.packets | received, sent, multicast | packets/s |
134 | net.errors | inbound, outbound | errors/s |
135 | net.drops | inbound, outbound | drops/s |
136 | net.fifo | receive, transmit | errors |
137 | net.compressed | received, sent | packets/s |
138 | net.events | frames, collisions, carrier | events/s |
139
140