0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-26 05:47:20 +00:00

Regenerate integrations docs ()

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
This commit is contained in:
Netdata bot 2024-12-11 05:25:35 -05:00 committed by GitHub
parent eabaed6be9
commit b65dd3f097
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 175 additions and 5 deletions

View file

@ -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)

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.