master
md 111 lines 2.49 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/integrations/power_supply.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml"
4 sidebar_label: "Power Supply"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Hardware and Sensors"
7 keywords: ['psu', '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
12
13
14 <img src="https://netdata.cloud/img/powersupply.svg" width="150"/>
15
16
17 Plugin: proc.plugin
18 Module: /sys/class/power_supply
19
20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22 ## Overview
23
24 This integration monitors Power supply metrics, such as battery status, AC power status and more.
25
26
27
28 This collector is supported on all platforms.
29
30 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
31
32
33 ### Default Behavior
34
35 #### Auto-Detection
36
37 This integration doesn't support auto-detection.
38
39 #### Limits
40
41 The default configuration for this integration does not impose any limits on data collection.
42
43 #### Performance Impact
44
45 The default configuration for this integration is not expected to impose a significant performance impact on the system.
46
47 ## Setup
48
49
50 ### Prerequisites
51
52 No action required.
53
54 ### Configuration
55
56 #### Options
57
58
59
60 There are no configuration options.
61
62
63
64 #### via File
65
66 There is no configuration file.
67
68 ##### Examples
69 There are no configuration examples.
70
71
72
73 ## Alerts
74
75
76 The following alerts are available:
77
78 | Alert name | On metric | Description |
79 |:------------|:----------|:------------|
80 | [ 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 |
81
82
83 ## Metrics
84
85 Metrics grouped by *scope*.
86
87 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
88
89
90
91 ### Per power device
92
93
94
95 Labels:
96
97 | Label | Description |
98 |:-----------|:----------------|
99 | device | TBD |
100
101 Metrics:
102
103 | Metric | Dimensions | Unit |
104 |:------|:----------|:----|
105 | powersupply.capacity | capacity | percentage |
106 | powersupply.power | power | W |
107 | powersupply.charge | empty_design, empty, now, full, full_design | Ah |
108 | powersupply.energy | empty_design, empty, now, full, full_design | Wh |
109 | powersupply.voltage | min_design, min, now, max, max_design | V |
110
111