Regenerate integrations docs (#20552)
Co-authored-by: thiagoftsm <49162938+thiagoftsm@users.noreply.github.com>
Netdata bot committed
Jun 24, 2025 at 07:34 UTC
9b94164c34f9407b098ac271bb1d95fcf3e35728
3 files changed
+134
-1
src/collectors/COLLECTORS.md
+2
@@ -1185,6 +1185,8 @@ If you don't see the app/service you'd like to monitor in this list:
1185
1186
- [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)
1187
1188
+- [Power supply](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/power_supply.md)
1189
+
1190
- [Processor](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/processor.md)
1191
1192
- [Semaphore statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/semaphore_statistics.md)
src/collectors/proc.plugin/integrations/power_supply.md
+1
-1
@@ -82,7 +82,7 @@ The following alerts are available:
82
83
| Alert name | On metric | Description |
84
|:------------|:----------|:------------|
85
-| [ linux_power_supply_capacity ](https://github.com/netdata/netdata/blob/master/src/health/health.d/linux_power_supply.conf) | powersupply.capacity | percentage of remaining power supply capacity |
85
+| [ power_supply_capacity ](https://github.com/netdata/netdata/blob/master/src/health/health.d/power_supply_capacity.conf) | powersupply.capacity | percentage of remaining power supply capacity |
86
87
88
## Setup
src/collectors/windows.plugin/integrations/power_supply.md
new
+131
@@ -0,0 +1,131 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/power_supply.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "Power supply"
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
+# Power supply
12
+
13
+
14
+<img src="https://netdata.cloud/img/powersupply.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: GetPowerSupply
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors power supply statistics on Windows systems.
25
+
26
+
27
+It uses Windows Internal API to retrieve available data.
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 Power Supply
62
+
63
+These metrics refer to Power Supply device.
64
+
65
+Labels:
66
+
67
+| Label | Description |
68
+|:-----------|:----------------|
69
+| device | Device name delivered as a Windows path. |
70
+
71
+Metrics:
72
+
73
+| Metric | Dimensions | Unit |
74
+|:------|:----------|:----|
75
+| powersupply.capacity | capacity | percentage |
76
+| powersupply.voltage | now | V |
77
+
78
+
79
+
80
+## Alerts
81
+
82
+
83
+The following alerts are available:
84
+
85
+| Alert name | On metric | Description |
86
+|:------------|:----------|:------------|
87
+| [ power_supply_capacity ](https://github.com/netdata/netdata/blob/master/src/health/health.d/power_supply_capacity.conf) | powersupply.capacity | percentage of remaining power supply capacity |
88
+
89
+
90
+## Setup
91
+
92
+### Prerequisites
93
+
94
+No action required.
95
+
96
+### Configuration
97
+
98
+#### File
99
+
100
+The configuration file name for this integration is `netdata.conf`.
101
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
102
+
103
+The file format is a modified INI syntax. The general structure is:
104
+
105
+```ini
106
+[section1]
107
+ option1 = some value
108
+ option2 = some other value
109
+
110
+[section2]
111
+ option3 = some third value
112
+```
113
+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
114
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
115
+
116
+```bash
117
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
118
+sudo ./edit-config netdata.conf
119
+```
120
+#### Options
121
+
122
+
123
+
124
+| Name | Description | Default | Required |
125
+|:----|:-----------|:-------|:--------:|
126
+| GetPowerSupply | An option to enable or disable the data collection. | yes | no |
127
+
128
+#### Examples
129
+There are no configuration examples.
130
+
131
+