@cryptotaxi247 / netdata-1 / commits / b65dd3f09

Regenerate integrations docs (#19184)

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

Netdata bot committed Dec 11, 2024 at 05:25 UTC b65dd3f097ab31b63a80d97ab8b672b7552f614e
7 files changed +175 -5
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 +- [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)
1171 +
1172 - [Processor](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/processor.md)
1173
1174 - [Semaphore statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/semaphore_statistics.md)
src/collectors/windows.plugin/integrations/hyper-v.md
+1 -1
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
58
59
60
61 -### Per Hyper-V instance
61 +### Per Hyper-V
62
63 These metrics refer to the Hyper-V instance.
64
src/collectors/windows.plugin/integrations/memory_statistics.md
+1 -1
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
58
59
60
61 -### Per Memory statistics instance
61 +### Per System
62
63 These metrics refer to the entire system.
64
src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md new
+168
@@ -0,0 +1,168 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4 +sidebar_label: "Physical and Logical Disk Performance Metrics"
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 +# Physical and Logical Disk Performance Metrics
12 +
13 +
14 +<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15 +
16 +
17 +Plugin: windows.plugin
18 +Module: PerflibStorage
19 +
20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21 +
22 +## Overview
23 +
24 +Detailed statistics for all disk devices and volumes.
25 +
26 +
27 +It queries 'LogicalDisk' and 'PhysicalDisk' 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.io | reads, writes | KiB/s |
72 +
73 +### Per Logical Disk
74 +
75 +These metrics refer to Logical Disks.
76 +
77 +Labels:
78 +
79 +| Label | Description |
80 +|:-----------|:----------------|
81 +| mount_point | Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:'). |
82 +| driver_type | Classification of the disk device (e.g., norootdir, removable, cdrom, ramdisk). |
83 +| filesystem | File system format used on the volume (e.g., NTFS, FAT32). |
84 +| rw_mode | Current read/write permissions status of the volume (read-only access, read and write access). |
85 +
86 +Metrics:
87 +
88 +| Metric | Dimensions | Unit |
89 +|:------|:----------|:----|
90 +| disk.space | avail, used | GiB |
91 +
92 +### Per Physical Disk
93 +
94 +These metrics refer to Physical Disks.
95 +
96 +Labels:
97 +
98 +| Label | Description |
99 +|:-----------|:----------------|
100 +| mount_point | Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:'). |
101 +| device | Manufacturer model name. |
102 +| model | The device model. |
103 +| device_id | Unique hardware identifier for the storage device within the system. |
104 +
105 +Metrics:
106 +
107 +| Metric | Dimensions | Unit |
108 +|:------|:----------|:----|
109 +| disk.io | reads, writes | KiB/s |
110 +| disk.avgsz | reads, writes | KiB/operation |
111 +| disk.ops | reads, writes | operations/s |
112 +| disk.split | discards | operations/s |
113 +| disk.await | reads, writes | milliseconds/operation |
114 +| disk.svctm | svctm | milliseconds/operation |
115 +| disk.util | utilization | percent |
116 +| disk.busy | busy | milliseconds |
117 +| disk.iotime | reads, writes | milliseconds/s |
118 +| disk.qops | operations | operations |
119 +
120 +
121 +
122 +## Alerts
123 +
124 +There are no alerts configured by default for this integration.
125 +
126 +
127 +## Setup
128 +
129 +### Prerequisites
130 +
131 +No action required.
132 +
133 +### Configuration
134 +
135 +#### File
136 +
137 +The configuration file name for this integration is `netdata.conf`.
138 +Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
139 +
140 +The file format is a modified INI syntax. The general structure is:
141 +
142 +```ini
143 +[section1]
144 + option1 = some value
145 + option2 = some other value
146 +
147 +[section2]
148 + option3 = some third value
149 +```
150 +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
151 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
152 +
153 +```bash
154 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
155 +sudo ./edit-config netdata.conf
156 +```
157 +#### Options
158 +
159 +
160 +
161 +| Name | Description | Default | Required |
162 +|:----|:-----------|:-------|:--------:|
163 +| PerflibStorage | An option to enable or disable the data collection. | yes | no |
164 +
165 +#### Examples
166 +There are no configuration examples.
167 +
168 +
src/collectors/windows.plugin/integrations/processor.md
+1 -1
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
58
59
60
61 -### Per Processor instance
61 +### Per System
62
63 These metrics refer to the entire system.
64
src/collectors/windows.plugin/integrations/semaphore_statistics.md
+1 -1
@@ -62,7 +62,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
62
63
64
65 -### Per Semaphore statistics instance
65 +### Per System
66
67 These metrics refer to the entire system.
68
src/collectors/windows.plugin/integrations/system_statistics.md
+1 -1
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
58
59
60
61 -### Per System statistics instance
61 +### Per System
62
63 These metrics refer to the entire system.
64