@cryptotaxi247 / netdata-1 / commits / b5bbeb3e4

Regenerate integrations docs (#19192)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>

Netdata bot committed Dec 12, 2024 at 05:37 UTC b5bbeb3e436ce9e1beab554d85c1f04d34e07f04
2 files changed +172
src/collectors/COLLECTORS.md
+2
@@ -1167,6 +1167,8 @@ If you don't see the app/service you'd like to monitor in this list:
1167
1168 - [NET Framework](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/net_framework.md)
1169
1170 +- [Network Subsystem](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/network_subsystem.md)
1171 +
1172 - [Physical and Logical Disk Performance Metrics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md)
1173
1174 - [Processor](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/processor.md)
src/collectors/windows.plugin/integrations/network_subsystem.md new
+170
@@ -0,0 +1,170 @@
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/Windows Systems"
7 +most_popular: False
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 +
53 +## Metrics
54 +
55 +Metrics grouped by *scope*.
56 +
57 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
58 +
59 +
60 +
61 +### Per System
62 +
63 +These metrics refer to the entire System.
64 +
65 +This scope has no labels.
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| system.net | received, sent | kilobits/s |
72 +| ip.tcppackets | received, sent | packets/s |
73 +| ipv4.packets | received, sent, forwarded, delivered | packets/s |
74 +| ipv4.tcppackets | received, sent | packets/s |
75 +| ipv4.udppackets | received, sent | packets/s |
76 +| ipv4.icmp | received, sent | packets/s |
77 +| ipv4.errors | InDiscards, OutDiscards, OutNoRoutes, InAddrErrors, InHdrErrors, InUnknownProtos | packets/s |
78 +| ipv4.icmpmsg | InEchoReps, OutEchoReps, InDestUnreachs, OutDestUnreachs, InRedirects, OutRedirects, InEchos, OutEchos, InRouterAdvert, OutRouterAdvert, InRouterSelect, OutRouterSelect, InTimeExcds, OutTimeExcds, InParmProbs, OutParmProbs, InTimestamps, OutTimestamps, InTimestampReps, OutTimestampReps | packets/s |
79 +| ipv6.packets | received, sent, forwarded, delivered | packets/s |
80 +| ipv6.tcppackets | received, sent | packets/s |
81 +| ipv6.udppackets | received, sent | packets/s |
82 +| ipv6.icmp | received, sent | packets/s |
83 +| ipv6.errors | InDiscards, OutDiscards, OutNoRoutes, InAddrErrors, InHdrErrors, InUnknownProtos | packets/s |
84 +| ipv6.icmpmsg | InEchoReps, OutEchoReps, InDestUnreachs, OutDestUnreachs, InRedirects, OutRedirects, InEchos, OutEchos, InRouterAdvert, OutRouterAdvert, InRouterSelect, OutRouterSelect, InTimeExcds, OutTimeExcds, InParmProbs, OutParmProbs, InTimestamps, OutTimestamps, InTimestampReps, OutTimestampReps | packets/s |
85 +
86 +### Per network device
87 +
88 +These metrics refer to Network Interfaces.
89 +
90 +Labels:
91 +
92 +| Label | Description |
93 +|:-----------|:----------------|
94 +| interface_type | Classification of the network interface (real or virtual). |
95 +| device | System-assigned network interface identifier. |
96 +
97 +Metrics:
98 +
99 +| Metric | Dimensions | Unit |
100 +|:------|:----------|:----|
101 +| net.net | received, sent | kilobits/s |
102 +| net.packets | received, sent | packets/s |
103 +| net.speed | speed | kilobits/s |
104 +| net.errors | inbound, outbound | errors/s |
105 +| net.drops | inbound, outbound | drops/s |
106 +| net.queue_length | length | packets |
107 +| net.rsc_connections | connections | connections |
108 +| net.rsc_packets | packets | packets/s |
109 +| net.rsc_exceptions | exceptions | exceptions/s |
110 +| net.rsc_average_packet_size | average | bytes |
111 +| net.chimney_connections | connections | connections |
112 +
113 +
114 +
115 +## Alerts
116 +
117 +
118 +The following alerts are available:
119 +
120 +| Alert name | On metric | Description |
121 +|:------------|:----------|:------------|
122 +| [ 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 |
123 +| [ 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 |
124 +| [ 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 |
125 +| [ 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 |
126 +| [ 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. |
127 +
128 +
129 +## Setup
130 +
131 +### Prerequisites
132 +
133 +No action required.
134 +
135 +### Configuration
136 +
137 +#### File
138 +
139 +The configuration file name for this integration is `netdata.conf`.
140 +Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
141 +
142 +The file format is a modified INI syntax. The general structure is:
143 +
144 +```ini
145 +[section1]
146 + option1 = some value
147 + option2 = some other value
148 +
149 +[section2]
150 + option3 = some third value
151 +```
152 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
153 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
154 +
155 +```bash
156 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
157 +sudo ./edit-config netdata.conf
158 +```
159 +#### Options
160 +
161 +
162 +
163 +| Name | Description | Default | Required |
164 +|:----|:-----------|:-------|:--------:|
165 +| PerflibNetwork | An option to enable or disable the data collection. | yes | no |
166 +
167 +#### Examples
168 +There are no configuration examples.
169 +
170 +