From b65dd3f097ab31b63a80d97ab8b672b7552f614e Mon Sep 17 00:00:00 2001
From: Netdata bot <43409846+netdatabot@users.noreply.github.com>
Date: Wed, 11 Dec 2024 05:25:35 -0500
Subject: [PATCH] Regenerate integrations docs (#19184)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
---
 src/collectors/COLLECTORS.md                  |   2 +
 .../windows.plugin/integrations/hyper-v.md    |   2 +-
 .../integrations/memory_statistics.md         |   2 +-
 ...al_and_logical_disk_performance_metrics.md | 168 ++++++++++++++++++
 .../windows.plugin/integrations/processor.md  |   2 +-
 .../integrations/semaphore_statistics.md      |   2 +-
 .../integrations/system_statistics.md         |   2 +-
 7 files changed, 175 insertions(+), 5 deletions(-)
 create mode 100644 src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md

diff --git a/src/collectors/COLLECTORS.md b/src/collectors/COLLECTORS.md
index 6e2d85ef54258f..f6da1480ee09aa 100644
--- a/src/collectors/COLLECTORS.md
+++ b/src/collectors/COLLECTORS.md
@@ -1167,6 +1167,8 @@ If you don't see the app/service you'd like to monitor in this list:
 
 - [NET Framework](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/net_framework.md)
 
+- [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)
+
 - [Processor](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/processor.md)
 
 - [Semaphore statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/semaphore_statistics.md)
diff --git a/src/collectors/windows.plugin/integrations/hyper-v.md b/src/collectors/windows.plugin/integrations/hyper-v.md
index 73245a52bba396..b99ca6fe0fe378 100644
--- a/src/collectors/windows.plugin/integrations/hyper-v.md
+++ b/src/collectors/windows.plugin/integrations/hyper-v.md
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
 
 
 
-### Per Hyper-V instance
+### Per Hyper-V
 
 These metrics refer to the Hyper-V instance.
 
diff --git a/src/collectors/windows.plugin/integrations/memory_statistics.md b/src/collectors/windows.plugin/integrations/memory_statistics.md
index a31972b2503a1e..df25e30a0ee408 100644
--- a/src/collectors/windows.plugin/integrations/memory_statistics.md
+++ b/src/collectors/windows.plugin/integrations/memory_statistics.md
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
 
 
 
-### Per Memory statistics instance
+### Per System
 
 These metrics refer to the entire system.
 
diff --git a/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md b/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md
new file mode 100644
index 00000000000000..c78d156b1c4616
--- /dev/null
+++ b/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md
@@ -0,0 +1,168 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
+sidebar_label: "Physical and Logical Disk Performance Metrics"
+learn_status: "Published"
+learn_rel_path: "Collecting Metrics/Windows Systems"
+most_popular: False
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
+endmeta-->
+
+# Physical and Logical Disk Performance Metrics
+
+
+<img src="https://netdata.cloud/img/windows.svg" width="150"/>
+
+
+Plugin: windows.plugin
+Module: PerflibStorage
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Overview
+
+Detailed statistics for all disk devices and volumes.
+
+
+It queries 'LogicalDisk' and 'PhysicalDisk' objects from Perflib in order to gather the metrics.
+
+
+This collector is only supported on the following platforms:
+
+- windows
+
+This collector only supports collecting metrics from a single instance of this integration.
+
+
+### Default Behavior
+
+#### Auto-Detection
+
+The collector automatically detects all of the metrics, no further configuration is required.
+
+
+#### Limits
+
+The default configuration for this integration does not impose any limits on data collection.
+
+#### Performance Impact
+
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
+
+
+## Metrics
+
+Metrics grouped by *scope*.
+
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
+
+
+
+### Per System
+
+These metrics refer to the entire System.
+
+This scope has no labels.
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| system.io | reads, writes | KiB/s |
+
+### Per Logical Disk
+
+These metrics refer to Logical Disks.
+
+Labels:
+
+| Label      | Description     |
+|:-----------|:----------------|
+| mount_point | Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:'). |
+| driver_type | Classification of the disk device (e.g., norootdir, removable, cdrom, ramdisk). |
+| filesystem | File system format used on the volume (e.g., NTFS, FAT32). |
+| rw_mode | Current read/write permissions status of the volume (read-only access, read and write access). |
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| disk.space | avail, used | GiB |
+
+### Per Physical Disk
+
+These metrics refer to Physical Disks.
+
+Labels:
+
+| Label      | Description     |
+|:-----------|:----------------|
+| mount_point | Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:'). |
+| device | Manufacturer model name. |
+| model | The device model. |
+| device_id | Unique hardware identifier for the storage device within the system. |
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| disk.io | reads, writes | KiB/s |
+| disk.avgsz | reads, writes | KiB/operation |
+| disk.ops | reads, writes | operations/s |
+| disk.split | discards | operations/s |
+| disk.await | reads, writes | milliseconds/operation |
+| disk.svctm | svctm | milliseconds/operation |
+| disk.util | utilization | percent |
+| disk.busy | busy | milliseconds |
+| disk.iotime | reads, writes | milliseconds/s |
+| disk.qops | operations | operations |
+
+
+
+## Alerts
+
+There are no alerts configured by default for this integration.
+
+
+## Setup
+
+### Prerequisites
+
+No action required.
+
+### Configuration
+
+#### File
+
+The configuration file name for this integration is `netdata.conf`.
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
+
+The file format is a modified INI syntax. The general structure is:
+
+```ini
+[section1]
+    option1 = some value
+    option2 = some other value
+
+[section2]
+    option3 = some third value
+```
+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
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
+
+```bash
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
+sudo ./edit-config netdata.conf
+```
+#### Options
+
+
+
+| Name | Description | Default | Required |
+|:----|:-----------|:-------|:--------:|
+| PerflibStorage | An option to enable or disable the data collection. | yes | no |
+
+#### Examples
+There are no configuration examples.
+
+
diff --git a/src/collectors/windows.plugin/integrations/processor.md b/src/collectors/windows.plugin/integrations/processor.md
index 86d2fca4163b9f..0254c251f83708 100644
--- a/src/collectors/windows.plugin/integrations/processor.md
+++ b/src/collectors/windows.plugin/integrations/processor.md
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
 
 
 
-### Per Processor instance
+### Per System
 
 These metrics refer to the entire system.
 
diff --git a/src/collectors/windows.plugin/integrations/semaphore_statistics.md b/src/collectors/windows.plugin/integrations/semaphore_statistics.md
index 7d8cd7eaf6737a..707dbcf711aa83 100644
--- a/src/collectors/windows.plugin/integrations/semaphore_statistics.md
+++ b/src/collectors/windows.plugin/integrations/semaphore_statistics.md
@@ -62,7 +62,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
 
 
 
-### Per Semaphore statistics instance
+### Per System
 
 These metrics refer to the entire system.
 
diff --git a/src/collectors/windows.plugin/integrations/system_statistics.md b/src/collectors/windows.plugin/integrations/system_statistics.md
index 03e433d88dacf5..c2a259a3775caa 100644
--- a/src/collectors/windows.plugin/integrations/system_statistics.md
+++ b/src/collectors/windows.plugin/integrations/system_statistics.md
@@ -58,7 +58,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
 
 
 
-### Per System statistics instance
+### Per System
 
 These metrics refer to the entire system.