@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 137 lines 3.33 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/power_supply_win.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4 sidebar_label: "Power Supply (Win)"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Hardware and Sensors"
7 keywords: ['power supply']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 endmeta-->
10
11 # Power Supply (Win)
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 ## Setup
53
54
55 ### Prerequisites
56
57 No action required.
58
59 ### Configuration
60
61 #### Options
62
63
64
65
66
67 | Option | Description | Default | Required |
68 |:-----|:------------|:--------|:---------:|
69 | update every | Data collection frequency. | 1 | no |
70
71
72
73
74 #### via File
75
76 The configuration file name for this integration is `netdata.conf`.
77 Configuration for this specific integration is located in the `[plugin:windows:GetPowerSupply]` section within that file.
78
79 The file format is a modified INI syntax. The general structure is:
80
81 ```ini
82 [section1]
83 option1 = some value
84 option2 = some other value
85
86 [section2]
87 option3 = some third value
88 ```
89 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
90 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91
92 ```bash
93 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
94 sudo ./edit-config netdata.conf
95 ```
96
97 ##### Examples
98 There are no configuration examples.
99
100
101
102 ## Alerts
103
104
105 The following alerts are available:
106
107 | Alert name | On metric | Description |
108 |:------------|:----------|:------------|
109 | [ 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 |
110
111
112 ## Metrics
113
114 Metrics grouped by *scope*.
115
116 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
117
118
119
120 ### Per Power Supply
121
122 These metrics refer to Power Supply device.
123
124 Labels:
125
126 | Label | Description |
127 |:-----------|:----------------|
128 | device | Device name delivered as a Windows path. |
129
130 Metrics:
131
132 | Metric | Dimensions | Unit |
133 |:------|:----------|:----|
134 | powersupply.capacity | capacity | percentage |
135 | powersupply.voltage | now | V |
136
137