@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
md 176 lines 6.32 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/network_subsystem.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4 sidebar_label: "Network Subsystem"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Networking"
7 keywords: ['network', 'bandwidth', 'ip', 'udp', 'tcp', 'interface']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 endmeta-->
10
11 # Network Subsystem
12
13
14 <img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
16
17 Plugin: windows.plugin
18 Module: PerflibNetwork
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 It queries 'Network Interface' and 'Network Adapter' objects from Perflib in order to gather the metrics.
28
29
30 This collector is only supported on the following platforms:
31
32 - windows
33
34 This collector only supports collecting metrics from a single instance of this integration.
35
36
37 ### Default Behavior
38
39 #### Auto-Detection
40
41 The collector automatically detects all of the metrics, no further configuration is required.
42
43
44 #### Limits
45
46 The default configuration for this integration does not impose any limits on data collection.
47
48 #### Performance Impact
49
50 The default configuration for this integration is not expected to impose a significant performance impact on the system.
51
52 ## Setup
53
54
55 ### Prerequisites
56
57 No action required.
58
59 ### Configuration
60
61 #### Options
62
63
64
65
66
67 | Option | Description | Default | Required |
68 |:-----|:------------|:--------|:---------:|
69 | update every | Data collection frequency. | 1 | no |
70
71
72
73
74 #### via File
75
76 The configuration file name for this integration is `netdata.conf`.
77 Configuration for this specific integration is located in the `[plugin:windows:PerflibNetwork]` section within that file.
78
79 The file format is a modified INI syntax. The general structure is:
80
81 ```ini
82 [section1]
83 option1 = some value
84 option2 = some other value
85
86 [section2]
87 option3 = some third value
88 ```
89 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
90 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91
92 ```bash
93 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
94 sudo ./edit-config netdata.conf
95 ```
96
97 ##### Examples
98 There are no configuration examples.
99
100
101
102 ## Alerts
103
104
105 The following alerts are available:
106
107 | Alert name | On metric | Description |
108 |:------------|:----------|:------------|
109 | [ 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 |
110 | [ 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 |
111 | [ 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 |
112 | [ 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 |
113 | [ network_interface_output_queue_length ](https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf) | net.queue_length | Output Queue Length on interface ${label:device} should be zero, otherwise there are delays and bottlenecks. |
114
115
116 ## Metrics
117
118 Metrics grouped by *scope*.
119
120 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
121
122
123
124 ### Per System
125
126 These metrics refer to the entire System.
127
128 This scope has no labels.
129
130 Metrics:
131
132 | Metric | Dimensions | Unit |
133 |:------|:----------|:----|
134 | system.net | received, sent | kilobits/s |
135 | ip.tcppackets | received, sent | packets/s |
136 | ipv4.packets | received, sent, forwarded, delivered | packets/s |
137 | ipv4.tcppackets | received, sent | packets/s |
138 | ipv4.udppackets | received, sent | packets/s |
139 | ipv4.icmp | received, sent | packets/s |
140 | ipv4.errors | InDiscards, OutDiscards, OutNoRoutes, InAddrErrors, InHdrErrors, InUnknownProtos | packets/s |
141 | ipv4.icmpmsg | InEchoReps, OutEchoReps, InDestUnreachs, OutDestUnreachs, InRedirects, OutRedirects, InEchos, OutEchos, InRouterAdvert, OutRouterAdvert, InRouterSelect, OutRouterSelect, InTimeExcds, OutTimeExcds, InParmProbs, OutParmProbs, InTimestamps, OutTimestamps, InTimestampReps, OutTimestampReps | packets/s |
142 | ipv6.packets | received, sent, forwarded, delivered | packets/s |
143 | ipv6.tcppackets | received, sent | packets/s |
144 | ipv6.udppackets | received, sent | packets/s |
145 | ipv6.icmp | received, sent | packets/s |
146 | ipv6.errors | InDiscards, OutDiscards, OutNoRoutes, InAddrErrors, InHdrErrors, InUnknownProtos | packets/s |
147 | ipv6.icmpmsg | InEchoReps, OutEchoReps, InDestUnreachs, OutDestUnreachs, InRedirects, OutRedirects, InEchos, OutEchos, InRouterAdvert, OutRouterAdvert, InRouterSelect, OutRouterSelect, InTimeExcds, OutTimeExcds, InParmProbs, OutParmProbs, InTimestamps, OutTimestamps, InTimestampReps, OutTimestampReps | packets/s |
148
149 ### Per network device
150
151 These metrics refer to Network Interfaces.
152
153 Labels:
154
155 | Label | Description |
156 |:-----------|:----------------|
157 | interface_type | Classification of the network interface (real or virtual). |
158 | device | System-assigned network interface identifier. |
159
160 Metrics:
161
162 | Metric | Dimensions | Unit |
163 |:------|:----------|:----|
164 | net.net | received, sent | kilobits/s |
165 | net.packets | received, sent | packets/s |
166 | net.speed | speed | kilobits/s |
167 | net.errors | inbound, outbound | errors/s |
168 | net.drops | inbound, outbound | drops/s |
169 | net.queue_length | length | packets |
170 | net.rsc_connections | connections | connections |
171 | net.rsc_packets | packets | packets/s |
172 | net.rsc_exceptions | exceptions | exceptions/s |
173 | net.rsc_average_packet_size | average | bytes |
174 | net.chimney_connections | connections | connections |
175
176