blob: 9540410bf46c44705e0c92d1bdaf4dfcc178046e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
plugin_name: freeipmi.plugin
modules:
- meta:
plugin_name: freeipmi.plugin
module_name: sensors
monitored_instance:
name: Intelligent Platform Management Interface (IPMI)
link: "https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface"
categories:
- data-collection.hardware-devices-and-sensors
icon_filename: "netdata.png"
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
keywords:
- sensors
- ipmi
- freeipmi
- ipmimonitoring
most_popular: true
overview:
data_collection:
metrics_description: |
"Monitor enterprise server sensor readings, event log entries, and hardware statuses to ensure reliable server operations."
method_description: |
The plugin uses open source library IPMImonitoring to communicate with sensors.
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: "The plugin needs setuid."
default_behavior:
auto_detection:
description: ""
limits:
description: ""
performance_impact:
description: "Linux kernel module for IPMI can create big overhead."
setup:
prerequisites:
list:
- title: Preliminary actions
description: |
If you have not previously used IPMI on your system, you will probably need to run the ipmimonitoring command as root to initialize IPMI settings so that the Netdata plugin works correctly. It should return information about available sensors on the system.
In some distributions libipmimonitoring.pc is located in a non-standard directory, which can cause building the plugin to fail when building Netdata from source. In that case you should find the file and link it to the standard pkg-config directory. Usually, running sudo ln -s /usr/lib/$(uname -m)-linux-gnu/pkgconfig/libipmimonitoring.pc/libipmimonitoring.pc /usr/lib/pkgconfig/libipmimonitoring.pc resolves this issue.
configuration:
file:
name: "netdata.conf"
section_name: '[plugin:freeipmi]'
description: "This is netdata main configuration file"
options:
description: "This tool receives command line options that are visible when user run: `./usr/libexec/netdata/plugins.d/freeipmi.plugin --help`"
folding:
title: "Config options"
enabled: true
list:
- name: command options
description: Variable used to pass arguments for the plugin.
default_value: 1
required: false
examples:
folding:
enabled: true
title: ""
list: []
troubleshooting:
problems:
list: []
alerts:
- name: ipmi_sensor_state
link: https://github.com/netdata/netdata/blob/master/health/health.d/ipmi.conf
metric: ipmi.sensor_state
info: IPMI sensor ${label:sensor} (${label:component}) state
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: sensor
description: ""
labels:
- name: sensor
description: The sensor name
- name: type
description: One of 45 recognized sensor types (Battery, Voltage...)
- name: component
description: One of 25 recognized components (Processor, Peripheral).
metrics:
- name: ipmi.sel
description: IPMI Events
unit: "events"
chart_type: area
dimensions:
- name: events
- name: ipmi.sensor_state
description: IPMI Sensors State
unit: "state"
chart_type: line
dimensions:
- name: nominal
- name: critical
- name: warning
- name: unknown
- name: ipmi.sensor_temperature_c
description: IPMI Sensor Temperature Celsius
unit: "Celsius"
chart_type: line
dimensions:
- name: temperature
- name: ipmi.sensor_temperature_f
description: IPMI Sensor Temperature Fahrenheit
unit: "Fahrenheit"
chart_type: line
dimensions:
- name: temperature
- name: ipmi.sensor_voltage
description: IPMI Sensor Voltage
unit: "Volts"
chart_type: line
dimensions:
- name: voltage
- name: ipmi.sensor_ampere
description: IPMI Sensor Current
unit: "Amps"
chart_type: line
dimensions:
- name: ampere
- name: ipmi.sensor_fan_speed
description: IPMI Sensor Fans Speed
unit: "RPM"
chart_type: line
dimensions:
- name: rotations
- name: ipmi.sensor_power
description: IPMI Sensor Power
unit: "Watts"
chart_type: line
dimensions:
- name: power
- name: ipmi.sensor_reading_percent
description: IPMI Sensor Reading Percentage
unit: "%"
chart_type: line
dimensions:
- name: percentage
|
