@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
md 163 lines 4.27 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/sensors.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4 sidebar_label: "Sensors"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Hardware and Sensors"
7 keywords: ['Sensors', 'Windows']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 endmeta-->
10
11 # Sensors
12
13
14 <img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
16
17 Plugin: windows.plugin
18 Module: GetSensors
19
20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22 ## Overview
23
24 This collector monitors sensors on Windows systems.
25
26
27 It uses Sensors 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:GetSensors]` 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
99 ###### Specific Sensors
100
101 You can add custom sensor information by creating a dedicated sensor section.
102
103 ```yaml
104 [plugin:windows:GetSensors:Your Sensor Name]
105 units = Speed
106 multiplier = 100
107 title = Current speed.
108
109 ```
110
111
112 ## Alerts
113
114 There are no alerts configured by default for this integration.
115
116
117 ## Metrics
118
119 Metrics grouped by *scope*.
120
121 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
122
123
124
125 ### Per Sensor
126
127 These metrics refer to Sensors.
128
129 Labels:
130
131 | Label | Description |
132 |:-----------|:----------------|
133 | name | Sensor friendly name. |
134 | manufacturer | The sensor manufacturer. |
135 | model | The sensor model. |
136
137 Metrics:
138
139 | Metric | Dimensions | Unit |
140 |:------|:----------|:----|
141 | system.hw.sensor.temperature.input | input | Cel |
142 | system.hw.sensor.power.input | input | W |
143 | system.hw.sensor.current.input | input | A |
144 | system.hw.sensor.humidity.input | input | % |
145 | system.hw.sensor.lux.input | input | lx |
146 | system.hw.sensor.color.input | input | Cel |
147 | system.hw.sensor.voltage.input | input | V |
148 | system.hw.sensor.resistance.input | input | Ohms |
149 | system.hw.sensor.capacitance.input | input | F |
150 | system.hw.sensor.inductance.input | input | H |
151 | system.hw.sensor.pressure.input | input | Pa |
152 | system.hw.sensor.latitude.input | input | Degrees |
153 | system.hw.sensor.longitude.input | input | Degrees |
154 | system.hw.sensor.force.input | input | N |
155 | system.hw.sensor.gauge_pressure.input | input | Pa |
156 | system.hw.sensor.human_presence.input | input | presence |
157 | system.hw.sensor.human_proximity.input | input | m |
158 | system.hw.sensor.distance.input | inputX, inputY, inputZ | m |
159 | system.hw.sensor.acceleration.input | inputX, inputY, inputZ | g |
160 | system.hw.sensor.state.input | ready, not_available, no_data, initializing, access_denied, error | status |
161 | system.hw.sensor.custom | inputN | nd |
162
163