Update metadata.yaml for charts.d collectors (#15559)
* update ap metadata * update apcupsd metadata * update libreswan metadata * update nut metadata * update opensips metadata and misc changes * update sensors metadata * Apply suggestions from code review * add keywords * make multi instance false * Added yamlint ignore line length --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud> Co-authored-by: Satyadeep Ashwathnarayana <96257330+sashwathn@users.noreply.github.com>
Emmanuel Vasilakis committed
Jul 28, 2023 at 14:04 UTC
e031a45a203eb9f616b0d1689f52b4d1050a7253
6 files changed
+781
-455
collectors/charts.d.plugin/ap/metadata.yaml
+103
-67
@@ -1,54 +1,90 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: charts.d.plugin
5
module_name: ap
6
monitored_instance:
7
name: Access Points
6
- link: ''
8
+ link: "https://learn.netdata.cloud/docs/data-collection/networking-stack-and-network-interfaces/linux-access-points"
9
categories:
8
- - data-collection.networking-stack-and-network-interfaces
9
- icon_filename: 'netdata.png'
10
+ - data-collection.networking-stack-and-network-interfaces
11
+ icon_filename: "network-wired.svg"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
+ description: ""
17
+ keywords:
18
+ - ap
19
+ - access
20
+ - point
21
+ - wireless
22
+ - network
23
most_popular: false
24
overview:
25
data_collection:
19
- metrics_description: 'Maintain surveillance over Access Points, ensuring optimal wireless network connectivity and performance. Monitor and troubleshoot in realtime for high-quality network operations.'
20
- method_description: ''
26
+ metrics_description: "The ap collector visualizes data related to wireless access points."
27
+ method_description: "It uses the `iw` command line utility to detect access points. For each interface that is of `type AP`, it then runs `iw INTERFACE station dump` and collects statistics."
28
supported_platforms:
22
- include: []
29
+ include: [Linux]
30
exclude: []
24
- multi_instance: true
31
+ multi_instance: false
32
additional_permissions:
26
- description: ''
33
+ description: ""
34
default_behavior:
35
auto_detection:
29
- description: ''
36
+ description: "The plugin is able to auto-detect if you are running access points on your linux box."
37
limits:
31
- description: ''
38
+ description: ""
39
performance_impact:
33
- description: ''
40
+ description: ""
41
setup:
42
prerequisites:
36
- list: []
43
+ list:
44
+ - title: "`iw` utility."
45
+ description: "Make sure the `iw` utility is installed."
46
configuration:
47
file:
39
- name: ''
40
- description: ''
48
+ name: charts.d/ap.conf
49
options:
42
- description: ''
50
+ description: |
51
+ The config file is sourced by the charts.d plugin. It's a standard bash file.
52
+
53
+ The following collapsed table contains all the options that can be configured for the ap collector.
54
folding:
44
- title: ''
55
+ title: "Config options"
56
enabled: true
46
- list: []
57
+ list:
58
+ - name: ap_update_every
59
+ description: The data collection frequency. If unset, will inherit the netdata update frequency.
60
+ default_value: 1
61
+ required: false
62
+ - name: ap_priority
63
+ description: Controls the order of charts at the netdata dashboard.
64
+ default_value: 6900
65
+ required: false
66
+ - name: ap_retries
67
+ description: The number of retries to do in case of failure before disabling the collector.
68
+ default_value: 10
69
+ required: false
70
examples:
71
folding:
49
- enabled: true
50
- title: ''
51
- list: []
72
+ enabled: false
73
+ title: "Config"
74
+ list:
75
+ - name: Change the collection frequency
76
+ description: Specify a custom collection frequence (update_every) for this collector
77
+ config: |
78
+ # the data collection frequency
79
+ # if unset, will inherit the netdata update frequency
80
+ ap_update_every=10
81
+
82
+ # the charts priority on the dashboard
83
+ #ap_priority=6900
84
+
85
+ # the number of retries to do in case of failure
86
+ # before disabling the module
87
+ #ap_retries=10
88
troubleshooting:
89
problems:
90
list: []
@@ -60,48 +96,48 @@ metrics:
96
description: ""
97
availability: []
98
scopes:
63
- - name: wireless device
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: ap.clients
68
- description: Connected clients to ${ssid} on ${dev}
69
- unit: "clients"
70
- chart_type: line
71
- dimensions:
72
- - name: clients
73
- - name: ap.net
74
- description: Bandwidth for ${ssid} on ${dev}
75
- unit: "kilobits/s"
76
- chart_type: area
77
- dimensions:
78
- - name: received
79
- - name: sent
80
- - name: ap.packets
81
- description: Packets for ${ssid} on ${dev}
82
- unit: "packets/s"
83
- chart_type: line
84
- dimensions:
85
- - name: received
86
- - name: sent
87
- - name: ap.issues
88
- description: Transmit Issues for ${ssid} on ${dev}
89
- unit: "issues/s"
90
- chart_type: line
91
- dimensions:
92
- - name: retries
93
- - name: failures
94
- - name: ap.signal
95
- description: Average Signal for ${ssid} on ${dev}
96
- unit: "dBm"
97
- chart_type: line
98
- dimensions:
99
- - name: average signal
100
- - name: ap.bitrate
101
- description: Bitrate for ${ssid} on ${dev}
102
- unit: "Mbps"
103
- chart_type: line
104
- dimensions:
105
- - name: receive
106
- - name: transmit
107
- - name: expected
99
+ - name: wireless device
100
+ description: "These metrics refer to the entire monitored application."
101
+ labels: []
102
+ metrics:
103
+ - name: ap.clients
104
+ description: Connected clients to ${ssid} on ${dev}
105
+ unit: "clients"
106
+ chart_type: line
107
+ dimensions:
108
+ - name: clients
109
+ - name: ap.net
110
+ description: Bandwidth for ${ssid} on ${dev}
111
+ unit: "kilobits/s"
112
+ chart_type: area
113
+ dimensions:
114
+ - name: received
115
+ - name: sent
116
+ - name: ap.packets
117
+ description: Packets for ${ssid} on ${dev}
118
+ unit: "packets/s"
119
+ chart_type: line
120
+ dimensions:
121
+ - name: received
122
+ - name: sent
123
+ - name: ap.issues
124
+ description: Transmit Issues for ${ssid} on ${dev}
125
+ unit: "issues/s"
126
+ chart_type: line
127
+ dimensions:
128
+ - name: retries
129
+ - name: failures
130
+ - name: ap.signal
131
+ description: Average Signal for ${ssid} on ${dev}
132
+ unit: "dBm"
133
+ chart_type: line
134
+ dimensions:
135
+ - name: average signal
136
+ - name: ap.bitrate
137
+ description: Bitrate for ${ssid} on ${dev}
138
+ unit: "Mbps"
139
+ chart_type: line
140
+ dimensions:
141
+ - name: receive
142
+ - name: transmit
143
+ - name: expected
collectors/charts.d.plugin/apcupsd/metadata.yaml
+156
-103
@@ -1,72 +1,125 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: charts.d.plugin
5
module_name: apcupsd
6
monitored_instance:
7
name: APC UPS
6
- link: ''
8
+ link: "https://www.apc.com"
9
categories:
8
- - data-collection.ups
9
- icon_filename: 'apc.png'
10
+ - data-collection.ups
11
+ icon_filename: "apc.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
+ description: ""
17
+ keywords:
18
+ - ups
19
+ - apc
20
+ - power
21
+ - supply
22
+ - battery
23
most_popular: false
24
overview:
25
data_collection:
19
- metrics_description: 'Monitor APC UPS performance with Netdata for optimal uninterruptible power supply operations. Enhance your power supply reliability with real-time APC UPS metrics.'
20
- method_description: ''
26
+ metrics_description: "Monitor APC UPS performance with Netdata for optimal uninterruptible power supply operations. Enhance your power supply reliability with real-time APC UPS metrics."
27
+ method_description: "The collector uses the `apcaccess` tool to contact the `apcupsd` daemon and get the APC UPS statistics."
28
supported_platforms:
29
include: []
30
exclude: []
24
- multi_instance: true
31
+ multi_instance: false
32
additional_permissions:
26
- description: ''
33
+ description: ""
34
default_behavior:
35
auto_detection:
29
- description: ''
36
+ description: "By default, with no configuration provided, the collector will try to contact 127.0.0.1:3551 with using the `apcaccess` utility."
37
limits:
31
- description: ''
38
+ description: ""
39
performance_impact:
33
- description: ''
40
+ description: ""
41
setup:
42
prerequisites:
36
- list: []
43
+ list:
44
+ - title: "Required software"
45
+ description: "Make sure the `apcaccess` and `apcupsd` are installed and running."
46
configuration:
47
file:
39
- name: ''
40
- description: ''
48
+ name: charts.d/apcupsd.conf
49
options:
42
- description: ''
50
+ description: |
51
+ The config file is sourced by the charts.d plugin. It's a standard bash file.
52
+
53
+ The following collapsed table contains all the options that can be configured for the apcupsd collector.
54
folding:
44
- title: ''
55
+ title: "Config options"
56
enabled: true
46
- list: []
57
+ list:
58
+ - name: apcupsd_sources
59
+ description: This is an array of apcupsd sources. You can have multiple entries there. Please refer to the example below on how to set it.
60
+ default_value: "127.0.0.1:3551"
61
+ required: false
62
+ - name: apcupsd_timeout
63
+ description: How long to wait for apcupsd to respond.
64
+ default_value: 3
65
+ required: false
66
+ - name: apcupsd_update_every
67
+ description: The data collection frequency. If unset, will inherit the netdata update frequency.
68
+ default_value: 1
69
+ required: false
70
+ - name: apcupsd_priority
71
+ description: The charts priority on the dashboard.
72
+ default_value: 90000
73
+ required: false
74
+ - name: apcupsd_retries
75
+ description: The number of retries to do in case of failure before disabling the collector.
76
+ default_value: 10
77
+ required: false
78
examples:
79
folding:
49
- enabled: true
50
- title: ''
51
- list: []
80
+ enabled: false
81
+ title: "Config"
82
+ list:
83
+ - name: Multiple apcupsd sources
84
+ description: Specify a multiple apcupsd sources along with a custom update interval
85
+ config: |
86
+ # add all your APC UPSes in this array - uncomment it too
87
+ declare -A apcupsd_sources=(
88
+ ["local"]="127.0.0.1:3551",
89
+ ["remote"]="1.2.3.4:3551"
90
+ )
91
+
92
+ # how long to wait for apcupsd to respond
93
+ #apcupsd_timeout=3
94
+
95
+ # the data collection frequency
96
+ # if unset, will inherit the netdata update frequency
97
+ apcupsd_update_every=5
98
+
99
+ # the charts priority on the dashboard
100
+ #apcupsd_priority=90000
101
+
102
+ # the number of retries to do in case of failure
103
+ # before disabling the module
104
+ #apcupsd_retries=10
105
troubleshooting:
106
problems:
107
list: []
108
alerts:
56
-- name: apcupsd_ups_charge
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/apcupsd.conf
58
- metric: apcupsd.charge
59
- info: average UPS charge over the last minute
60
- os: "*"
61
-- name: apcupsd_10min_ups_load
62
- link: https://github.com/netdata/netdata/blob/master/health/health.d/apcupsd.conf
63
- metric: apcupsd.load
64
- info: average UPS load over the last 10 minutes
65
- os: "*"
66
-- name: apcupsd_last_collected_secs
67
- link: https://github.com/netdata/netdata/blob/master/health/health.d/apcupsd.conf
68
- metric: apcupsd.load
69
- info: number of seconds since the last successful data collection
109
+ - name: apcupsd_ups_charge
110
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/apcupsd.conf
111
+ metric: apcupsd.charge
112
+ info: average UPS charge over the last minute
113
+ os: "*"
114
+ - name: apcupsd_10min_ups_load
115
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/apcupsd.conf
116
+ metric: apcupsd.load
117
+ info: average UPS load over the last 10 minutes
118
+ os: "*"
119
+ - name: apcupsd_last_collected_secs
120
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/apcupsd.conf
121
+ metric: apcupsd.load
122
+ info: number of seconds since the last successful data collection
123
metrics:
124
folding:
125
title: Metrics
@@ -74,71 +127,71 @@ metrics:
127
description: ""
128
availability: []
129
scopes:
77
- - name: ups
78
- description: ""
79
- labels: []
80
- metrics:
81
- - name: apcupsd.charge
82
- description: UPS Charge
83
- unit: "percentage"
84
- chart_type: area
85
- dimensions:
86
- - name: charge
87
- - name: apcupsd.battery.voltage
88
- description: UPS Battery Voltage
89
- unit: "Volts"
90
- chart_type: line
91
- dimensions:
92
- - name: voltage
93
- - name: nominal
94
- - name: apcupsd.input.voltage
95
- description: UPS Input Voltage
96
- unit: "Volts"
97
- chart_type: line
98
- dimensions:
99
- - name: voltage
100
- - name: min
101
- - name: max
102
- - name: apcupsd.output.voltage
103
- description: UPS Output Voltage
104
- unit: "Volts"
105
- chart_type: line
106
- dimensions:
107
- - name: absolute
108
- - name: nominal
109
- - name: apcupsd.input.frequency
110
- description: UPS Input Voltage
111
- unit: "Hz"
112
- chart_type: line
113
- dimensions:
114
- - name: frequency
115
- - name: apcupsd.load
116
- description: UPS Load
117
- unit: "percentage"
118
- chart_type: area
119
- dimensions:
120
- - name: load
121
- - name: apcupsd.load_usage
122
- description: UPS Load Usage
123
- unit: "Watts"
124
- chart_type: area
125
- dimensions:
126
- - name: load
127
- - name: apcupsd.temperature
128
- description: UPS Temperature
129
- unit: "Celsius"
130
- chart_type: line
131
- dimensions:
132
- - name: temp
133
- - name: apcupsd.time
134
- description: UPS Time Remaining
135
- unit: "Minutes"
136
- chart_type: area
137
- dimensions:
138
- - name: time
139
- - name: apcupsd.online
140
- description: UPS ONLINE flag
141
- unit: "boolean"
142
- chart_type: line
143
- dimensions:
144
- - name: online
130
+ - name: ups
131
+ description: "Metrics related to UPS. Each UPS provides its own set of the following metrics."
132
+ labels: []
133
+ metrics:
134
+ - name: apcupsd.charge
135
+ description: UPS Charge
136
+ unit: "percentage"
137
+ chart_type: area
138
+ dimensions:
139
+ - name: charge
140
+ - name: apcupsd.battery.voltage
141
+ description: UPS Battery Voltage
142
+ unit: "Volts"
143
+ chart_type: line
144
+ dimensions:
145
+ - name: voltage
146
+ - name: nominal
147
+ - name: apcupsd.input.voltage
148
+ description: UPS Input Voltage
149
+ unit: "Volts"
150
+ chart_type: line
151
+ dimensions:
152
+ - name: voltage
153
+ - name: min
154
+ - name: max
155
+ - name: apcupsd.output.voltage
156
+ description: UPS Output Voltage
157
+ unit: "Volts"
158
+ chart_type: line
159
+ dimensions:
160
+ - name: absolute
161
+ - name: nominal
162
+ - name: apcupsd.input.frequency
163
+ description: UPS Input Voltage
164
+ unit: "Hz"
165
+ chart_type: line
166
+ dimensions:
167
+ - name: frequency
168
+ - name: apcupsd.load
169
+ description: UPS Load
170
+ unit: "percentage"
171
+ chart_type: area
172
+ dimensions:
173
+ - name: load
174
+ - name: apcupsd.load_usage
175
+ description: UPS Load Usage
176
+ unit: "Watts"
177
+ chart_type: area
178
+ dimensions:
179
+ - name: load
180
+ - name: apcupsd.temperature
181
+ description: UPS Temperature
182
+ unit: "Celsius"
183
+ chart_type: line
184
+ dimensions:
185
+ - name: temp
186
+ - name: apcupsd.time
187
+ description: UPS Time Remaining
188
+ unit: "Minutes"
189
+ chart_type: area
190
+ dimensions:
191
+ - name: time
192
+ - name: apcupsd.online
193
+ description: UPS ONLINE flag
194
+ unit: "boolean"
195
+ chart_type: line
196
+ dimensions:
197
+ - name: online
collectors/charts.d.plugin/libreswan/metadata.yaml
+101
-37
@@ -1,54 +1,118 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: charts.d.plugin
5
module_name: libreswan
6
monitored_instance:
7
name: Libreswan
6
- link: ''
8
+ link: "https://libreswan.org/"
9
categories:
8
- - data-collection.vpns
9
- icon_filename: 'libreswan.png'
10
+ - data-collection.vpns
11
+ icon_filename: "libreswan.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
+ description: ""
17
+ keywords:
18
+ - vpn
19
+ - libreswan
20
+ - network
21
+ - ipsec
22
most_popular: false
23
overview:
24
data_collection:
19
- metrics_description: 'Monitor Libreswan performance for optimal IPsec VPN operations. Improve your VPN operations with Netdata''s real-time metrics and built-in alerts.'
20
- method_description: ''
25
+ metrics_description: "Monitor Libreswan performance for optimal IPsec VPN operations. Improve your VPN operations with Netdata''s real-time metrics and built-in alerts."
26
+ method_description: "The collector uses the `ipsec` command to collect the information it needs."
27
supported_platforms:
28
include: []
29
exclude: []
30
multi_instance: true
31
additional_permissions:
26
- description: ''
32
+ description: ""
33
default_behavior:
34
auto_detection:
29
- description: ''
35
+ description: ""
36
limits:
31
- description: ''
37
+ description: ""
38
performance_impact:
33
- description: ''
39
+ description: ""
40
setup:
41
prerequisites:
36
- list: []
42
+ list:
43
+ - title: "Permissions to execute `ipsec`"
44
+ description: |
45
+ The plugin executes 2 commands to collect all the information it needs:
46
+
47
+ ```sh
48
+ ipsec whack --status
49
+ ipsec whack --trafficstatus
50
+ ```
51
+
52
+ The first command is used to extract the currently established tunnels, their IDs and their names.
53
+ The second command is used to extract the current uptime and traffic.
54
+
55
+ Most probably user `netdata` will not be able to query libreswan, so the `ipsec` commands will be denied.
56
+ The plugin attempts to run `ipsec` as `sudo ipsec ...`, to get access to libreswan statistics.
57
+
58
+ To allow user `netdata` execute `sudo ipsec ...`, create the file `/etc/sudoers.d/netdata` with this content:
59
+
60
+ ```
61
+ netdata ALL = (root) NOPASSWD: /sbin/ipsec whack --status
62
+ netdata ALL = (root) NOPASSWD: /sbin/ipsec whack --trafficstatus
63
+ ```
64
+
65
+ Make sure the path `/sbin/ipsec` matches your setup (execute `which ipsec` to find the right path).
66
configuration:
67
file:
39
- name: ''
40
- description: ''
68
+ name: charts.d/libreswan.conf
69
options:
42
- description: ''
70
+ description: |
71
+ The config file is sourced by the charts.d plugin. It's a standard bash file.
72
+
73
+ The following collapsed table contains all the options that can be configured for the libreswan collector.
74
folding:
44
- title: ''
75
+ title: "Config options"
76
enabled: true
46
- list: []
77
+ list:
78
+ - name: libreswan_update_every
79
+ description: The data collection frequency. If unset, will inherit the netdata update frequency.
80
+ default_value: 1
81
+ required: false
82
+ - name: libreswan_priority
83
+ description: The charts priority on the dashboard
84
+ default_value: 90000
85
+ required: false
86
+ - name: libreswan_retries
87
+ description: The number of retries to do in case of failure before disabling the collector.
88
+ default_value: 10
89
+ required: false
90
+ - name: libreswan_sudo
91
+ description: Whether to run `ipsec` with `sudo` or not.
92
+ default_value: 1
93
+ required: false
94
examples:
95
folding:
49
- enabled: true
50
- title: ''
51
- list: []
96
+ enabled: false
97
+ title: "Config"
98
+ list:
99
+ - name: Run `ipsec` without sudo
100
+ description: Run the `ipsec` utility without sudo
101
+ config: |
102
+ # the data collection frequency
103
+ # if unset, will inherit the netdata update frequency
104
+ #libreswan_update_every=1
105
+
106
+ # the charts priority on the dashboard
107
+ #libreswan_priority=90000
108
+
109
+ # the number of retries to do in case of failure
110
+ # before disabling the module
111
+ #libreswan_retries=10
112
+
113
+ # set to 1, to run ipsec with sudo (the default)
114
+ # set to 0, to run ipsec without sudo
115
+ libreswan_sudo=0
116
troubleshooting:
117
problems:
118
list: []
@@ -60,20 +124,20 @@ metrics:
124
description: ""
125
availability: []
126
scopes:
63
- - name: IPSEC tunnel
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: libreswan.net
68
- description: LibreSWAN Tunnel ${name} Traffic
69
- unit: "kilobits/s"
70
- chart_type: area
71
- dimensions:
72
- - name: in
73
- - name: out
74
- - name: libreswan.uptime
75
- description: LibreSWAN Tunnel ${name} Uptime
76
- unit: "seconds"
77
- chart_type: line
78
- dimensions:
79
- - name: uptime
127
+ - name: IPSEC tunnel
128
+ description: "Metrics related to IPSEC tunnels. Each tunnel provides its own set of the following metrics."
129
+ labels: []
130
+ metrics:
131
+ - name: libreswan.net
132
+ description: LibreSWAN Tunnel ${name} Traffic
133
+ unit: "kilobits/s"
134
+ chart_type: area
135
+ dimensions:
136
+ - name: in
137
+ - name: out
138
+ - name: libreswan.uptime
139
+ description: LibreSWAN Tunnel ${name} Uptime
140
+ unit: "seconds"
141
+ chart_type: line
142
+ dimensions:
143
+ - name: uptime
collectors/charts.d.plugin/nut/metadata.yaml
+76
-11
@@ -12,12 +12,16 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - nut
17
+ - network ups tools
18
+ - ups
19
+ - pdu
20
most_popular: false
21
overview:
22
data_collection:
23
metrics_description: 'Examine UPS/PDU metrics with Netdata for insights into power device performance. Improve your power device performance with comprehensive dashboards and anomaly detection.'
20
- method_description: ''
24
+ method_description: 'This collector uses the `nut` (Network UPS Tools) to query statistics for multiple UPS devices.'
25
supported_platforms:
26
include: []
27
exclude: []
@@ -33,22 +37,83 @@ overview:
37
description: ''
38
setup:
39
prerequisites:
36
- list: []
40
+ list:
41
+ - title: "Required software"
42
+ description: "Make sure the Network UPS Tools (`nut`) is installed and can detect your UPS devices."
43
configuration:
44
file:
39
- name: ''
40
- description: ''
45
+ name: charts.d/nut.conf
46
options:
42
- description: ''
47
+ description: |
48
+ The config file is sourced by the charts.d plugin. It's a standard bash file.
49
+
50
+ The following collapsed table contains all the options that can be configured for the nut collector.
51
folding:
44
- title: ''
52
+ title: "Config options"
53
enabled: true
46
- list: []
54
+ list:
55
+ - name: nut_ups
56
+ description: A space separated list of UPS names. If empty, the list returned by `upsc -l` will be used.
57
+ default_value: ""
58
+ required: false
59
+ - name: nut_names
60
+ description: Each line represents an alias for one UPS. If empty, the FQDN will be used.
61
+ default_value: ""
62
+ required: false
63
+ - name: nut_timeout
64
+ description: How long to wait for nut to respond.
65
+ default_value: 2
66
+ required: false
67
+ - name: nut_clients_chart
68
+ description: Set this to 1 to enable another chart showing the number of UPS clients connected to `upsd`.
69
+ default_value: 1
70
+ required: false
71
+ - name: nut_update_every
72
+ description: The data collection frequency. If unset, will inherit the netdata update frequency.
73
+ default_value: 2
74
+ required: false
75
+ - name: nut_priority
76
+ description: The charts priority on the dashboard
77
+ default_value: 90000
78
+ required: false
79
+ - name: nut_retries
80
+ description: The number of retries to do in case of failure before disabling the collector.
81
+ default_value: 10
82
+ required: false
83
examples:
84
folding:
85
enabled: true
50
- title: ''
51
- list: []
86
+ title: "Config"
87
+ list:
88
+ - name: Provide names to UPS devices
89
+ description: Map aliases to UPS devices
90
+ config: |
91
+ # a space separated list of UPS names
92
+ # if empty, the list returned by 'upsc -l' will be used
93
+ #nut_ups=
94
+
95
+ # each line represents an alias for one UPS
96
+ # if empty, the FQDN will be used
97
+ nut_names["XXXXXX"]="UPS-office"
98
+ nut_names["YYYYYY"]="UPS-rack"
99
+
100
+ # how much time in seconds, to wait for nut to respond
101
+ #nut_timeout=2
102
+
103
+ # set this to 1, to enable another chart showing the number
104
+ # of UPS clients connected to upsd
105
+ #nut_clients_chart=1
106
+
107
+ # the data collection frequency
108
+ # if unset, will inherit the netdata update frequency
109
+ #nut_update_every=2
110
+
111
+ # the charts priority on the dashboard
112
+ #nut_priority=90000
113
+
114
+ # the number of retries to do in case of failure
115
+ # before disabling the module
116
+ #nut_retries=10
117
troubleshooting:
118
problems:
119
list: []
@@ -75,7 +140,7 @@ metrics:
140
availability: []
141
scopes:
142
- name: ups
78
- description: ""
143
+ description: "Metrics related to UPS. Each UPS provides its own set of the following metrics."
144
labels: []
145
metrics:
146
- name: nut.charge
collectors/charts.d.plugin/opensips/metadata.yaml
+225
-173
@@ -1,54 +1,106 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: charts.d.plugin
5
module_name: opensips
6
monitored_instance:
7
name: OpenSIPS
6
- link: ''
8
+ link: "https://opensips.org/"
9
categories:
8
- - data-collection.telephony-servers
9
- icon_filename: 'opensips.png'
10
+ - data-collection.telephony-servers
11
+ icon_filename: "opensips.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
+ description: ""
17
+ keywords:
18
+ - opensips
19
+ - sip
20
+ - voice
21
+ - video
22
+ - stream
23
most_popular: false
24
overview:
25
data_collection:
19
- metrics_description: 'Examine OpenSIPS metrics for insights into SIP server operations. Study call rates, error rates, and response times for reliable voice over IP services.'
20
- method_description: ''
26
+ metrics_description: "Examine OpenSIPS metrics for insights into SIP server operations. Study call rates, error rates, and response times for reliable voice over IP services."
27
+ method_description: "The collector uses the `opensipsctl` command line utility to gather OpenSIPS metrics."
28
supported_platforms:
29
include: []
30
exclude: []
31
multi_instance: true
32
additional_permissions:
26
- description: ''
33
+ description: ""
34
default_behavior:
35
auto_detection:
29
- description: ''
36
+ description: "The collector will attempt to call `opensipsctl` along with a default number of parameters, even without any configuration."
37
limits:
31
- description: ''
38
+ description: ""
39
performance_impact:
33
- description: ''
40
+ description: ""
41
setup:
42
prerequisites:
36
- list: []
43
+ list:
44
+ - title: "Required software"
45
+ description: "The collector requires the `opensipsctl` to be installed."
46
configuration:
47
file:
39
- name: ''
40
- description: ''
48
+ name: charts.d/opensips.conf
49
options:
42
- description: ''
50
+ description: |
51
+ The config file is sourced by the charts.d plugin. It's a standard bash file.
52
+
53
+ The following collapsed table contains all the options that can be configured for the opensips collector.
54
folding:
44
- title: ''
55
+ title: "Config options"
56
enabled: true
46
- list: []
57
+ list:
58
+ - name: opensips_opts
59
+ description: Specify parameters to the `opensipsctl` command. If the default value fails to get global status, set here whatever options are needed to connect to the opensips server.
60
+ default_value: "fifo get_statistics all"
61
+ required: false
62
+ - name: opensips_cmd
63
+ description: If `opensipsctl` is not in $PATH, specify it's full path here.
64
+ default_value: ""
65
+ required: false
66
+ - name: opensips_timeout
67
+ description: How long to wait for `opensipsctl` to respond.
68
+ default_value: 2
69
+ required: false
70
+ - name: opensips_update_every
71
+ description: The data collection frequency. If unset, will inherit the netdata update frequency.
72
+ default_value: 5
73
+ required: false
74
+ - name: opensips_priority
75
+ description: The charts priority on the dashboard.
76
+ default_value: 80000
77
+ required: false
78
+ - name: opensips_retries
79
+ description: The number of retries to do in case of failure before disabling the collector.
80
+ default_value: 10
81
+ required: false
82
examples:
83
folding:
49
- enabled: true
50
- title: ''
51
- list: []
84
+ enabled: false
85
+ title: "Config"
86
+ list:
87
+ - name: Custom `opensipsctl` command
88
+ description: Set a custom path to the `opensipsctl` command
89
+ config: |
90
+ #opensips_opts="fifo get_statistics all"
91
+ opensips_cmd=/opt/opensips/bin/opensipsctl
92
+ #opensips_timeout=2
93
+
94
+ # the data collection frequency
95
+ # if unset, will inherit the netdata update frequency
96
+ #opensips_update_every=5
97
+
98
+ # the charts priority on the dashboard
99
+ #opensips_priority=80000
100
+
101
+ # the number of retries to do in case of failure
102
+ # before disabling the module
103
+ #opensips_retries=10
104
troubleshooting:
105
problems:
106
list: []
@@ -60,156 +112,156 @@ metrics:
112
description: ""
113
availability: []
114
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: opensips.dialogs_active
68
- description: OpenSIPS Active Dialogs
69
- unit: "dialogs"
70
- chart_type: area
71
- dimensions:
72
- - name: active
73
- - name: early
74
- - name: opensips.users
75
- description: OpenSIPS Users
76
- unit: "users"
77
- chart_type: line
78
- dimensions:
79
- - name: registered
80
- - name: location
81
- - name: contacts
82
- - name: expires
83
- - name: opensips.registrar
84
- description: OpenSIPS Registrar
85
- unit: "registrations/s"
86
- chart_type: line
87
- dimensions:
88
- - name: accepted
89
- - name: rejected
90
- - name: opensips.transactions
91
- description: OpenSIPS Transactions
92
- unit: "transactions/s"
93
- chart_type: line
94
- dimensions:
95
- - name: UAS
96
- - name: UAC
97
- - name: opensips.core_rcv
98
- description: OpenSIPS Core Receives
99
- unit: "queries/s"
100
- chart_type: line
101
- dimensions:
102
- - name: requests
103
- - name: replies
104
- - name: opensips.core_fwd
105
- description: OpenSIPS Core Forwards
106
- unit: "queries/s"
107
- chart_type: line
108
- dimensions:
109
- - name: requests
110
- - name: replies
111
- - name: opensips.core_drop
112
- description: OpenSIPS Core Drops
113
- unit: "queries/s"
114
- chart_type: line
115
- dimensions:
116
- - name: requests
117
- - name: replies
118
- - name: opensips.core_err
119
- description: OpenSIPS Core Errors
120
- unit: "queries/s"
121
- chart_type: line
122
- dimensions:
123
- - name: requests
124
- - name: replies
125
- - name: opensips.core_bad
126
- description: OpenSIPS Core Bad
127
- unit: "queries/s"
128
- chart_type: line
129
- dimensions:
130
- - name: bad_URIs_rcvd
131
- - name: unsupported_methods
132
- - name: bad_msg_hdr
133
- - name: opensips.tm_replies
134
- description: OpenSIPS TM Replies
135
- unit: "replies/s"
136
- chart_type: line
137
- dimensions:
138
- - name: received
139
- - name: relayed
140
- - name: local
141
- - name: opensips.transactions_status
142
- description: OpenSIPS Transactions Status
143
- unit: "transactions/s"
144
- chart_type: line
145
- dimensions:
146
- - name: 2xx
147
- - name: 3xx
148
- - name: 4xx
149
- - name: 5xx
150
- - name: 6xx
151
- - name: opensips.transactions_inuse
152
- description: OpenSIPS InUse Transactions
153
- unit: "transactions"
154
- chart_type: line
155
- dimensions:
156
- - name: inuse
157
- - name: opensips.sl_replies
158
- description: OpenSIPS SL Replies
159
- unit: "replies/s"
160
- chart_type: line
161
- dimensions:
162
- - name: 1xx
163
- - name: 2xx
164
- - name: 3xx
165
- - name: 4xx
166
- - name: 5xx
167
- - name: 6xx
168
- - name: sent
169
- - name: error
170
- - name: ACKed
171
- - name: opensips.dialogs
172
- description: OpenSIPS Dialogs
173
- unit: "dialogs/s"
174
- chart_type: line
175
- dimensions:
176
- - name: processed
177
- - name: expire
178
- - name: failed
179
- - name: opensips.net_waiting
180
- description: OpenSIPS Network Waiting
181
- unit: "kilobytes"
182
- chart_type: line
183
- dimensions:
184
- - name: UDP
185
- - name: TCP
186
- - name: opensips.uri_checks
187
- description: OpenSIPS URI Checks
188
- unit: "checks / sec"
189
- chart_type: line
190
- dimensions:
191
- - name: positive
192
- - name: negative
193
- - name: opensips.traces
194
- description: OpenSIPS Traces
195
- unit: "traces / sec"
196
- chart_type: line
197
- dimensions:
198
- - name: requests
199
- - name: replies
200
- - name: opensips.shmem
201
- description: OpenSIPS Shared Memory
202
- unit: "kilobytes"
203
- chart_type: line
204
- dimensions:
205
- - name: total
206
- - name: used
207
- - name: real_used
208
- - name: max_used
209
- - name: free
210
- - name: opensips.shmem_fragment
211
- description: OpenSIPS Shared Memory Fragmentation
212
- unit: "fragments"
213
- chart_type: line
214
- dimensions:
215
- - name: fragments
115
+ - name: global
116
+ description: "These metrics refer to the entire monitored application."
117
+ labels: []
118
+ metrics:
119
+ - name: opensips.dialogs_active
120
+ description: OpenSIPS Active Dialogs
121
+ unit: "dialogs"
122
+ chart_type: area
123
+ dimensions:
124
+ - name: active
125
+ - name: early
126
+ - name: opensips.users
127
+ description: OpenSIPS Users
128
+ unit: "users"
129
+ chart_type: line
130
+ dimensions:
131
+ - name: registered
132
+ - name: location
133
+ - name: contacts
134
+ - name: expires
135
+ - name: opensips.registrar
136
+ description: OpenSIPS Registrar
137
+ unit: "registrations/s"
138
+ chart_type: line
139
+ dimensions:
140
+ - name: accepted
141
+ - name: rejected
142
+ - name: opensips.transactions
143
+ description: OpenSIPS Transactions
144
+ unit: "transactions/s"
145
+ chart_type: line
146
+ dimensions:
147
+ - name: UAS
148
+ - name: UAC
149
+ - name: opensips.core_rcv
150
+ description: OpenSIPS Core Receives
151
+ unit: "queries/s"
152
+ chart_type: line
153
+ dimensions:
154
+ - name: requests
155
+ - name: replies
156
+ - name: opensips.core_fwd
157
+ description: OpenSIPS Core Forwards
158
+ unit: "queries/s"
159
+ chart_type: line
160
+ dimensions:
161
+ - name: requests
162
+ - name: replies
163
+ - name: opensips.core_drop
164
+ description: OpenSIPS Core Drops
165
+ unit: "queries/s"
166
+ chart_type: line
167
+ dimensions:
168
+ - name: requests
169
+ - name: replies
170
+ - name: opensips.core_err
171
+ description: OpenSIPS Core Errors
172
+ unit: "queries/s"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: requests
176
+ - name: replies
177
+ - name: opensips.core_bad
178
+ description: OpenSIPS Core Bad
179
+ unit: "queries/s"
180
+ chart_type: line
181
+ dimensions:
182
+ - name: bad_URIs_rcvd
183
+ - name: unsupported_methods
184
+ - name: bad_msg_hdr
185
+ - name: opensips.tm_replies
186
+ description: OpenSIPS TM Replies
187
+ unit: "replies/s"
188
+ chart_type: line
189
+ dimensions:
190
+ - name: received
191
+ - name: relayed
192
+ - name: local
193
+ - name: opensips.transactions_status
194
+ description: OpenSIPS Transactions Status
195
+ unit: "transactions/s"
196
+ chart_type: line
197
+ dimensions:
198
+ - name: 2xx
199
+ - name: 3xx
200
+ - name: 4xx
201
+ - name: 5xx
202
+ - name: 6xx
203
+ - name: opensips.transactions_inuse
204
+ description: OpenSIPS InUse Transactions
205
+ unit: "transactions"
206
+ chart_type: line
207
+ dimensions:
208
+ - name: inuse
209
+ - name: opensips.sl_replies
210
+ description: OpenSIPS SL Replies
211
+ unit: "replies/s"
212
+ chart_type: line
213
+ dimensions:
214
+ - name: 1xx
215
+ - name: 2xx
216
+ - name: 3xx
217
+ - name: 4xx
218
+ - name: 5xx
219
+ - name: 6xx
220
+ - name: sent
221
+ - name: error
222
+ - name: ACKed
223
+ - name: opensips.dialogs
224
+ description: OpenSIPS Dialogs
225
+ unit: "dialogs/s"
226
+ chart_type: line
227
+ dimensions:
228
+ - name: processed
229
+ - name: expire
230
+ - name: failed
231
+ - name: opensips.net_waiting
232
+ description: OpenSIPS Network Waiting
233
+ unit: "kilobytes"
234
+ chart_type: line
235
+ dimensions:
236
+ - name: UDP
237
+ - name: TCP
238
+ - name: opensips.uri_checks
239
+ description: OpenSIPS URI Checks
240
+ unit: "checks / sec"
241
+ chart_type: line
242
+ dimensions:
243
+ - name: positive
244
+ - name: negative
245
+ - name: opensips.traces
246
+ description: OpenSIPS Traces
247
+ unit: "traces / sec"
248
+ chart_type: line
249
+ dimensions:
250
+ - name: requests
251
+ - name: replies
252
+ - name: opensips.shmem
253
+ description: OpenSIPS Shared Memory
254
+ unit: "kilobytes"
255
+ chart_type: line
256
+ dimensions:
257
+ - name: total
258
+ - name: used
259
+ - name: real_used
260
+ - name: max_used
261
+ - name: free
262
+ - name: opensips.shmem_fragment
263
+ description: OpenSIPS Shared Memory Fragmentation
264
+ unit: "fragments"
265
+ chart_type: line
266
+ dimensions:
267
+ - name: fragments
collectors/charts.d.plugin/sensors/metadata.yaml
+120
-64
@@ -1,17 +1,19 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: charts.d.plugin
5
module_name: sensors
6
monitored_instance:
7
name: Linux Sensors (sysfs)
6
- link: ''
8
+ link: "https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface"
9
categories:
10
- data-collection.hardware-devices-and-sensors
9
- icon_filename: 'microchip.svg'
11
+ icon_filename: "microchip.svg"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
16
+ description: ""
17
keywords:
18
- sensors
19
- sysfs
@@ -21,39 +23,93 @@ meta:
23
most_popular: false
24
overview:
25
data_collection:
24
- metrics_description: "Examine Linux Sensors metrics with Netdata for insights into hardware health and performance. Enhance your system's reliability with real-time hardware health insights."
25
- method_description: ''
26
+ metrics_description: |
27
+ Use this collector when `lm-sensors` doesn't work on your device (e.g. for RPi temperatures).
28
+ For all other cases use the [Python collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/sensors), which supports multiple jobs, is more efficient and performs calculations on top of the kernel provided values."
29
+ method_description: |
30
+ It will provide charts for all configured system sensors, by reading sensors directly from the kernel.
31
+ The values graphed are the raw hardware values of the sensors.
32
supported_platforms:
27
- include: []
33
+ include: [Linux]
34
exclude: []
35
multi_instance: true
36
additional_permissions:
31
- description: ''
37
+ description: ""
38
default_behavior:
39
auto_detection:
34
- description: ''
40
+ description: "By default, the collector will try to read entries under `/sys/devices`"
41
limits:
36
- description: ''
42
+ description: ""
43
performance_impact:
38
- description: ''
44
+ description: ""
45
setup:
46
prerequisites:
47
list: []
48
configuration:
49
file:
44
- name: ''
45
- description: ''
50
+ name: charts.d/sensors.conf
51
options:
47
- description: ''
52
+ description: |
53
+ The config file is sourced by the charts.d plugin. It's a standard bash file.
54
+
55
+ The following collapsed table contains all the options that can be configured for the sensors collector.
56
folding:
49
- title: ''
57
+ title: "Config options"
58
enabled: true
51
- list: []
59
+ list:
60
+ - name: sensors_sys_dir
61
+ description: The directory the kernel exposes sensor data.
62
+ default_value: "/sys/devices"
63
+ required: false
64
+ - name: sensors_sys_depth
65
+ description: How deep in the tree to check for sensor data.
66
+ default_value: 10
67
+ required: false
68
+ - name: sensors_source_update
69
+ description: If set to 1, the script will overwrite internal script functions with code generated ones.
70
+ default_value: 1
71
+ required: false
72
+ - name: sensors_update_every
73
+ description: The data collection frequency. If unset, will inherit the netdata update frequency.
74
+ default_value: 1
75
+ required: false
76
+ - name: sensors_priority
77
+ description: The charts priority on the dashboard.
78
+ default_value: 90000
79
+ required: false
80
+ - name: sensors_retries
81
+ description: The number of retries to do in case of failure before disabling the collector.
82
+ default_value: 10
83
+ required: false
84
examples:
85
folding:
54
- enabled: true
55
- title: ''
56
- list: []
86
+ enabled: false
87
+ title: "Config"
88
+ list:
89
+ - name: Set sensors path depth
90
+ description: Set a different sensors path depth
91
+ config: |
92
+ # the directory the kernel keeps sensor data
93
+ #sensors_sys_dir="/sys/devices"
94
+
95
+ # how deep in the tree to check for sensor data
96
+ sensors_sys_depth=5
97
+
98
+ # if set to 1, the script will overwrite internal
99
+ # script functions with code generated ones
100
+ # leave to 1, is faster
101
+ #sensors_source_update=1
102
+
103
+ # the data collection frequency
104
+ # if unset, will inherit the netdata update frequency
105
+ #sensors_update_every=
106
+
107
+ # the charts priority on the dashboard
108
+ #sensors_priority=90000
109
+
110
+ # the number of retries to do in case of failure
111
+ # before disabling the module
112
+ #sensors_retries=10
113
troubleshooting:
114
problems:
115
list: []
@@ -65,49 +121,49 @@ metrics:
121
description: ""
122
availability: []
123
scopes:
68
- - name: sensor chip
69
- description: ""
70
- labels: []
71
- metrics:
72
- - name: sensors.temp
73
- description: Temperature
74
- unit: "Celsius"
75
- chart_type: line
76
- dimensions:
77
- - name: '{filename}'
78
- - name: sensors.volt
79
- description: Voltage
80
- unit: "Volts"
81
- chart_type: line
82
- dimensions:
83
- - name: '{filename}'
84
- - name: sensors.curr
85
- description: Current
86
- unit: "Ampere"
87
- chart_type: line
88
- dimensions:
89
- - name: '{filename}'
90
- - name: sensors.power
91
- description: Power
92
- unit: "Watt"
93
- chart_type: line
94
- dimensions:
95
- - name: '{filename}'
96
- - name: sensors.fans
97
- description: Fans Speed
98
- unit: "Rotations / Minute"
99
- chart_type: line
100
- dimensions:
101
- - name: '{filename}'
102
- - name: sensors.energy
103
- description: Energy
104
- unit: "Joule"
105
- chart_type: area
106
- dimensions:
107
- - name: '{filename}'
108
- - name: sensors.humidity
109
- description: Humidity
110
- unit: "Percent"
111
- chart_type: line
112
- dimensions:
113
- - name: '{filename}'
124
+ - name: sensor chip
125
+ description: "Metrics related to sensor chips. Each chip provides its own set of the following metrics."
126
+ labels: []
127
+ metrics:
128
+ - name: sensors.temp
129
+ description: Temperature
130
+ unit: "Celsius"
131
+ chart_type: line
132
+ dimensions:
133
+ - name: "{filename}"
134
+ - name: sensors.volt
135
+ description: Voltage
136
+ unit: "Volts"
137
+ chart_type: line
138
+ dimensions:
139
+ - name: "{filename}"
140
+ - name: sensors.curr
141
+ description: Current
142
+ unit: "Ampere"
143
+ chart_type: line
144
+ dimensions:
145
+ - name: "{filename}"
146
+ - name: sensors.power
147
+ description: Power
148
+ unit: "Watt"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: "{filename}"
152
+ - name: sensors.fans
153
+ description: Fans Speed
154
+ unit: "Rotations / Minute"
155
+ chart_type: line
156
+ dimensions:
157
+ - name: "{filename}"
158
+ - name: sensors.energy
159
+ description: Energy
160
+ unit: "Joule"
161
+ chart_type: area
162
+ dimensions:
163
+ - name: "{filename}"
164
+ - name: sensors.humidity
165
+ description: Humidity
166
+ unit: "Percent"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: "{filename}"