Skip to content

Commit f61e7b6

Browse files
AncaironAncairon
authored
Merge pull request #2464 from netdata/ingest
Ingest New Documentation
2 parents 57bfd29 + c2158a6 commit f61e7b6

File tree

11 files changed

+149
-6
lines changed

11 files changed

+149
-6
lines changed

‎docs/collecting-metrics/Linux Systems/Power Supply/Power-Supply.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The following alerts are available:
8686

8787
| Alert name | On metric | Description |
8888
|:------------|:----------|:------------|
89-
| [ 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 |
89+
| [ 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 |
9090

9191

9292
## Setup

‎docs/collecting-metrics/Windows Systems/Power-supply.mdx

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
3+
sidebar_label: "Power supply"
4+
learn_status: "Published"
5+
toc_max_heading_level: "4"
6+
learn_rel_path: "Collecting Metrics/Windows Systems"
7+
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8+
most_popular: "False"
9+
sidebar_position: "884110"
10+
slug: "/collecting-metrics/windows-systems/power-supply"
11+
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/windows-systems/power-supply"
12+
---
13+
14+
15+
# Power supply
16+
17+
18+
<img src="https://netdata.cloud/img/powersupply.svg" width="150"/>
19+
20+
21+
Plugin: windows.plugin
22+
Module: GetPowerSupply
23+
24+
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
25+
26+
## Overview
27+
28+
This collector monitors power supply statistics on Windows systems.
29+
30+
31+
It uses Windows Internal API to retrieve available data.
32+
33+
34+
This collector is only supported on the following platforms:
35+
36+
- windows
37+
38+
This collector only supports collecting metrics from a single instance of this integration.
39+
40+
41+
### Default Behavior
42+
43+
#### Auto-Detection
44+
45+
The collector automatically detects all of the metrics, no further configuration is required.
46+
47+
48+
#### Limits
49+
50+
The default configuration for this integration does not impose any limits on data collection.
51+
52+
#### Performance Impact
53+
54+
The default configuration for this integration is not expected to impose a significant performance impact on the system.
55+
56+
57+
## Metrics
58+
59+
Metrics grouped by *scope*.
60+
61+
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
62+
63+
64+
65+
### Per Power Supply
66+
67+
These metrics refer to Power Supply device.
68+
69+
Labels:
70+
71+
| Label | Description |
72+
|:-----------|:----------------|
73+
| device | Device name delivered as a Windows path. |
74+
75+
Metrics:
76+
77+
| Metric | Dimensions | Unit |
78+
|:------|:----------|:----|
79+
| powersupply.capacity | capacity | percentage |
80+
| powersupply.voltage | now | V |
81+
82+
83+
84+
## Alerts
85+
86+
87+
The following alerts are available:
88+
89+
| Alert name | On metric | Description |
90+
|:------------|:----------|:------------|
91+
| [ 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 |
92+
93+
94+
## Setup
95+
96+
### Prerequisites
97+
98+
No action required.
99+
100+
### Configuration
101+
102+
#### File
103+
104+
The configuration file name for this integration is `netdata.conf`.
105+
Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
106+
107+
The file format is a modified INI syntax. The general structure is:
108+
109+
```ini
110+
[section1]
111+
option1 = some value
112+
option2 = some other value
113+
114+
[section2]
115+
option3 = some third value
116+
```
117+
You can edit the configuration file using the [`edit-config`](/docs/netdata-agent/configuration#edit-a-configuration-file-using-edit-config) script from the
118+
Netdata [config directory](/docs/netdata-agent/configuration#the-netdata-config-directory).
119+
120+
```bash
121+
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
122+
sudo ./edit-config netdata.conf
123+
```
124+
#### Options
125+
126+
127+
128+
| Name | Description | Default | Required |
129+
|:----|:-----------|:-------|:--------:|
130+
| GetPowerSupply | An option to enable or disable the data collection. | yes | no |
131+
132+
#### Examples
133+
There are no configuration examples.
134+
135+

‎docs/collecting-metrics/Windows Systems/Processor.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ toc_max_heading_level: "4"
66
learn_rel_path: "Collecting Metrics/Windows Systems"
77
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
88
most_popular: "False"
9-
sidebar_position: "884110"
9+
sidebar_position: "884120"
1010
slug: "/collecting-metrics/windows-systems/processor"
1111
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/windows-systems/processor"
1212
---

‎docs/collecting-metrics/Windows Systems/Semaphore-statistics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ toc_max_heading_level: "4"
66
learn_rel_path: "Collecting Metrics/Windows Systems"
77
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
88
most_popular: "False"
9-
sidebar_position: "884120"
9+
sidebar_position: "884130"
1010
slug: "/collecting-metrics/windows-systems/semaphore-statistics"
1111
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/windows-systems/semaphore-statistics"
1212
---

‎docs/collecting-metrics/Windows Systems/System-statistics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ toc_max_heading_level: "4"
66
learn_rel_path: "Collecting Metrics/Windows Systems"
77
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
88
most_popular: "False"
9-
sidebar_position: "884130"
9+
sidebar_position: "884140"
1010
slug: "/collecting-metrics/windows-systems/system-statistics"
1111
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/windows-systems/system-statistics"
1212
---

‎docs/collecting-metrics/Windows Systems/System-thermal-zone.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ toc_max_heading_level: "4"
66
learn_rel_path: "Collecting Metrics/Windows Systems"
77
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
88
most_popular: "False"
9-
sidebar_position: "884140"
9+
sidebar_position: "884150"
1010
slug: "/collecting-metrics/windows-systems/system-thermal-zone"
1111
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/windows-systems/system-thermal-zone"
1212
---

‎docs/collecting-metrics/Windows Systems/Windows Systems.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ import { Grid, Box } from '@site/src/components/Grid_integrations';
5757
<img custom-image src="https://netdata.cloud/img/windows.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }}/>
5858
</Box>
5959

60+
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/windows-systems/power-supply" title="Power supply">
61+
<img custom-image src="https://netdata.cloud/img/powersupply.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }}/>
62+
</Box>
63+
6064
<Box banner="by Netdata" banner_color="#00ab44" to="/docs/collecting-metrics/windows-systems/processor" title="Processor">
6165
<img custom-image src="https://netdata.cloud/img/windows.svg" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }}/>
6266
</Box>

‎docs/collecting-metrics/Windows Systems/Windows-Services.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ toc_max_heading_level: "4"
66
learn_rel_path: "Collecting Metrics/Windows Systems"
77
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
88
most_popular: "False"
9-
sidebar_position: "884150"
9+
sidebar_position: "884160"
1010
slug: "/collecting-metrics/windows-systems/windows-services"
1111
learn_link: "https://learn.netdata.cloud/docs/collecting-metrics/windows-systems/windows-services"
1212
---

‎docs/collecting-metrics/monitor-anything.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1196,6 +1196,8 @@ If you don't see the app/service you'd like to monitor in this list:
11961196

11971197
- [Physical and Logical Disk Performance Metrics](/docs/collecting-metrics/windows-systems/physical-and-logical-disk-performance-metrics)
11981198

1199+
- [Power supply](/docs/collecting-metrics/windows-systems/power-supply)
1200+
11991201
- [Processor](/docs/collecting-metrics/windows-systems/processor)
12001202

12011203
- [Semaphore statistics](/docs/collecting-metrics/windows-systems/semaphore-statistics)

‎ingest/generated_map.tsv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,7 @@ https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/int
647647
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/net_framework.md NET Framework Published Collecting Metrics/Windows Systems https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE False
648648
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/network_subsystem.md Network Subsystem Published Collecting Metrics/Windows Systems https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE False
649649
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/physical_and_logical_disk_performance_metrics.md Physical and Logical Disk Performance Metrics Published Collecting Metrics/Windows Systems https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE False
650+
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/power_supply.md Power supply Published Collecting Metrics/Windows Systems https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE False
650651
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/processor.md Processor Published Collecting Metrics/Windows Systems https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE False
651652
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/semaphore_statistics.md Semaphore statistics Published Collecting Metrics/Windows Systems https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE False
652653
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/system_statistics.md System statistics Published Collecting Metrics/Windows Systems https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE False

‎ingest/one_commit_back_file-dict.tsv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -644,6 +644,7 @@ https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/int
644644
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/ms_sql_server.md /docs/collecting-metrics/windows-systems/ms-sql-server
645645
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/active_directory.md /docs/collecting-metrics/windows-systems/active-directory
646646
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/ms_exchange.md /docs/collecting-metrics/windows-systems/ms-exchange
647+
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/power_supply.md /docs/collecting-metrics/windows-systems/power-supply
647648
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/iis.md /docs/collecting-metrics/windows-systems/iis
648649
https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/net_framework.md /docs/collecting-metrics/windows-systems/net-framework
649650
https://github.com/netdata/netdata/edit/master/src/collectors/diskspace.plugin/README.md /docs/collecting-metrics/linux-systems/disk-space

0 commit comments

Comments
 (0)