convert collectors meta files from single to multi (#15642)
Ilya Mashchenko committed
Jul 31, 2023 at 12:23 UTC
44807f0dab784fda5f2949633a3d91ab32365462
71 files changed
+11269
-11316
.vscode/settings.json
+4
-5
@@ -1,7 +1,6 @@
1
{
2
- "yaml.schemas": {
3
- "./integrations/schemas/collection-single-module.json": "/metadata.yaml",
4
- "./integrations/schemas/collection-multi-module.json": "/multi_metadata.yaml",
5
- "./integrations/schemas/categories.json": "/categories.yaml",
6
- }
2
+ "yaml.schemas": {
3
+ "./integrations/schemas/collector.json": "/metadata.yaml",
4
+ "./integrations/schemas/categories.json": "/categories.yaml"
5
+ }
6
}
collectors/apps.plugin/metadata.yaml
renamed
collectors/cgroups.plugin/metadata.yaml
renamed
collectors/charts.d.plugin/ap/metadata.yaml
+141
-141
@@ -1,143 +1,143 @@
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
8
- link: "https://learn.netdata.cloud/docs/data-collection/networking-stack-and-network-interfaces/linux-access-points"
9
- categories:
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:
16
- description: ""
17
- keywords:
18
- - ap
19
- - access
20
- - point
21
- - wireless
22
- - network
23
- most_popular: false
24
-overview:
25
- data_collection:
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:
29
- include: [Linux]
30
- exclude: []
31
- multi_instance: false
32
- additional_permissions:
33
- description: ""
34
- default_behavior:
35
- auto_detection:
36
- description: "The plugin is able to auto-detect if you are running access points on your linux box."
37
- limits:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
-setup:
42
- prerequisites:
43
- list:
44
- - title: "`iw` utility."
45
- description: "Make sure the `iw` utility is installed."
46
- configuration:
47
- file:
48
- name: charts.d/ap.conf
49
- options:
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:
55
- title: "Config options"
56
- enabled: true
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:
1
+plugin_name: charts.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: charts.d.plugin
5
+ module_name: ap
6
+ monitored_instance:
7
+ name: Access Points
8
+ link: "https://learn.netdata.cloud/docs/data-collection/networking-stack-and-network-interfaces/linux-access-points"
9
+ categories:
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:
16
+ description: ""
17
+ keywords:
18
+ - ap
19
+ - access
20
+ - point
21
+ - wireless
22
+ - network
23
+ most_popular: false
24
+ overview:
25
+ data_collection:
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:
29
+ include: [Linux]
30
+ exclude: []
31
+ multi_instance: false
32
+ additional_permissions:
33
+ description: ""
34
+ default_behavior:
35
+ auto_detection:
36
+ description: "The plugin is able to auto-detect if you are running access points on your linux box."
37
+ limits:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list:
44
+ - title: "`iw` utility."
45
+ description: "Make sure the `iw` utility is installed."
46
+ configuration:
47
+ file:
48
+ name: charts.d/ap.conf
49
+ options:
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:
55
+ title: "Config options"
56
+ enabled: true
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:
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: []
91
+ alerts: []
92
+ metrics:
93
folding:
94
+ title: Metrics
95
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: []
91
-alerts: []
92
-metrics:
93
- folding:
94
- title: Metrics
95
- enabled: false
96
- description: ""
97
- availability: []
98
- scopes:
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
96
+ description: ""
97
+ availability: []
98
+ scopes:
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
+195
-195
@@ -1,197 +1,197 @@
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
8
- link: "https://www.apc.com"
9
- categories:
10
- - data-collection.ups
11
- icon_filename: "apc.svg"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - ups
19
- - apc
20
- - power
21
- - supply
22
- - battery
23
- most_popular: false
24
-overview:
25
- data_collection:
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: []
31
- multi_instance: false
32
- additional_permissions:
33
- description: ""
34
- default_behavior:
35
- auto_detection:
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:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
-setup:
42
- prerequisites:
43
- list:
44
- - title: "Required software"
45
- description: "Make sure the `apcaccess` and `apcupsd` are installed and running."
46
- configuration:
47
- file:
48
- name: charts.d/apcupsd.conf
49
- options:
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:
55
- title: "Config options"
56
- enabled: true
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:
1
+plugin_name: charts.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: charts.d.plugin
5
+ module_name: apcupsd
6
+ monitored_instance:
7
+ name: APC UPS
8
+ link: "https://www.apc.com"
9
+ categories:
10
+ - data-collection.ups
11
+ icon_filename: "apc.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - ups
19
+ - apc
20
+ - power
21
+ - supply
22
+ - battery
23
+ most_popular: false
24
+ overview:
25
+ data_collection:
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: []
31
+ multi_instance: false
32
+ additional_permissions:
33
+ description: ""
34
+ default_behavior:
35
+ auto_detection:
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:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list:
44
+ - title: "Required software"
45
+ description: "Make sure the `apcaccess` and `apcupsd` are installed and running."
46
+ configuration:
47
+ file:
48
+ name: charts.d/apcupsd.conf
49
+ options:
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:
55
+ title: "Config options"
56
+ enabled: true
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:
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:
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
126
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:
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
126
- enabled: false
127
- description: ""
128
- availability: []
129
- scopes:
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
127
+ description: ""
128
+ availability: []
129
+ scopes:
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
+141
-141
@@ -1,143 +1,143 @@
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
8
- link: "https://libreswan.org/"
9
- categories:
10
- - data-collection.vpns
11
- icon_filename: "libreswan.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - vpn
19
- - libreswan
20
- - network
21
- - ipsec
22
- most_popular: false
23
-overview:
24
- data_collection:
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:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: ""
36
- limits:
37
- description: ""
38
- performance_impact:
39
- description: ""
40
-setup:
41
- prerequisites:
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:
68
- name: charts.d/libreswan.conf
69
- options:
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:
75
- title: "Config options"
76
- enabled: true
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:
1
+plugin_name: charts.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: charts.d.plugin
5
+ module_name: libreswan
6
+ monitored_instance:
7
+ name: Libreswan
8
+ link: "https://libreswan.org/"
9
+ categories:
10
+ - data-collection.vpns
11
+ icon_filename: "libreswan.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - vpn
19
+ - libreswan
20
+ - network
21
+ - ipsec
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
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:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: ""
36
+ limits:
37
+ description: ""
38
+ performance_impact:
39
+ description: ""
40
+ setup:
41
+ prerequisites:
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:
68
+ name: charts.d/libreswan.conf
69
+ options:
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:
75
+ title: "Config options"
76
+ enabled: true
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:
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: []
119
+ alerts: []
120
+ metrics:
121
folding:
122
+ title: Metrics
123
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: []
119
-alerts: []
120
-metrics:
121
- folding:
122
- title: Metrics
123
- enabled: false
124
- description: ""
125
- availability: []
126
- scopes:
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
124
+ description: ""
125
+ availability: []
126
+ scopes:
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
+218
-216
@@ -1,217 +1,219 @@
1
-meta:
2
- plugin_name: charts.d.plugin
3
- module_name: nut
4
- monitored_instance:
5
- name: UPS/PDU
6
- link: ''
7
- categories:
8
- - data-collection.ups
9
- icon_filename: 'plug-circle-bolt.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
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.'
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: []
28
- multi_instance: true
29
- additional_permissions:
30
- description: ''
31
- default_behavior:
32
- auto_detection:
33
- description: ''
34
- limits:
35
- description: ''
36
- performance_impact:
37
- description: ''
38
-setup:
39
- prerequisites:
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:
45
- name: charts.d/nut.conf
46
- options:
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:
52
- title: "Config options"
53
- enabled: true
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
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: []
120
-alerts:
121
-- name: nut_ups_charge
122
- link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
123
- metric: nut.charge
124
- info: average UPS charge over the last minute
125
- os: "*"
126
-- name: nut_10min_ups_load
127
- link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
128
- metric: nut.load
129
- info: average UPS load over the last 10 minutes
130
- os: "*"
131
-- name: nut_last_collected_secs
132
- link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
133
- metric: nut.load
134
- info: number of seconds since the last successful data collection
135
-metrics:
136
- folding:
137
- title: Metrics
138
- enabled: false
139
- description: ""
140
- availability: []
141
- scopes:
142
- - name: ups
143
- description: "Metrics related to UPS. Each UPS provides its own set of the following metrics."
144
- labels: []
1
+plugin_name: charts.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: charts.d.plugin
5
+ module_name: nut
6
+ monitored_instance:
7
+ name: UPS/PDU
8
+ link: ''
9
+ categories:
10
+ - data-collection.ups
11
+ icon_filename: 'plug-circle-bolt.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - nut
19
+ - network ups tools
20
+ - ups
21
+ - pdu
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ 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.'
26
+ method_description: 'This collector uses the `nut` (Network UPS Tools) to query statistics for multiple UPS devices.'
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
+ description: ''
33
+ default_behavior:
34
+ auto_detection:
35
+ description: ''
36
+ limits:
37
+ description: ''
38
+ performance_impact:
39
+ description: ''
40
+ setup:
41
+ prerequisites:
42
+ list:
43
+ - title: "Required software"
44
+ description: "Make sure the Network UPS Tools (`nut`) is installed and can detect your UPS devices."
45
+ configuration:
46
+ file:
47
+ name: charts.d/nut.conf
48
+ options:
49
+ description: |
50
+ The config file is sourced by the charts.d plugin. It's a standard bash file.
51
+
52
+ The following collapsed table contains all the options that can be configured for the nut collector.
53
+ folding:
54
+ title: "Config options"
55
+ enabled: true
56
+ list:
57
+ - name: nut_ups
58
+ description: A space separated list of UPS names. If empty, the list returned by `upsc -l` will be used.
59
+ default_value: ""
60
+ required: false
61
+ - name: nut_names
62
+ description: Each line represents an alias for one UPS. If empty, the FQDN will be used.
63
+ default_value: ""
64
+ required: false
65
+ - name: nut_timeout
66
+ description: How long to wait for nut to respond.
67
+ default_value: 2
68
+ required: false
69
+ - name: nut_clients_chart
70
+ description: Set this to 1 to enable another chart showing the number of UPS clients connected to `upsd`.
71
+ default_value: 1
72
+ required: false
73
+ - name: nut_update_every
74
+ description: The data collection frequency. If unset, will inherit the netdata update frequency.
75
+ default_value: 2
76
+ required: false
77
+ - name: nut_priority
78
+ description: The charts priority on the dashboard
79
+ default_value: 90000
80
+ required: false
81
+ - name: nut_retries
82
+ description: The number of retries to do in case of failure before disabling the collector.
83
+ default_value: 10
84
+ required: false
85
+ examples:
86
+ folding:
87
+ enabled: true
88
+ title: "Config"
89
+ list:
90
+ - name: Provide names to UPS devices
91
+ description: Map aliases to UPS devices
92
+ config: |
93
+ # a space separated list of UPS names
94
+ # if empty, the list returned by 'upsc -l' will be used
95
+ #nut_ups=
96
+
97
+ # each line represents an alias for one UPS
98
+ # if empty, the FQDN will be used
99
+ nut_names["XXXXXX"]="UPS-office"
100
+ nut_names["YYYYYY"]="UPS-rack"
101
+
102
+ # how much time in seconds, to wait for nut to respond
103
+ #nut_timeout=2
104
+
105
+ # set this to 1, to enable another chart showing the number
106
+ # of UPS clients connected to upsd
107
+ #nut_clients_chart=1
108
+
109
+ # the data collection frequency
110
+ # if unset, will inherit the netdata update frequency
111
+ #nut_update_every=2
112
+
113
+ # the charts priority on the dashboard
114
+ #nut_priority=90000
115
+
116
+ # the number of retries to do in case of failure
117
+ # before disabling the module
118
+ #nut_retries=10
119
+ troubleshooting:
120
+ problems:
121
+ list: []
122
+ alerts:
123
+ - name: nut_ups_charge
124
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
125
+ metric: nut.charge
126
+ info: average UPS charge over the last minute
127
+ os: "*"
128
+ - name: nut_10min_ups_load
129
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
130
+ metric: nut.load
131
+ info: average UPS load over the last 10 minutes
132
+ os: "*"
133
+ - name: nut_last_collected_secs
134
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
135
+ metric: nut.load
136
+ info: number of seconds since the last successful data collection
137
metrics:
146
- - name: nut.charge
147
- description: UPS Charge
148
- unit: "percentage"
149
- chart_type: area
150
- dimensions:
151
- - name: charge
152
- - name: nut.runtime
153
- description: UPS Runtime
154
- unit: "seconds"
155
- chart_type: line
156
- dimensions:
157
- - name: runtime
158
- - name: nut.battery.voltage
159
- description: UPS Battery Voltage
160
- unit: "Volts"
161
- chart_type: line
162
- dimensions:
163
- - name: voltage
164
- - name: high
165
- - name: low
166
- - name: nominal
167
- - name: nut.input.voltage
168
- description: UPS Input Voltage
169
- unit: "Volts"
170
- chart_type: line
171
- dimensions:
172
- - name: voltage
173
- - name: fault
174
- - name: nominal
175
- - name: nut.input.current
176
- description: UPS Input Current
177
- unit: "Ampere"
178
- chart_type: line
179
- dimensions:
180
- - name: nominal
181
- - name: nut.input.frequency
182
- description: UPS Input Frequency
183
- unit: "Hz"
184
- chart_type: line
185
- dimensions:
186
- - name: frequency
187
- - name: nominal
188
- - name: nut.output.voltage
189
- description: UPS Output Voltage
190
- unit: "Volts"
191
- chart_type: line
192
- dimensions:
193
- - name: voltage
194
- - name: nut.load
195
- description: UPS Load
196
- unit: "percentage"
197
- chart_type: area
198
- dimensions:
199
- - name: load
200
- - name: nut.load_usage
201
- description: UPS Load Usage
202
- unit: "Watts"
203
- chart_type: area
204
- dimensions:
205
- - name: load_usage
206
- - name: nut.temperature
207
- description: UPS Temperature
208
- unit: "temperature"
209
- chart_type: line
210
- dimensions:
211
- - name: temp
212
- - name: nut.clients
213
- description: UPS Connected Clients
214
- unit: "clients"
215
- chart_type: area
216
- dimensions:
217
- - name: clients
138
+ folding:
139
+ title: Metrics
140
+ enabled: false
141
+ description: ""
142
+ availability: []
143
+ scopes:
144
+ - name: ups
145
+ description: "Metrics related to UPS. Each UPS provides its own set of the following metrics."
146
+ labels: []
147
+ metrics:
148
+ - name: nut.charge
149
+ description: UPS Charge
150
+ unit: "percentage"
151
+ chart_type: area
152
+ dimensions:
153
+ - name: charge
154
+ - name: nut.runtime
155
+ description: UPS Runtime
156
+ unit: "seconds"
157
+ chart_type: line
158
+ dimensions:
159
+ - name: runtime
160
+ - name: nut.battery.voltage
161
+ description: UPS Battery Voltage
162
+ unit: "Volts"
163
+ chart_type: line
164
+ dimensions:
165
+ - name: voltage
166
+ - name: high
167
+ - name: low
168
+ - name: nominal
169
+ - name: nut.input.voltage
170
+ description: UPS Input Voltage
171
+ unit: "Volts"
172
+ chart_type: line
173
+ dimensions:
174
+ - name: voltage
175
+ - name: fault
176
+ - name: nominal
177
+ - name: nut.input.current
178
+ description: UPS Input Current
179
+ unit: "Ampere"
180
+ chart_type: line
181
+ dimensions:
182
+ - name: nominal
183
+ - name: nut.input.frequency
184
+ description: UPS Input Frequency
185
+ unit: "Hz"
186
+ chart_type: line
187
+ dimensions:
188
+ - name: frequency
189
+ - name: nominal
190
+ - name: nut.output.voltage
191
+ description: UPS Output Voltage
192
+ unit: "Volts"
193
+ chart_type: line
194
+ dimensions:
195
+ - name: voltage
196
+ - name: nut.load
197
+ description: UPS Load
198
+ unit: "percentage"
199
+ chart_type: area
200
+ dimensions:
201
+ - name: load
202
+ - name: nut.load_usage
203
+ description: UPS Load Usage
204
+ unit: "Watts"
205
+ chart_type: area
206
+ dimensions:
207
+ - name: load_usage
208
+ - name: nut.temperature
209
+ description: UPS Temperature
210
+ unit: "temperature"
211
+ chart_type: line
212
+ dimensions:
213
+ - name: temp
214
+ - name: nut.clients
215
+ description: UPS Connected Clients
216
+ unit: "clients"
217
+ chart_type: area
218
+ dimensions:
219
+ - name: clients
collectors/charts.d.plugin/opensips/metadata.yaml
+265
-265
@@ -1,267 +1,267 @@
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
8
- link: "https://opensips.org/"
9
- categories:
10
- - data-collection.telephony-servers
11
- icon_filename: "opensips.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - opensips
19
- - sip
20
- - voice
21
- - video
22
- - stream
23
- most_popular: false
24
-overview:
25
- data_collection:
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:
33
- description: ""
34
- default_behavior:
35
- auto_detection:
36
- description: "The collector will attempt to call `opensipsctl` along with a default number of parameters, even without any configuration."
37
- limits:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
-setup:
42
- prerequisites:
43
- list:
44
- - title: "Required software"
45
- description: "The collector requires the `opensipsctl` to be installed."
46
- configuration:
47
- file:
48
- name: charts.d/opensips.conf
49
- options:
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:
55
- title: "Config options"
56
- enabled: true
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:
1
+plugin_name: charts.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: charts.d.plugin
5
+ module_name: opensips
6
+ monitored_instance:
7
+ name: OpenSIPS
8
+ link: "https://opensips.org/"
9
+ categories:
10
+ - data-collection.telephony-servers
11
+ icon_filename: "opensips.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - opensips
19
+ - sip
20
+ - voice
21
+ - video
22
+ - stream
23
+ most_popular: false
24
+ overview:
25
+ data_collection:
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:
33
+ description: ""
34
+ default_behavior:
35
+ auto_detection:
36
+ description: "The collector will attempt to call `opensipsctl` along with a default number of parameters, even without any configuration."
37
+ limits:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list:
44
+ - title: "Required software"
45
+ description: "The collector requires the `opensipsctl` to be installed."
46
+ configuration:
47
+ file:
48
+ name: charts.d/opensips.conf
49
+ options:
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:
55
+ title: "Config options"
56
+ enabled: true
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:
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: []
107
+ alerts: []
108
+ metrics:
109
folding:
110
+ title: Metrics
111
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: []
107
-alerts: []
108
-metrics:
109
- folding:
110
- title: Metrics
111
- enabled: false
112
- description: ""
113
- availability: []
114
- scopes:
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
112
+ description: ""
113
+ availability: []
114
+ scopes:
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
+167
-167
@@ -1,169 +1,169 @@
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)
8
- link: "https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface"
9
- categories:
10
- - data-collection.hardware-devices-and-sensors
11
- icon_filename: "microchip.svg"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - sensors
19
- - sysfs
20
- - hwmon
21
- - rpi
22
- - raspberry pi
23
- most_popular: false
24
-overview:
25
- data_collection:
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:
33
- include: [Linux]
34
- exclude: []
35
- multi_instance: true
36
- additional_permissions:
37
- description: ""
38
- default_behavior:
39
- auto_detection:
40
- description: "By default, the collector will try to read entries under `/sys/devices`"
41
- limits:
42
- description: ""
43
- performance_impact:
44
- description: ""
45
-setup:
46
- prerequisites:
47
- list: []
48
- configuration:
49
- file:
50
- name: charts.d/sensors.conf
51
- options:
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:
57
- title: "Config options"
58
- enabled: true
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:
1
+plugin_name: charts.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: charts.d.plugin
5
+ module_name: sensors
6
+ monitored_instance:
7
+ name: Linux Sensors (sysfs)
8
+ link: "https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface"
9
+ categories:
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: "microchip.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - sensors
19
+ - sysfs
20
+ - hwmon
21
+ - rpi
22
+ - raspberry pi
23
+ most_popular: false
24
+ overview:
25
+ data_collection:
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:
33
+ include: [Linux]
34
+ exclude: []
35
+ multi_instance: true
36
+ additional_permissions:
37
+ description: ""
38
+ default_behavior:
39
+ auto_detection:
40
+ description: "By default, the collector will try to read entries under `/sys/devices`"
41
+ limits:
42
+ description: ""
43
+ performance_impact:
44
+ description: ""
45
+ setup:
46
+ prerequisites:
47
+ list: []
48
+ configuration:
49
+ file:
50
+ name: charts.d/sensors.conf
51
+ options:
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:
57
+ title: "Config options"
58
+ enabled: true
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:
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: []
116
+ alerts: []
117
+ metrics:
118
folding:
119
+ title: Metrics
120
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: []
116
-alerts: []
117
-metrics:
118
- folding:
119
- title: Metrics
120
- enabled: false
121
- description: ""
122
- availability: []
123
- scopes:
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}"
121
+ description: ""
122
+ availability: []
123
+ scopes:
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}"
collectors/cups.plugin/metadata.yaml
+130
-130
@@ -1,131 +1,131 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: cups.plugin
5
- module_name: cups.plugin
6
- monitored_instance:
7
- name: CUPS
8
- link: "https://www.cups.org/"
9
- categories:
10
- - data-collection.hardware-devices-and-sensors
11
- icon_filename: "cups.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords: []
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: "Monitor CUPS performance for achieving optimal printing system operations. Monitor job statuses, queue lengths, and error rates to ensure smooth printing tasks."
22
- method_description: "The plugin uses CUPS shared library to connect and monitor the server."
23
- supported_platforms:
24
- include: []
25
- exclude: []
26
- multi_instance: true
27
- additional_permissions:
28
- description: "The plugin needs to access the server. Netdata sets permissions during installation time to reach the server through its library."
29
- default_behavior:
30
- auto_detection:
31
- description: "The plugin detects when CUPS server is running and tries to connect to it."
32
- limits:
33
- description: ""
34
- performance_impact:
35
- description: ""
36
-setup:
37
- prerequisites:
38
- list:
39
- - title: Minimum setup
40
- description: "The CUPS server must be installed and running."
41
- configuration:
42
- file:
43
- name: "netdata.conf"
44
- section_name: "[plugin:cups]"
45
- description: "The netdata main configuration file."
46
- options:
47
- description: ""
48
- folding:
49
- title: "Config options"
50
- enabled: true
51
- list:
52
- - name: update every
53
- description: Data collection frequency.
54
- default_value: 1
55
- required: false
56
- - name: command options
57
- description: Additional parameters for the collector
58
- default_value: ""
59
- required: false
60
- examples:
61
- folding:
62
- enabled: true
63
- title: ""
64
- list: []
65
-troubleshooting:
66
- problems:
67
- list: []
68
-alerts: []
69
-metrics:
70
- folding:
71
- title: Metrics
72
- enabled: false
73
- description: ""
74
- availability: []
75
- scopes:
76
- - name: global
77
- description: ""
78
- labels: []
79
- metrics:
80
- - name: cups.dests_state
81
- description: Destinations by state
82
- unit: "dests"
83
- chart_type: stacked
84
- dimensions:
85
- - name: idle
86
- - name: printing
87
- - name: stopped
88
- - name: cups.dests_option
89
- description: Destinations by option
90
- unit: "dests"
91
- chart_type: line
92
- dimensions:
93
- - name: total
94
- - name: acceptingjobs
95
- - name: shared
96
- - name: cups.job_num
97
- description: Active jobs
98
- unit: "jobs"
99
- chart_type: stacked
100
- dimensions:
101
- - name: pending
102
- - name: held
103
- - name: processing
104
- - name: cups.job_size
105
- description: Active jobs size
106
- unit: "KB"
107
- chart_type: stacked
108
- dimensions:
109
- - name: pending
110
- - name: held
111
- - name: processing
112
- - name: destination
113
- description: ""
114
- labels: []
1
+plugin_name: cups.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: cups.plugin
5
+ module_name: cups.plugin
6
+ monitored_instance:
7
+ name: CUPS
8
+ link: "https://www.cups.org/"
9
+ categories:
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: "cups.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords: []
18
+ most_popular: false
19
+ overview:
20
+ data_collection:
21
+ metrics_description: "Monitor CUPS performance for achieving optimal printing system operations. Monitor job statuses, queue lengths, and error rates to ensure smooth printing tasks."
22
+ method_description: "The plugin uses CUPS shared library to connect and monitor the server."
23
+ supported_platforms:
24
+ include: []
25
+ exclude: []
26
+ multi_instance: true
27
+ additional_permissions:
28
+ description: "The plugin needs to access the server. Netdata sets permissions during installation time to reach the server through its library."
29
+ default_behavior:
30
+ auto_detection:
31
+ description: "The plugin detects when CUPS server is running and tries to connect to it."
32
+ limits:
33
+ description: ""
34
+ performance_impact:
35
+ description: ""
36
+ setup:
37
+ prerequisites:
38
+ list:
39
+ - title: Minimum setup
40
+ description: "The CUPS server must be installed and running."
41
+ configuration:
42
+ file:
43
+ name: "netdata.conf"
44
+ section_name: "[plugin:cups]"
45
+ description: "The netdata main configuration file."
46
+ options:
47
+ description: ""
48
+ folding:
49
+ title: "Config options"
50
+ enabled: true
51
+ list:
52
+ - name: update every
53
+ description: Data collection frequency.
54
+ default_value: 1
55
+ required: false
56
+ - name: command options
57
+ description: Additional parameters for the collector
58
+ default_value: ""
59
+ required: false
60
+ examples:
61
+ folding:
62
+ enabled: true
63
+ title: ""
64
+ list: []
65
+ troubleshooting:
66
+ problems:
67
+ list: []
68
+ alerts: []
69
metrics:
116
- - name: cups.destination_job_num
117
- description: Active jobs of {destination}
118
- unit: "jobs"
119
- chart_type: stacked
120
- dimensions:
121
- - name: pending
122
- - name: held
123
- - name: processing
124
- - name: cups.destination_job_size
125
- description: Active jobs size of {destination}
126
- unit: "KB"
127
- chart_type: stacked
128
- dimensions:
129
- - name: pending
130
- - name: held
131
- - name: processing
70
+ folding:
71
+ title: Metrics
72
+ enabled: false
73
+ description: ""
74
+ availability: []
75
+ scopes:
76
+ - name: global
77
+ description: ""
78
+ labels: []
79
+ metrics:
80
+ - name: cups.dests_state
81
+ description: Destinations by state
82
+ unit: "dests"
83
+ chart_type: stacked
84
+ dimensions:
85
+ - name: idle
86
+ - name: printing
87
+ - name: stopped
88
+ - name: cups.dests_option
89
+ description: Destinations by option
90
+ unit: "dests"
91
+ chart_type: line
92
+ dimensions:
93
+ - name: total
94
+ - name: acceptingjobs
95
+ - name: shared
96
+ - name: cups.job_num
97
+ description: Active jobs
98
+ unit: "jobs"
99
+ chart_type: stacked
100
+ dimensions:
101
+ - name: pending
102
+ - name: held
103
+ - name: processing
104
+ - name: cups.job_size
105
+ description: Active jobs size
106
+ unit: "KB"
107
+ chart_type: stacked
108
+ dimensions:
109
+ - name: pending
110
+ - name: held
111
+ - name: processing
112
+ - name: destination
113
+ description: ""
114
+ labels: []
115
+ metrics:
116
+ - name: cups.destination_job_num
117
+ description: Active jobs of {destination}
118
+ unit: "jobs"
119
+ chart_type: stacked
120
+ dimensions:
121
+ - name: pending
122
+ - name: held
123
+ - name: processing
124
+ - name: cups.destination_job_size
125
+ description: Active jobs size of {destination}
126
+ unit: "KB"
127
+ chart_type: stacked
128
+ dimensions:
129
+ - name: pending
130
+ - name: held
131
+ - name: processing
collectors/debugfs.plugin/metadata.yaml
renamed
collectors/diskspace.plugin/metadata.yaml
+137
-135
@@ -1,137 +1,139 @@
1
-meta:
2
- plugin_name: diskspace.plugin
3
- module_name: diskspace.plugin
4
- monitored_instance:
5
- name: Disk space
6
- link: ""
7
- categories:
8
- - data-collection.linux-systems
9
- icon_filename: "hard-drive.svg"
10
- related_resources:
11
- integrations:
12
- list:
13
- - plugin_name: ebpf.plugin
14
- module_name: disk
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - disk
19
- - I/O
20
- - space
21
- - inode
22
- most_popular: false
23
-overview:
24
- data_collection:
25
- metrics_description: "Monitor Disk space metrics for proficient storage management. Keep track of usage, free space, and error rates to prevent disk space issues."
26
- method_description: ""
27
- supported_platforms:
28
- include: []
29
- exclude: []
30
- multi_instance: true
31
- additional_permissions:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: "The plugin reads data from `/proc/self/mountinfo` and `/proc/diskstats file`."
36
- limits:
37
- description: ""
38
- performance_impact:
39
- description: ""
40
-setup:
41
- prerequisites:
42
- list: []
43
- configuration:
44
- file:
45
- name: "netdata.conf"
46
- section_name: "[plugin:proc:diskspace]"
47
- description: "This is netdata main configuration file"
48
- options:
49
- description: "You can also specify per mount point `[plugin:proc:diskspace:mountpoint]`"
50
- folding:
51
- title: "Config options"
52
- enabled: true
53
- list:
54
- - name: update every
55
- description: Data collection frequency.
56
- default_value: 1
57
- required: false
58
- - name: remove charts of unmounted disks
59
- description: Remove chart when a device is unmounted on host.
60
- default_value: yes
61
- required: false
62
- - name: check for new mount points every
63
- description: Parse proc files frequency.
64
- default_value: 15
65
- required: false
66
- - name: exclude space metrics on paths
67
- description: Do not show metrics (charts) for listed paths. This option accepts netdata simple pattern.
68
- default_value: /proc/* /sys/* /var/run/user/* /run/user/* /snap/* /var/lib/docker/*
69
- required: false
70
- - name: exclude space metrics on filesystems
71
- description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.
72
- default_value: "*gvfs *gluster* *s3fs *ipfs *davfs2 *httpfs *sshfs *gdfs *moosefs fusectl autofs"
73
- required: false
74
- - name: exclude inode metrics on filesystems
75
- description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.
76
- default_value: msdosfs msdos vfat overlayfs aufs* *unionfs
77
- required: false
78
- - name: space usage for all disks
79
- description: Define if plugin will show metrics for space usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option.
80
- default_value: auto
81
- required: false
82
- - name: inodes usage for all disks
83
- description: Define if plugin will show metrics for inode usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option.
84
- default_value: auto
85
- required: false
86
- examples:
1
+plugin_name: diskspace.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: diskspace.plugin
5
+ module_name: diskspace.plugin
6
+ monitored_instance:
7
+ name: Disk space
8
+ link: ""
9
+ categories:
10
+ - data-collection.linux-systems
11
+ icon_filename: "hard-drive.svg"
12
+ related_resources:
13
+ integrations:
14
+ list:
15
+ - plugin_name: ebpf.plugin
16
+ module_name: disk
17
+ info_provided_to_referring_integrations:
18
+ description: ""
19
+ keywords:
20
+ - disk
21
+ - I/O
22
+ - space
23
+ - inode
24
+ most_popular: false
25
+ overview:
26
+ data_collection:
27
+ metrics_description: "Monitor Disk space metrics for proficient storage management. Keep track of usage, free space, and error rates to prevent disk space issues."
28
+ method_description: ""
29
+ supported_platforms:
30
+ include: []
31
+ exclude: []
32
+ multi_instance: true
33
+ additional_permissions:
34
+ description: ""
35
+ default_behavior:
36
+ auto_detection:
37
+ description: "The plugin reads data from `/proc/self/mountinfo` and `/proc/diskstats file`."
38
+ limits:
39
+ description: ""
40
+ performance_impact:
41
+ description: ""
42
+ setup:
43
+ prerequisites:
44
+ list: []
45
+ configuration:
46
+ file:
47
+ name: "netdata.conf"
48
+ section_name: "[plugin:proc:diskspace]"
49
+ description: "This is netdata main configuration file"
50
+ options:
51
+ description: "You can also specify per mount point `[plugin:proc:diskspace:mountpoint]`"
52
+ folding:
53
+ title: "Config options"
54
+ enabled: true
55
+ list:
56
+ - name: update every
57
+ description: Data collection frequency.
58
+ default_value: 1
59
+ required: false
60
+ - name: remove charts of unmounted disks
61
+ description: Remove chart when a device is unmounted on host.
62
+ default_value: yes
63
+ required: false
64
+ - name: check for new mount points every
65
+ description: Parse proc files frequency.
66
+ default_value: 15
67
+ required: false
68
+ - name: exclude space metrics on paths
69
+ description: Do not show metrics (charts) for listed paths. This option accepts netdata simple pattern.
70
+ default_value: /proc/* /sys/* /var/run/user/* /run/user/* /snap/* /var/lib/docker/*
71
+ required: false
72
+ - name: exclude space metrics on filesystems
73
+ description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.
74
+ default_value: "*gvfs *gluster* *s3fs *ipfs *davfs2 *httpfs *sshfs *gdfs *moosefs fusectl autofs"
75
+ required: false
76
+ - name: exclude inode metrics on filesystems
77
+ description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.
78
+ default_value: msdosfs msdos vfat overlayfs aufs* *unionfs
79
+ required: false
80
+ - name: space usage for all disks
81
+ description: Define if plugin will show metrics for space usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option.
82
+ default_value: auto
83
+ required: false
84
+ - name: inodes usage for all disks
85
+ description: Define if plugin will show metrics for inode usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option.
86
+ default_value: auto
87
+ required: false
88
+ examples:
89
+ folding:
90
+ enabled: true
91
+ title: ""
92
+ list: []
93
+ troubleshooting:
94
+ problems:
95
+ list: []
96
+ alerts:
97
+ - name: disk_space_usage
98
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/disks.conf
99
+ metric: disk.space
100
+ info: disk ${label:mount_point} space utilization
101
+ os: "linux freebsd"
102
+ - name: disk_inode_usage
103
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/disks.conf
104
+ metric: disk.inodes
105
+ info: disk ${label:mount_point} inode utilization
106
+ os: "linux freebsd"
107
+ metrics:
108
folding:
88
- enabled: true
89
- title: ""
90
- list: []
91
-troubleshooting:
92
- problems:
93
- list: []
94
-alerts:
95
- - name: disk_space_usage
96
- link: https://github.com/netdata/netdata/blob/master/health/health.d/disks.conf
97
- metric: disk.space
98
- info: disk ${label:mount_point} space utilization
99
- os: "linux freebsd"
100
- - name: disk_inode_usage
101
- link: https://github.com/netdata/netdata/blob/master/health/health.d/disks.conf
102
- metric: disk.inodes
103
- info: disk ${label:mount_point} inode utilization
104
- os: "linux freebsd"
105
-metrics:
106
- folding:
107
- title: Metrics
108
- enabled: false
109
- description: ""
110
- availability: []
111
- scopes:
112
- - name: mount point
109
+ title: Metrics
110
+ enabled: false
111
description: ""
114
- labels:
115
- - name: mount_point
116
- description: Path used to mount a filesystem
117
- - name: filesystem
118
- description: The filesystem used to format a partition.
119
- - name: mount_root
120
- description: Root directory where mount points are present.
121
- metrics:
122
- - name: disk.space
123
- description: Disk Space Usage
124
- unit: "GiB"
125
- chart_type: stacked
126
- dimensions:
127
- - name: avail
128
- - name: used
129
- - name: reserved_for_root
130
- - name: disk.inodes
131
- description: Disk Files (inodes) Usage
132
- unit: "inodes"
133
- chart_type: stacked
134
- dimensions:
135
- - name: avail
136
- - name: used
137
- - name: reserved_for_root
112
+ availability: []
113
+ scopes:
114
+ - name: mount point
115
+ description: ""
116
+ labels:
117
+ - name: mount_point
118
+ description: Path used to mount a filesystem
119
+ - name: filesystem
120
+ description: The filesystem used to format a partition.
121
+ - name: mount_root
122
+ description: Root directory where mount points are present.
123
+ metrics:
124
+ - name: disk.space
125
+ description: Disk Space Usage
126
+ unit: "GiB"
127
+ chart_type: stacked
128
+ dimensions:
129
+ - name: avail
130
+ - name: used
131
+ - name: reserved_for_root
132
+ - name: disk.inodes
133
+ description: Disk Files (inodes) Usage
134
+ unit: "inodes"
135
+ chart_type: stacked
136
+ dimensions:
137
+ - name: avail
138
+ - name: used
139
+ - name: reserved_for_root
collectors/ebpf.plugin/metadata.yaml
renamed
+112
-114
@@ -1,5 +1,3 @@
1
-# yamllint disable rule:line-length
2
----
1
plugin_name: ebpf.plugin
2
modules:
3
- meta:
@@ -271,22 +269,22 @@ modules:
269
list:
270
- title: Compile kernel
271
description: |
274
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
275
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
276
- with different names.
277
-
278
- Now follow steps:
279
- 1. Copy the configuration file to /usr/src/linux/.config.
280
- 2. Select the necessary options: make oldconfig
281
- 3. Compile your kernel image: make bzImage
282
- 4. Compile your modules: make modules
283
- 5. Copy your new kernel image for boot loader directory
284
- 6. Install the new modules: make modules_install
285
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
286
- 8. Update your boot loader
272
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
273
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
274
+ with different names.
275
+
276
+ Now follow steps:
277
+ 1. Copy the configuration file to /usr/src/linux/.config.
278
+ 2. Select the necessary options: make oldconfig
279
+ 3. Compile your kernel image: make bzImage
280
+ 4. Compile your modules: make modules
281
+ 5. Copy your new kernel image for boot loader directory
282
+ 6. Install the new modules: make modules_install
283
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
284
+ 8. Update your boot loader
285
- title: Debug Filesystem
286
description: |
289
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
287
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
288
configuration:
289
file:
290
name: "ebpf.d/process.conf"
@@ -520,22 +518,22 @@ modules:
518
list:
519
- title: Compile kernel
520
description: |
523
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
524
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
525
- with different names.
526
-
527
- Now follow steps:
528
- 1. Copy the configuration file to /usr/src/linux/.config.
529
- 2. Select the necessary options: make oldconfig
530
- 3. Compile your kernel image: make bzImage
531
- 4. Compile your modules: make modules
532
- 5. Copy your new kernel image for boot loader directory
533
- 6. Install the new modules: make modules_install
534
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
535
- 8. Update your boot loader
521
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
522
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
523
+ with different names.
524
+
525
+ Now follow steps:
526
+ 1. Copy the configuration file to /usr/src/linux/.config.
527
+ 2. Select the necessary options: make oldconfig
528
+ 3. Compile your kernel image: make bzImage
529
+ 4. Compile your modules: make modules
530
+ 5. Copy your new kernel image for boot loader directory
531
+ 6. Install the new modules: make modules_install
532
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
533
+ 8. Update your boot loader
534
- title: Debug Filesystem
535
description: |
538
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
536
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
537
configuration:
538
file:
539
name: "ebpf.d/disk.conf"
@@ -626,22 +624,22 @@ modules:
624
list:
625
- title: Compile kernel
626
description: |
629
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
630
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
631
- with different names.
632
-
633
- Now follow steps:
634
- 1. Copy the configuration file to /usr/src/linux/.config.
635
- 2. Select the necessary options: make oldconfig
636
- 3. Compile your kernel image: make bzImage
637
- 4. Compile your modules: make modules
638
- 5. Copy your new kernel image for boot loader directory
639
- 6. Install the new modules: make modules_install
640
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
641
- 8. Update your boot loader
627
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
628
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
629
+ with different names.
630
+
631
+ Now follow steps:
632
+ 1. Copy the configuration file to /usr/src/linux/.config.
633
+ 2. Select the necessary options: make oldconfig
634
+ 3. Compile your kernel image: make bzImage
635
+ 4. Compile your modules: make modules
636
+ 5. Copy your new kernel image for boot loader directory
637
+ 6. Install the new modules: make modules_install
638
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
639
+ 8. Update your boot loader
640
- title: Debug Filesystem
641
description: |
644
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
642
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
643
configuration:
644
file:
645
name: "ebpf.d/hardirq.conf"
@@ -964,22 +962,22 @@ modules:
962
list:
963
- title: Compile kernel
964
description: |
967
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
968
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
969
- with different names.
970
-
971
- Now follow steps:
972
- 1. Copy the configuration file to /usr/src/linux/.config.
973
- 2. Select the necessary options: make oldconfig
974
- 3. Compile your kernel image: make bzImage
975
- 4. Compile your modules: make modules
976
- 5. Copy your new kernel image for boot loader directory
977
- 6. Install the new modules: make modules_install
978
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
979
- 8. Update your boot loader
965
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
966
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
967
+ with different names.
968
+
969
+ Now follow steps:
970
+ 1. Copy the configuration file to /usr/src/linux/.config.
971
+ 2. Select the necessary options: make oldconfig
972
+ 3. Compile your kernel image: make bzImage
973
+ 4. Compile your modules: make modules
974
+ 5. Copy your new kernel image for boot loader directory
975
+ 6. Install the new modules: make modules_install
976
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
977
+ 8. Update your boot loader
978
- title: Debug Filesystem
979
description: |
982
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug`).
980
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug`).
981
configuration:
982
file:
983
name: "ebpf.d/sync.conf"
@@ -1430,22 +1428,22 @@ modules:
1428
list:
1429
- title: Compile kernel
1430
description: |
1433
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
1434
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
1435
- with different names.
1436
-
1437
- Now follow steps:
1438
- 1. Copy the configuration file to /usr/src/linux/.config.
1439
- 2. Select the necessary options: make oldconfig
1440
- 3. Compile your kernel image: make bzImage
1441
- 4. Compile your modules: make modules
1442
- 5. Copy your new kernel image for boot loader directory
1443
- 6. Install the new modules: make modules_install
1444
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
1445
- 8. Update your boot loader
1431
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
1432
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
1433
+ with different names.
1434
+
1435
+ Now follow steps:
1436
+ 1. Copy the configuration file to /usr/src/linux/.config.
1437
+ 2. Select the necessary options: make oldconfig
1438
+ 3. Compile your kernel image: make bzImage
1439
+ 4. Compile your modules: make modules
1440
+ 5. Copy your new kernel image for boot loader directory
1441
+ 6. Install the new modules: make modules_install
1442
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
1443
+ 8. Update your boot loader
1444
- title: Debug Filesystem
1445
description: |
1448
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
1446
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
1447
configuration:
1448
file:
1449
name: "ebpf.d/oomkill.conf"
@@ -2311,22 +2309,22 @@ modules:
2309
list:
2310
- title: Compile kernel
2311
description: |
2314
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
2315
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
2316
- with different names.
2317
-
2318
- Now follow steps:
2319
- 1. Copy the configuration file to /usr/src/linux/.config.
2320
- 2. Select the necessary options: make oldconfig
2321
- 3. Compile your kernel image: make bzImage
2322
- 4. Compile your modules: make modules
2323
- 5. Copy your new kernel image for boot loader directory
2324
- 6. Install the new modules: make modules_install
2325
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
2326
- 8. Update your boot loader
2312
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
2313
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
2314
+ with different names.
2315
+
2316
+ Now follow steps:
2317
+ 1. Copy the configuration file to /usr/src/linux/.config.
2318
+ 2. Select the necessary options: make oldconfig
2319
+ 3. Compile your kernel image: make bzImage
2320
+ 4. Compile your modules: make modules
2321
+ 5. Copy your new kernel image for boot loader directory
2322
+ 6. Install the new modules: make modules_install
2323
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
2324
+ 8. Update your boot loader
2325
- title: Debug Filesystem
2326
description: |
2329
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
2327
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
2328
configuration:
2329
file:
2330
name: "ebpf.d/shm.conf"
@@ -2540,22 +2538,22 @@ modules:
2538
list:
2539
- title: Compile kernel
2540
description: |
2543
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
2544
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
2545
- with different names.
2546
-
2547
- Now follow steps:
2548
- 1. Copy the configuration file to /usr/src/linux/.config.
2549
- 2. Select the necessary options: make oldconfig
2550
- 3. Compile your kernel image: make bzImage
2551
- 4. Compile your modules: make modules
2552
- 5. Copy your new kernel image for boot loader directory
2553
- 6. Install the new modules: make modules_install
2554
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
2555
- 8. Update your boot loader
2541
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
2542
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
2543
+ with different names.
2544
+
2545
+ Now follow steps:
2546
+ 1. Copy the configuration file to /usr/src/linux/.config.
2547
+ 2. Select the necessary options: make oldconfig
2548
+ 3. Compile your kernel image: make bzImage
2549
+ 4. Compile your modules: make modules
2550
+ 5. Copy your new kernel image for boot loader directory
2551
+ 6. Install the new modules: make modules_install
2552
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
2553
+ 8. Update your boot loader
2554
- title: Debug Filesystem
2555
description: |
2558
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
2556
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
2557
configuration:
2558
file:
2559
name: "ebpf.d/softirq.conf"
@@ -2648,22 +2646,22 @@ modules:
2646
list:
2647
- title: Compile kernel
2648
description: |
2651
- Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
2652
- When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
2653
- with different names.
2654
-
2655
- Now follow steps:
2656
- 1. Copy the configuration file to /usr/src/linux/.config.
2657
- 2. Select the necessary options: make oldconfig
2658
- 3. Compile your kernel image: make bzImage
2659
- 4. Compile your modules: make modules
2660
- 5. Copy your new kernel image for boot loader directory
2661
- 6. Install the new modules: make modules_install
2662
- 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
2663
- 8. Update your boot loader
2649
+ Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
2650
+ When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
2651
+ with different names.
2652
+
2653
+ Now follow steps:
2654
+ 1. Copy the configuration file to /usr/src/linux/.config.
2655
+ 2. Select the necessary options: make oldconfig
2656
+ 3. Compile your kernel image: make bzImage
2657
+ 4. Compile your modules: make modules
2658
+ 5. Copy your new kernel image for boot loader directory
2659
+ 6. Install the new modules: make modules_install
2660
+ 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
2661
+ 8. Update your boot loader
2662
- title: Debug Filesystem
2663
description: |
2666
- This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
2664
+ This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
2665
configuration:
2666
file:
2667
name: "ebpf.d/mount.conf"
collectors/freebsd.plugin/metadata.yaml
renamed
-2
@@ -1,5 +1,3 @@
1
-# yamllint disable rule:line-length
2
----
1
plugin_name: freebsd.plugin
2
modules:
3
- meta:
collectors/freeipmi.plugin/metadata.yaml
renamed
+3
-4
@@ -1,10 +1,9 @@
1
plugin_name: freeipmi.plugin
2
modules:
3
- - &module
4
- meta: &meta
3
+ - meta:
4
plugin_name: freeipmi.plugin
5
module_name: sensors
7
- monitored_instance: &monitored_instance
6
+ monitored_instance:
7
name: IPMI
8
link: "https://www.ibm.com/docs/en/power9/0009-ESS?topic=ipmi-overview"
9
categories:
@@ -20,7 +19,7 @@ modules:
19
- ipmi
20
- freeipmi
21
most_popular: true
23
- overview: &overview
22
+ overview:
23
data_collection:
24
metrics_description: |
25
"Monitor enterprise server sensor readings, event log entries, and hardware statuses to ensure reliable server operations."
collectors/idlejitter.plugin/metadata.yaml
+87
-85
@@ -1,88 +1,90 @@
1
-meta:
2
- plugin_name: idlejitter.plugin
3
- module_name: idlejitter.plugin
4
- monitored_instance:
5
- name: Idle OS Jitter
6
- link: ''
7
- categories:
8
- - data-collection.synthetic-checks
9
- icon_filename: 'syslog.png'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - latency
17
- - jitter
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: >
22
- Monitor delays in timing for user processes caused by scheduling limitations to optimize the system to run
23
- latency sensitive applications with minimal jitter, improving consistency and quality of service.
24
- method_description: >
25
- A thread is spawned that requests to sleep for fixed amount of time. When the system wakes it up, it
26
- measures how many microseconds have passed. The difference between the requested and the actual duration of
27
- the sleep, is the idle jitter. This is done dozens of times per second to ensure we have a representative sample.
28
- supported_platforms:
29
- include: []
30
- exclude: []
31
- multi_instance: false
32
- additional_permissions:
33
- description: ''
34
- default_behavior:
35
- auto_detection:
36
- description: 'This integration will run by default on all supported systems.'
37
- limits:
38
- description: ''
39
- performance_impact:
40
- description: ''
41
-setup:
42
- prerequisites:
43
- list: []
44
- configuration:
45
- file:
46
- name: 'netdata.conf'
47
- section: 'plugin:idlejitter'
48
- description: ''
49
- options:
50
- description: >
51
- This integration only supports a single configuration option, and most users will not need to change it.
52
- folding:
53
- title: ''
54
- enabled: false
55
- list:
56
- - name: loop time in ms
1
+plugin_name: idlejitter.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: idlejitter.plugin
5
+ module_name: idlejitter.plugin
6
+ monitored_instance:
7
+ name: Idle OS Jitter
8
+ link: ''
9
+ categories:
10
+ - data-collection.synthetic-checks
11
+ icon_filename: 'syslog.png'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - latency
19
+ - jitter
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: >
24
+ Monitor delays in timing for user processes caused by scheduling limitations to optimize the system to run
25
+ latency sensitive applications with minimal jitter, improving consistency and quality of service.
26
+ method_description: >
27
+ A thread is spawned that requests to sleep for fixed amount of time. When the system wakes it up, it
28
+ measures how many microseconds have passed. The difference between the requested and the actual duration of
29
+ the sleep, is the idle jitter. This is done dozens of times per second to ensure we have a representative sample.
30
+ supported_platforms:
31
+ include: []
32
+ exclude: []
33
+ multi_instance: false
34
+ additional_permissions:
35
+ description: ''
36
+ default_behavior:
37
+ auto_detection:
38
+ description: 'This integration will run by default on all supported systems.'
39
+ limits:
40
+ description: ''
41
+ performance_impact:
42
+ description: ''
43
+ setup:
44
+ prerequisites:
45
+ list: []
46
+ configuration:
47
+ file:
48
+ name: 'netdata.conf'
49
+ section: 'plugin:idlejitter'
50
+ description: ''
51
+ options:
52
description: >
58
- Specifies the target time for the data collection thread to sleep, measured in miliseconds.
59
- default_value: 20
60
- required: false
61
- examples:
53
+ This integration only supports a single configuration option, and most users will not need to change it.
54
+ folding:
55
+ title: ''
56
+ enabled: false
57
+ list:
58
+ - name: loop time in ms
59
+ description: >
60
+ Specifies the target time for the data collection thread to sleep, measured in miliseconds.
61
+ default_value: 20
62
+ required: false
63
+ examples:
64
+ folding:
65
+ enabled: true
66
+ title: ''
67
+ list: []
68
+ troubleshooting:
69
+ problems:
70
+ list: []
71
+ alerts: []
72
+ metrics:
73
folding:
63
- enabled: true
64
- title: ''
65
- list: []
66
-troubleshooting:
67
- problems:
68
- list: []
69
-alerts: []
70
-metrics:
71
- folding:
72
- title: Metrics
73
- enabled: false
74
- description: ""
75
- availability: []
76
- scopes:
77
- - name: global
74
+ title: Metrics
75
+ enabled: false
76
description: ""
79
- labels: []
80
- metrics:
81
- - name: system.idlejitter
82
- description: CPU Idle Jitter
83
- unit: "microseconds lost/s"
84
- chart_type: line
85
- dimensions:
86
- - name: min
87
- - name: max
88
- - name: average
77
+ availability: []
78
+ scopes:
79
+ - name: global
80
+ description: ""
81
+ labels: []
82
+ metrics:
83
+ - name: system.idlejitter
84
+ description: CPU Idle Jitter
85
+ unit: "microseconds lost/s"
86
+ chart_type: line
87
+ dimensions:
88
+ - name: min
89
+ - name: max
90
+ - name: average
collectors/ioping.plugin/metadata.yaml
+100
-100
@@ -1,101 +1,101 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: ioping.plugin
5
- module_name: ioping.plugin
6
- monitored_instance:
7
- name: IOPing
8
- link: "https://github.com/koct9i/ioping"
9
- categories:
10
- - data-collection.synthetic-checks
11
- icon_filename: "syslog.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords: []
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: "Monitor IOPing metrics for efficient disk I/O latency tracking. Keep track of read/write speeds, latency, and error rates for optimized disk operations."
22
- method_description: "Plugin uses `ioping` command."
23
- supported_platforms:
24
- include: []
25
- exclude: []
26
- multi_instance: true
27
- additional_permissions:
28
- description: ""
29
- default_behavior:
30
- auto_detection:
31
- description: ""
32
- limits:
33
- description: ""
34
- performance_impact:
35
- description: ""
36
-setup:
37
- prerequisites:
38
- list:
39
- - title: Install ioping
40
- description: |
41
- You can install the command by passing the argument `install` to the plugin (`/usr/libexec/netdata/plugins.d/ioping.plugin install`).
42
- configuration:
43
- file:
44
- name: "ioping.conf"
45
- description: "File with options to specify hardware to monitor and arguments for ioping command."
46
- options:
47
- description: ""
48
- folding:
49
- title: "Config options"
50
- enabled: true
51
- list:
52
- - name: update_every
53
- description: Data collection frequency.
54
- default_value: 1s
55
- required: false
56
- - name: destination
57
- description: The directory/file/device to ioping.
58
- default_value: ""
59
- required: true
60
- - name: request_size
61
- description: The request size in bytes to ioping the destination (symbolic modifiers are supported)
62
- default_value: 4k
63
- required: false
64
- - name: ioping_opts
65
- description: Options passed to `ioping` commands.
66
- default_value: -T 1000000
67
- required: false
68
- examples:
69
- folding:
70
- enabled: true
71
- title: "Config"
72
- list:
73
- - name: Basic Configuration
74
- description: This example has the minimum configuration necessary to have the plugin running.
75
- config: |
76
- destination="/dev/sda"
77
-troubleshooting:
78
- problems:
79
- list: []
80
-alerts:
81
-- name: ioping_disk_latency
82
- link: https://github.com/netdata/netdata/blob/master/health/health.d/ioping.conf
83
- metric: ioping.latency
84
- info: average I/O latency over the last 10 seconds
85
-metrics:
86
- folding:
87
- title: Metrics
88
- enabled: false
89
- description: ""
90
- availability: []
91
- scopes:
92
- - name: disk
93
- description: ""
94
- labels: []
1
+plugin_name: ioping.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: ioping.plugin
5
+ module_name: ioping.plugin
6
+ monitored_instance:
7
+ name: IOPing
8
+ link: "https://github.com/koct9i/ioping"
9
+ categories:
10
+ - data-collection.synthetic-checks
11
+ icon_filename: "syslog.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords: []
18
+ most_popular: false
19
+ overview:
20
+ data_collection:
21
+ metrics_description: "Monitor IOPing metrics for efficient disk I/O latency tracking. Keep track of read/write speeds, latency, and error rates for optimized disk operations."
22
+ method_description: "Plugin uses `ioping` command."
23
+ supported_platforms:
24
+ include: []
25
+ exclude: []
26
+ multi_instance: true
27
+ additional_permissions:
28
+ description: ""
29
+ default_behavior:
30
+ auto_detection:
31
+ description: ""
32
+ limits:
33
+ description: ""
34
+ performance_impact:
35
+ description: ""
36
+ setup:
37
+ prerequisites:
38
+ list:
39
+ - title: Install ioping
40
+ description: |
41
+ You can install the command by passing the argument `install` to the plugin (`/usr/libexec/netdata/plugins.d/ioping.plugin install`).
42
+ configuration:
43
+ file:
44
+ name: "ioping.conf"
45
+ description: "File with options to specify hardware to monitor and arguments for ioping command."
46
+ options:
47
+ description: ""
48
+ folding:
49
+ title: "Config options"
50
+ enabled: true
51
+ list:
52
+ - name: update_every
53
+ description: Data collection frequency.
54
+ default_value: 1s
55
+ required: false
56
+ - name: destination
57
+ description: The directory/file/device to ioping.
58
+ default_value: ""
59
+ required: true
60
+ - name: request_size
61
+ description: The request size in bytes to ioping the destination (symbolic modifiers are supported)
62
+ default_value: 4k
63
+ required: false
64
+ - name: ioping_opts
65
+ description: Options passed to `ioping` commands.
66
+ default_value: -T 1000000
67
+ required: false
68
+ examples:
69
+ folding:
70
+ enabled: true
71
+ title: "Config"
72
+ list:
73
+ - name: Basic Configuration
74
+ description: This example has the minimum configuration necessary to have the plugin running.
75
+ config: |
76
+ destination="/dev/sda"
77
+ troubleshooting:
78
+ problems:
79
+ list: []
80
+ alerts:
81
+ - name: ioping_disk_latency
82
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/ioping.conf
83
+ metric: ioping.latency
84
+ info: average I/O latency over the last 10 seconds
85
metrics:
96
- - name: ioping.latency
97
- description: Read Latency
98
- unit: "microseconds"
99
- chart_type: line
100
- dimensions:
101
- - name: latency
86
+ folding:
87
+ title: Metrics
88
+ enabled: false
89
+ description: ""
90
+ availability: []
91
+ scopes:
92
+ - name: disk
93
+ description: ""
94
+ labels: []
95
+ metrics:
96
+ - name: ioping.latency
97
+ description: Read Latency
98
+ unit: "microseconds"
99
+ chart_type: line
100
+ dimensions:
101
+ - name: latency
collectors/macos.plugin/metadata.yaml
renamed
-2
@@ -1,5 +1,3 @@
1
-# yamllint disable rule:line-length
2
----
1
plugin_name: macos.plugin
2
modules:
3
- meta:
collectors/metadata/single-module-template.yaml
deleted
-97
@@ -1,97 +0,0 @@
1
-meta:
2
- plugin_name: ""
3
- module_name: ""
4
- alternative_monitored_instances: []
5
- monitored_instance:
6
- name: ""
7
- link: ""
8
- categories: []
9
- icon_filename: ""
10
- related_resources:
11
- integrations:
12
- list:
13
- - plugin_name: ""
14
- module_name: ""
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords: []
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: ""
22
- method_description: ""
23
- supported_platforms:
24
- include: []
25
- exclude: []
26
- multi_instance: true
27
- additional_permissions:
28
- description: ""
29
- default_behavior:
30
- auto_detection:
31
- description: ""
32
- limits:
33
- description: ""
34
- performance_impact:
35
- description: ""
36
-setup:
37
- prerequisites:
38
- list:
39
- - title: ""
40
- description: ""
41
- configuration:
42
- file:
43
- name: ""
44
- description: ""
45
- options:
46
- description: ""
47
- folding:
48
- title: ""
49
- enabled: true
50
- list:
51
- - name: ""
52
- default_value: ""
53
- description: ""
54
- required: false
55
- examples:
56
- folding:
57
- enabled: true
58
- title: ""
59
- list:
60
- - name: ""
61
- folding:
62
- enabled: false
63
- description: ""
64
- config: ""
65
-troubleshooting:
66
- problems:
67
- list:
68
- - name: ""
69
- description: ""
70
-alerts:
71
- - info: ""
72
- link: ""
73
- metric: ""
74
- name: ""
75
- os: ""
76
-metrics:
77
- folding:
78
- enabled: false
79
- title: ""
80
- description: ""
81
- availability:
82
- - ""
83
- scopes:
84
- - name: ""
85
- description: ""
86
- labels:
87
- - name: ""
88
- description: ""
89
- metrics:
90
- - name: ""
91
- availability:
92
- - ""
93
- description: ""
94
- unit: ""
95
- chart_type: line
96
- dimensions:
97
- - name: ""
collectors/nfacct.plugin/metadata.yaml
+132
-130
@@ -1,131 +1,133 @@
1
-meta:
2
- plugin_name: nfacct.plugin
3
- module_name: nfacct.plugin
4
- monitored_instance:
5
- name: Netfilter
6
- link: 'https://www.netfilter.org/'
7
- categories:
8
- - data-collection.networking-stack-and-network-interfaces
9
- icon_filename: 'netfilter.png'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
- most_popular: false
17
-overview:
18
- data_collection:
19
- metrics_description: 'Monitor Netfilter metrics for optimal packet filtering and manipulation. Keep tabs on packet counts, dropped packets, and error rates to secure network operations.'
20
- method_description: 'Netdata uses libmnl (https://www.netfilter.org/projects/libmnl/index.html) to collect information.'
21
- supported_platforms:
22
- include: []
23
- exclude: []
24
- multi_instance: true
25
- additional_permissions:
26
- description: 'This plugin needs setuid.'
27
- default_behavior:
28
- auto_detection:
29
- description: 'This plugin uses socket to connect with netfilter to collect data'
30
- limits:
31
- description: ''
32
- performance_impact:
33
- description: ''
34
-setup:
35
- prerequisites:
36
- list:
37
- - title: Install required packages
38
- description: |
39
- Install `libmnl-dev` and `libnetfilter-acct-dev` using the package manager of your system.
40
- configuration:
41
- file:
42
- name: 'netdata.conf'
43
- section_name: '[plugin:nfacct]'
44
- description: 'This is netdata main configuration file'
45
- options:
46
- description: ''
47
- folding:
48
- title: 'Config options'
49
- enabled: true
50
- list:
51
- - name: update every
52
- description: Data collection frequency.
53
- default_value: 1
54
- required: false
55
- - name: command options
56
- description: Additinal parameters for collector
57
- default_value: ""
58
- required: false
59
- examples:
60
- folding:
61
- enabled: true
62
- title: ''
63
- list: []
64
-troubleshooting:
65
- problems:
66
- list: []
67
-alerts: []
68
-metrics:
69
- folding:
70
- title: Metrics
71
- enabled: false
72
- description: ""
73
- availability: []
74
- scopes:
75
- - name: global
76
- description: ""
77
- labels: []
1
+plugin_name: nfacct.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: nfacct.plugin
5
+ module_name: nfacct.plugin
6
+ monitored_instance:
7
+ name: Netfilter
8
+ link: 'https://www.netfilter.org/'
9
+ categories:
10
+ - data-collection.networking-stack-and-network-interfaces
11
+ icon_filename: 'netfilter.png'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords: []
18
+ most_popular: false
19
+ overview:
20
+ data_collection:
21
+ metrics_description: 'Monitor Netfilter metrics for optimal packet filtering and manipulation. Keep tabs on packet counts, dropped packets, and error rates to secure network operations.'
22
+ method_description: 'Netdata uses libmnl (https://www.netfilter.org/projects/libmnl/index.html) to collect information.'
23
+ supported_platforms:
24
+ include: []
25
+ exclude: []
26
+ multi_instance: true
27
+ additional_permissions:
28
+ description: 'This plugin needs setuid.'
29
+ default_behavior:
30
+ auto_detection:
31
+ description: 'This plugin uses socket to connect with netfilter to collect data'
32
+ limits:
33
+ description: ''
34
+ performance_impact:
35
+ description: ''
36
+ setup:
37
+ prerequisites:
38
+ list:
39
+ - title: Install required packages
40
+ description: |
41
+ Install `libmnl-dev` and `libnetfilter-acct-dev` using the package manager of your system.
42
+ configuration:
43
+ file:
44
+ name: 'netdata.conf'
45
+ section_name: '[plugin:nfacct]'
46
+ description: 'This is netdata main configuration file'
47
+ options:
48
+ description: ''
49
+ folding:
50
+ title: 'Config options'
51
+ enabled: true
52
+ list:
53
+ - name: update every
54
+ description: Data collection frequency.
55
+ default_value: 1
56
+ required: false
57
+ - name: command options
58
+ description: Additinal parameters for collector
59
+ default_value: ""
60
+ required: false
61
+ examples:
62
+ folding:
63
+ enabled: true
64
+ title: ''
65
+ list: []
66
+ troubleshooting:
67
+ problems:
68
+ list: []
69
+ alerts: []
70
metrics:
79
- - name: netfilter.netlink_new
80
- description: Connection Tracker New Connections
81
- unit: "connections/s"
82
- chart_type: line
83
- dimensions:
84
- - name: new
85
- - name: ignore
86
- - name: invalid
87
- - name: netfilter.netlink_changes
88
- description: Connection Tracker Changes
89
- unit: "changes/s"
90
- chart_type: line
91
- dimensions:
92
- - name: insert
93
- - name: delete
94
- - name: delete_list
95
- - name: netfilter.netlink_search
96
- description: Connection Tracker Searches
97
- unit: "searches/s"
98
- chart_type: line
99
- dimensions:
100
- - name: searched
101
- - name: search_restart
102
- - name: found
103
- - name: netfilter.netlink_errors
104
- description: Connection Tracker Errors
105
- unit: "events/s"
106
- chart_type: line
107
- dimensions:
108
- - name: icmp_error
109
- - name: insert_failed
110
- - name: drop
111
- - name: early_drop
112
- - name: netfilter.netlink_expect
113
- description: Connection Tracker Expectations
114
- unit: "expectations/s"
115
- chart_type: line
116
- dimensions:
117
- - name: created
118
- - name: deleted
119
- - name: new
120
- - name: netfilter.nfacct_packets
121
- description: Netfilter Accounting Packets
122
- unit: "packets/s"
123
- chart_type: line
124
- dimensions:
125
- - name: a dimension per nfacct object
126
- - name: netfilter.nfacct_bytes
127
- description: Netfilter Accounting Bandwidth
128
- unit: "kilobytes/s"
129
- chart_type: line
130
- dimensions:
131
- - name: a dimension per nfacct object
71
+ folding:
72
+ title: Metrics
73
+ enabled: false
74
+ description: ""
75
+ availability: []
76
+ scopes:
77
+ - name: global
78
+ description: ""
79
+ labels: []
80
+ metrics:
81
+ - name: netfilter.netlink_new
82
+ description: Connection Tracker New Connections
83
+ unit: "connections/s"
84
+ chart_type: line
85
+ dimensions:
86
+ - name: new
87
+ - name: ignore
88
+ - name: invalid
89
+ - name: netfilter.netlink_changes
90
+ description: Connection Tracker Changes
91
+ unit: "changes/s"
92
+ chart_type: line
93
+ dimensions:
94
+ - name: insert
95
+ - name: delete
96
+ - name: delete_list
97
+ - name: netfilter.netlink_search
98
+ description: Connection Tracker Searches
99
+ unit: "searches/s"
100
+ chart_type: line
101
+ dimensions:
102
+ - name: searched
103
+ - name: search_restart
104
+ - name: found
105
+ - name: netfilter.netlink_errors
106
+ description: Connection Tracker Errors
107
+ unit: "events/s"
108
+ chart_type: line
109
+ dimensions:
110
+ - name: icmp_error
111
+ - name: insert_failed
112
+ - name: drop
113
+ - name: early_drop
114
+ - name: netfilter.netlink_expect
115
+ description: Connection Tracker Expectations
116
+ unit: "expectations/s"
117
+ chart_type: line
118
+ dimensions:
119
+ - name: created
120
+ - name: deleted
121
+ - name: new
122
+ - name: netfilter.nfacct_packets
123
+ description: Netfilter Accounting Packets
124
+ unit: "packets/s"
125
+ chart_type: line
126
+ dimensions:
127
+ - name: a dimension per nfacct object
128
+ - name: netfilter.nfacct_bytes
129
+ description: Netfilter Accounting Bandwidth
130
+ unit: "kilobytes/s"
131
+ chart_type: line
132
+ dimensions:
133
+ - name: a dimension per nfacct object
collectors/perf.plugin/metadata.yaml
+215
-215
@@ -1,216 +1,216 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: perf.plugin
5
- module_name: perf.plugin
6
- monitored_instance:
7
- name: CPU performance
8
- link: "https://kernel.org/"
9
- categories:
10
- - data-collection.linux-systems
11
- icon_filename: "bolt.svg"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - linux
19
- - cpu performance
20
- - cpu cache
21
- - perf.plugin
22
- most_popular: false
23
-overview:
24
- data_collection:
25
- metrics_description: "This collector monitors CPU performance metrics about cycles, instructions, migrations, cache operations and more."
26
- method_description: "It uses syscall (2) to open a file descriptior to monitor the perf events."
27
- supported_platforms:
28
- include:
29
- - Linux
30
- exclude: []
31
- multi_instance: true
32
- additional_permissions:
33
- description: "It needs setuid to use necessary syscall to collect perf events. Netada sets the permission during installation time."
34
- default_behavior:
35
- auto_detection:
36
- description: ""
37
- limits:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
-setup:
42
- prerequisites:
43
- list: []
44
- configuration:
45
- file:
46
- name: "netdata.conf"
47
- section_name: "[plugin:perf]"
48
- description: "The main netdata configuration file."
49
- options:
50
- description: |
51
- You can get the available options running:
52
-
53
- ```bash
54
- /usr/libexec/netdata/plugins.d/perf.plugin --help
55
- ````
56
- folding:
57
- title: "Config options"
58
- enabled: true
59
- list:
60
- - name: update every
61
- description: Data collection frequency.
62
- default_value: 1
63
- required: false
64
- - name: command options
65
- description: Command options that specify charts shown by plugin.
66
- default_value: 1
67
- required: true
68
- examples:
69
- folding:
70
- enabled: true
71
- title: "Config"
72
- list:
73
- - name: All metrics
1
+plugin_name: perf.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: perf.plugin
5
+ module_name: perf.plugin
6
+ monitored_instance:
7
+ name: CPU performance
8
+ link: "https://kernel.org/"
9
+ categories:
10
+ - data-collection.linux-systems
11
+ icon_filename: "bolt.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - linux
19
+ - cpu performance
20
+ - cpu cache
21
+ - perf.plugin
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: "This collector monitors CPU performance metrics about cycles, instructions, migrations, cache operations and more."
26
+ method_description: "It uses syscall (2) to open a file descriptior to monitor the perf events."
27
+ supported_platforms:
28
+ include:
29
+ - Linux
30
+ exclude: []
31
+ multi_instance: true
32
+ additional_permissions:
33
+ description: "It needs setuid to use necessary syscall to collect perf events. Netada sets the permission during installation time."
34
+ default_behavior:
35
+ auto_detection:
36
+ description: ""
37
+ limits:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list: []
44
+ configuration:
45
+ file:
46
+ name: "netdata.conf"
47
+ section_name: "[plugin:perf]"
48
+ description: "The main netdata configuration file."
49
+ options:
50
+ description: |
51
+ You can get the available options running:
52
+
53
+ ```bash
54
+ /usr/libexec/netdata/plugins.d/perf.plugin --help
55
+ ````
56
+ folding:
57
+ title: "Config options"
58
+ enabled: true
59
+ list:
60
+ - name: update every
61
+ description: Data collection frequency.
62
+ default_value: 1
63
+ required: false
64
+ - name: command options
65
+ description: Command options that specify charts shown by plugin.
66
+ default_value: 1
67
+ required: true
68
+ examples:
69
folding:
75
- enabled: false
76
- description: Monitor all metrics available.
77
- config: |
78
- [plugin:perf]
79
- command options = all
80
- - name: CPU cycles
81
- description: Monitor CPU cycles.
82
- config: |
83
- [plugin:perf]
84
- command options = cycles
85
-troubleshooting:
86
- problems:
87
- list: []
88
-alerts: []
89
-metrics:
90
- folding:
91
- title: Metrics
92
- enabled: false
93
- description: ""
94
- availability: []
95
- scopes:
96
- - name: global
97
- description: "These metrics refer to the entire monitored application."
98
- labels: []
99
- metrics:
100
- - name: perf.cpu_cycles
101
- description: CPU cycles
102
- unit: "cycles/s"
103
- chart_type: line
104
- dimensions:
105
- - name: cpu
106
- - name: ref_cpu
107
- - name: perf.instructions
108
- description: Instructions
109
- unit: "instructions/s"
110
- chart_type: line
111
- dimensions:
112
- - name: instructions
113
- - name: perf.instructions_per_cycle
114
- description: Instructions per Cycle(IPC)
115
- unit: "instructions/cycle"
116
- chart_type: line
117
- dimensions:
118
- - name: ipc
119
- - name: perf.branch_instructions
120
- description: Branch instructions
121
- unit: "instructions/s"
122
- chart_type: line
123
- dimensions:
124
- - name: instructions
125
- - name: misses
126
- - name: perf.cache
127
- description: Cache operations
128
- unit: "operations/s"
129
- chart_type: line
130
- dimensions:
131
- - name: references
132
- - name: misses
133
- - name: perf.bus_cycles
134
- description: Bus cycles
135
- unit: "cycles/s"
136
- chart_type: line
137
- dimensions:
138
- - name: bus
139
- - name: perf.stalled_cycles
140
- description: Stalled frontend and backend cycles
141
- unit: "cycles/s"
142
- chart_type: line
143
- dimensions:
144
- - name: frontend
145
- - name: backend
146
- - name: perf.migrations
147
- description: CPU migrations
148
- unit: "migrations"
149
- chart_type: line
150
- dimensions:
151
- - name: migrations
152
- - name: perf.alignment_faults
153
- description: Alignment faults
154
- unit: "faults"
155
- chart_type: line
156
- dimensions:
157
- - name: faults
158
- - name: perf.emulation_faults
159
- description: Emulation faults
160
- unit: "faults"
161
- chart_type: line
162
- dimensions:
163
- - name: faults
164
- - name: perf.l1d_cache
165
- description: L1D cache operations
166
- unit: "events/s"
167
- chart_type: line
168
- dimensions:
169
- - name: read_access
170
- - name: read_misses
171
- - name: write_access
172
- - name: write_misses
173
- - name: perf.l1d_cache_prefetch
174
- description: L1D prefetch cache operations
175
- unit: "prefetches/s"
176
- chart_type: line
177
- dimensions:
178
- - name: prefetches
179
- - name: perf.l1i_cache
180
- description: L1I cache operations
181
- unit: "events/s"
182
- chart_type: line
183
- dimensions:
184
- - name: read_access
185
- - name: read_misses
186
- - name: perf.ll_cache
187
- description: LL cache operations
188
- unit: "events/s"
189
- chart_type: line
190
- dimensions:
191
- - name: read_access
192
- - name: read_misses
193
- - name: write_access
194
- - name: write_misses
195
- - name: perf.dtlb_cache
196
- description: DTLB cache operations
197
- unit: "events/s"
198
- chart_type: line
199
- dimensions:
200
- - name: read_access
201
- - name: read_misses
202
- - name: write_access
203
- - name: write_misses
204
- - name: perf.itlb_cache
205
- description: ITLB cache operations
206
- unit: "events/s"
207
- chart_type: line
208
- dimensions:
209
- - name: read_access
210
- - name: read_misses
211
- - name: perf.pbu_cache
212
- description: PBU cache operations
213
- unit: "events/s"
214
- chart_type: line
215
- dimensions:
216
- - name: read_access
70
+ enabled: true
71
+ title: "Config"
72
+ list:
73
+ - name: All metrics
74
+ folding:
75
+ enabled: false
76
+ description: Monitor all metrics available.
77
+ config: |
78
+ [plugin:perf]
79
+ command options = all
80
+ - name: CPU cycles
81
+ description: Monitor CPU cycles.
82
+ config: |
83
+ [plugin:perf]
84
+ command options = cycles
85
+ troubleshooting:
86
+ problems:
87
+ list: []
88
+ alerts: []
89
+ metrics:
90
+ folding:
91
+ title: Metrics
92
+ enabled: false
93
+ description: ""
94
+ availability: []
95
+ scopes:
96
+ - name: global
97
+ description: "These metrics refer to the entire monitored application."
98
+ labels: []
99
+ metrics:
100
+ - name: perf.cpu_cycles
101
+ description: CPU cycles
102
+ unit: "cycles/s"
103
+ chart_type: line
104
+ dimensions:
105
+ - name: cpu
106
+ - name: ref_cpu
107
+ - name: perf.instructions
108
+ description: Instructions
109
+ unit: "instructions/s"
110
+ chart_type: line
111
+ dimensions:
112
+ - name: instructions
113
+ - name: perf.instructions_per_cycle
114
+ description: Instructions per Cycle(IPC)
115
+ unit: "instructions/cycle"
116
+ chart_type: line
117
+ dimensions:
118
+ - name: ipc
119
+ - name: perf.branch_instructions
120
+ description: Branch instructions
121
+ unit: "instructions/s"
122
+ chart_type: line
123
+ dimensions:
124
+ - name: instructions
125
+ - name: misses
126
+ - name: perf.cache
127
+ description: Cache operations
128
+ unit: "operations/s"
129
+ chart_type: line
130
+ dimensions:
131
+ - name: references
132
+ - name: misses
133
+ - name: perf.bus_cycles
134
+ description: Bus cycles
135
+ unit: "cycles/s"
136
+ chart_type: line
137
+ dimensions:
138
+ - name: bus
139
+ - name: perf.stalled_cycles
140
+ description: Stalled frontend and backend cycles
141
+ unit: "cycles/s"
142
+ chart_type: line
143
+ dimensions:
144
+ - name: frontend
145
+ - name: backend
146
+ - name: perf.migrations
147
+ description: CPU migrations
148
+ unit: "migrations"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: migrations
152
+ - name: perf.alignment_faults
153
+ description: Alignment faults
154
+ unit: "faults"
155
+ chart_type: line
156
+ dimensions:
157
+ - name: faults
158
+ - name: perf.emulation_faults
159
+ description: Emulation faults
160
+ unit: "faults"
161
+ chart_type: line
162
+ dimensions:
163
+ - name: faults
164
+ - name: perf.l1d_cache
165
+ description: L1D cache operations
166
+ unit: "events/s"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: read_access
170
+ - name: read_misses
171
+ - name: write_access
172
+ - name: write_misses
173
+ - name: perf.l1d_cache_prefetch
174
+ description: L1D prefetch cache operations
175
+ unit: "prefetches/s"
176
+ chart_type: line
177
+ dimensions:
178
+ - name: prefetches
179
+ - name: perf.l1i_cache
180
+ description: L1I cache operations
181
+ unit: "events/s"
182
+ chart_type: line
183
+ dimensions:
184
+ - name: read_access
185
+ - name: read_misses
186
+ - name: perf.ll_cache
187
+ description: LL cache operations
188
+ unit: "events/s"
189
+ chart_type: line
190
+ dimensions:
191
+ - name: read_access
192
+ - name: read_misses
193
+ - name: write_access
194
+ - name: write_misses
195
+ - name: perf.dtlb_cache
196
+ description: DTLB cache operations
197
+ unit: "events/s"
198
+ chart_type: line
199
+ dimensions:
200
+ - name: read_access
201
+ - name: read_misses
202
+ - name: write_access
203
+ - name: write_misses
204
+ - name: perf.itlb_cache
205
+ description: ITLB cache operations
206
+ unit: "events/s"
207
+ chart_type: line
208
+ dimensions:
209
+ - name: read_access
210
+ - name: read_misses
211
+ - name: perf.pbu_cache
212
+ description: PBU cache operations
213
+ unit: "events/s"
214
+ chart_type: line
215
+ dimensions:
216
+ - name: read_access
collectors/proc.plugin/multi_metadata.yaml
+5
-5
@@ -43,7 +43,7 @@ modules:
43
- `/sys/devices/system/cpu/[X]/cpuidle/state[X]/time` to get the total time each specific CPU core has spent in each idle state since the system was started.
44
method_description: ""
45
supported_platforms:
46
- include: [ "linux" ]
46
+ include: ["linux"]
47
exclude: []
48
multi_instance: false
49
additional_permissions:
@@ -244,7 +244,7 @@ modules:
244
can help to mitigate the risk of entropy depletion, but they may not be as reliable as hardware-based solutions.
245
method_description: ""
246
supported_platforms:
247
- include: [ "linux" ]
247
+ include: ["linux"]
248
exclude: []
249
multi_instance: false
250
additional_permissions:
@@ -332,7 +332,7 @@ modules:
332
- **Compliance requirements**: Server uptime data can be used to demonstrate compliance with regulatory requirements or SLAs that mandate a minimum level of server availability.
333
method_description: ""
334
supported_platforms:
335
- include: [ "linux" ]
335
+ include: ["linux"]
336
exclude: []
337
multi_instance: false
338
additional_permissions:
@@ -429,7 +429,7 @@ modules:
429
of memory resources.
430
method_description: ""
431
supported_platforms:
432
- include: [ "linux" ]
432
+ include: ["linux"]
433
exclude: []
434
multi_instance: false
435
additional_permissions:
@@ -1151,7 +1151,7 @@ modules:
1151
`/proc/net/softnet_stat` provides statistics that relate to the handling of network packets by softirq.
1152
1153
It provides information about:
1154
-
1154
+
1155
- Total number of processed packets (`processed`).
1156
- Times ksoftirq ran out of quota (`dropped`).
1157
- Times net_rx_action was rescheduled.
collectors/python.d.plugin/adaptec_raid/metadata.yaml
+166
-164
@@ -1,165 +1,167 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: adaptec_raid
4
- monitored_instance:
5
- name: AdaptecRAID
6
- link: "https://www.microchip.com/en-us/products/storage"
7
- categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: "adaptec.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - storage
17
- - raid-controller
18
- - manage-disks
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: |
23
- This collector monitors Adaptec RAID hardware storage controller metrics about both physical and logical drives.
24
- method_description: |
25
- It uses the arcconf command line utility (from adaptec) to monitor your raid controller.
26
-
27
- Executed commands:
28
- - sudo -n arcconf GETCONFIG 1 LD
29
- - sudo -n arcconf GETCONFIG 1 PD
30
- supported_platforms:
31
- include: []
32
- exclude: []
33
- multi_instance: false
34
- additional_permissions:
35
- description: "The module uses arcconf, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute arcconf as root without a password."
36
- default_behavior:
37
- auto_detection:
38
- description: "After all the permissions are satisfied, netdata should be to execute commands via the arcconf command line utility"
39
- limits:
40
- description: ""
41
- performance_impact:
42
- description: ""
43
-setup:
44
- prerequisites:
45
- list:
46
- - title: Grant permissions for netdata, to run arcconf as sudoer
47
- description: |
48
- The module uses arcconf, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute arcconf as root without a password.
49
-
50
- Add to your /etc/sudoers file:
51
- which arcconf shows the full path to the binary.
52
-
53
- ```bash
54
- netdata ALL=(root) NOPASSWD: /path/to/arcconf
55
- ```
56
- - title: Reset Netdata's systemd unit CapabilityBoundingSet (Linux distributions with systemd)
57
- description: |
58
- The default CapabilityBoundingSet doesn't allow using sudo, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute arcconf using sudo.
59
-
60
- As root user, do the following:
61
-
62
- ```bash
63
- mkdir /etc/systemd/system/netdata.service.d
64
- echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
65
- systemctl daemon-reload
66
- systemctl restart netdata.service
67
- ```
68
- configuration:
69
- file:
70
- name: "python.d/adaptec_raid.conf"
71
- options:
72
- description: |
73
- There are 2 sections:
74
-
75
- * Global variables
76
- * One or more JOBS that can define multiple different instances to monitor.
77
-
78
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
79
-
80
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
81
-
82
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
83
- folding:
84
- title: "Config options"
85
- enabled: true
86
- list:
87
- - name: update_every
88
- description: Sets the default data collection frequency.
89
- default_value: 5
90
- required: false
91
- - name: priority
92
- description: Controls the order of charts at the netdata dashboard.
93
- default_value: 60000
94
- required: false
95
- - name: autodetection_retry
96
- description: Sets the job re-check interval in seconds.
97
- default_value: 0
98
- required: false
99
- - name: penalty
100
- description: Indicates whether to apply penalty to update_every in case of failures.
101
- default_value: yes
102
- required: false
103
- examples:
104
- folding:
105
- enabled: true
106
- title: "Config"
107
- list:
108
- - name: Basic
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: adaptec_raid
6
+ monitored_instance:
7
+ name: AdaptecRAID
8
+ link: "https://www.microchip.com/en-us/products/storage"
9
+ categories:
10
+ - data-collection.storage-mount-points-and-filesystems
11
+ icon_filename: "adaptec.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - storage
19
+ - raid-controller
20
+ - manage-disks
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: |
25
+ This collector monitors Adaptec RAID hardware storage controller metrics about both physical and logical drives.
26
+ method_description: |
27
+ It uses the arcconf command line utility (from adaptec) to monitor your raid controller.
28
+
29
+ Executed commands:
30
+ - sudo -n arcconf GETCONFIG 1 LD
31
+ - sudo -n arcconf GETCONFIG 1 PD
32
+ supported_platforms:
33
+ include: []
34
+ exclude: []
35
+ multi_instance: false
36
+ additional_permissions:
37
+ description: "The module uses arcconf, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute arcconf as root without a password."
38
+ default_behavior:
39
+ auto_detection:
40
+ description: "After all the permissions are satisfied, netdata should be to execute commands via the arcconf command line utility"
41
+ limits:
42
+ description: ""
43
+ performance_impact:
44
+ description: ""
45
+ setup:
46
+ prerequisites:
47
+ list:
48
+ - title: Grant permissions for netdata, to run arcconf as sudoer
49
+ description: |
50
+ The module uses arcconf, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute arcconf as root without a password.
51
+
52
+ Add to your /etc/sudoers file:
53
+ which arcconf shows the full path to the binary.
54
+
55
+ ```bash
56
+ netdata ALL=(root) NOPASSWD: /path/to/arcconf
57
+ ```
58
+ - title: Reset Netdata's systemd unit CapabilityBoundingSet (Linux distributions with systemd)
59
+ description: |
60
+ The default CapabilityBoundingSet doesn't allow using sudo, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute arcconf using sudo.
61
+
62
+ As root user, do the following:
63
+
64
+ ```bash
65
+ mkdir /etc/systemd/system/netdata.service.d
66
+ echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
67
+ systemctl daemon-reload
68
+ systemctl restart netdata.service
69
+ ```
70
+ configuration:
71
+ file:
72
+ name: "python.d/adaptec_raid.conf"
73
+ options:
74
+ description: |
75
+ There are 2 sections:
76
+
77
+ * Global variables
78
+ * One or more JOBS that can define multiple different instances to monitor.
79
+
80
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
81
+
82
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
83
+
84
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
85
folding:
110
- enabled: false
111
- description: A basic example configuration per job
112
- config: |
113
- job_name:
114
- name: my_job_name
115
- update_every: 1 # the JOB's data collection frequency
116
- priority: 60000 # the JOB's order on the dashboard
117
- penalty: yes # the JOB's penalty
118
- autodetection_retry: 0 # the JOB's re-check interval in seconds
119
-troubleshooting:
120
- problems:
121
- list: []
122
-alerts:
123
- - name: adaptec_raid_ld_status
124
- link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
125
- metric: adaptec_raid.ld_status
126
- info: logical device status is failed or degraded
127
- - name: adaptec_raid_pd_state
128
- link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
129
- metric: adaptec_raid.pd_state
130
- info: physical device state is not online
131
-metrics:
132
- folding:
133
- title: Metrics
134
- enabled: false
135
- description: ""
136
- availability: []
137
- scopes:
138
- - name: global
139
- description: "These metrics refer to the entire monitored application."
140
- labels: []
141
- metrics:
142
- - name: adaptec_raid.ld_status
143
- description: "Status of logical devices (1: Failed or Degraded)"
144
- unit: "bool"
145
- chart_type: line
146
- dimensions:
147
- - name: a dimension per logical device
148
- - name: adaptec_raid.pd_state
149
- description: "State of physical devices (1: not Online)"
150
- unit: "bool"
151
- chart_type: line
152
- dimensions:
153
- - name: a dimension per physical device
154
- - name: adaptec_raid.smart_warnings
155
- description: S.M.A.R.T warnings
156
- unit: "count"
157
- chart_type: line
158
- dimensions:
159
- - name: a dimension per physical device
160
- - name: adaptec_raid.temperature
161
- description: Temperature
162
- unit: "celsius"
163
- chart_type: line
164
- dimensions:
165
- - name: a dimension per physical device
86
+ title: "Config options"
87
+ enabled: true
88
+ list:
89
+ - name: update_every
90
+ description: Sets the default data collection frequency.
91
+ default_value: 5
92
+ required: false
93
+ - name: priority
94
+ description: Controls the order of charts at the netdata dashboard.
95
+ default_value: 60000
96
+ required: false
97
+ - name: autodetection_retry
98
+ description: Sets the job re-check interval in seconds.
99
+ default_value: 0
100
+ required: false
101
+ - name: penalty
102
+ description: Indicates whether to apply penalty to update_every in case of failures.
103
+ default_value: yes
104
+ required: false
105
+ examples:
106
+ folding:
107
+ enabled: true
108
+ title: "Config"
109
+ list:
110
+ - name: Basic
111
+ folding:
112
+ enabled: false
113
+ description: A basic example configuration per job
114
+ config: |
115
+ job_name:
116
+ name: my_job_name
117
+ update_every: 1 # the JOB's data collection frequency
118
+ priority: 60000 # the JOB's order on the dashboard
119
+ penalty: yes # the JOB's penalty
120
+ autodetection_retry: 0 # the JOB's re-check interval in seconds
121
+ troubleshooting:
122
+ problems:
123
+ list: []
124
+ alerts:
125
+ - name: adaptec_raid_ld_status
126
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
127
+ metric: adaptec_raid.ld_status
128
+ info: logical device status is failed or degraded
129
+ - name: adaptec_raid_pd_state
130
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
131
+ metric: adaptec_raid.pd_state
132
+ info: physical device state is not online
133
+ metrics:
134
+ folding:
135
+ title: Metrics
136
+ enabled: false
137
+ description: ""
138
+ availability: []
139
+ scopes:
140
+ - name: global
141
+ description: "These metrics refer to the entire monitored application."
142
+ labels: []
143
+ metrics:
144
+ - name: adaptec_raid.ld_status
145
+ description: "Status of logical devices (1: Failed or Degraded)"
146
+ unit: "bool"
147
+ chart_type: line
148
+ dimensions:
149
+ - name: a dimension per logical device
150
+ - name: adaptec_raid.pd_state
151
+ description: "State of physical devices (1: not Online)"
152
+ unit: "bool"
153
+ chart_type: line
154
+ dimensions:
155
+ - name: a dimension per physical device
156
+ - name: adaptec_raid.smart_warnings
157
+ description: S.M.A.R.T warnings
158
+ unit: "count"
159
+ chart_type: line
160
+ dimensions:
161
+ - name: a dimension per physical device
162
+ - name: adaptec_raid.temperature
163
+ description: Temperature
164
+ unit: "celsius"
165
+ chart_type: line
166
+ dimensions:
167
+ - name: a dimension per physical device
collectors/python.d.plugin/alarms/metadata.yaml
+173
-173
@@ -1,177 +1,177 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: alarms
6
- monitored_instance:
7
- name: python.d alarms
8
- link: https://learn.netdata.cloud/docs/data-collection/netdata-specific/alarms
9
- categories:
10
- - data-collection.other
11
- icon_filename: ""
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - alarms
19
- - netdata
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: |
24
- This collector creates an 'Alarms' menu with one line plot of `alarms.status`.
25
- method_description: |
26
- Alarm status is read from the Netdata agent rest api [`/api/v1/alarms?all`](https://learn.netdata.cloud/api#/alerts/alerts1).
27
- supported_platforms:
28
- include: []
29
- exclude: []
30
- multi_instance: true
31
- additional_permissions:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: |
36
- It discovers instances of Netdata running on localhost, and gathers metrics from `http://127.0.0.1:19999/api/v1/alarms?all`. `CLEAR` status is mapped to `0`, `WARNING` to `1` and `CRITICAL` to `2`. Also, by default all alarms produced will be monitored.
37
- limits:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
-setup:
42
- prerequisites:
43
- list: []
44
- configuration:
45
- file:
46
- name: python.d/alarms.conf
47
- description: ""
48
- options:
49
- description: |
50
- There are 2 sections:
51
-
52
- * Global variables
53
- * One or more JOBS that can define multiple different instances to monitor.
54
-
55
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
-
57
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
-
59
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
- folding:
61
- title: Config options
62
- enabled: true
63
- list:
64
- - name: url
65
- description: Netdata agent alarms endpoint to collect from. Can be local or remote so long as reachable by agent.
66
- default_value: http://127.0.0.1:19999/api/v1/alarms?all
67
- required: true
68
- - name: status_map
69
- description: Mapping of alarm status to integer number that will be the metric value collected.
70
- default_value: '{"CLEAR": 0, "WARNING": 1, "CRITICAL": 2}'
71
- required: true
72
- - name: collect_alarm_values
73
- description: set to true to include a chart with calculated alarm values over time.
74
- default_value: false
75
- required: true
76
- - name: alarm_status_chart_type
77
- description: define the type of chart for plotting status over time e.g. 'line' or 'stacked'.
78
- default_value: "line"
79
- required: true
80
- - name: alarm_contains_words
81
- description: >
82
- A "," separated list of words you want to filter alarm names for. For example 'cpu,load' would filter for only alarms with "cpu" or "load" in alarm name. Default includes all.
83
- default_value: ""
84
- required: true
85
- - name: alarm_excludes_words
86
- description: >
87
- A "," separated list of words you want to exclude based on alarm name. For example 'cpu,load' would exclude all alarms with "cpu" or "load" in alarm name. Default excludes None.
88
- default_value: ""
89
- required: true
90
- - name: update_every
91
- description: Sets the default data collection frequency.
92
- default_value: 10
93
- required: false
94
- - name: priority
95
- description: Controls the order of charts at the netdata dashboard.
96
- default_value: 60000
97
- required: false
98
- - name: autodetection_retry
99
- description: Sets the job re-check interval in seconds.
100
- default_value: 0
101
- required: false
102
- - name: penalty
103
- description: Indicates whether to apply penalty to update_every in case of failures.
104
- default_value: yes
105
- required: false
106
- - name: name
107
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
108
- default_value: ""
109
- required: false
110
- examples:
111
- folding:
112
- enabled: true
113
- title: Config
114
- list:
115
- - name: Basic
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: alarms
6
+ monitored_instance:
7
+ name: python.d alarms
8
+ link: https://learn.netdata.cloud/docs/data-collection/netdata-specific/alarms
9
+ categories:
10
+ - data-collection.other
11
+ icon_filename: ""
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - alarms
19
+ - netdata
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: |
24
+ This collector creates an 'Alarms' menu with one line plot of `alarms.status`.
25
+ method_description: |
26
+ Alarm status is read from the Netdata agent rest api [`/api/v1/alarms?all`](https://learn.netdata.cloud/api#/alerts/alerts1).
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: |
36
+ It discovers instances of Netdata running on localhost, and gathers metrics from `http://127.0.0.1:19999/api/v1/alarms?all`. `CLEAR` status is mapped to `0`, `WARNING` to `1` and `CRITICAL` to `2`. Also, by default all alarms produced will be monitored.
37
+ limits:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list: []
44
+ configuration:
45
+ file:
46
+ name: python.d/alarms.conf
47
+ description: ""
48
+ options:
49
+ description: |
50
+ There are 2 sections:
51
+
52
+ * Global variables
53
+ * One or more JOBS that can define multiple different instances to monitor.
54
+
55
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
+
57
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
+
59
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
folding:
117
- enabled: false
118
- description: A basic example configuration.
119
- config: |
120
- jobs:
121
- url: 'http://127.0.0.1:19999/api/v1/alarms?all'
122
- - name: Advanced
61
+ title: Config options
62
+ enabled: true
63
+ list:
64
+ - name: url
65
+ description: Netdata agent alarms endpoint to collect from. Can be local or remote so long as reachable by agent.
66
+ default_value: http://127.0.0.1:19999/api/v1/alarms?all
67
+ required: true
68
+ - name: status_map
69
+ description: Mapping of alarm status to integer number that will be the metric value collected.
70
+ default_value: '{"CLEAR": 0, "WARNING": 1, "CRITICAL": 2}'
71
+ required: true
72
+ - name: collect_alarm_values
73
+ description: set to true to include a chart with calculated alarm values over time.
74
+ default_value: false
75
+ required: true
76
+ - name: alarm_status_chart_type
77
+ description: define the type of chart for plotting status over time e.g. 'line' or 'stacked'.
78
+ default_value: "line"
79
+ required: true
80
+ - name: alarm_contains_words
81
+ description: >
82
+ A "," separated list of words you want to filter alarm names for. For example 'cpu,load' would filter for only alarms with "cpu" or "load" in alarm name. Default includes all.
83
+ default_value: ""
84
+ required: true
85
+ - name: alarm_excludes_words
86
+ description: >
87
+ A "," separated list of words you want to exclude based on alarm name. For example 'cpu,load' would exclude all alarms with "cpu" or "load" in alarm name. Default excludes None.
88
+ default_value: ""
89
+ required: true
90
+ - name: update_every
91
+ description: Sets the default data collection frequency.
92
+ default_value: 10
93
+ required: false
94
+ - name: priority
95
+ description: Controls the order of charts at the netdata dashboard.
96
+ default_value: 60000
97
+ required: false
98
+ - name: autodetection_retry
99
+ description: Sets the job re-check interval in seconds.
100
+ default_value: 0
101
+ required: false
102
+ - name: penalty
103
+ description: Indicates whether to apply penalty to update_every in case of failures.
104
+ default_value: yes
105
+ required: false
106
+ - name: name
107
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
108
+ default_value: ""
109
+ required: false
110
+ examples:
111
folding:
112
enabled: true
113
+ title: Config
114
+ list:
115
+ - name: Basic
116
+ folding:
117
+ enabled: false
118
+ description: A basic example configuration.
119
+ config: |
120
+ jobs:
121
+ url: 'http://127.0.0.1:19999/api/v1/alarms?all'
122
+ - name: Advanced
123
+ folding:
124
+ enabled: true
125
+ description: |
126
+ An advanced example configuration with multiple jobs collecting different subsets of alarms for plotting on different charts.
127
+ "ML" job will collect status and values for all alarms with "ml_" in the name. Default job will collect status for all other alarms.
128
+ config: |
129
+ ML:
130
+ update_every: 5
131
+ url: 'http://127.0.0.1:19999/api/v1/alarms?all'
132
+ status_map:
133
+ CLEAR: 0
134
+ WARNING: 1
135
+ CRITICAL: 2
136
+ collect_alarm_values: true
137
+ alarm_status_chart_type: 'stacked'
138
+ alarm_contains_words: 'ml_'
139
+
140
+ Default:
141
+ update_every: 5
142
+ url: 'http://127.0.0.1:19999/api/v1/alarms?all'
143
+ status_map:
144
+ CLEAR: 0
145
+ WARNING: 1
146
+ CRITICAL: 2
147
+ collect_alarm_values: false
148
+ alarm_status_chart_type: 'stacked'
149
+ alarm_excludes_words: 'ml_'
150
+ troubleshooting:
151
+ problems:
152
+ list: []
153
+ alerts: []
154
+ metrics:
155
+ folding:
156
+ title: Metrics
157
+ enabled: false
158
+ description: ""
159
+ availability: []
160
+ scopes:
161
+ - name: global
162
description: |
126
- An advanced example configuration with multiple jobs collecting different subsets of alarms for plotting on different charts.
127
- "ML" job will collect status and values for all alarms with "ml_" in the name. Default job will collect status for all other alarms.
128
- config: |
129
- ML:
130
- update_every: 5
131
- url: 'http://127.0.0.1:19999/api/v1/alarms?all'
132
- status_map:
133
- CLEAR: 0
134
- WARNING: 1
135
- CRITICAL: 2
136
- collect_alarm_values: true
137
- alarm_status_chart_type: 'stacked'
138
- alarm_contains_words: 'ml_'
139
-
140
- Default:
141
- update_every: 5
142
- url: 'http://127.0.0.1:19999/api/v1/alarms?all'
143
- status_map:
144
- CLEAR: 0
145
- WARNING: 1
146
- CRITICAL: 2
147
- collect_alarm_values: false
148
- alarm_status_chart_type: 'stacked'
149
- alarm_excludes_words: 'ml_'
150
-troubleshooting:
151
- problems:
152
- list: []
153
-alerts: []
154
-metrics:
155
- folding:
156
- title: Metrics
157
- enabled: false
158
- description: ""
159
- availability: []
160
- scopes:
161
- - name: global
162
- description: |
163
- These metrics refer to the entire monitored application.
164
- labels: []
165
- metrics:
166
- - name: alarms.status
167
- description: Alarms ({status mapping})
168
- unit: "status"
169
- chart_type: line
170
- dimensions:
171
- - name: a dimension per alarm representing the latest status of the alarm.
172
- - name: alarms.values
173
- description: Alarm Values
174
- unit: "value"
175
- chart_type: line
176
- dimensions:
177
- - name: a dimension per alarm representing the latest collected value of the alarm.
163
+ These metrics refer to the entire monitored application.
164
+ labels: []
165
+ metrics:
166
+ - name: alarms.status
167
+ description: Alarms ({status mapping})
168
+ unit: "status"
169
+ chart_type: line
170
+ dimensions:
171
+ - name: a dimension per alarm representing the latest status of the alarm.
172
+ - name: alarms.values
173
+ description: Alarm Values
174
+ unit: "value"
175
+ chart_type: line
176
+ dimensions:
177
+ - name: a dimension per alarm representing the latest collected value of the alarm.
collectors/python.d.plugin/am2320/metadata.yaml
+133
-131
@@ -1,133 +1,135 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: am2320
4
- monitored_instance:
5
- name: AM2320
6
- link: 'https://learn.adafruit.com/adafruit-am2320-temperature-humidity-i2c-sensor/overview'
7
- categories:
8
- - data-collection.hardware-devices-and-sensors
9
- icon_filename: 'microchip.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - temperature
17
- - am2320
18
- - sensor
19
- - humidity
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: 'This collector monitors AM2320 sensor metrics about temperature and humidity.'
24
- method_description: 'It retrieves temperature and humidity values by contacting an AM2320 sensor over i2c.'
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: false
29
- additional_permissions:
30
- description: ''
31
- default_behavior:
32
- auto_detection:
33
- description: 'Assuming prerequisites are met, the collector will try to connect to the sensor via i2c'
34
- limits:
35
- description: ''
36
- performance_impact:
37
- description: ''
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: 'Sensor connection to a Raspberry Pi'
42
- description: |
43
- Connect the am2320 to the Raspberry Pi I2C pins
44
-
45
- Raspberry Pi 3B/4 Pins:
46
-
47
- - Board 3.3V (pin 1) to sensor VIN (pin 1)
48
- - Board SDA (pin 3) to sensor SDA (pin 2)
49
- - Board GND (pin 6) to sensor GND (pin 3)
50
- - Board SCL (pin 5) to sensor SCL (pin 4)
51
-
52
- You may also need to add two I2C pullup resistors if your board does not already have them. The Raspberry Pi does have internal pullup resistors but it doesn't hurt to add them anyway. You can use 2.2K - 10K but we will just use 10K. The resistors go from VDD to SCL and SDA each.
53
- - title: 'Software requirements'
54
- description: |
55
- Install the Adafruit Circuit Python AM2320 library:
56
-
57
- `sudo pip3 install adafruit-circuitpython-am2320`
58
- configuration:
59
- file:
60
- name: python.d/am2320.conf
61
- options:
62
- description: |
63
- There are 2 sections:
64
-
65
- * Global variables
66
- * One or more JOBS that can define multiple different instances to monitor.
67
-
68
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
69
-
70
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
71
-
72
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
73
- folding:
74
- title: "Config options"
75
- enabled: true
76
- list:
77
- - name: update_every
78
- description: Sets the default data collection frequency.
79
- default_value: 5
80
- required: false
81
- - name: priority
82
- description: Controls the order of charts at the netdata dashboard.
83
- default_value: 60000
84
- required: false
85
- - name: autodetection_retry
86
- description: Sets the job re-check interval in seconds.
87
- default_value: 0
88
- required: false
89
- - name: penalty
90
- description: Indicates whether to apply penalty to update_every in case of failures.
91
- default_value: yes
92
- required: false
93
- - name: name
94
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
95
- default_value: ''
96
- required: false
97
- examples:
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: am2320
6
+ monitored_instance:
7
+ name: AM2320
8
+ link: 'https://learn.adafruit.com/adafruit-am2320-temperature-humidity-i2c-sensor/overview'
9
+ categories:
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: 'microchip.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - temperature
19
+ - am2320
20
+ - sensor
21
+ - humidity
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: 'This collector monitors AM2320 sensor metrics about temperature and humidity.'
26
+ method_description: 'It retrieves temperature and humidity values by contacting an AM2320 sensor over i2c.'
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: false
31
+ additional_permissions:
32
+ description: ''
33
+ default_behavior:
34
+ auto_detection:
35
+ description: 'Assuming prerequisites are met, the collector will try to connect to the sensor via i2c'
36
+ limits:
37
+ description: ''
38
+ performance_impact:
39
+ description: ''
40
+ setup:
41
+ prerequisites:
42
+ list:
43
+ - title: 'Sensor connection to a Raspberry Pi'
44
+ description: |
45
+ Connect the am2320 to the Raspberry Pi I2C pins
46
+
47
+ Raspberry Pi 3B/4 Pins:
48
+
49
+ - Board 3.3V (pin 1) to sensor VIN (pin 1)
50
+ - Board SDA (pin 3) to sensor SDA (pin 2)
51
+ - Board GND (pin 6) to sensor GND (pin 3)
52
+ - Board SCL (pin 5) to sensor SCL (pin 4)
53
+
54
+ You may also need to add two I2C pullup resistors if your board does not already have them. The Raspberry Pi does have internal pullup resistors but it doesn't hurt to add them anyway. You can use 2.2K - 10K but we will just use 10K. The resistors go from VDD to SCL and SDA each.
55
+ - title: 'Software requirements'
56
+ description: |
57
+ Install the Adafruit Circuit Python AM2320 library:
58
+
59
+ `sudo pip3 install adafruit-circuitpython-am2320`
60
+ configuration:
61
+ file:
62
+ name: python.d/am2320.conf
63
+ options:
64
+ description: |
65
+ There are 2 sections:
66
+
67
+ * Global variables
68
+ * One or more JOBS that can define multiple different instances to monitor.
69
+
70
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
71
+
72
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
73
+
74
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
75
+ folding:
76
+ title: "Config options"
77
+ enabled: true
78
+ list:
79
+ - name: update_every
80
+ description: Sets the default data collection frequency.
81
+ default_value: 5
82
+ required: false
83
+ - name: priority
84
+ description: Controls the order of charts at the netdata dashboard.
85
+ default_value: 60000
86
+ required: false
87
+ - name: autodetection_retry
88
+ description: Sets the job re-check interval in seconds.
89
+ default_value: 0
90
+ required: false
91
+ - name: penalty
92
+ description: Indicates whether to apply penalty to update_every in case of failures.
93
+ default_value: yes
94
+ required: false
95
+ - name: name
96
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
97
+ default_value: ''
98
+ required: false
99
+ examples:
100
+ folding:
101
+ enabled: false
102
+ title: "Config"
103
+ list:
104
+ - name: Local sensor
105
+ description: A basic JOB configuration
106
+ config: |
107
+ local_sensor:
108
+ name: 'Local AM2320'
109
+ troubleshooting:
110
+ problems:
111
+ list: []
112
+ alerts: []
113
+ metrics:
114
folding:
115
+ title: Metrics
116
enabled: false
100
- title: "Config"
101
- list:
102
- - name: Local sensor
103
- description: A basic JOB configuration
104
- config: |
105
- local_sensor:
106
- name: 'Local AM2320'
107
-troubleshooting:
108
- problems:
109
- list: []
110
-alerts: []
111
-metrics:
112
- folding:
113
- title: Metrics
114
- enabled: false
115
- description: ""
116
- availability: []
117
- scopes:
118
- - name: global
119
- description: "These metrics refer to the entire monitored application."
120
- labels: []
121
- metrics:
122
- - name: am2320.temperature
123
- description: Temperature
124
- unit: "celsius"
125
- chart_type: line
126
- dimensions:
127
- - name: temperature
128
- - name: am2320.humidity
129
- description: Relative Humidity
130
- unit: "percentage"
131
- chart_type: line
132
- dimensions:
133
- - name: humidity
117
+ description: ""
118
+ availability: []
119
+ scopes:
120
+ - name: global
121
+ description: "These metrics refer to the entire monitored application."
122
+ labels: []
123
+ metrics:
124
+ - name: am2320.temperature
125
+ description: Temperature
126
+ unit: "celsius"
127
+ chart_type: line
128
+ dimensions:
129
+ - name: temperature
130
+ - name: am2320.humidity
131
+ description: Relative Humidity
132
+ unit: "percentage"
133
+ chart_type: line
134
+ dimensions:
135
+ - name: humidity
collectors/python.d.plugin/beanstalk/metadata.yaml
+261
-260
@@ -1,261 +1,262 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: beanstalk
5
- monitored_instance:
6
- name: Beanstalk
7
- link: "https://beanstalkd.github.io/"
8
- categories:
9
- - data-collection.message-brokers
10
- icon_filename: "beanstalk.svg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - beanstalk
18
- - beanstalkd
19
- - message
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "Monitor Beanstalk metrics to enhance job queueing and processing efficiency. Track job rates, processing times, and queue lengths for better task management."
24
- method_description: "The collector uses the `beanstalkc` python module to connect to a `beanstalkd` service and gather metrics."
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: true
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: "If no configuration is given, module will attempt to connect to beanstalkd on 127.0.0.1:11300 address."
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: "beanstalkc python module"
42
- description: The collector requires the `beanstalkc` python module to be installed.
43
- configuration:
44
- file:
45
- name: python.d/beanstalk.conf
46
- options:
47
- description: |
48
- There are 2 sections:
49
-
50
- * Global variables
51
- * One or more JOBS that can define multiple different instances to monitor.
52
-
53
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
54
-
55
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
-
57
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
- folding:
59
- title: "Config options"
60
- enabled: true
61
- list:
62
- - name: update_every
63
- description: Sets the default data collection frequency.
64
- default_value: 5
65
- required: false
66
- - name: priority
67
- description: Controls the order of charts at the netdata dashboard.
68
- default_value: 60000
69
- required: false
70
- - name: autodetection_retry
71
- description: Sets the job re-check interval in seconds.
72
- default_value: 0
73
- required: false
74
- - name: penalty
75
- description: Indicates whether to apply penalty to update_every in case of failures.
76
- default_value: yes
77
- required: false
78
- - name: name
79
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
80
- default_value: ""
81
- required: false
82
- - name: host
83
- description: IP or URL to a beanstalk service.
84
- default_value: "127.0.0.1"
85
- required: false
86
- - name: port
87
- description: Port to the IP or URL to a beanstalk service.
88
- default_value: "11300"
89
- required: false
90
- examples:
91
- folding:
92
- enabled: true
93
- title: "Config"
94
- list:
95
- - name: Remote beanstalk server
96
- description: A basic remote beanstalk server
97
- folding:
98
- enabled: false
99
- config: |
100
- remote:
101
- name: 'beanstalk'
102
- host: '1.2.3.4'
103
- port: 11300
104
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: beanstalk
6
+ monitored_instance:
7
+ name: Beanstalk
8
+ link: "https://beanstalkd.github.io/"
9
+ categories:
10
+ - data-collection.message-brokers
11
+ icon_filename: "beanstalk.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - beanstalk
19
+ - beanstalkd
20
+ - message
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "Monitor Beanstalk metrics to enhance job queueing and processing efficiency. Track job rates, processing times, and queue lengths for better task management."
25
+ method_description: "The collector uses the `beanstalkc` python module to connect to a `beanstalkd` service and gather metrics."
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: true
30
+ additional_permissions:
31
+ description: ""
32
+ default_behavior:
33
+ auto_detection:
34
+ description: "If no configuration is given, module will attempt to connect to beanstalkd on 127.0.0.1:11300 address."
35
+ limits:
36
+ description: ""
37
+ performance_impact:
38
+ description: ""
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: "beanstalkc python module"
43
+ description: The collector requires the `beanstalkc` python module to be installed.
44
+ configuration:
45
+ file:
46
+ name: python.d/beanstalk.conf
47
+ options:
48
description: |
106
- > **Note**: When you define multiple jobs, their names must be unique.
107
-
108
- Collecting metrics from local and remote instances.
109
- config: |
110
- localhost:
111
- name: 'local_beanstalk'
112
- host: '127.0.0.1'
113
- port: 11300
114
-
115
- remote_job:
116
- name: 'remote_beanstalk'
117
- host: '192.0.2.1'
118
- port: 113000
119
-troubleshooting:
120
- problems:
121
- list: []
122
-alerts:
123
- - name: beanstalk_server_buried_jobs
124
- link: https://github.com/netdata/netdata/blob/master/health/health.d/beanstalkd.conf
125
- metric: beanstalk.current_jobs
126
- info: number of buried jobs across all tubes. You need to manually kick them so they can be processed. Presence of buried jobs in a tube does not affect new jobs.
127
-metrics:
128
- folding:
129
- title: Metrics
130
- enabled: false
131
- description: ""
132
- availability: []
133
- scopes:
134
- - name: global
135
- description: "These metrics refer to the entire monitored application."
136
- labels: []
137
- metrics:
138
- - name: beanstalk.cpu_usage
139
- description: Cpu Usage
140
- unit: "cpu time"
141
- chart_type: area
142
- dimensions:
143
- - name: user
144
- - name: system
145
- - name: beanstalk.jobs_rate
146
- description: Jobs Rate
147
- unit: "jobs/s"
148
- chart_type: line
149
- dimensions:
150
- - name: total
151
- - name: timeouts
152
- - name: beanstalk.connections_rate
153
- description: Connections Rate
154
- unit: "connections/s"
155
- chart_type: area
156
- dimensions:
157
- - name: connections
158
- - name: beanstalk.commands_rate
159
- description: Commands Rate
160
- unit: "commands/s"
161
- chart_type: stacked
162
- dimensions:
163
- - name: put
164
- - name: peek
165
- - name: peek-ready
166
- - name: peek-delayed
167
- - name: peek-buried
168
- - name: reserve
169
- - name: use
170
- - name: watch
171
- - name: ignore
172
- - name: delete
173
- - name: bury
174
- - name: kick
175
- - name: stats
176
- - name: stats-job
177
- - name: stats-tube
178
- - name: list-tubes
179
- - name: list-tube-used
180
- - name: list-tubes-watched
181
- - name: pause-tube
182
- - name: beanstalk.connections_rate
183
- description: Current Tubes
184
- unit: "tubes"
185
- chart_type: area
186
- dimensions:
187
- - name: tubes
188
- - name: beanstalk.current_jobs
189
- description: Current Jobs
190
- unit: "jobs"
191
- chart_type: stacked
192
- dimensions:
193
- - name: urgent
194
- - name: ready
195
- - name: reserved
196
- - name: delayed
197
- - name: buried
198
- - name: beanstalk.current_connections
199
- description: Current Connections
200
- unit: "connections"
201
- chart_type: line
202
- dimensions:
203
- - name: written
204
- - name: producers
205
- - name: workers
206
- - name: waiting
207
- - name: beanstalk.binlog
208
- description: Binlog
209
- unit: "records/s"
210
- chart_type: line
211
- dimensions:
212
- - name: written
213
- - name: migrated
214
- - name: beanstalk.uptime
215
- description: seconds
216
- unit: "seconds"
217
- chart_type: line
218
- dimensions:
219
- - name: uptime
220
- - name: tube
221
- description: "Metrics related to Beanstalk tubes. Each tube produces its own set of the following metrics."
222
- labels: []
223
- metrics:
224
- - name: beanstalk.jobs_rate
225
- description: Jobs Rate
226
- unit: "jobs/s"
227
- chart_type: area
228
- dimensions:
229
- - name: jobs
230
- - name: beanstalk.jobs
231
- description: Jobs
232
- unit: "jobs"
233
- chart_type: stacked
234
- dimensions:
235
- - name: urgent
236
- - name: ready
237
- - name: reserved
238
- - name: delayed
239
- - name: buried
240
- - name: beanstalk.connections
241
- description: Connections
242
- unit: "connections"
243
- chart_type: stacked
244
- dimensions:
245
- - name: using
246
- - name: waiting
247
- - name: watching
248
- - name: beanstalk.commands
249
- description: Commands
250
- unit: "commands/s"
251
- chart_type: stacked
252
- dimensions:
253
- - name: deletes
254
- - name: pauses
255
- - name: beanstalk.pause
256
- description: Pause
257
- unit: "seconds"
258
- chart_type: stacked
259
- dimensions:
260
- - name: since
261
- - name: left
49
+ There are 2 sections:
50
+
51
+ * Global variables
52
+ * One or more JOBS that can define multiple different instances to monitor.
53
+
54
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
55
+
56
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
+
58
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
+ folding:
60
+ title: "Config options"
61
+ enabled: true
62
+ list:
63
+ - name: update_every
64
+ description: Sets the default data collection frequency.
65
+ default_value: 5
66
+ required: false
67
+ - name: priority
68
+ description: Controls the order of charts at the netdata dashboard.
69
+ default_value: 60000
70
+ required: false
71
+ - name: autodetection_retry
72
+ description: Sets the job re-check interval in seconds.
73
+ default_value: 0
74
+ required: false
75
+ - name: penalty
76
+ description: Indicates whether to apply penalty to update_every in case of failures.
77
+ default_value: yes
78
+ required: false
79
+ - name: name
80
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
+ default_value: ""
82
+ required: false
83
+ - name: host
84
+ description: IP or URL to a beanstalk service.
85
+ default_value: "127.0.0.1"
86
+ required: false
87
+ - name: port
88
+ description: Port to the IP or URL to a beanstalk service.
89
+ default_value: "11300"
90
+ required: false
91
+ examples:
92
+ folding:
93
+ enabled: true
94
+ title: "Config"
95
+ list:
96
+ - name: Remote beanstalk server
97
+ description: A basic remote beanstalk server
98
+ folding:
99
+ enabled: false
100
+ config: |
101
+ remote:
102
+ name: 'beanstalk'
103
+ host: '1.2.3.4'
104
+ port: 11300
105
+ - name: Multi-instance
106
+ description: |
107
+ > **Note**: When you define multiple jobs, their names must be unique.
108
+
109
+ Collecting metrics from local and remote instances.
110
+ config: |
111
+ localhost:
112
+ name: 'local_beanstalk'
113
+ host: '127.0.0.1'
114
+ port: 11300
115
+
116
+ remote_job:
117
+ name: 'remote_beanstalk'
118
+ host: '192.0.2.1'
119
+ port: 113000
120
+ troubleshooting:
121
+ problems:
122
+ list: []
123
+ alerts:
124
+ - name: beanstalk_server_buried_jobs
125
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/beanstalkd.conf
126
+ metric: beanstalk.current_jobs
127
+ info: number of buried jobs across all tubes. You need to manually kick them so they can be processed. Presence of buried jobs in a tube does not affect new jobs.
128
+ metrics:
129
+ folding:
130
+ title: Metrics
131
+ enabled: false
132
+ description: ""
133
+ availability: []
134
+ scopes:
135
+ - name: global
136
+ description: "These metrics refer to the entire monitored application."
137
+ labels: []
138
+ metrics:
139
+ - name: beanstalk.cpu_usage
140
+ description: Cpu Usage
141
+ unit: "cpu time"
142
+ chart_type: area
143
+ dimensions:
144
+ - name: user
145
+ - name: system
146
+ - name: beanstalk.jobs_rate
147
+ description: Jobs Rate
148
+ unit: "jobs/s"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: total
152
+ - name: timeouts
153
+ - name: beanstalk.connections_rate
154
+ description: Connections Rate
155
+ unit: "connections/s"
156
+ chart_type: area
157
+ dimensions:
158
+ - name: connections
159
+ - name: beanstalk.commands_rate
160
+ description: Commands Rate
161
+ unit: "commands/s"
162
+ chart_type: stacked
163
+ dimensions:
164
+ - name: put
165
+ - name: peek
166
+ - name: peek-ready
167
+ - name: peek-delayed
168
+ - name: peek-buried
169
+ - name: reserve
170
+ - name: use
171
+ - name: watch
172
+ - name: ignore
173
+ - name: delete
174
+ - name: bury
175
+ - name: kick
176
+ - name: stats
177
+ - name: stats-job
178
+ - name: stats-tube
179
+ - name: list-tubes
180
+ - name: list-tube-used
181
+ - name: list-tubes-watched
182
+ - name: pause-tube
183
+ - name: beanstalk.connections_rate
184
+ description: Current Tubes
185
+ unit: "tubes"
186
+ chart_type: area
187
+ dimensions:
188
+ - name: tubes
189
+ - name: beanstalk.current_jobs
190
+ description: Current Jobs
191
+ unit: "jobs"
192
+ chart_type: stacked
193
+ dimensions:
194
+ - name: urgent
195
+ - name: ready
196
+ - name: reserved
197
+ - name: delayed
198
+ - name: buried
199
+ - name: beanstalk.current_connections
200
+ description: Current Connections
201
+ unit: "connections"
202
+ chart_type: line
203
+ dimensions:
204
+ - name: written
205
+ - name: producers
206
+ - name: workers
207
+ - name: waiting
208
+ - name: beanstalk.binlog
209
+ description: Binlog
210
+ unit: "records/s"
211
+ chart_type: line
212
+ dimensions:
213
+ - name: written
214
+ - name: migrated
215
+ - name: beanstalk.uptime
216
+ description: seconds
217
+ unit: "seconds"
218
+ chart_type: line
219
+ dimensions:
220
+ - name: uptime
221
+ - name: tube
222
+ description: "Metrics related to Beanstalk tubes. Each tube produces its own set of the following metrics."
223
+ labels: []
224
+ metrics:
225
+ - name: beanstalk.jobs_rate
226
+ description: Jobs Rate
227
+ unit: "jobs/s"
228
+ chart_type: area
229
+ dimensions:
230
+ - name: jobs
231
+ - name: beanstalk.jobs
232
+ description: Jobs
233
+ unit: "jobs"
234
+ chart_type: stacked
235
+ dimensions:
236
+ - name: urgent
237
+ - name: ready
238
+ - name: reserved
239
+ - name: delayed
240
+ - name: buried
241
+ - name: beanstalk.connections
242
+ description: Connections
243
+ unit: "connections"
244
+ chart_type: stacked
245
+ dimensions:
246
+ - name: using
247
+ - name: waiting
248
+ - name: watching
249
+ - name: beanstalk.commands
250
+ description: Commands
251
+ unit: "commands/s"
252
+ chart_type: stacked
253
+ dimensions:
254
+ - name: deletes
255
+ - name: pauses
256
+ - name: beanstalk.pause
257
+ description: Pause
258
+ unit: "seconds"
259
+ chart_type: stacked
260
+ dimensions:
261
+ - name: since
262
+ - name: left
collectors/python.d.plugin/bind_rndc/metadata.yaml
+188
-187
@@ -1,190 +1,191 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: bind_rndc
5
- monitored_instance:
6
- name: ISCBind (RNDC)
7
- link: "https://www.isc.org/bind/"
8
- categories:
9
- - data-collection.dns-and-dhcp-servers
10
- icon_filename: "isc.png"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - dns
18
- - bind
19
- - server
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "Monitor ISCBind (RNDC) performance for optimal DNS server operations. Monitor query rates, response times, and error rates to ensure reliable DNS service delivery."
24
- method_description: "This collector uses the `rndc` tool to dump (named.stats) statistics then read them to gather Bind Name Server summary performance metrics."
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: false
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: "If no configuration is given, the collector will attempt to read named.stats file at `/var/log/bind/named.stats`"
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: "Minimum bind version and permissions"
42
- description: "Version of bind must be >=9.6 and the Netdata user must have permissions to run `rndc stats`"
43
- - title: "Setup log rotate for bind stats"
44
- description: |
45
- BIND appends logs at EVERY RUN. It is NOT RECOMMENDED to set `update_every` below 30 sec.
46
- It is STRONGLY RECOMMENDED to create a `bind-rndc.conf` file for logrotate.
47
-
48
- To set up BIND to dump stats do the following:
49
-
50
- 1. Add to 'named.conf.options' options {}:
51
- `statistics-file "/var/log/bind/named.stats";`
52
-
53
- 2. Create bind/ directory in /var/log:
54
- `cd /var/log/ && mkdir bind`
55
-
56
- 3. Change owner of directory to 'bind' user:
57
- `chown bind bind/`
58
-
59
- 4. RELOAD (NOT restart) BIND:
60
- `systemctl reload bind9.service`
61
-
62
- 5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
63
-
64
- To allow Netdata to run 'rndc stats' change '/etc/bind/rndc.key' group to netdata:
65
- `chown :netdata rndc.key`
66
-
67
- Last, BUT NOT least, is to create bind-rndc.conf in logrotate.d/:
68
- ```
69
- /var/log/bind/named.stats {
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: bind_rndc
6
+ monitored_instance:
7
+ name: ISCBind (RNDC)
8
+ link: "https://www.isc.org/bind/"
9
+ categories:
10
+ - data-collection.dns-and-dhcp-servers
11
+ icon_filename: "isc.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - dns
19
+ - bind
20
+ - server
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "Monitor ISCBind (RNDC) performance for optimal DNS server operations. Monitor query rates, response times, and error rates to ensure reliable DNS service delivery."
25
+ method_description: "This collector uses the `rndc` tool to dump (named.stats) statistics then read them to gather Bind Name Server summary performance metrics."
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: false
30
+ additional_permissions:
31
+ description: ""
32
+ default_behavior:
33
+ auto_detection:
34
+ description: "If no configuration is given, the collector will attempt to read named.stats file at `/var/log/bind/named.stats`"
35
+ limits:
36
+ description: ""
37
+ performance_impact:
38
+ description: ""
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: "Minimum bind version and permissions"
43
+ description: "Version of bind must be >=9.6 and the Netdata user must have permissions to run `rndc stats`"
44
+ - title: "Setup log rotate for bind stats"
45
+ description: |
46
+ BIND appends logs at EVERY RUN. It is NOT RECOMMENDED to set `update_every` below 30 sec.
47
+ It is STRONGLY RECOMMENDED to create a `bind-rndc.conf` file for logrotate.
48
+
49
+ To set up BIND to dump stats do the following:
50
+
51
+ 1. Add to 'named.conf.options' options {}:
52
+ `statistics-file "/var/log/bind/named.stats";`
53
+
54
+ 2. Create bind/ directory in /var/log:
55
+ `cd /var/log/ && mkdir bind`
56
+
57
+ 3. Change owner of directory to 'bind' user:
58
+ `chown bind bind/`
59
+
60
+ 4. RELOAD (NOT restart) BIND:
61
+ `systemctl reload bind9.service`
62
+
63
+ 5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
64
+
65
+ To allow Netdata to run 'rndc stats' change '/etc/bind/rndc.key' group to netdata:
66
+ `chown :netdata rndc.key`
67
+
68
+ Last, BUT NOT least, is to create bind-rndc.conf in logrotate.d/:
69
+ ```
70
+ /var/log/bind/named.stats {
71
+
72
+ daily
73
+ rotate 4
74
+ compress
75
+ delaycompress
76
+ create 0644 bind bind
77
+ missingok
78
+ postrotate
79
+ rndc reload > /dev/null
80
+ endscript
81
+ }
82
+ ```
83
+ To test your logrotate conf file run as root:
84
+ `logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)`
85
+ configuration:
86
+ file:
87
+ name: python.d/bind_rndc.conf
88
+ options:
89
+ description: |
90
+ There are 2 sections:
91
71
- daily
72
- rotate 4
73
- compress
74
- delaycompress
75
- create 0644 bind bind
76
- missingok
77
- postrotate
78
- rndc reload > /dev/null
79
- endscript
80
- }
81
- ```
82
- To test your logrotate conf file run as root:
83
- `logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)`
84
- configuration:
85
- file:
86
- name: python.d/bind_rndc.conf
87
- options:
88
- description: |
89
- There are 2 sections:
90
-
91
- * Global variables
92
- * One or more JOBS that can define multiple different instances to monitor.
93
-
94
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
95
-
96
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
97
-
98
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
99
- folding:
100
- title: "Config options"
101
- enabled: true
102
- list:
103
- - name: update_every
104
- description: Sets the default data collection frequency.
105
- default_value: 5
106
- required: false
107
- - name: priority
108
- description: Controls the order of charts at the netdata dashboard.
109
- default_value: 60000
110
- required: false
111
- - name: autodetection_retry
112
- description: Sets the job re-check interval in seconds.
113
- default_value: 0
114
- required: false
115
- - name: penalty
116
- description: Indicates whether to apply penalty to update_every in case of failures.
117
- default_value: yes
118
- required: false
119
- - name: name
120
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
121
- default_value: ""
122
- required: false
123
- - name: named_stats_path
124
- description: Path to the named stats, after being dumped by `nrdc`
125
- default_value: "/var/log/bind/named.stats"
126
- required: false
127
- examples:
92
+ * Global variables
93
+ * One or more JOBS that can define multiple different instances to monitor.
94
+
95
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
96
+
97
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
98
+
99
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
100
+ folding:
101
+ title: "Config options"
102
+ enabled: true
103
+ list:
104
+ - name: update_every
105
+ description: Sets the default data collection frequency.
106
+ default_value: 5
107
+ required: false
108
+ - name: priority
109
+ description: Controls the order of charts at the netdata dashboard.
110
+ default_value: 60000
111
+ required: false
112
+ - name: autodetection_retry
113
+ description: Sets the job re-check interval in seconds.
114
+ default_value: 0
115
+ required: false
116
+ - name: penalty
117
+ description: Indicates whether to apply penalty to update_every in case of failures.
118
+ default_value: yes
119
+ required: false
120
+ - name: name
121
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
122
+ default_value: ""
123
+ required: false
124
+ - name: named_stats_path
125
+ description: Path to the named stats, after being dumped by `nrdc`
126
+ default_value: "/var/log/bind/named.stats"
127
+ required: false
128
+ examples:
129
+ folding:
130
+ enabled: false
131
+ title: "Config"
132
+ list:
133
+ - name: Local bind stats
134
+ description: Define a local path to bind stats file
135
+ config: |
136
+ local:
137
+ named_stats_path: '/var/log/bind/named.stats'
138
+ troubleshooting:
139
+ problems:
140
+ list: []
141
+ alerts:
142
+ - name: bind_rndc_stats_file_size
143
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf
144
+ metric: bind_rndc.stats_size
145
+ info: BIND statistics-file size
146
+ metrics:
147
folding:
148
+ title: Metrics
149
enabled: false
130
- title: "Config"
131
- list:
132
- - name: Local bind stats
133
- description: Define a local path to bind stats file
134
- config: |
135
- local:
136
- named_stats_path: '/var/log/bind/named.stats'
137
-troubleshooting:
138
- problems:
139
- list: []
140
-alerts:
141
- - name: bind_rndc_stats_file_size
142
- link: https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf
143
- metric: bind_rndc.stats_size
144
- info: BIND statistics-file size
145
-metrics:
146
- folding:
147
- title: Metrics
148
- enabled: false
149
- description: ""
150
- availability: []
151
- scopes:
152
- - name: global
153
- description: "These metrics refer to the entire monitored application."
154
- labels: []
155
- metrics:
156
- - name: bind_rndc.name_server_statistics
157
- description: Name Server Statistics
158
- unit: "stats"
159
- chart_type: line
160
- dimensions:
161
- - name: requests
162
- - name: rejected_queries
163
- - name: success
164
- - name: failure
165
- - name: responses
166
- - name: duplicate
167
- - name: recursion
168
- - name: nxrrset
169
- - name: nxdomain
170
- - name: non_auth_answer
171
- - name: auth_answer
172
- - name: dropped_queries
173
- - name: bind_rndc.incoming_queries
174
- description: Incoming queries
175
- unit: "queries"
176
- chart_type: line
177
- dimensions:
178
- - name: a dimension per incoming query type
179
- - name: bind_rndc.outgoing_queries
180
- description: Outgoing queries
181
- unit: "queries"
182
- chart_type: line
183
- dimensions:
184
- - name: a dimension per outgoing query type
185
- - name: bind_rndc.stats_size
186
- description: Named Stats File Size
187
- unit: "MiB"
188
- chart_type: line
189
- dimensions:
190
- - name: stats_size
150
+ description: ""
151
+ availability: []
152
+ scopes:
153
+ - name: global
154
+ description: "These metrics refer to the entire monitored application."
155
+ labels: []
156
+ metrics:
157
+ - name: bind_rndc.name_server_statistics
158
+ description: Name Server Statistics
159
+ unit: "stats"
160
+ chart_type: line
161
+ dimensions:
162
+ - name: requests
163
+ - name: rejected_queries
164
+ - name: success
165
+ - name: failure
166
+ - name: responses
167
+ - name: duplicate
168
+ - name: recursion
169
+ - name: nxrrset
170
+ - name: nxdomain
171
+ - name: non_auth_answer
172
+ - name: auth_answer
173
+ - name: dropped_queries
174
+ - name: bind_rndc.incoming_queries
175
+ description: Incoming queries
176
+ unit: "queries"
177
+ chart_type: line
178
+ dimensions:
179
+ - name: a dimension per incoming query type
180
+ - name: bind_rndc.outgoing_queries
181
+ description: Outgoing queries
182
+ unit: "queries"
183
+ chart_type: line
184
+ dimensions:
185
+ - name: a dimension per outgoing query type
186
+ - name: bind_rndc.stats_size
187
+ description: Named Stats File Size
188
+ unit: "MiB"
189
+ chart_type: line
190
+ dimensions:
191
+ - name: stats_size
collectors/python.d.plugin/boinc/metadata.yaml
+197
-196
@@ -1,197 +1,198 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: boinc
5
- monitored_instance:
6
- name: BOINC
7
- link: "https://boinc.berkeley.edu/"
8
- categories:
9
- - data-collection.distributed-computing-systems
10
- icon_filename: "bolt.svg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - boinc
18
- - distributed
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: "This collector monitors task counts for the Berkeley Open Infrastructure Networking Computing (BOINC) distributed computing client."
23
- method_description: "It uses the same RPC interface that the BOINC monitoring GUI does."
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ""
30
- default_behavior:
31
- auto_detection:
32
- description: "By default, the module will try to auto-detect the password to the RPC interface by looking in `/var/lib/boinc` for this file (this is the location most Linux distributions use for a system-wide BOINC installation), so things may just work without needing configuration for a local system."
33
- limits:
34
- description: ""
35
- performance_impact:
36
- description: ""
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: "Boinc RPC interface"
41
- description: BOINC requires use of a password to access it's RPC interface. You can find this password in the `gui_rpc_auth.cfg` file in your BOINC directory.
42
- configuration:
43
- file:
44
- name: python.d/boinc.conf
45
- options:
46
- description: |
47
- There are 2 sections:
48
-
49
- * Global variables
50
- * One or more JOBS that can define multiple different instances to monitor.
51
-
52
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
53
-
54
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
-
56
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
- folding:
58
- title: "Config options"
59
- enabled: true
60
- list:
61
- - name: update_every
62
- description: Sets the default data collection frequency.
63
- default_value: 5
64
- required: false
65
- - name: priority
66
- description: Controls the order of charts at the netdata dashboard.
67
- default_value: 60000
68
- required: false
69
- - name: autodetection_retry
70
- description: Sets the job re-check interval in seconds.
71
- default_value: 0
72
- required: false
73
- - name: penalty
74
- description: Indicates whether to apply penalty to update_every in case of failures.
75
- default_value: yes
76
- required: false
77
- - name: name
78
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
- default_value: ""
80
- required: false
81
- - name: hostname
82
- description: Define a hostname where boinc is running.
83
- default_value: "localhost"
84
- required: false
85
- - name: port
86
- description: The port of boinc RPC interface.
87
- default_value: ""
88
- required: false
89
- - name: password
90
- description: Provide a password to connect to a boinc RPC interface.
91
- default_value: ""
92
- required: false
93
- examples:
94
- folding:
95
- enabled: true
96
- title: "Config"
97
- list:
98
- - name: Configuration of a remote boinc instance
99
- description: A basic JOB configuration for a remote boinc instance
100
- folding:
101
- enabled: false
102
- config: |
103
- remote:
104
- hostname: '1.2.3.4'
105
- port: 1234
106
- password: 'some-password'
107
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: boinc
6
+ monitored_instance:
7
+ name: BOINC
8
+ link: "https://boinc.berkeley.edu/"
9
+ categories:
10
+ - data-collection.distributed-computing-systems
11
+ icon_filename: "bolt.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - boinc
19
+ - distributed
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: "This collector monitors task counts for the Berkeley Open Infrastructure Networking Computing (BOINC) distributed computing client."
24
+ method_description: "It uses the same RPC interface that the BOINC monitoring GUI does."
25
+ supported_platforms:
26
+ include: []
27
+ exclude: []
28
+ multi_instance: true
29
+ additional_permissions:
30
+ description: ""
31
+ default_behavior:
32
+ auto_detection:
33
+ description: "By default, the module will try to auto-detect the password to the RPC interface by looking in `/var/lib/boinc` for this file (this is the location most Linux distributions use for a system-wide BOINC installation), so things may just work without needing configuration for a local system."
34
+ limits:
35
+ description: ""
36
+ performance_impact:
37
+ description: ""
38
+ setup:
39
+ prerequisites:
40
+ list:
41
+ - title: "Boinc RPC interface"
42
+ description: BOINC requires use of a password to access it's RPC interface. You can find this password in the `gui_rpc_auth.cfg` file in your BOINC directory.
43
+ configuration:
44
+ file:
45
+ name: python.d/boinc.conf
46
+ options:
47
description: |
109
- > **Note**: When you define multiple jobs, their names must be unique.
110
-
111
- Collecting metrics from local and remote instances.
112
- config: |
113
- localhost:
114
- name: 'local'
115
- host: '127.0.0.1'
116
- port: 1234
117
- password: 'some-password'
118
-
119
- remote_job:
120
- name: 'remote'
121
- host: '192.0.2.1'
122
- port: 1234
123
- password: some-other-password
124
-troubleshooting:
125
- problems:
126
- list: []
127
-alerts:
128
- - name: boinc_total_tasks
129
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
130
- metric: boinc.tasks
131
- info: average number of total tasks over the last 10 minutes
132
- os: "*"
133
- - name: boinc_active_tasks
134
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
135
- metric: boinc.tasks
136
- info: average number of active tasks over the last 10 minutes
137
- os: "*"
138
- - name: boinc_compute_errors
139
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
140
- metric: boinc.states
141
- info: average number of compute errors over the last 10 minutes
142
- os: "*"
143
- - name: boinc_upload_errors
144
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
145
- metric: boinc.states
146
- info: average number of failed uploads over the last 10 minutes
147
- os: "*"
148
-metrics:
149
- folding:
150
- title: Metrics
151
- enabled: false
152
- description: ""
153
- availability: []
154
- scopes:
155
- - name: global
156
- description: "These metrics refer to the entire monitored application."
157
- labels: []
158
- metrics:
159
- - name: boinc.tasks
160
- description: Overall Tasks
161
- unit: "tasks"
162
- chart_type: line
163
- dimensions:
164
- - name: Total
165
- - name: Active
166
- - name: boinc.states
167
- description: Tasks per State
168
- unit: "tasks"
169
- chart_type: line
170
- dimensions:
171
- - name: New
172
- - name: Downloading
173
- - name: Ready to Run
174
- - name: Compute Errors
175
- - name: Uploading
176
- - name: Uploaded
177
- - name: Aborted
178
- - name: Failed Uploads
179
- - name: boinc.sched
180
- description: Tasks per Scheduler State
181
- unit: "tasks"
182
- chart_type: line
183
- dimensions:
184
- - name: Uninitialized
185
- - name: Preempted
186
- - name: Scheduled
187
- - name: boinc.process
188
- description: Tasks per Process State
189
- unit: "tasks"
190
- chart_type: line
191
- dimensions:
192
- - name: Uninitialized
193
- - name: Executing
194
- - name: Suspended
195
- - name: Aborted
196
- - name: Quit
197
- - name: Copy Pending
48
+ There are 2 sections:
49
+
50
+ * Global variables
51
+ * One or more JOBS that can define multiple different instances to monitor.
52
+
53
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
54
+
55
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
+
57
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
+ folding:
59
+ title: "Config options"
60
+ enabled: true
61
+ list:
62
+ - name: update_every
63
+ description: Sets the default data collection frequency.
64
+ default_value: 5
65
+ required: false
66
+ - name: priority
67
+ description: Controls the order of charts at the netdata dashboard.
68
+ default_value: 60000
69
+ required: false
70
+ - name: autodetection_retry
71
+ description: Sets the job re-check interval in seconds.
72
+ default_value: 0
73
+ required: false
74
+ - name: penalty
75
+ description: Indicates whether to apply penalty to update_every in case of failures.
76
+ default_value: yes
77
+ required: false
78
+ - name: name
79
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
80
+ default_value: ""
81
+ required: false
82
+ - name: hostname
83
+ description: Define a hostname where boinc is running.
84
+ default_value: "localhost"
85
+ required: false
86
+ - name: port
87
+ description: The port of boinc RPC interface.
88
+ default_value: ""
89
+ required: false
90
+ - name: password
91
+ description: Provide a password to connect to a boinc RPC interface.
92
+ default_value: ""
93
+ required: false
94
+ examples:
95
+ folding:
96
+ enabled: true
97
+ title: "Config"
98
+ list:
99
+ - name: Configuration of a remote boinc instance
100
+ description: A basic JOB configuration for a remote boinc instance
101
+ folding:
102
+ enabled: false
103
+ config: |
104
+ remote:
105
+ hostname: '1.2.3.4'
106
+ port: 1234
107
+ password: 'some-password'
108
+ - name: Multi-instance
109
+ description: |
110
+ > **Note**: When you define multiple jobs, their names must be unique.
111
+
112
+ Collecting metrics from local and remote instances.
113
+ config: |
114
+ localhost:
115
+ name: 'local'
116
+ host: '127.0.0.1'
117
+ port: 1234
118
+ password: 'some-password'
119
+
120
+ remote_job:
121
+ name: 'remote'
122
+ host: '192.0.2.1'
123
+ port: 1234
124
+ password: some-other-password
125
+ troubleshooting:
126
+ problems:
127
+ list: []
128
+ alerts:
129
+ - name: boinc_total_tasks
130
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
131
+ metric: boinc.tasks
132
+ info: average number of total tasks over the last 10 minutes
133
+ os: "*"
134
+ - name: boinc_active_tasks
135
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
136
+ metric: boinc.tasks
137
+ info: average number of active tasks over the last 10 minutes
138
+ os: "*"
139
+ - name: boinc_compute_errors
140
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
141
+ metric: boinc.states
142
+ info: average number of compute errors over the last 10 minutes
143
+ os: "*"
144
+ - name: boinc_upload_errors
145
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
146
+ metric: boinc.states
147
+ info: average number of failed uploads over the last 10 minutes
148
+ os: "*"
149
+ metrics:
150
+ folding:
151
+ title: Metrics
152
+ enabled: false
153
+ description: ""
154
+ availability: []
155
+ scopes:
156
+ - name: global
157
+ description: "These metrics refer to the entire monitored application."
158
+ labels: []
159
+ metrics:
160
+ - name: boinc.tasks
161
+ description: Overall Tasks
162
+ unit: "tasks"
163
+ chart_type: line
164
+ dimensions:
165
+ - name: Total
166
+ - name: Active
167
+ - name: boinc.states
168
+ description: Tasks per State
169
+ unit: "tasks"
170
+ chart_type: line
171
+ dimensions:
172
+ - name: New
173
+ - name: Downloading
174
+ - name: Ready to Run
175
+ - name: Compute Errors
176
+ - name: Uploading
177
+ - name: Uploaded
178
+ - name: Aborted
179
+ - name: Failed Uploads
180
+ - name: boinc.sched
181
+ description: Tasks per Scheduler State
182
+ unit: "tasks"
183
+ chart_type: line
184
+ dimensions:
185
+ - name: Uninitialized
186
+ - name: Preempted
187
+ - name: Scheduled
188
+ - name: boinc.process
189
+ description: Tasks per Process State
190
+ unit: "tasks"
191
+ chart_type: line
192
+ dimensions:
193
+ - name: Uninitialized
194
+ - name: Executing
195
+ - name: Suspended
196
+ - name: Aborted
197
+ - name: Quit
198
+ - name: Copy Pending
collectors/python.d.plugin/ceph/metadata.yaml
+221
-219
@@ -1,221 +1,223 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: ceph
4
- monitored_instance:
5
- name: Ceph
6
- link: 'https://ceph.io/'
7
- categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: 'ceph.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - ceph
17
- - storage
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: 'This collector monitors Ceph metrics about Cluster statistics, OSD usage, latency and Pool statistics.'
22
- method_description: 'Uses the `rados` python module to connect to a Ceph cluster.'
23
- supported_platforms:
24
- include: []
25
- exclude: []
26
- multi_instance: true
27
- additional_permissions:
28
- description: ''
29
- default_behavior:
30
- auto_detection:
31
- description: ''
32
- limits:
33
- description: ''
34
- performance_impact:
35
- description: ''
36
-setup:
37
- prerequisites:
38
- list:
39
- - title: '`rados` python module'
40
- description: 'Make sure the `rados` python module is installed'
41
- - title: 'Granting read permissions to ceph group from keyring file'
42
- description: 'Execute: `chmod 640 /etc/ceph/ceph.client.admin.keyring`'
43
- - title: 'Create a specific rados_id'
44
- description: 'You can optionally create a rados_id to use instead of admin'
45
- configuration:
46
- file:
47
- name: python.d/ceph.conf
48
- options:
49
- description: |
50
- There are 2 sections:
51
-
52
- * Global variables
53
- * One or more JOBS that can define multiple different instances to monitor.
54
-
55
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
-
57
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
-
59
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
- folding:
61
- title: "Config options"
62
- enabled: true
63
- list:
64
- - name: update_every
65
- description: Sets the default data collection frequency.
66
- default_value: 5
67
- required: false
68
- - name: priority
69
- description: Controls the order of charts at the netdata dashboard.
70
- default_value: 60000
71
- required: false
72
- - name: autodetection_retry
73
- description: Sets the job re-check interval in seconds.
74
- default_value: 0
75
- required: false
76
- - name: penalty
77
- description: Indicates whether to apply penalty to update_every in case of failures.
78
- default_value: yes
79
- required: false
80
- - name: name
81
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
82
- default_value: ''
83
- required: false
84
- - name: config_file
85
- description: Ceph config file
86
- default_value: ''
87
- required: true
88
- - name: keyring_file
89
- description: Ceph keyring file. netdata user must be added into ceph group and keyring file must be read group permission.
90
- default_value: ''
91
- required: true
92
- - name: rados_id
93
- description: A rados user id to use for connecting to the Ceph cluster.
94
- default_value: 'admin'
95
- required: false
96
- examples:
97
- folding:
98
- enabled: true
99
- title: "Config"
100
- list:
101
- - name: Basic local Ceph cluster
102
- description: A basic configuration to connect to a local Ceph cluster.
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: ceph
6
+ monitored_instance:
7
+ name: Ceph
8
+ link: 'https://ceph.io/'
9
+ categories:
10
+ - data-collection.storage-mount-points-and-filesystems
11
+ icon_filename: 'ceph.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - ceph
19
+ - storage
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: 'This collector monitors Ceph metrics about Cluster statistics, OSD usage, latency and Pool statistics.'
24
+ method_description: 'Uses the `rados` python module to connect to a Ceph cluster.'
25
+ supported_platforms:
26
+ include: []
27
+ exclude: []
28
+ multi_instance: true
29
+ additional_permissions:
30
+ description: ''
31
+ default_behavior:
32
+ auto_detection:
33
+ description: ''
34
+ limits:
35
+ description: ''
36
+ performance_impact:
37
+ description: ''
38
+ setup:
39
+ prerequisites:
40
+ list:
41
+ - title: '`rados` python module'
42
+ description: 'Make sure the `rados` python module is installed'
43
+ - title: 'Granting read permissions to ceph group from keyring file'
44
+ description: 'Execute: `chmod 640 /etc/ceph/ceph.client.admin.keyring`'
45
+ - title: 'Create a specific rados_id'
46
+ description: 'You can optionally create a rados_id to use instead of admin'
47
+ configuration:
48
+ file:
49
+ name: python.d/ceph.conf
50
+ options:
51
+ description: |
52
+ There are 2 sections:
53
+
54
+ * Global variables
55
+ * One or more JOBS that can define multiple different instances to monitor.
56
+
57
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
58
+
59
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
60
+
61
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
62
folding:
104
- enabled: false
105
- config: |
106
- local:
107
- config_file: '/etc/ceph/ceph.conf'
108
- keyring_file: '/etc/ceph/ceph.client.admin.keyring'
109
-troubleshooting:
110
- problems:
111
- list: []
112
-alerts:
113
-- name: ceph_cluster_space_usage
114
- link: https://github.com/netdata/netdata/blob/master/health/health.d/ceph.conf
115
- metric: ceph.general_usage
116
- info: cluster disk space utilization
117
-metrics:
118
- folding:
119
- title: Metrics
120
- enabled: false
121
- description: ""
122
- availability: []
123
- scopes:
124
- - name: global
125
- description: "These metrics refer to the entire monitored application."
126
- labels: []
63
+ title: "Config options"
64
+ enabled: true
65
+ list:
66
+ - name: update_every
67
+ description: Sets the default data collection frequency.
68
+ default_value: 5
69
+ required: false
70
+ - name: priority
71
+ description: Controls the order of charts at the netdata dashboard.
72
+ default_value: 60000
73
+ required: false
74
+ - name: autodetection_retry
75
+ description: Sets the job re-check interval in seconds.
76
+ default_value: 0
77
+ required: false
78
+ - name: penalty
79
+ description: Indicates whether to apply penalty to update_every in case of failures.
80
+ default_value: yes
81
+ required: false
82
+ - name: name
83
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
84
+ default_value: ''
85
+ required: false
86
+ - name: config_file
87
+ description: Ceph config file
88
+ default_value: ''
89
+ required: true
90
+ - name: keyring_file
91
+ description: Ceph keyring file. netdata user must be added into ceph group and keyring file must be read group permission.
92
+ default_value: ''
93
+ required: true
94
+ - name: rados_id
95
+ description: A rados user id to use for connecting to the Ceph cluster.
96
+ default_value: 'admin'
97
+ required: false
98
+ examples:
99
+ folding:
100
+ enabled: true
101
+ title: "Config"
102
+ list:
103
+ - name: Basic local Ceph cluster
104
+ description: A basic configuration to connect to a local Ceph cluster.
105
+ folding:
106
+ enabled: false
107
+ config: |
108
+ local:
109
+ config_file: '/etc/ceph/ceph.conf'
110
+ keyring_file: '/etc/ceph/ceph.client.admin.keyring'
111
+ troubleshooting:
112
+ problems:
113
+ list: []
114
+ alerts:
115
+ - name: ceph_cluster_space_usage
116
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/ceph.conf
117
+ metric: ceph.general_usage
118
+ info: cluster disk space utilization
119
metrics:
128
- - name: ceph.general_usage
129
- description: Ceph General Space
130
- unit: "KiB"
131
- chart_type: stacked
132
- dimensions:
133
- - name: avail
134
- - name: used
135
- - name: ceph.general_objects
136
- description: Ceph General Objects
137
- unit: "objects"
138
- chart_type: area
139
- dimensions:
140
- - name: cluster
141
- - name: ceph.general_bytes
142
- description: Ceph General Read/Write Data/s
143
- unit: "KiB/s"
144
- chart_type: area
145
- dimensions:
146
- - name: read
147
- - name: write
148
- - name: ceph.general_operations
149
- description: Ceph General Read/Write Operations/s
150
- unit: "operations"
151
- chart_type: area
152
- dimensions:
153
- - name: read
154
- - name: write
155
- - name: ceph.general_latency
156
- description: Ceph General Apply/Commit latency
157
- unit: "milliseconds"
158
- chart_type: area
159
- dimensions:
160
- - name: apply
161
- - name: commit
162
- - name: ceph.pool_usage
163
- description: Ceph Pools
164
- unit: "KiB"
165
- chart_type: line
166
- dimensions:
167
- - name: a dimension per Ceph Pool
168
- - name: ceph.pool_objects
169
- description: Ceph Pools
170
- unit: "objects"
171
- chart_type: line
172
- dimensions:
173
- - name: a dimension per Ceph Pool
174
- - name: ceph.pool_read_bytes
175
- description: Ceph Read Pool Data/s
176
- unit: "KiB/s"
177
- chart_type: area
178
- dimensions:
179
- - name: a dimension per Ceph Pool
180
- - name: ceph.pool_write_bytes
181
- description: Ceph Write Pool Data/s
182
- unit: "KiB/s"
183
- chart_type: area
184
- dimensions:
185
- - name: a dimension per Ceph Pool
186
- - name: ceph.pool_read_operations
187
- description: Ceph Read Pool Operations/s
188
- unit: "operations"
189
- chart_type: area
190
- dimensions:
191
- - name: a dimension per Ceph Pool
192
- - name: ceph.pool_write_operations
193
- description: Ceph Write Pool Operations/s
194
- unit: "operations"
195
- chart_type: area
196
- dimensions:
197
- - name: a dimension per Ceph Pool
198
- - name: ceph.osd_usage
199
- description: Ceph OSDs
200
- unit: "KiB"
201
- chart_type: line
202
- dimensions:
203
- - name: a dimension per Ceph OSD
204
- - name: ceph.osd_size
205
- description: Ceph OSDs size
206
- unit: "KiB"
207
- chart_type: line
208
- dimensions:
209
- - name: a dimension per Ceph OSD
210
- - name: ceph.apply_latency
211
- description: Ceph OSDs apply latency
212
- unit: "milliseconds"
213
- chart_type: line
214
- dimensions:
215
- - name: a dimension per Ceph OSD
216
- - name: ceph.commit_latency
217
- description: Ceph OSDs commit latency
218
- unit: "milliseconds"
219
- chart_type: line
220
- dimensions:
221
- - name: a dimension per Ceph OSD
120
+ folding:
121
+ title: Metrics
122
+ enabled: false
123
+ description: ""
124
+ availability: []
125
+ scopes:
126
+ - name: global
127
+ description: "These metrics refer to the entire monitored application."
128
+ labels: []
129
+ metrics:
130
+ - name: ceph.general_usage
131
+ description: Ceph General Space
132
+ unit: "KiB"
133
+ chart_type: stacked
134
+ dimensions:
135
+ - name: avail
136
+ - name: used
137
+ - name: ceph.general_objects
138
+ description: Ceph General Objects
139
+ unit: "objects"
140
+ chart_type: area
141
+ dimensions:
142
+ - name: cluster
143
+ - name: ceph.general_bytes
144
+ description: Ceph General Read/Write Data/s
145
+ unit: "KiB/s"
146
+ chart_type: area
147
+ dimensions:
148
+ - name: read
149
+ - name: write
150
+ - name: ceph.general_operations
151
+ description: Ceph General Read/Write Operations/s
152
+ unit: "operations"
153
+ chart_type: area
154
+ dimensions:
155
+ - name: read
156
+ - name: write
157
+ - name: ceph.general_latency
158
+ description: Ceph General Apply/Commit latency
159
+ unit: "milliseconds"
160
+ chart_type: area
161
+ dimensions:
162
+ - name: apply
163
+ - name: commit
164
+ - name: ceph.pool_usage
165
+ description: Ceph Pools
166
+ unit: "KiB"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: a dimension per Ceph Pool
170
+ - name: ceph.pool_objects
171
+ description: Ceph Pools
172
+ unit: "objects"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: a dimension per Ceph Pool
176
+ - name: ceph.pool_read_bytes
177
+ description: Ceph Read Pool Data/s
178
+ unit: "KiB/s"
179
+ chart_type: area
180
+ dimensions:
181
+ - name: a dimension per Ceph Pool
182
+ - name: ceph.pool_write_bytes
183
+ description: Ceph Write Pool Data/s
184
+ unit: "KiB/s"
185
+ chart_type: area
186
+ dimensions:
187
+ - name: a dimension per Ceph Pool
188
+ - name: ceph.pool_read_operations
189
+ description: Ceph Read Pool Operations/s
190
+ unit: "operations"
191
+ chart_type: area
192
+ dimensions:
193
+ - name: a dimension per Ceph Pool
194
+ - name: ceph.pool_write_operations
195
+ description: Ceph Write Pool Operations/s
196
+ unit: "operations"
197
+ chart_type: area
198
+ dimensions:
199
+ - name: a dimension per Ceph Pool
200
+ - name: ceph.osd_usage
201
+ description: Ceph OSDs
202
+ unit: "KiB"
203
+ chart_type: line
204
+ dimensions:
205
+ - name: a dimension per Ceph OSD
206
+ - name: ceph.osd_size
207
+ description: Ceph OSDs size
208
+ unit: "KiB"
209
+ chart_type: line
210
+ dimensions:
211
+ - name: a dimension per Ceph OSD
212
+ - name: ceph.apply_latency
213
+ description: Ceph OSDs apply latency
214
+ unit: "milliseconds"
215
+ chart_type: line
216
+ dimensions:
217
+ - name: a dimension per Ceph OSD
218
+ - name: ceph.commit_latency
219
+ description: Ceph OSDs commit latency
220
+ unit: "milliseconds"
221
+ chart_type: line
222
+ dimensions:
223
+ - name: a dimension per Ceph OSD
collectors/python.d.plugin/changefinder/metadata.yaml
+78
-76
@@ -1,77 +1,79 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: changefinder
4
- monitored_instance:
5
- name: python.d changefinder
6
- link: ''
7
- categories: []
8
- icon_filename: ''
9
- related_resources:
10
- integrations:
11
- list: []
12
- info_provided_to_referring_integrations:
13
- description: ''
14
- keywords: []
15
- most_popular: false
16
-overview:
17
- data_collection:
18
- metrics_description: ''
19
- method_description: ''
20
- supported_platforms:
21
- include: []
22
- exclude: []
23
- multi_instance: true
24
- additional_permissions:
25
- description: ''
26
- default_behavior:
27
- auto_detection:
28
- description: ''
29
- limits:
30
- description: ''
31
- performance_impact:
32
- description: ''
33
-setup:
34
- prerequisites:
35
- list: []
36
- configuration:
37
- file:
38
- name: ''
39
- description: ''
40
- options:
41
- description: ''
42
- folding:
43
- title: ''
44
- enabled: true
45
- list: []
46
- examples:
47
- folding:
48
- enabled: true
49
- title: ''
50
- list: []
51
-troubleshooting:
52
- problems:
53
- list: []
54
-alerts: []
55
-metrics:
56
- folding:
57
- title: Metrics
58
- enabled: false
59
- description: ""
60
- availability: []
61
- scopes:
62
- - name: global
63
- description: ""
64
- labels: []
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: changefinder
6
+ monitored_instance:
7
+ name: python.d changefinder
8
+ link: ''
9
+ categories: []
10
+ icon_filename: ''
11
+ related_resources:
12
+ integrations:
13
+ list: []
14
+ info_provided_to_referring_integrations:
15
+ description: ''
16
+ keywords: []
17
+ most_popular: false
18
+ overview:
19
+ data_collection:
20
+ metrics_description: ''
21
+ method_description: ''
22
+ supported_platforms:
23
+ include: []
24
+ exclude: []
25
+ multi_instance: true
26
+ additional_permissions:
27
+ description: ''
28
+ default_behavior:
29
+ auto_detection:
30
+ description: ''
31
+ limits:
32
+ description: ''
33
+ performance_impact:
34
+ description: ''
35
+ setup:
36
+ prerequisites:
37
+ list: []
38
+ configuration:
39
+ file:
40
+ name: ''
41
+ description: ''
42
+ options:
43
+ description: ''
44
+ folding:
45
+ title: ''
46
+ enabled: true
47
+ list: []
48
+ examples:
49
+ folding:
50
+ enabled: true
51
+ title: ''
52
+ list: []
53
+ troubleshooting:
54
+ problems:
55
+ list: []
56
+ alerts: []
57
metrics:
66
- - name: changefinder.scores
67
- description: ChangeFinder
68
- unit: "score"
69
- chart_type: line
70
- dimensions:
71
- - name: a dimension per chart
72
- - name: changefinder.flags
73
- description: ChangeFinder
74
- unit: "flag"
75
- chart_type: stacked
76
- dimensions:
77
- - name: a dimension per chart
58
+ folding:
59
+ title: Metrics
60
+ enabled: false
61
+ description: ""
62
+ availability: []
63
+ scopes:
64
+ - name: global
65
+ description: ""
66
+ labels: []
67
+ metrics:
68
+ - name: changefinder.scores
69
+ description: ChangeFinder
70
+ unit: "score"
71
+ chart_type: line
72
+ dimensions:
73
+ - name: a dimension per chart
74
+ - name: changefinder.flags
75
+ description: ChangeFinder
76
+ unit: "flag"
77
+ chart_type: stacked
78
+ dimensions:
79
+ - name: a dimension per chart
collectors/python.d.plugin/dovecot/metadata.yaml
+206
-204
@@ -1,205 +1,207 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: dovecot
4
- monitored_instance:
5
- name: Dovecot
6
- link: 'https://www.dovecot.org/'
7
- categories:
8
- - data-collection.mail-servers
9
- icon_filename: 'dovecot.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - dovecot
17
- - imap
18
- - mail
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: 'This collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.'
23
- method_description: 'It uses the dovecot socket and executes the `EXPORT global` command to get the statistics.'
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ''
30
- default_behavior:
31
- auto_detection:
32
- description: 'If no configuration is given, the collector will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`'
33
- limits:
34
- description: ''
35
- performance_impact:
36
- description: ''
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: 'Dovecot configuration'
41
- description: The Dovecot UNIX socket should have R/W permissions for user netdata, or Dovecot should be configured with a TCP/IP socket.
42
- configuration:
43
- file:
44
- name: python.d/dovecot.conf
45
- options:
46
- description: |
47
- There are 2 sections:
48
-
49
- * Global variables
50
- * One or more JOBS that can define multiple different instances to monitor.
51
-
52
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
53
-
54
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
-
56
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
- folding:
58
- title: "Config options"
59
- enabled: true
60
- list:
61
- - name: update_every
62
- description: Sets the default data collection frequency.
63
- default_value: 5
64
- required: false
65
- - name: priority
66
- description: Controls the order of charts at the netdata dashboard.
67
- default_value: 60000
68
- required: false
69
- - name: autodetection_retry
70
- description: Sets the job re-check interval in seconds.
71
- default_value: 0
72
- required: false
73
- - name: penalty
74
- description: Indicates whether to apply penalty to update_every in case of failures.
75
- default_value: yes
76
- required: false
77
- - name: name
78
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
- default_value: ''
80
- required: false
81
- - name: socket
82
- description: Use this socket to communicate with Devcot
83
- default_value: /var/run/dovecot/stats
84
- required: false
85
- - name: host
86
- description: Instead of using a socket, you can point the collector to an ip for devcot statistics.
87
- default_value: ''
88
- required: false
89
- - name: port
90
- description: Used in combination with host, configures the port devcot listens to.
91
- default_value: ''
92
- required: false
93
- examples:
94
- folding:
95
- enabled: true
96
- title: "Config"
97
- list:
98
- - name: Local TCP
99
- description: A basic TCP configuration.
100
- config: |
101
- localtcpip:
102
- name: 'local'
103
- host: '127.0.0.1'
104
- port: 24242
105
- - name: Local socket
106
- description: A basic local socket configuration
107
- config: |
108
- localsocket:
109
- name: 'local'
110
- socket: '/var/run/dovecot/stats'
111
-troubleshooting:
112
- problems:
113
- list: []
114
-alerts: []
115
-metrics:
116
- folding:
117
- title: Metrics
118
- enabled: false
119
- description: ""
120
- availability: []
121
- scopes:
122
- - name: global
123
- description: "These metrics refer to the entire monitored application."
124
- labels: []
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: dovecot
6
+ monitored_instance:
7
+ name: Dovecot
8
+ link: 'https://www.dovecot.org/'
9
+ categories:
10
+ - data-collection.mail-servers
11
+ icon_filename: 'dovecot.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - dovecot
19
+ - imap
20
+ - mail
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: 'This collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.'
25
+ method_description: 'It uses the dovecot socket and executes the `EXPORT global` command to get the statistics.'
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: true
30
+ additional_permissions:
31
+ description: ''
32
+ default_behavior:
33
+ auto_detection:
34
+ description: 'If no configuration is given, the collector will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`'
35
+ limits:
36
+ description: ''
37
+ performance_impact:
38
+ description: ''
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: 'Dovecot configuration'
43
+ description: The Dovecot UNIX socket should have R/W permissions for user netdata, or Dovecot should be configured with a TCP/IP socket.
44
+ configuration:
45
+ file:
46
+ name: python.d/dovecot.conf
47
+ options:
48
+ description: |
49
+ There are 2 sections:
50
+
51
+ * Global variables
52
+ * One or more JOBS that can define multiple different instances to monitor.
53
+
54
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
55
+
56
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
+
58
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
+ folding:
60
+ title: "Config options"
61
+ enabled: true
62
+ list:
63
+ - name: update_every
64
+ description: Sets the default data collection frequency.
65
+ default_value: 5
66
+ required: false
67
+ - name: priority
68
+ description: Controls the order of charts at the netdata dashboard.
69
+ default_value: 60000
70
+ required: false
71
+ - name: autodetection_retry
72
+ description: Sets the job re-check interval in seconds.
73
+ default_value: 0
74
+ required: false
75
+ - name: penalty
76
+ description: Indicates whether to apply penalty to update_every in case of failures.
77
+ default_value: yes
78
+ required: false
79
+ - name: name
80
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
+ default_value: ''
82
+ required: false
83
+ - name: socket
84
+ description: Use this socket to communicate with Devcot
85
+ default_value: /var/run/dovecot/stats
86
+ required: false
87
+ - name: host
88
+ description: Instead of using a socket, you can point the collector to an ip for devcot statistics.
89
+ default_value: ''
90
+ required: false
91
+ - name: port
92
+ description: Used in combination with host, configures the port devcot listens to.
93
+ default_value: ''
94
+ required: false
95
+ examples:
96
+ folding:
97
+ enabled: true
98
+ title: "Config"
99
+ list:
100
+ - name: Local TCP
101
+ description: A basic TCP configuration.
102
+ config: |
103
+ localtcpip:
104
+ name: 'local'
105
+ host: '127.0.0.1'
106
+ port: 24242
107
+ - name: Local socket
108
+ description: A basic local socket configuration
109
+ config: |
110
+ localsocket:
111
+ name: 'local'
112
+ socket: '/var/run/dovecot/stats'
113
+ troubleshooting:
114
+ problems:
115
+ list: []
116
+ alerts: []
117
metrics:
126
- - name: dovecot.sessions
127
- description: Dovecot Active Sessions
128
- unit: "number"
129
- chart_type: line
130
- dimensions:
131
- - name: active sessions
132
- - name: dovecot.logins
133
- description: Dovecot Logins
134
- unit: "number"
135
- chart_type: line
136
- dimensions:
137
- - name: logins
138
- - name: dovecot.commands
139
- description: Dovecot Commands
140
- unit: "commands"
141
- chart_type: line
142
- dimensions:
143
- - name: commands
144
- - name: dovecot.faults
145
- description: Dovecot Page Faults
146
- unit: "faults"
147
- chart_type: line
148
- dimensions:
149
- - name: minor
150
- - name: major
151
- - name: dovecot.context_switches
152
- description: Dovecot Context Switches
153
- unit: "switches"
154
- chart_type: line
155
- dimensions:
156
- - name: voluntary
157
- - name: involuntary
158
- - name: dovecot.io
159
- description: Dovecot Disk I/O
160
- unit: "KiB/s"
161
- chart_type: area
162
- dimensions:
163
- - name: read
164
- - name: write
165
- - name: dovecot.net
166
- description: Dovecot Network Bandwidth
167
- unit: "kilobits/s"
168
- chart_type: area
169
- dimensions:
170
- - name: read
171
- - name: write
172
- - name: dovecot.syscalls
173
- description: Dovecot Number of SysCalls
174
- unit: "syscalls/s"
175
- chart_type: line
176
- dimensions:
177
- - name: read
178
- - name: write
179
- - name: dovecot.lookup
180
- description: Dovecot Lookups
181
- unit: "number/s"
182
- chart_type: stacked
183
- dimensions:
184
- - name: path
185
- - name: attr
186
- - name: dovecot.cache
187
- description: Dovecot Cache Hits
188
- unit: "hits/s"
189
- chart_type: line
190
- dimensions:
191
- - name: hits
192
- - name: dovecot.auth
193
- description: Dovecot Authentications
194
- unit: "attempts"
195
- chart_type: stacked
196
- dimensions:
197
- - name: ok
198
- - name: failed
199
- - name: dovecot.auth_cache
200
- description: Dovecot Authentication Cache
201
- unit: "number"
202
- chart_type: stacked
203
- dimensions:
204
- - name: hit
205
- - name: miss
118
+ folding:
119
+ title: Metrics
120
+ enabled: false
121
+ description: ""
122
+ availability: []
123
+ scopes:
124
+ - name: global
125
+ description: "These metrics refer to the entire monitored application."
126
+ labels: []
127
+ metrics:
128
+ - name: dovecot.sessions
129
+ description: Dovecot Active Sessions
130
+ unit: "number"
131
+ chart_type: line
132
+ dimensions:
133
+ - name: active sessions
134
+ - name: dovecot.logins
135
+ description: Dovecot Logins
136
+ unit: "number"
137
+ chart_type: line
138
+ dimensions:
139
+ - name: logins
140
+ - name: dovecot.commands
141
+ description: Dovecot Commands
142
+ unit: "commands"
143
+ chart_type: line
144
+ dimensions:
145
+ - name: commands
146
+ - name: dovecot.faults
147
+ description: Dovecot Page Faults
148
+ unit: "faults"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: minor
152
+ - name: major
153
+ - name: dovecot.context_switches
154
+ description: Dovecot Context Switches
155
+ unit: "switches"
156
+ chart_type: line
157
+ dimensions:
158
+ - name: voluntary
159
+ - name: involuntary
160
+ - name: dovecot.io
161
+ description: Dovecot Disk I/O
162
+ unit: "KiB/s"
163
+ chart_type: area
164
+ dimensions:
165
+ - name: read
166
+ - name: write
167
+ - name: dovecot.net
168
+ description: Dovecot Network Bandwidth
169
+ unit: "kilobits/s"
170
+ chart_type: area
171
+ dimensions:
172
+ - name: read
173
+ - name: write
174
+ - name: dovecot.syscalls
175
+ description: Dovecot Number of SysCalls
176
+ unit: "syscalls/s"
177
+ chart_type: line
178
+ dimensions:
179
+ - name: read
180
+ - name: write
181
+ - name: dovecot.lookup
182
+ description: Dovecot Lookups
183
+ unit: "number/s"
184
+ chart_type: stacked
185
+ dimensions:
186
+ - name: path
187
+ - name: attr
188
+ - name: dovecot.cache
189
+ description: Dovecot Cache Hits
190
+ unit: "hits/s"
191
+ chart_type: line
192
+ dimensions:
193
+ - name: hits
194
+ - name: dovecot.auth
195
+ description: Dovecot Authentications
196
+ unit: "attempts"
197
+ chart_type: stacked
198
+ dimensions:
199
+ - name: ok
200
+ - name: failed
201
+ - name: dovecot.auth_cache
202
+ description: Dovecot Authentication Cache
203
+ unit: "number"
204
+ chart_type: stacked
205
+ dimensions:
206
+ - name: hit
207
+ - name: miss
collectors/python.d.plugin/example/metadata.yaml
+137
-137
@@ -1,138 +1,138 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: example
6
- monitored_instance:
7
- name: python.d alarms
8
- link: https://learn.netdata.cloud/docs/data-collection/examples/example-module-in-python
9
- categories:
10
- - data-collection.other
11
- icon_filename: ""
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - example
19
- - netdata
20
- - python
21
- most_popular: false
22
-overview:
23
- data_collection:
24
- metrics_description: |
25
- Example collector that generates some random numbers as metrics.
26
-
27
- If you want to write your own collector, read our [writing a new Python module](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#how-to-write-a-new-module) tutorial.
28
- method_description: |
29
- The `get_data()` function uses `random.randint()` to generate a random number which will be collected as a metric.
30
- supported_platforms:
31
- include: []
32
- exclude: []
33
- multi_instance: true
34
- additional_permissions:
35
- description: ""
36
- default_behavior:
37
- auto_detection:
38
- description: ""
39
- limits:
40
- description: ""
41
- performance_impact:
42
- description: ""
43
-setup:
44
- prerequisites:
45
- list: []
46
- configuration:
47
- file:
48
- name: python.d/example.conf
49
- description: ""
50
- options:
51
- description: |
52
- There are 2 sections:
53
-
54
- * Global variables
55
- * One or more JOBS that can define multiple different instances to monitor.
56
-
57
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
58
-
59
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
60
-
61
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
62
- folding:
63
- title: Config options
64
- enabled: true
65
- list:
66
- - name: num_lines
67
- description: The number of lines to create.
68
- default_value: 4
69
- required: false
70
- - name: lower
71
- description: The lower bound of numbers to randomly sample from.
72
- default_value: 0
73
- required: false
74
- - name: upper
75
- description: The upper bound of numbers to randomly sample from.
76
- default_value: 100
77
- required: false
78
- - name: update_every
79
- description: Sets the default data collection frequency.
80
- default_value: 1
81
- required: false
82
- - name: priority
83
- description: Controls the order of charts at the netdata dashboard.
84
- default_value: 60000
85
- required: false
86
- - name: autodetection_retry
87
- description: Sets the job re-check interval in seconds.
88
- default_value: 0
89
- required: false
90
- - name: penalty
91
- description: Indicates whether to apply penalty to update_every in case of failures.
92
- default_value: yes
93
- required: false
94
- - name: name
95
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
96
- default_value: ""
97
- required: false
98
- examples:
99
- folding:
100
- enabled: true
101
- title: Config
102
- list:
103
- - name: Basic
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: example
6
+ monitored_instance:
7
+ name: python.d alarms
8
+ link: https://learn.netdata.cloud/docs/data-collection/examples/example-module-in-python
9
+ categories:
10
+ - data-collection.other
11
+ icon_filename: ""
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - example
19
+ - netdata
20
+ - python
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: |
25
+ Example collector that generates some random numbers as metrics.
26
+
27
+ If you want to write your own collector, read our [writing a new Python module](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#how-to-write-a-new-module) tutorial.
28
+ method_description: |
29
+ The `get_data()` function uses `random.randint()` to generate a random number which will be collected as a metric.
30
+ supported_platforms:
31
+ include: []
32
+ exclude: []
33
+ multi_instance: true
34
+ additional_permissions:
35
+ description: ""
36
+ default_behavior:
37
+ auto_detection:
38
+ description: ""
39
+ limits:
40
+ description: ""
41
+ performance_impact:
42
+ description: ""
43
+ setup:
44
+ prerequisites:
45
+ list: []
46
+ configuration:
47
+ file:
48
+ name: python.d/example.conf
49
+ description: ""
50
+ options:
51
+ description: |
52
+ There are 2 sections:
53
+
54
+ * Global variables
55
+ * One or more JOBS that can define multiple different instances to monitor.
56
+
57
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
58
+
59
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
60
+
61
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
62
+ folding:
63
+ title: Config options
64
+ enabled: true
65
+ list:
66
+ - name: num_lines
67
+ description: The number of lines to create.
68
+ default_value: 4
69
+ required: false
70
+ - name: lower
71
+ description: The lower bound of numbers to randomly sample from.
72
+ default_value: 0
73
+ required: false
74
+ - name: upper
75
+ description: The upper bound of numbers to randomly sample from.
76
+ default_value: 100
77
+ required: false
78
+ - name: update_every
79
+ description: Sets the default data collection frequency.
80
+ default_value: 1
81
+ required: false
82
+ - name: priority
83
+ description: Controls the order of charts at the netdata dashboard.
84
+ default_value: 60000
85
+ required: false
86
+ - name: autodetection_retry
87
+ description: Sets the job re-check interval in seconds.
88
+ default_value: 0
89
+ required: false
90
+ - name: penalty
91
+ description: Indicates whether to apply penalty to update_every in case of failures.
92
+ default_value: yes
93
+ required: false
94
+ - name: name
95
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
96
+ default_value: ""
97
+ required: false
98
+ examples:
99
folding:
105
- enabled: false
106
- description: A basic example configuration.
107
- config: |
108
- four_lines:
109
- name: "Four Lines"
110
- update_every: 1
111
- priority: 60000
112
- penalty: yes
113
- autodetection_retry: 0
114
- num_lines: 4
115
- lower: 0
116
- upper: 100
117
-troubleshooting:
118
- problems:
119
- list: []
120
-alerts: []
121
-metrics:
122
- folding:
123
- title: Metrics
124
- enabled: false
125
- description: ""
126
- availability: []
127
- scopes:
128
- - name: global
129
- description: |
130
- These metrics refer to the entire monitored application.
131
- labels: []
132
- metrics:
133
- - name: example.random
134
- description: A random number
135
- unit: number
136
- chart_type: line
137
- dimensions:
138
- - name: random
100
+ enabled: true
101
+ title: Config
102
+ list:
103
+ - name: Basic
104
+ folding:
105
+ enabled: false
106
+ description: A basic example configuration.
107
+ config: |
108
+ four_lines:
109
+ name: "Four Lines"
110
+ update_every: 1
111
+ priority: 60000
112
+ penalty: yes
113
+ autodetection_retry: 0
114
+ num_lines: 4
115
+ lower: 0
116
+ upper: 100
117
+ troubleshooting:
118
+ problems:
119
+ list: []
120
+ alerts: []
121
+ metrics:
122
+ folding:
123
+ title: Metrics
124
+ enabled: false
125
+ description: ""
126
+ availability: []
127
+ scopes:
128
+ - name: global
129
+ description: |
130
+ These metrics refer to the entire monitored application.
131
+ labels: []
132
+ metrics:
133
+ - name: example.random
134
+ description: A random number
135
+ unit: number
136
+ chart_type: line
137
+ dimensions:
138
+ - name: random
collectors/python.d.plugin/exim/metadata.yaml
+130
-129
@@ -1,131 +1,132 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: exim
5
- monitored_instance:
6
- name: Exim
7
- link: "https://www.exim.org/"
8
- categories:
9
- - data-collection.mail-servers
10
- icon_filename: "exim.jpg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - exim
18
- - mail
19
- - server
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "This collector monitors Exim mail queue."
24
- method_description: "It uses the `exim` command line binary to get the statistics."
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: false
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: "Assuming setup prerequisites are met, the collector will try to gather statistics using the method described above, even without any configuration."
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: "Exim configuration - local installation"
42
- description: |
43
- The module uses the `exim` binary, which can only be executed as root by default. We need to allow other users to `exim` binary. We solve that adding `queue_list_requires_admin` statement in exim configuration and set to `false`, because it is `true` by default. On many Linux distributions, the default location of `exim` configuration is in `/etc/exim.conf`.
44
-
45
- 1. Edit the `exim` configuration with your preferred editor and add:
46
- `queue_list_requires_admin = false`
47
- 2. Restart `exim` and Netdata
48
- - title: "Exim configuration - WHM (CPanel) server"
49
- description: |
50
- On a WHM server, you can reconfigure `exim` over the WHM interface with the following steps.
51
-
52
- 1. Login to WHM
53
- 2. Navigate to Service Configuration --> Exim Configuration Manager --> tab Advanced Editor
54
- 3. Scroll down to the button **Add additional configuration setting** and click on it.
55
- 4. In the new dropdown which will appear above we need to find and choose:
56
- `queue_list_requires_admin` and set to `false`
57
- 5. Scroll to the end and click the **Save** button.
58
- configuration:
59
- file:
60
- name: python.d/exim.conf
61
- options:
62
- description: |
63
- There are 2 sections:
64
-
65
- * Global variables
66
- * One or more JOBS that can define multiple different instances to monitor.
67
-
68
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
69
-
70
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
71
-
72
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
73
- folding:
74
- title: "Config options"
75
- enabled: true
76
- list:
77
- - name: update_every
78
- description: Sets the default data collection frequency.
79
- default_value: 5
80
- required: false
81
- - name: priority
82
- description: Controls the order of charts at the netdata dashboard.
83
- default_value: 60000
84
- required: false
85
- - name: autodetection_retry
86
- description: Sets the job re-check interval in seconds.
87
- default_value: 0
88
- required: false
89
- - name: penalty
90
- description: Indicates whether to apply penalty to update_every in case of failures.
91
- default_value: yes
92
- required: false
93
- - name: name
94
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
95
- default_value: ""
96
- required: false
97
- - name: command
98
- description: Path and command to the `exim` binary
99
- default_value: "exim -bpc"
100
- required: false
101
- examples:
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: exim
6
+ monitored_instance:
7
+ name: Exim
8
+ link: "https://www.exim.org/"
9
+ categories:
10
+ - data-collection.mail-servers
11
+ icon_filename: "exim.jpg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - exim
19
+ - mail
20
+ - server
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "This collector monitors Exim mail queue."
25
+ method_description: "It uses the `exim` command line binary to get the statistics."
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: false
30
+ additional_permissions:
31
+ description: ""
32
+ default_behavior:
33
+ auto_detection:
34
+ description: "Assuming setup prerequisites are met, the collector will try to gather statistics using the method described above, even without any configuration."
35
+ limits:
36
+ description: ""
37
+ performance_impact:
38
+ description: ""
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: "Exim configuration - local installation"
43
+ description: |
44
+ The module uses the `exim` binary, which can only be executed as root by default. We need to allow other users to `exim` binary. We solve that adding `queue_list_requires_admin` statement in exim configuration and set to `false`, because it is `true` by default. On many Linux distributions, the default location of `exim` configuration is in `/etc/exim.conf`.
45
+
46
+ 1. Edit the `exim` configuration with your preferred editor and add:
47
+ `queue_list_requires_admin = false`
48
+ 2. Restart `exim` and Netdata
49
+ - title: "Exim configuration - WHM (CPanel) server"
50
+ description: |
51
+ On a WHM server, you can reconfigure `exim` over the WHM interface with the following steps.
52
+
53
+ 1. Login to WHM
54
+ 2. Navigate to Service Configuration --> Exim Configuration Manager --> tab Advanced Editor
55
+ 3. Scroll down to the button **Add additional configuration setting** and click on it.
56
+ 4. In the new dropdown which will appear above we need to find and choose:
57
+ `queue_list_requires_admin` and set to `false`
58
+ 5. Scroll to the end and click the **Save** button.
59
+ configuration:
60
+ file:
61
+ name: python.d/exim.conf
62
+ options:
63
+ description: |
64
+ There are 2 sections:
65
+
66
+ * Global variables
67
+ * One or more JOBS that can define multiple different instances to monitor.
68
+
69
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
70
+
71
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
72
+
73
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
74
+ folding:
75
+ title: "Config options"
76
+ enabled: true
77
+ list:
78
+ - name: update_every
79
+ description: Sets the default data collection frequency.
80
+ default_value: 5
81
+ required: false
82
+ - name: priority
83
+ description: Controls the order of charts at the netdata dashboard.
84
+ default_value: 60000
85
+ required: false
86
+ - name: autodetection_retry
87
+ description: Sets the job re-check interval in seconds.
88
+ default_value: 0
89
+ required: false
90
+ - name: penalty
91
+ description: Indicates whether to apply penalty to update_every in case of failures.
92
+ default_value: yes
93
+ required: false
94
+ - name: name
95
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
96
+ default_value: ""
97
+ required: false
98
+ - name: command
99
+ description: Path and command to the `exim` binary
100
+ default_value: "exim -bpc"
101
+ required: false
102
+ examples:
103
+ folding:
104
+ enabled: false
105
+ title: "Config"
106
+ list:
107
+ - name: Local exim install
108
+ description: A basic local exim install
109
+ config: |
110
+ local:
111
+ command: 'exim -bpc'
112
+ troubleshooting:
113
+ problems:
114
+ list: []
115
+ alerts: []
116
+ metrics:
117
folding:
118
+ title: Metrics
119
enabled: false
104
- title: "Config"
105
- list:
106
- - name: Local exim install
107
- description: A basic local exim install
108
- config: |
109
- local:
110
- command: 'exim -bpc'
111
-troubleshooting:
112
- problems:
113
- list: []
114
-alerts: []
115
-metrics:
116
- folding:
117
- title: Metrics
118
- enabled: false
119
- description: ""
120
- availability: []
121
- scopes:
122
- - name: global
123
- description: "These metrics refer to the entire monitored application."
124
- labels: []
125
- metrics:
126
- - name: exim.qemails
127
- description: Exim Queue Emails
128
- unit: "emails"
129
- chart_type: line
130
- dimensions:
131
- - name: emails
120
+ description: ""
121
+ availability: []
122
+ scopes:
123
+ - name: global
124
+ description: "These metrics refer to the entire monitored application."
125
+ labels: []
126
+ metrics:
127
+ - name: exim.qemails
128
+ description: Exim Queue Emails
129
+ unit: "emails"
130
+ chart_type: line
131
+ dimensions:
132
+ - name: emails
collectors/python.d.plugin/fail2ban/metadata.yaml
+179
-179
@@ -1,180 +1,180 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: fail2ban
6
- monitored_instance:
7
- name: Fail2ban
8
- link: https://www.fail2ban.org/
9
- categories:
10
- - data-collection.authentication-and-authorization
11
- icon_filename: "fail2ban.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - fail2ban
19
- - security
20
- - authentication
21
- - authorization
22
- most_popular: false
23
-overview:
24
- data_collection:
25
- metrics_description: |
26
- Monitor Fail2ban performance for prime intrusion prevention operations. Monitor ban counts, jail statuses, and failed login attempts to ensure robust network security.
27
- method_description: |
28
- It collects metrics through reading the default log and configuration files of fail2ban.
29
- supported_platforms:
30
- include: []
31
- exclude: []
32
- multi_instance: true
33
- additional_permissions:
34
- description: |
35
- The `fail2ban.log` file must be readable by the user `netdata`.
36
- - change the file ownership and access permissions.
37
- - update `/etc/logrotate.d/fail2ban`` to persist the changes after rotating the log file.
38
-
39
- To change the file ownership and access permissions, execute the following:
40
-
41
- ```shell
42
- sudo chown root:netdata /var/log/fail2ban.log
43
- sudo chmod 640 /var/log/fail2ban.log
44
- ```
45
-
46
- To persist the changes after rotating the log file, add `create 640 root netdata` to the `/etc/logrotate.d/fail2ban`:
47
-
48
- ```shell
49
- /var/log/fail2ban.log {
50
-
51
- weekly
52
- rotate 4
53
- compress
54
-
55
- delaycompress
56
- missingok
57
- postrotate
58
- fail2ban-client flushlogs 1>/dev/null
59
- endscript
60
-
61
- # If fail2ban runs as non-root it still needs to have write access
62
- # to logfiles.
63
- # create 640 fail2ban adm
64
- create 640 root netdata
65
- }
66
- ```
67
- default_behavior:
68
- auto_detection:
69
- description: |
70
- By default the collector will attempt to read log file at /var/log/fail2ban.log and conf file at /etc/fail2ban/jail.local. If conf file is not found default jail is ssh.
71
- limits:
72
- description: ""
73
- performance_impact:
74
- description: ""
75
-setup:
76
- prerequisites:
77
- list: []
78
- configuration:
79
- file:
80
- name: ""
81
- description: ""
82
- options:
83
- description: |
84
- There are 2 sections:
85
-
86
- * Global variables
87
- * One or more JOBS that can define multiple different instances to monitor.
88
-
89
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
90
-
91
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
92
-
93
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
94
- folding:
95
- title: Config options
96
- enabled: true
97
- list:
98
- - name: log_path
99
- description: path to fail2ban.log.
100
- default_value: /var/log/fail2ban.log
101
- required: false
102
- - name: conf_path
103
- description: path to jail.local/jail.conf.
104
- default_value: /etc/fail2ban/jail.local
105
- required: false
106
- - name: conf_dir
107
- description: path to jail.d/.
108
- default_value: /etc/fail2ban/jail.d/
109
- required: false
110
- - name: exclude
111
- description: jails you want to exclude from autodetection.
112
- default_value: ""
113
- required: false
114
- - name: update_every
115
- description: Sets the default data collection frequency.
116
- default_value: 1
117
- required: false
118
- - name: priority
119
- description: Controls the order of charts at the netdata dashboard.
120
- default_value: 60000
121
- required: false
122
- - name: autodetection_retry
123
- description: Sets the job re-check interval in seconds.
124
- default_value: 0
125
- required: false
126
- - name: penalty
127
- description: Indicates whether to apply penalty to update_every in case of failures.
128
- default_value: yes
129
- required: false
130
- - name: name
131
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
132
- default_value: ""
133
- required: false
134
- examples:
135
- folding:
136
- enabled: true
137
- title: Config
138
- list:
139
- - name: Basic
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: fail2ban
6
+ monitored_instance:
7
+ name: Fail2ban
8
+ link: https://www.fail2ban.org/
9
+ categories:
10
+ - data-collection.authentication-and-authorization
11
+ icon_filename: "fail2ban.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - fail2ban
19
+ - security
20
+ - authentication
21
+ - authorization
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: |
26
+ Monitor Fail2ban performance for prime intrusion prevention operations. Monitor ban counts, jail statuses, and failed login attempts to ensure robust network security.
27
+ method_description: |
28
+ It collects metrics through reading the default log and configuration files of fail2ban.
29
+ supported_platforms:
30
+ include: []
31
+ exclude: []
32
+ multi_instance: true
33
+ additional_permissions:
34
+ description: |
35
+ The `fail2ban.log` file must be readable by the user `netdata`.
36
+ - change the file ownership and access permissions.
37
+ - update `/etc/logrotate.d/fail2ban`` to persist the changes after rotating the log file.
38
+
39
+ To change the file ownership and access permissions, execute the following:
40
+
41
+ ```shell
42
+ sudo chown root:netdata /var/log/fail2ban.log
43
+ sudo chmod 640 /var/log/fail2ban.log
44
+ ```
45
+
46
+ To persist the changes after rotating the log file, add `create 640 root netdata` to the `/etc/logrotate.d/fail2ban`:
47
+
48
+ ```shell
49
+ /var/log/fail2ban.log {
50
+
51
+ weekly
52
+ rotate 4
53
+ compress
54
+
55
+ delaycompress
56
+ missingok
57
+ postrotate
58
+ fail2ban-client flushlogs 1>/dev/null
59
+ endscript
60
+
61
+ # If fail2ban runs as non-root it still needs to have write access
62
+ # to logfiles.
63
+ # create 640 fail2ban adm
64
+ create 640 root netdata
65
+ }
66
+ ```
67
+ default_behavior:
68
+ auto_detection:
69
+ description: |
70
+ By default the collector will attempt to read log file at /var/log/fail2ban.log and conf file at /etc/fail2ban/jail.local. If conf file is not found default jail is ssh.
71
+ limits:
72
+ description: ""
73
+ performance_impact:
74
+ description: ""
75
+ setup:
76
+ prerequisites:
77
+ list: []
78
+ configuration:
79
+ file:
80
+ name: ""
81
+ description: ""
82
+ options:
83
+ description: |
84
+ There are 2 sections:
85
+
86
+ * Global variables
87
+ * One or more JOBS that can define multiple different instances to monitor.
88
+
89
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
90
+
91
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
92
+
93
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
94
+ folding:
95
+ title: Config options
96
+ enabled: true
97
+ list:
98
+ - name: log_path
99
+ description: path to fail2ban.log.
100
+ default_value: /var/log/fail2ban.log
101
+ required: false
102
+ - name: conf_path
103
+ description: path to jail.local/jail.conf.
104
+ default_value: /etc/fail2ban/jail.local
105
+ required: false
106
+ - name: conf_dir
107
+ description: path to jail.d/.
108
+ default_value: /etc/fail2ban/jail.d/
109
+ required: false
110
+ - name: exclude
111
+ description: jails you want to exclude from autodetection.
112
+ default_value: ""
113
+ required: false
114
+ - name: update_every
115
+ description: Sets the default data collection frequency.
116
+ default_value: 1
117
+ required: false
118
+ - name: priority
119
+ description: Controls the order of charts at the netdata dashboard.
120
+ default_value: 60000
121
+ required: false
122
+ - name: autodetection_retry
123
+ description: Sets the job re-check interval in seconds.
124
+ default_value: 0
125
+ required: false
126
+ - name: penalty
127
+ description: Indicates whether to apply penalty to update_every in case of failures.
128
+ default_value: yes
129
+ required: false
130
+ - name: name
131
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
132
+ default_value: ""
133
+ required: false
134
+ examples:
135
folding:
141
- enabled: false
142
- description: A basic example configuration.
143
- config: |
144
- local:
145
- log_path: '/var/log/fail2ban.log'
146
- conf_path: '/etc/fail2ban/jail.local'
147
-troubleshooting:
148
- problems:
149
- list: []
150
-alerts: []
151
-metrics:
152
- folding:
153
- title: Metrics
154
- enabled: false
155
- description: ""
156
- availability: []
157
- scopes:
158
- - name: global
159
- description: |
160
- These metrics refer to the entire monitored application.
161
- labels: []
162
- metrics:
163
- - name: fail2ban.failed_attempts
164
- description: Failed attempts
165
- unit: "attempts/s"
166
- chart_type: line
167
- dimensions:
168
- - name: a dimension per jail
169
- - name: fail2ban.bans
170
- description: Bans
171
- unit: "bans/s"
172
- chart_type: line
173
- dimensions:
174
- - name: a dimension per jail
175
- - name: fail2ban.banned_ips
176
- description: Banned IP addresses (since the last restart of netdata)
177
- unit: "ips"
178
- chart_type: line
179
- dimensions:
180
- - name: a dimension per jail
136
+ enabled: true
137
+ title: Config
138
+ list:
139
+ - name: Basic
140
+ folding:
141
+ enabled: false
142
+ description: A basic example configuration.
143
+ config: |
144
+ local:
145
+ log_path: '/var/log/fail2ban.log'
146
+ conf_path: '/etc/fail2ban/jail.local'
147
+ troubleshooting:
148
+ problems:
149
+ list: []
150
+ alerts: []
151
+ metrics:
152
+ folding:
153
+ title: Metrics
154
+ enabled: false
155
+ description: ""
156
+ availability: []
157
+ scopes:
158
+ - name: global
159
+ description: |
160
+ These metrics refer to the entire monitored application.
161
+ labels: []
162
+ metrics:
163
+ - name: fail2ban.failed_attempts
164
+ description: Failed attempts
165
+ unit: "attempts/s"
166
+ chart_type: line
167
+ dimensions:
168
+ - name: a dimension per jail
169
+ - name: fail2ban.bans
170
+ description: Bans
171
+ unit: "bans/s"
172
+ chart_type: line
173
+ dimensions:
174
+ - name: a dimension per jail
175
+ - name: fail2ban.banned_ips
176
+ description: Banned IP addresses (since the last restart of netdata)
177
+ unit: "ips"
178
+ chart_type: line
179
+ dimensions:
180
+ - name: a dimension per jail
collectors/python.d.plugin/gearman/metadata.yaml
+167
-166
@@ -1,167 +1,168 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: gearman
5
- monitored_instance:
6
- name: Gearman
7
- link: "http://gearman.org/"
8
- categories:
9
- - data-collection.distributed-computing-systems
10
- icon_filename: "gearman.svg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - gearman
18
- - gearman job server
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: "Monitor Gearman metrics for proficient system task distribution. Track job counts, worker statuses, and queue lengths for effective distributed task management."
23
- method_description: "This collector connects to a Gearman instance via either TCP or unix socket."
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ""
30
- default_behavior:
31
- auto_detection:
32
- description: "When no configuration file is found, the collector tries to connect to TCP/IP socket: localhost:4730."
33
- limits:
34
- description: ""
35
- performance_impact:
36
- description: ""
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: "Socket permissions"
41
- description: The gearman UNIX socket should have read permission for user netdata.
42
- configuration:
43
- file:
44
- name: python.d/gearman.conf
45
- options:
46
- description: |
47
- There are 2 sections:
48
-
49
- * Global variables
50
- * One or more JOBS that can define multiple different instances to monitor.
51
-
52
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
53
-
54
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
-
56
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
- folding:
58
- title: "Config options"
59
- enabled: true
60
- list:
61
- - name: update_every
62
- description: Sets the default data collection frequency.
63
- default_value: 5
64
- required: false
65
- - name: priority
66
- description: Controls the order of charts at the netdata dashboard.
67
- default_value: 60000
68
- required: false
69
- - name: autodetection_retry
70
- description: Sets the job re-check interval in seconds.
71
- default_value: 0
72
- required: false
73
- - name: penalty
74
- description: Indicates whether to apply penalty to update_every in case of failures.
75
- default_value: yes
76
- required: false
77
- - name: name
78
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
- default_value: ""
80
- required: false
81
- - name: host
82
- description: URL or IP where gearman is running.
83
- default_value: "localhost"
84
- required: false
85
- - name: port
86
- description: Port of URL or IP where gearman is running.
87
- default_value: "4730"
88
- required: false
89
- - name: tls
90
- description: Use tls to connect to gearman.
91
- default_value: "false"
92
- required: false
93
- - name: cert
94
- description: Provide a certificate file if needed to connect to a TLS gearman instance.
95
- default_value: ""
96
- required: false
97
- - name: key
98
- description: Provide a key file if needed to connect to a TLS gearman instance.
99
- default_value: ""
100
- required: false
101
- examples:
102
- folding:
103
- enabled: true
104
- title: "Config"
105
- list:
106
- - name: Local gearman service
107
- description: A basic host and port gearman configuration for localhost.
108
- folding:
109
- enabled: false
110
- config: |
111
- localhost:
112
- name: 'local'
113
- host: 'localhost'
114
- port: 4730
115
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: gearman
6
+ monitored_instance:
7
+ name: Gearman
8
+ link: "http://gearman.org/"
9
+ categories:
10
+ - data-collection.distributed-computing-systems
11
+ icon_filename: "gearman.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - gearman
19
+ - gearman job server
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: "Monitor Gearman metrics for proficient system task distribution. Track job counts, worker statuses, and queue lengths for effective distributed task management."
24
+ method_description: "This collector connects to a Gearman instance via either TCP or unix socket."
25
+ supported_platforms:
26
+ include: []
27
+ exclude: []
28
+ multi_instance: true
29
+ additional_permissions:
30
+ description: ""
31
+ default_behavior:
32
+ auto_detection:
33
+ description: "When no configuration file is found, the collector tries to connect to TCP/IP socket: localhost:4730."
34
+ limits:
35
+ description: ""
36
+ performance_impact:
37
+ description: ""
38
+ setup:
39
+ prerequisites:
40
+ list:
41
+ - title: "Socket permissions"
42
+ description: The gearman UNIX socket should have read permission for user netdata.
43
+ configuration:
44
+ file:
45
+ name: python.d/gearman.conf
46
+ options:
47
description: |
117
- > **Note**: When you define multiple jobs, their names must be unique.
118
-
119
- Collecting metrics from local and remote instances.
120
- config: |
121
- localhost:
122
- name: 'local'
123
- host: 'localhost'
124
- port: 4730
125
-
126
- remote:
127
- name: 'remote'
128
- host: '192.0.2.1'
129
- port: 4730
130
-troubleshooting:
131
- problems:
132
- list: []
133
-alerts:
134
- - name: gearman_workers_queued
135
- link: https://github.com/netdata/netdata/blob/master/health/health.d/gearman.conf
136
- metric: gearman.single_job
137
- info: average number of queued jobs over the last 10 minutes
138
-metrics:
139
- folding:
140
- title: Metrics
141
- enabled: false
142
- description: ""
143
- availability: []
144
- scopes:
145
- - name: global
146
- description: "These metrics refer to the entire monitored application."
147
- labels: []
148
- metrics:
149
- - name: gearman.total_jobs
150
- description: Total Jobs
151
- unit: "Jobs"
152
- chart_type: line
153
- dimensions:
154
- - name: Pending
155
- - name: Running
156
- - name: gearman job
157
- description: "Metrics related to Gearman jobs. Each job produces its own set of the following metrics."
158
- labels: []
159
- metrics:
160
- - name: gearman.single_job
161
- description: "{job_name}"
162
- unit: "Jobs"
163
- chart_type: stacked
164
- dimensions:
165
- - name: Pending
166
- - name: Idle
167
- - name: Runnning
48
+ There are 2 sections:
49
+
50
+ * Global variables
51
+ * One or more JOBS that can define multiple different instances to monitor.
52
+
53
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
54
+
55
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
+
57
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
+ folding:
59
+ title: "Config options"
60
+ enabled: true
61
+ list:
62
+ - name: update_every
63
+ description: Sets the default data collection frequency.
64
+ default_value: 5
65
+ required: false
66
+ - name: priority
67
+ description: Controls the order of charts at the netdata dashboard.
68
+ default_value: 60000
69
+ required: false
70
+ - name: autodetection_retry
71
+ description: Sets the job re-check interval in seconds.
72
+ default_value: 0
73
+ required: false
74
+ - name: penalty
75
+ description: Indicates whether to apply penalty to update_every in case of failures.
76
+ default_value: yes
77
+ required: false
78
+ - name: name
79
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
80
+ default_value: ""
81
+ required: false
82
+ - name: host
83
+ description: URL or IP where gearman is running.
84
+ default_value: "localhost"
85
+ required: false
86
+ - name: port
87
+ description: Port of URL or IP where gearman is running.
88
+ default_value: "4730"
89
+ required: false
90
+ - name: tls
91
+ description: Use tls to connect to gearman.
92
+ default_value: "false"
93
+ required: false
94
+ - name: cert
95
+ description: Provide a certificate file if needed to connect to a TLS gearman instance.
96
+ default_value: ""
97
+ required: false
98
+ - name: key
99
+ description: Provide a key file if needed to connect to a TLS gearman instance.
100
+ default_value: ""
101
+ required: false
102
+ examples:
103
+ folding:
104
+ enabled: true
105
+ title: "Config"
106
+ list:
107
+ - name: Local gearman service
108
+ description: A basic host and port gearman configuration for localhost.
109
+ folding:
110
+ enabled: false
111
+ config: |
112
+ localhost:
113
+ name: 'local'
114
+ host: 'localhost'
115
+ port: 4730
116
+ - name: Multi-instance
117
+ description: |
118
+ > **Note**: When you define multiple jobs, their names must be unique.
119
+
120
+ Collecting metrics from local and remote instances.
121
+ config: |
122
+ localhost:
123
+ name: 'local'
124
+ host: 'localhost'
125
+ port: 4730
126
+
127
+ remote:
128
+ name: 'remote'
129
+ host: '192.0.2.1'
130
+ port: 4730
131
+ troubleshooting:
132
+ problems:
133
+ list: []
134
+ alerts:
135
+ - name: gearman_workers_queued
136
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/gearman.conf
137
+ metric: gearman.single_job
138
+ info: average number of queued jobs over the last 10 minutes
139
+ metrics:
140
+ folding:
141
+ title: Metrics
142
+ enabled: false
143
+ description: ""
144
+ availability: []
145
+ scopes:
146
+ - name: global
147
+ description: "These metrics refer to the entire monitored application."
148
+ labels: []
149
+ metrics:
150
+ - name: gearman.total_jobs
151
+ description: Total Jobs
152
+ unit: "Jobs"
153
+ chart_type: line
154
+ dimensions:
155
+ - name: Pending
156
+ - name: Running
157
+ - name: gearman job
158
+ description: "Metrics related to Gearman jobs. Each job produces its own set of the following metrics."
159
+ labels: []
160
+ metrics:
161
+ - name: gearman.single_job
162
+ description: "{job_name}"
163
+ unit: "Jobs"
164
+ chart_type: stacked
165
+ dimensions:
166
+ - name: Pending
167
+ - name: Idle
168
+ - name: Runnning
collectors/python.d.plugin/go_expvar/metadata.yaml
+314
-313
@@ -1,318 +1,319 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: go_expvar
5
- monitored_instance:
6
- name: Go applications
7
- link: "https://pkg.go.dev/expvar"
8
- categories:
9
- - data-collection.apm
10
- icon_filename: "go.png"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - go
18
- - expvar
19
- - application
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "This collector monitors Go applications that expose their metrics with the use of the `expvar` package from the Go standard library. It produces charts for Go runtime memory statistics and optionally any number of custom charts."
24
- method_description: "It connects via http to gather the metrics exposed via the `expvar` package."
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: true
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: ""
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: "Sample `expvar` usage in a Go application"
42
- description: |
43
- The `expvar` package exposes metrics over HTTP and is very easy to use.
44
- Consider this minimal sample below:
45
-
46
- ```go
47
- package main
48
-
49
- import (
50
- _ "expvar"
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: go_expvar
6
+ monitored_instance:
7
+ name: Go applications
8
+ link: "https://pkg.go.dev/expvar"
9
+ categories:
10
+ - data-collection.apm
11
+ icon_filename: "go.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - go
19
+ - expvar
20
+ - application
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "This collector monitors Go applications that expose their metrics with the use of the `expvar` package from the Go standard library. It produces charts for Go runtime memory statistics and optionally any number of custom charts."
25
+ method_description: "It connects via http to gather the metrics exposed via the `expvar` package."
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: true
30
+ additional_permissions:
31
+ description: ""
32
+ default_behavior:
33
+ auto_detection:
34
+ description: ""
35
+ limits:
36
+ description: ""
37
+ performance_impact:
38
+ description: ""
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: "Sample `expvar` usage in a Go application"
43
+ description: |
44
+ The `expvar` package exposes metrics over HTTP and is very easy to use.
45
+ Consider this minimal sample below:
46
+
47
+ ```go
48
+ package main
49
+
50
+ import (
51
+ _ "expvar"
52
+ "net/http"
53
+ )
54
+
55
+ func main() {
56
+ http.ListenAndServe("127.0.0.1:8080", nil)
57
+ }
58
+ ```
59
+
60
+ When imported this way, the `expvar` package registers a HTTP handler at `/debug/vars` that
61
+ exposes Go runtime's memory statistics in JSON format. You can inspect the output by opening
62
+ the URL in your browser (or by using `wget` or `curl`).
63
+
64
+ Sample output:
65
+
66
+ ```json
67
+ {
68
+ "cmdline": ["./expvar-demo-binary"],
69
+ "memstats": {"Alloc":630856,"TotalAlloc":630856,"Sys":3346432,"Lookups":27, <omitted for brevity>}
70
+ }
71
+ ```
72
+
73
+ You can of course expose and monitor your own variables as well.
74
+ Here is a sample Go application that exposes a few custom variables:
75
+
76
+ ```go
77
+ package main
78
+
79
+ import (
80
+ "expvar"
81
"net/http"
52
- )
53
-
54
- func main() {
55
- http.ListenAndServe("127.0.0.1:8080", nil)
56
- }
57
- ```
58
-
59
- When imported this way, the `expvar` package registers a HTTP handler at `/debug/vars` that
60
- exposes Go runtime's memory statistics in JSON format. You can inspect the output by opening
61
- the URL in your browser (or by using `wget` or `curl`).
62
-
63
- Sample output:
64
-
65
- ```json
66
- {
67
- "cmdline": ["./expvar-demo-binary"],
68
- "memstats": {"Alloc":630856,"TotalAlloc":630856,"Sys":3346432,"Lookups":27, <omitted for brevity>}
69
- }
70
- ```
71
-
72
- You can of course expose and monitor your own variables as well.
73
- Here is a sample Go application that exposes a few custom variables:
74
-
75
- ```go
76
- package main
77
-
78
- import (
79
- "expvar"
80
- "net/http"
81
- "runtime"
82
- "time"
83
- )
84
-
85
- func main() {
86
-
87
- tick := time.NewTicker(1 * time.Second)
88
- num_go := expvar.NewInt("runtime.goroutines")
89
- counters := expvar.NewMap("counters")
90
- counters.Set("cnt1", new(expvar.Int))
91
- counters.Set("cnt2", new(expvar.Float))
92
-
93
- go http.ListenAndServe(":8080", nil)
94
-
95
- for {
96
- select {
97
- case <- tick.C:
98
- num_go.Set(int64(runtime.NumGoroutine()))
99
- counters.Add("cnt1", 1)
100
- counters.AddFloat("cnt2", 1.452)
82
+ "runtime"
83
+ "time"
84
+ )
85
+
86
+ func main() {
87
+
88
+ tick := time.NewTicker(1 * time.Second)
89
+ num_go := expvar.NewInt("runtime.goroutines")
90
+ counters := expvar.NewMap("counters")
91
+ counters.Set("cnt1", new(expvar.Int))
92
+ counters.Set("cnt2", new(expvar.Float))
93
+
94
+ go http.ListenAndServe(":8080", nil)
95
+
96
+ for {
97
+ select {
98
+ case <- tick.C:
99
+ num_go.Set(int64(runtime.NumGoroutine()))
100
+ counters.Add("cnt1", 1)
101
+ counters.AddFloat("cnt2", 1.452)
102
+ }
103
}
104
}
103
- }
104
- ```
105
-
106
- Apart from the runtime memory stats, this application publishes two counters and the
107
- number of currently running Goroutines and updates these stats every second.
108
- configuration:
109
- file:
110
- name: python.d/go_expvar.conf
111
- options:
112
- description: |
113
- There are 2 sections:
114
-
115
- * Global variables
116
- * One or more JOBS that can define multiple different instances to monitor.
117
-
118
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
119
-
120
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
121
-
122
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified. Each JOB can be used to monitor a different Go application.
123
- folding:
124
- title: "Config options"
125
- enabled: true
126
- list:
127
- - name: update_every
128
- description: Sets the default data collection frequency.
129
- default_value: 5
130
- required: false
131
- - name: priority
132
- description: Controls the order of charts at the netdata dashboard.
133
- default_value: 60000
134
- required: false
135
- - name: autodetection_retry
136
- description: Sets the job re-check interval in seconds.
137
- default_value: 0
138
- required: false
139
- - name: penalty
140
- description: Indicates whether to apply penalty to update_every in case of failures.
141
- default_value: yes
142
- required: false
143
- - name: name
144
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
145
- default_value: ""
146
- required: false
147
- - name: url
148
- description: the URL and port of the expvar endpoint. Please include the whole path of the endpoint, as the expvar handler can be installed in a non-standard location.
149
- default_value: ""
150
- required: true
151
- - name: user
152
- description: If the URL is password protected, this is the username to use.
153
- default_value: ""
154
- required: false
155
- - name: pass
156
- description: If the URL is password protected, this is the password to use.
157
- default_value: ""
158
- required: false
159
- - name: collect_memstats
160
- description: Enables charts for Go runtime's memory statistics.
161
- default_value: ""
162
- required: false
163
- - name: extra_charts
164
- description: Defines extra data/charts to monitor, please see the example below.
165
- default_value: ""
166
- required: false
167
- examples:
105
+ ```
106
+
107
+ Apart from the runtime memory stats, this application publishes two counters and the
108
+ number of currently running Goroutines and updates these stats every second.
109
+ configuration:
110
+ file:
111
+ name: python.d/go_expvar.conf
112
+ options:
113
+ description: |
114
+ There are 2 sections:
115
+
116
+ * Global variables
117
+ * One or more JOBS that can define multiple different instances to monitor.
118
+
119
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
120
+
121
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
122
+
123
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified. Each JOB can be used to monitor a different Go application.
124
+ folding:
125
+ title: "Config options"
126
+ enabled: true
127
+ list:
128
+ - name: update_every
129
+ description: Sets the default data collection frequency.
130
+ default_value: 5
131
+ required: false
132
+ - name: priority
133
+ description: Controls the order of charts at the netdata dashboard.
134
+ default_value: 60000
135
+ required: false
136
+ - name: autodetection_retry
137
+ description: Sets the job re-check interval in seconds.
138
+ default_value: 0
139
+ required: false
140
+ - name: penalty
141
+ description: Indicates whether to apply penalty to update_every in case of failures.
142
+ default_value: yes
143
+ required: false
144
+ - name: name
145
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
146
+ default_value: ""
147
+ required: false
148
+ - name: url
149
+ description: the URL and port of the expvar endpoint. Please include the whole path of the endpoint, as the expvar handler can be installed in a non-standard location.
150
+ default_value: ""
151
+ required: true
152
+ - name: user
153
+ description: If the URL is password protected, this is the username to use.
154
+ default_value: ""
155
+ required: false
156
+ - name: pass
157
+ description: If the URL is password protected, this is the password to use.
158
+ default_value: ""
159
+ required: false
160
+ - name: collect_memstats
161
+ description: Enables charts for Go runtime's memory statistics.
162
+ default_value: ""
163
+ required: false
164
+ - name: extra_charts
165
+ description: Defines extra data/charts to monitor, please see the example below.
166
+ default_value: ""
167
+ required: false
168
+ examples:
169
+ folding:
170
+ enabled: false
171
+ title: "Config"
172
+ list:
173
+ - name: Monitor a Go app1 application
174
+ description: |
175
+ The example below sets a configuration for a Go application, called `app1`. Besides the `memstats`, the application also exposes two counters and the number of currently running Goroutines and updates these stats every second.
176
+
177
+ The `go_expvar` collector can monitor these as well with the use of the `extra_charts` configuration variable.
178
+
179
+ The `extra_charts` variable is a YaML list of Netdata chart definitions.
180
+ Each chart definition has the following keys:
181
+
182
+ ```
183
+ id: Netdata chart ID
184
+ options: a key-value mapping of chart options
185
+ lines: a list of line definitions
186
+ ```
187
+
188
+ **Note: please do not use dots in the chart or line ID field.
189
+ See [this issue](https://github.com/netdata/netdata/pull/1902#issuecomment-284494195) for explanation.**
190
+
191
+ Please see these two links to the official Netdata documentation for more information about the values:
192
+
193
+ - [External plugins - charts](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#chart)
194
+ - [Chart variables](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#global-variables-order-and-chart)
195
+
196
+ **Line definitions**
197
+
198
+ Each chart can define multiple lines (dimensions).
199
+ A line definition is a key-value mapping of line options.
200
+ Each line can have the following options:
201
+
202
+ ```
203
+ # mandatory
204
+ expvar_key: the name of the expvar as present in the JSON output of /debug/vars endpoint
205
+ expvar_type: value type; supported are "float" or "int"
206
+ id: the id of this line/dimension in Netdata
207
+
208
+ # optional - Netdata defaults are used if these options are not defined
209
+ name: ''
210
+ algorithm: absolute
211
+ multiplier: 1
212
+ divisor: 100 if expvar_type == float, 1 if expvar_type == int
213
+ hidden: False
214
+ ```
215
+
216
+ Please see the following link for more information about the options and their default values:
217
+ [External plugins - dimensions](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#dimension)
218
+
219
+ Apart from top-level expvars, this plugin can also parse expvars stored in a multi-level map;
220
+ All dicts in the resulting JSON document are then flattened to one level.
221
+ Expvar names are joined together with '.' when flattening.
222
+
223
+ Example:
224
+
225
+ ```
226
+ {
227
+ "counters": {"cnt1": 1042, "cnt2": 1512.9839999999983},
228
+ "runtime.goroutines": 5
229
+ }
230
+ ```
231
+
232
+ In the above case, the exported variables will be available under `runtime.goroutines`,
233
+ `counters.cnt1` and `counters.cnt2` expvar_keys. If the flattening results in a key collision,
234
+ the first defined key wins and all subsequent keys with the same name are ignored.
235
+ config: |
236
+ app1:
237
+ name : 'app1'
238
+ url : 'http://127.0.0.1:8080/debug/vars'
239
+ collect_memstats: true
240
+ extra_charts:
241
+ - id: "runtime_goroutines"
242
+ options:
243
+ name: num_goroutines
244
+ title: "runtime: number of goroutines"
245
+ units: goroutines
246
+ family: runtime
247
+ context: expvar.runtime.goroutines
248
+ chart_type: line
249
+ lines:
250
+ - {expvar_key: 'runtime.goroutines', expvar_type: int, id: runtime_goroutines}
251
+ - id: "foo_counters"
252
+ options:
253
+ name: counters
254
+ title: "some random counters"
255
+ units: awesomeness
256
+ family: counters
257
+ context: expvar.foo.counters
258
+ chart_type: line
259
+ lines:
260
+ - {expvar_key: 'counters.cnt1', expvar_type: int, id: counters_cnt1}
261
+ - {expvar_key: 'counters.cnt2', expvar_type: float, id: counters_cnt2}
262
+ troubleshooting:
263
+ problems:
264
+ list: []
265
+ alerts: []
266
+ metrics:
267
folding:
268
+ title: Metrics
269
enabled: false
170
- title: "Config"
171
- list:
172
- - name: Monitor a Go app1 application
173
- description: |
174
- The example below sets a configuration for a Go application, called `app1`. Besides the `memstats`, the application also exposes two counters and the number of currently running Goroutines and updates these stats every second.
175
-
176
- The `go_expvar` collector can monitor these as well with the use of the `extra_charts` configuration variable.
177
-
178
- The `extra_charts` variable is a YaML list of Netdata chart definitions.
179
- Each chart definition has the following keys:
180
-
181
- ```
182
- id: Netdata chart ID
183
- options: a key-value mapping of chart options
184
- lines: a list of line definitions
185
- ```
186
-
187
- **Note: please do not use dots in the chart or line ID field.
188
- See [this issue](https://github.com/netdata/netdata/pull/1902#issuecomment-284494195) for explanation.**
189
-
190
- Please see these two links to the official Netdata documentation for more information about the values:
191
-
192
- - [External plugins - charts](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#chart)
193
- - [Chart variables](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#global-variables-order-and-chart)
194
-
195
- **Line definitions**
196
-
197
- Each chart can define multiple lines (dimensions).
198
- A line definition is a key-value mapping of line options.
199
- Each line can have the following options:
200
-
201
- ```
202
- # mandatory
203
- expvar_key: the name of the expvar as present in the JSON output of /debug/vars endpoint
204
- expvar_type: value type; supported are "float" or "int"
205
- id: the id of this line/dimension in Netdata
206
-
207
- # optional - Netdata defaults are used if these options are not defined
208
- name: ''
209
- algorithm: absolute
210
- multiplier: 1
211
- divisor: 100 if expvar_type == float, 1 if expvar_type == int
212
- hidden: False
213
- ```
214
-
215
- Please see the following link for more information about the options and their default values:
216
- [External plugins - dimensions](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#dimension)
217
-
218
- Apart from top-level expvars, this plugin can also parse expvars stored in a multi-level map;
219
- All dicts in the resulting JSON document are then flattened to one level.
220
- Expvar names are joined together with '.' when flattening.
221
-
222
- Example:
223
-
224
- ```
225
- {
226
- "counters": {"cnt1": 1042, "cnt2": 1512.9839999999983},
227
- "runtime.goroutines": 5
228
- }
229
- ```
230
-
231
- In the above case, the exported variables will be available under `runtime.goroutines`,
232
- `counters.cnt1` and `counters.cnt2` expvar_keys. If the flattening results in a key collision,
233
- the first defined key wins and all subsequent keys with the same name are ignored.
234
- config: |
235
- app1:
236
- name : 'app1'
237
- url : 'http://127.0.0.1:8080/debug/vars'
238
- collect_memstats: true
239
- extra_charts:
240
- - id: "runtime_goroutines"
241
- options:
242
- name: num_goroutines
243
- title: "runtime: number of goroutines"
244
- units: goroutines
245
- family: runtime
246
- context: expvar.runtime.goroutines
247
- chart_type: line
248
- lines:
249
- - {expvar_key: 'runtime.goroutines', expvar_type: int, id: runtime_goroutines}
250
- - id: "foo_counters"
251
- options:
252
- name: counters
253
- title: "some random counters"
254
- units: awesomeness
255
- family: counters
256
- context: expvar.foo.counters
257
- chart_type: line
258
- lines:
259
- - {expvar_key: 'counters.cnt1', expvar_type: int, id: counters_cnt1}
260
- - {expvar_key: 'counters.cnt2', expvar_type: float, id: counters_cnt2}
261
-troubleshooting:
262
- problems:
263
- list: []
264
-alerts: []
265
-metrics:
266
- folding:
267
- title: Metrics
268
- enabled: false
269
- description: ""
270
- availability: []
271
- scopes:
272
- - name: global
273
- description: "These metrics refer to the entire monitored application."
274
- labels: []
275
- metrics:
276
- - name: expvar.memstats.heap
277
- description: "memory: size of heap memory structures"
278
- unit: "KiB"
279
- chart_type: line
280
- dimensions:
281
- - name: alloc
282
- - name: inuse
283
- - name: expvar.memstats.stack
284
- description: "memory: size of stack memory structures"
285
- unit: "KiB"
286
- chart_type: line
287
- dimensions:
288
- - name: inuse
289
- - name: expvar.memstats.mspan
290
- description: "memory: size of mspan memory structures"
291
- unit: "KiB"
292
- chart_type: line
293
- dimensions:
294
- - name: inuse
295
- - name: expvar.memstats.mcache
296
- description: "memory: size of mcache memory structures"
297
- unit: "KiB"
298
- chart_type: line
299
- dimensions:
300
- - name: inuse
301
- - name: expvar.memstats.live_objects
302
- description: "memory: number of live objects"
303
- unit: "objects"
304
- chart_type: line
305
- dimensions:
306
- - name: live
307
- - name: expvar.memstats.sys
308
- description: "memory: size of reserved virtual address space"
309
- unit: "KiB"
310
- chart_type: line
311
- dimensions:
312
- - name: sys
313
- - name: expvar.memstats.gc_pauses
314
- description: "memory: average duration of GC pauses"
315
- unit: "ns"
316
- chart_type: line
317
- dimensions:
318
- - name: avg
270
+ description: ""
271
+ availability: []
272
+ scopes:
273
+ - name: global
274
+ description: "These metrics refer to the entire monitored application."
275
+ labels: []
276
+ metrics:
277
+ - name: expvar.memstats.heap
278
+ description: "memory: size of heap memory structures"
279
+ unit: "KiB"
280
+ chart_type: line
281
+ dimensions:
282
+ - name: alloc
283
+ - name: inuse
284
+ - name: expvar.memstats.stack
285
+ description: "memory: size of stack memory structures"
286
+ unit: "KiB"
287
+ chart_type: line
288
+ dimensions:
289
+ - name: inuse
290
+ - name: expvar.memstats.mspan
291
+ description: "memory: size of mspan memory structures"
292
+ unit: "KiB"
293
+ chart_type: line
294
+ dimensions:
295
+ - name: inuse
296
+ - name: expvar.memstats.mcache
297
+ description: "memory: size of mcache memory structures"
298
+ unit: "KiB"
299
+ chart_type: line
300
+ dimensions:
301
+ - name: inuse
302
+ - name: expvar.memstats.live_objects
303
+ description: "memory: number of live objects"
304
+ unit: "objects"
305
+ chart_type: line
306
+ dimensions:
307
+ - name: live
308
+ - name: expvar.memstats.sys
309
+ description: "memory: size of reserved virtual address space"
310
+ unit: "KiB"
311
+ chart_type: line
312
+ dimensions:
313
+ - name: sys
314
+ - name: expvar.memstats.gc_pauses
315
+ description: "memory: average duration of GC pauses"
316
+ unit: "ns"
317
+ chart_type: line
318
+ dimensions:
319
+ - name: avg
collectors/python.d.plugin/hddtemp/metadata.yaml
+162
-160
@@ -1,161 +1,163 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: hddtemp
4
- monitored_instance:
5
- name: HDD temperature
6
- link: https://linux.die.net/man/8/hddtemp
7
- categories:
8
- - data-collection.hardware-devices-and-sensors
9
- icon_filename: "hard-drive.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - hardware
17
- - hdd temperature
18
- - disk temperature
19
- - temperature
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: |
24
- This collector monitors disk temperatures.
25
- method_description: |
26
- It uses the `hddtemp` daemon to gather the metrics.
27
- supported_platforms:
28
- include:
29
- - Linux
30
- exclude: []
31
- multi_instance: true
32
- additional_permissions:
33
- description: ""
34
- default_behavior:
35
- auto_detection:
36
- description: By default, this collector will attempt to connect to the `hddtemp` daemon on `127.0.0.1:7634`
37
- limits:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
-setup:
42
- prerequisites:
43
- list:
44
- - title: Run `hddtemp` in daemon mode
45
- description: |
46
- You can execute `hddtemp` in TCP/IP daemon mode by using the `-d` argument.
47
-
48
- So running `hddtemp -d` would run the daemon, by default on port 7634.
49
- configuration:
50
- file:
51
- name: "python.d/hddtemp.conf"
52
- options:
53
- description: |
54
- There are 2 sections:
55
-
56
- * Global variables
57
- * One or more JOBS that can define multiple different instances to monitor.
58
-
59
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
60
-
61
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
62
-
63
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
64
-
65
- By default this collector will try to autodetect disks (autodetection works only for disk which names start with "sd"). However this can be overridden by setting the option `disks` to an array of desired disks.
66
- folding:
67
- title: "Config options"
68
- enabled: true
69
- list:
70
- - name: update_every
71
- description: Sets the default data collection frequency.
72
- default_value: 1
73
- required: false
74
- - name: priority
75
- description: Controls the order of charts at the netdata dashboard.
76
- default_value: 60000
77
- required: false
78
- - name: autodetection_retry
79
- description: Sets the job re-check interval in seconds.
80
- default_value: 0
81
- required: false
82
- - name: penalty
83
- description: Indicates whether to apply penalty to update_every in case of failures.
84
- default_value: yes
85
- required: false
86
- - name: name
87
- description: >
88
- Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
89
- default_value: "local"
90
- required: false
91
- - name: devices
92
- description: Array of desired disks to detect, in case their name doesn't start with `sd`.
93
- default_value: ""
94
- required: false
95
- - name: host
96
- description: The IP or HOSTNAME to connect to.
97
- default_value: "localhost"
98
- required: true
99
- - name: port
100
- description: The port to connect to.
101
- default_value: 7634
102
- required: false
103
- examples:
104
- folding:
105
- enabled: true
106
- title: ""
107
- list:
108
- - name: Basic
109
- description: A basic example configuration.
110
- folding:
111
- enabled: false
112
- config: |
113
- localhost:
114
- name: 'local'
115
- host: '127.0.0.1'
116
- port: 7634
117
- - name: Custom disk names
118
- description: An example defining the disk names to detect.
119
- config: |
120
- localhost:
121
- name: 'local'
122
- host: '127.0.0.1'
123
- port: 7634
124
- devices:
125
- - customdisk1
126
- - customdisk2
127
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: hddtemp
6
+ monitored_instance:
7
+ name: HDD temperature
8
+ link: https://linux.die.net/man/8/hddtemp
9
+ categories:
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: "hard-drive.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - hardware
19
+ - hdd temperature
20
+ - disk temperature
21
+ - temperature
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: |
26
+ This collector monitors disk temperatures.
27
+ method_description: |
28
+ It uses the `hddtemp` daemon to gather the metrics.
29
+ supported_platforms:
30
+ include:
31
+ - Linux
32
+ exclude: []
33
+ multi_instance: true
34
+ additional_permissions:
35
+ description: ""
36
+ default_behavior:
37
+ auto_detection:
38
+ description: By default, this collector will attempt to connect to the `hddtemp` daemon on `127.0.0.1:7634`
39
+ limits:
40
+ description: ""
41
+ performance_impact:
42
+ description: ""
43
+ setup:
44
+ prerequisites:
45
+ list:
46
+ - title: Run `hddtemp` in daemon mode
47
+ description: |
48
+ You can execute `hddtemp` in TCP/IP daemon mode by using the `-d` argument.
49
+
50
+ So running `hddtemp -d` would run the daemon, by default on port 7634.
51
+ configuration:
52
+ file:
53
+ name: "python.d/hddtemp.conf"
54
+ options:
55
description: |
129
- > **Note**: When you define multiple jobs, their names must be unique.
130
-
131
- Collecting metrics from local and remote instances.
132
- config: |
133
- localhost:
134
- name: 'local'
135
- host: '127.0.0.1'
136
- port: 7634
137
-
138
- remote_job:
139
- name : 'remote'
140
- host : 'http://192.0.2.1:2812'
141
-troubleshooting:
142
- problems:
143
- list: []
144
-alerts: []
145
-metrics:
146
- folding:
147
- title: Metrics
148
- enabled: false
149
- description: ""
150
- availability: []
151
- scopes:
152
- - name: global
153
- description: "These metrics refer to the entire monitored application."
154
- labels: []
155
- metrics:
156
- - name: hddtemp.temperatures
157
- description: Disk Temperatures
158
- unit: "Celsius"
159
- chart_type: line
160
- dimensions:
161
- - name: a dimension per disk
56
+ There are 2 sections:
57
+
58
+ * Global variables
59
+ * One or more JOBS that can define multiple different instances to monitor.
60
+
61
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
62
+
63
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
64
+
65
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
66
+
67
+ By default this collector will try to autodetect disks (autodetection works only for disk which names start with "sd"). However this can be overridden by setting the option `disks` to an array of desired disks.
68
+ folding:
69
+ title: "Config options"
70
+ enabled: true
71
+ list:
72
+ - name: update_every
73
+ description: Sets the default data collection frequency.
74
+ default_value: 1
75
+ required: false
76
+ - name: priority
77
+ description: Controls the order of charts at the netdata dashboard.
78
+ default_value: 60000
79
+ required: false
80
+ - name: autodetection_retry
81
+ description: Sets the job re-check interval in seconds.
82
+ default_value: 0
83
+ required: false
84
+ - name: penalty
85
+ description: Indicates whether to apply penalty to update_every in case of failures.
86
+ default_value: yes
87
+ required: false
88
+ - name: name
89
+ description: >
90
+ Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
91
+ default_value: "local"
92
+ required: false
93
+ - name: devices
94
+ description: Array of desired disks to detect, in case their name doesn't start with `sd`.
95
+ default_value: ""
96
+ required: false
97
+ - name: host
98
+ description: The IP or HOSTNAME to connect to.
99
+ default_value: "localhost"
100
+ required: true
101
+ - name: port
102
+ description: The port to connect to.
103
+ default_value: 7634
104
+ required: false
105
+ examples:
106
+ folding:
107
+ enabled: true
108
+ title: ""
109
+ list:
110
+ - name: Basic
111
+ description: A basic example configuration.
112
+ folding:
113
+ enabled: false
114
+ config: |
115
+ localhost:
116
+ name: 'local'
117
+ host: '127.0.0.1'
118
+ port: 7634
119
+ - name: Custom disk names
120
+ description: An example defining the disk names to detect.
121
+ config: |
122
+ localhost:
123
+ name: 'local'
124
+ host: '127.0.0.1'
125
+ port: 7634
126
+ devices:
127
+ - customdisk1
128
+ - customdisk2
129
+ - name: Multi-instance
130
+ description: |
131
+ > **Note**: When you define multiple jobs, their names must be unique.
132
+
133
+ Collecting metrics from local and remote instances.
134
+ config: |
135
+ localhost:
136
+ name: 'local'
137
+ host: '127.0.0.1'
138
+ port: 7634
139
+
140
+ remote_job:
141
+ name : 'remote'
142
+ host : 'http://192.0.2.1:2812'
143
+ troubleshooting:
144
+ problems:
145
+ list: []
146
+ alerts: []
147
+ metrics:
148
+ folding:
149
+ title: Metrics
150
+ enabled: false
151
+ description: ""
152
+ availability: []
153
+ scopes:
154
+ - name: global
155
+ description: "These metrics refer to the entire monitored application."
156
+ labels: []
157
+ metrics:
158
+ - name: hddtemp.temperatures
159
+ description: Disk Temperatures
160
+ unit: "Celsius"
161
+ chart_type: line
162
+ dimensions:
163
+ - name: a dimension per disk
collectors/python.d.plugin/hpssa/metadata.yaml
+172
-170
@@ -1,173 +1,175 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: hpssa
4
- monitored_instance:
5
- name: HP Smart Storage Arrays
6
- link: 'https://buy.hpe.com/us/en/software/server-management-software/server-management-software/smart-array-management-software/hpe-smart-storage-administrator/p/5409020'
7
- categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: 'hp.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - storage
17
- - hp
18
- - hpssa
19
- - array
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: 'This collector monitors HP Smart Storage Arrays metrics about operational statuses and temperatures.'
24
- method_description: 'It uses the command line tool `ssacli`. The exact command used is `sudo -n ssacli ctrl all show config detail`'
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: false
29
- additional_permissions:
30
- description: ''
31
- default_behavior:
32
- auto_detection:
33
- description: 'If no configuration is provided, the collector will try to execute the `ssacli` binary.'
34
- limits:
35
- description: ''
36
- performance_impact:
37
- description: ''
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: 'Allow user netdata to execute `ssacli` as root.'
42
- description: |
43
- This module uses `ssacli`, which can only be executed by root. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `ssacli` as root without a password.
44
-
45
- - Add to your `/etc/sudoers` file:
46
-
47
- `which ssacli` shows the full path to the binary.
48
-
49
- ```bash
50
- netdata ALL=(root) NOPASSWD: /path/to/ssacli
51
- ```
52
-
53
- - Reset Netdata's systemd
54
- unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux
55
- distributions with systemd)
56
-
57
- The default CapabilityBoundingSet doesn't allow using `sudo`, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute `ssacli` using `sudo`.
58
-
59
- As the `root` user, do the following:
60
-
61
- ```cmd
62
- mkdir /etc/systemd/system/netdata.service.d
63
- echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
64
- systemctl daemon-reload
65
- systemctl restart netdata.service
66
- ```
67
- configuration:
68
- file:
69
- name: python.d/hpssa.conf
70
- options:
71
- description: |
72
- There are 2 sections:
73
-
74
- * Global variables
75
- * One or more JOBS that can define multiple different instances to monitor.
76
-
77
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
78
-
79
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
80
-
81
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
82
- folding:
83
- title: "Config options"
84
- enabled: true
85
- list:
86
- - name: update_every
87
- description: Sets the default data collection frequency.
88
- default_value: 5
89
- required: false
90
- - name: priority
91
- description: Controls the order of charts at the netdata dashboard.
92
- default_value: 60000
93
- required: false
94
- - name: autodetection_retry
95
- description: Sets the job re-check interval in seconds.
96
- default_value: 0
97
- required: false
98
- - name: penalty
99
- description: Indicates whether to apply penalty to update_every in case of failures.
100
- default_value: yes
101
- required: false
102
- - name: name
103
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
104
- default_value: ''
105
- required: false
106
- - name: ssacli_path
107
- description: Path to the `ssacli` command line utility. Configure this if `ssacli` is not in the $PATH
108
- default_value: ''
109
- required: false
110
- - name: use_sudo
111
- description: Whether or not to use `sudo` to execute `ssacli`
112
- default_value: 'True'
113
- required: false
114
- examples:
115
- folding:
116
- enabled: false
117
- title: "Config"
118
- list:
119
- - name: Local simple config
120
- description: A basic configuration, specyfing the path to `ssacli`
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: hpssa
6
+ monitored_instance:
7
+ name: HP Smart Storage Arrays
8
+ link: 'https://buy.hpe.com/us/en/software/server-management-software/server-management-software/smart-array-management-software/hpe-smart-storage-administrator/p/5409020'
9
+ categories:
10
+ - data-collection.storage-mount-points-and-filesystems
11
+ icon_filename: 'hp.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - storage
19
+ - hp
20
+ - hpssa
21
+ - array
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: 'This collector monitors HP Smart Storage Arrays metrics about operational statuses and temperatures.'
26
+ method_description: 'It uses the command line tool `ssacli`. The exact command used is `sudo -n ssacli ctrl all show config detail`'
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: false
31
+ additional_permissions:
32
+ description: ''
33
+ default_behavior:
34
+ auto_detection:
35
+ description: 'If no configuration is provided, the collector will try to execute the `ssacli` binary.'
36
+ limits:
37
+ description: ''
38
+ performance_impact:
39
+ description: ''
40
+ setup:
41
+ prerequisites:
42
+ list:
43
+ - title: 'Allow user netdata to execute `ssacli` as root.'
44
+ description: |
45
+ This module uses `ssacli`, which can only be executed by root. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `ssacli` as root without a password.
46
+
47
+ - Add to your `/etc/sudoers` file:
48
+
49
+ `which ssacli` shows the full path to the binary.
50
+
51
+ ```bash
52
+ netdata ALL=(root) NOPASSWD: /path/to/ssacli
53
+ ```
54
+
55
+ - Reset Netdata's systemd
56
+ unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux
57
+ distributions with systemd)
58
+
59
+ The default CapabilityBoundingSet doesn't allow using `sudo`, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute `ssacli` using `sudo`.
60
+
61
+ As the `root` user, do the following:
62
+
63
+ ```cmd
64
+ mkdir /etc/systemd/system/netdata.service.d
65
+ echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
66
+ systemctl daemon-reload
67
+ systemctl restart netdata.service
68
+ ```
69
+ configuration:
70
+ file:
71
+ name: python.d/hpssa.conf
72
+ options:
73
+ description: |
74
+ There are 2 sections:
75
+
76
+ * Global variables
77
+ * One or more JOBS that can define multiple different instances to monitor.
78
+
79
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
80
+
81
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
82
+
83
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
84
+ folding:
85
+ title: "Config options"
86
+ enabled: true
87
+ list:
88
+ - name: update_every
89
+ description: Sets the default data collection frequency.
90
+ default_value: 5
91
+ required: false
92
+ - name: priority
93
+ description: Controls the order of charts at the netdata dashboard.
94
+ default_value: 60000
95
+ required: false
96
+ - name: autodetection_retry
97
+ description: Sets the job re-check interval in seconds.
98
+ default_value: 0
99
+ required: false
100
+ - name: penalty
101
+ description: Indicates whether to apply penalty to update_every in case of failures.
102
+ default_value: yes
103
+ required: false
104
+ - name: name
105
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
106
+ default_value: ''
107
+ required: false
108
+ - name: ssacli_path
109
+ description: Path to the `ssacli` command line utility. Configure this if `ssacli` is not in the $PATH
110
+ default_value: ''
111
+ required: false
112
+ - name: use_sudo
113
+ description: Whether or not to use `sudo` to execute `ssacli`
114
+ default_value: 'True'
115
+ required: false
116
+ examples:
117
folding:
118
enabled: false
123
- config: |
124
- local:
125
- ssacli_path: /usr/sbin/ssacli
126
-troubleshooting:
127
- problems:
128
- list: []
129
-alerts: []
130
-metrics:
131
- folding:
132
- title: Metrics
133
- enabled: false
134
- description: ""
135
- availability: []
136
- scopes:
137
- - name: global
138
- description: "These metrics refer to the entire monitored application."
139
- labels: []
119
+ title: "Config"
120
+ list:
121
+ - name: Local simple config
122
+ description: A basic configuration, specyfing the path to `ssacli`
123
+ folding:
124
+ enabled: false
125
+ config: |
126
+ local:
127
+ ssacli_path: /usr/sbin/ssacli
128
+ troubleshooting:
129
+ problems:
130
+ list: []
131
+ alerts: []
132
metrics:
141
- - name: hpssa.ctrl_status
142
- description: Status 1 is OK, Status 0 is not OK
143
- unit: "Status"
144
- chart_type: line
145
- dimensions:
146
- - name: ctrl_{adapter slot}_status
147
- - name: cache_{adapter slot}_status
148
- - name: battery_{adapter slot}_status per adapter
149
- - name: hpssa.ctrl_temperature
150
- description: Temperature
151
- unit: "Celsius"
152
- chart_type: line
153
- dimensions:
154
- - name: ctrl_{adapter slot}_temperature
155
- - name: cache_{adapter slot}_temperature per adapter
156
- - name: hpssa.ld_status
157
- description: Status 1 is OK, Status 0 is not OK
158
- unit: "Status"
159
- chart_type: line
160
- dimensions:
161
- - name: a dimension per logical drive
162
- - name: hpssa.pd_status
163
- description: Status 1 is OK, Status 0 is not OK
164
- unit: "Status"
165
- chart_type: line
166
- dimensions:
167
- - name: a dimension per physical drive
168
- - name: hpssa.pd_temperature
169
- description: Temperature
170
- unit: "Celsius"
171
- chart_type: line
172
- dimensions:
173
- - name: a dimension per physical drive
133
+ folding:
134
+ title: Metrics
135
+ enabled: false
136
+ description: ""
137
+ availability: []
138
+ scopes:
139
+ - name: global
140
+ description: "These metrics refer to the entire monitored application."
141
+ labels: []
142
+ metrics:
143
+ - name: hpssa.ctrl_status
144
+ description: Status 1 is OK, Status 0 is not OK
145
+ unit: "Status"
146
+ chart_type: line
147
+ dimensions:
148
+ - name: ctrl_{adapter slot}_status
149
+ - name: cache_{adapter slot}_status
150
+ - name: battery_{adapter slot}_status per adapter
151
+ - name: hpssa.ctrl_temperature
152
+ description: Temperature
153
+ unit: "Celsius"
154
+ chart_type: line
155
+ dimensions:
156
+ - name: ctrl_{adapter slot}_temperature
157
+ - name: cache_{adapter slot}_temperature per adapter
158
+ - name: hpssa.ld_status
159
+ description: Status 1 is OK, Status 0 is not OK
160
+ unit: "Status"
161
+ chart_type: line
162
+ dimensions:
163
+ - name: a dimension per logical drive
164
+ - name: hpssa.pd_status
165
+ description: Status 1 is OK, Status 0 is not OK
166
+ unit: "Status"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: a dimension per physical drive
170
+ - name: hpssa.pd_temperature
171
+ description: Temperature
172
+ unit: "Celsius"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: a dimension per physical drive
collectors/python.d.plugin/icecast/metadata.yaml
+124
-122
@@ -1,125 +1,127 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: icecast
4
- monitored_instance:
5
- name: Icecast
6
- link: 'https://icecast.org/'
7
- categories:
8
- - data-collection.media-streaming-servers
9
- icon_filename: 'icecast.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - icecast
17
- - streaming
18
- - media
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: 'This collector monitors Icecast listener counts.'
23
- method_description: 'It connects to an icecast URL and uses the `status-json.xsl` endpoint to retrieve statistics.'
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ''
30
- default_behavior:
31
- auto_detection:
32
- description: 'Without configuration, the collector attempts to connect to http://localhost:8443/status-json.xsl'
33
- limits:
34
- description: ''
35
- performance_impact:
36
- description: ''
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: 'Icecast minimum version'
41
- description: 'Needs at least icecast version >= 2.4.0'
42
- configuration:
43
- file:
44
- name: python.d/icecast.conf
45
- options:
46
- description: |
47
- There are 2 sections:
48
-
49
- * Global variables
50
- * One or more JOBS that can define multiple different instances to monitor.
51
-
52
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
53
-
54
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
-
56
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
- folding:
58
- title: "Config options"
59
- enabled: true
60
- list:
61
- - name: update_every
62
- description: Sets the default data collection frequency.
63
- default_value: 5
64
- required: false
65
- - name: priority
66
- description: Controls the order of charts at the netdata dashboard.
67
- default_value: 60000
68
- required: false
69
- - name: autodetection_retry
70
- description: Sets the job re-check interval in seconds.
71
- default_value: 0
72
- required: false
73
- - name: penalty
74
- description: Indicates whether to apply penalty to update_every in case of failures.
75
- default_value: yes
76
- required: false
77
- - name: name
78
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
- default_value: ''
80
- required: false
81
- - name: url
82
- description: The URL (and port) to the icecast server. Needs to also include `/status-json.xsl`
83
- default_value: 'http://localhost:8443/status-json.xsl'
84
- required: false
85
- - name: user
86
- description: Username to use to connect to `url` if it's password protected.
87
- default_value: ''
88
- required: false
89
- - name: pass
90
- description: Password to use to connect to `url` if it's password protected.
91
- default_value: ''
92
- required: false
93
- examples:
94
- folding:
95
- enabled: false
96
- title: "Config"
97
- list:
98
- - name: Remote Icecast server
99
- description: Configure a remote icecast server
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: icecast
6
+ monitored_instance:
7
+ name: Icecast
8
+ link: 'https://icecast.org/'
9
+ categories:
10
+ - data-collection.media-streaming-servers
11
+ icon_filename: 'icecast.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - icecast
19
+ - streaming
20
+ - media
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: 'This collector monitors Icecast listener counts.'
25
+ method_description: 'It connects to an icecast URL and uses the `status-json.xsl` endpoint to retrieve statistics.'
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: true
30
+ additional_permissions:
31
+ description: ''
32
+ default_behavior:
33
+ auto_detection:
34
+ description: 'Without configuration, the collector attempts to connect to http://localhost:8443/status-json.xsl'
35
+ limits:
36
+ description: ''
37
+ performance_impact:
38
+ description: ''
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: 'Icecast minimum version'
43
+ description: 'Needs at least icecast version >= 2.4.0'
44
+ configuration:
45
+ file:
46
+ name: python.d/icecast.conf
47
+ options:
48
+ description: |
49
+ There are 2 sections:
50
+
51
+ * Global variables
52
+ * One or more JOBS that can define multiple different instances to monitor.
53
+
54
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
55
+
56
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
+
58
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
+ folding:
60
+ title: "Config options"
61
+ enabled: true
62
+ list:
63
+ - name: update_every
64
+ description: Sets the default data collection frequency.
65
+ default_value: 5
66
+ required: false
67
+ - name: priority
68
+ description: Controls the order of charts at the netdata dashboard.
69
+ default_value: 60000
70
+ required: false
71
+ - name: autodetection_retry
72
+ description: Sets the job re-check interval in seconds.
73
+ default_value: 0
74
+ required: false
75
+ - name: penalty
76
+ description: Indicates whether to apply penalty to update_every in case of failures.
77
+ default_value: yes
78
+ required: false
79
+ - name: name
80
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
+ default_value: ''
82
+ required: false
83
+ - name: url
84
+ description: The URL (and port) to the icecast server. Needs to also include `/status-json.xsl`
85
+ default_value: 'http://localhost:8443/status-json.xsl'
86
+ required: false
87
+ - name: user
88
+ description: Username to use to connect to `url` if it's password protected.
89
+ default_value: ''
90
+ required: false
91
+ - name: pass
92
+ description: Password to use to connect to `url` if it's password protected.
93
+ default_value: ''
94
+ required: false
95
+ examples:
96
folding:
97
enabled: false
102
- config: |
103
- remote:
104
- url: 'http://1.2.3.4:8443/status-json.xsl'
105
-troubleshooting:
106
- problems:
107
- list: []
108
-alerts: []
109
-metrics:
110
- folding:
111
- title: Metrics
112
- enabled: false
113
- description: ""
114
- availability: []
115
- scopes:
116
- - name: global
117
- description: "These metrics refer to the entire monitored application."
118
- labels: []
98
+ title: "Config"
99
+ list:
100
+ - name: Remote Icecast server
101
+ description: Configure a remote icecast server
102
+ folding:
103
+ enabled: false
104
+ config: |
105
+ remote:
106
+ url: 'http://1.2.3.4:8443/status-json.xsl'
107
+ troubleshooting:
108
+ problems:
109
+ list: []
110
+ alerts: []
111
metrics:
120
- - name: icecast.listeners
121
- description: Number Of Listeners
122
- unit: "listeners"
123
- chart_type: line
124
- dimensions:
125
- - name: a dimension for each active source
112
+ folding:
113
+ title: Metrics
114
+ enabled: false
115
+ description: ""
116
+ availability: []
117
+ scopes:
118
+ - name: global
119
+ description: "These metrics refer to the entire monitored application."
120
+ labels: []
121
+ metrics:
122
+ - name: icecast.listeners
123
+ description: Number Of Listeners
124
+ unit: "listeners"
125
+ chart_type: line
126
+ dimensions:
127
+ - name: a dimension for each active source
collectors/python.d.plugin/ipfs/metadata.yaml
+171
-169
@@ -1,170 +1,172 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: ipfs
4
- monitored_instance:
5
- name: IPFS
6
- link: "https://ipfs.tech/"
7
- categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: "ipfs.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords: []
16
- most_popular: false
17
-overview:
18
- data_collection:
19
- metrics_description: "This collector monitors IPFS server metrics about its quality and performance."
20
- method_description: "It connects to an http endpoint of the IPFS server to collect the metrics"
21
- supported_platforms:
22
- include: []
23
- exclude: []
24
- multi_instance: true
25
- additional_permissions:
26
- description: ""
27
- default_behavior:
28
- auto_detection:
29
- description: "If the endpoint is accessible by the Agent, netdata will autodetect it"
30
- limits:
31
- description: |
32
- Calls to the following endpoints are disabled due to IPFS bugs:
33
-
34
- /api/v0/stats/repo (https://github.com/ipfs/go-ipfs/issues/3874)
35
- /api/v0/pin/ls (https://github.com/ipfs/go-ipfs/issues/7528)
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list: []
41
- configuration:
42
- file:
43
- name: "python.d/ipfs.conf"
44
- options:
45
- description: |
46
- There are 2 sections:
47
-
48
- * Global variables
49
- * One or more JOBS that can define multiple different instances to monitor.
50
-
51
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
52
-
53
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
54
-
55
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
56
- folding:
57
- title: ""
58
- enabled: true
59
- list:
60
- - name: update_every
61
- description: Sets the default data collection frequency.
62
- default_value: 5
63
- required: false
64
- - name: priority
65
- description: Controls the order of charts at the netdata dashboard.
66
- default_value: 60000
67
- required: false
68
- - name: autodetection_retry
69
- description: Sets the job re-check interval in seconds.
70
- default_value: 0
71
- required: false
72
- - name: penalty
73
- description: Indicates whether to apply penalty to update_every in case of failures.
74
- default_value: yes
75
- required: false
76
- - name: name
77
- description: The JOB's name as it will appear at the dashboard (by default is the job_name)
78
- default_value: job_name
79
- required: false
80
- - name: url
81
- description: URL to the IPFS API
82
- default_value: no
83
- required: true
84
- - name: repoapi
85
- description: Collect repo metrics.
86
- default_value: no
87
- required: false
88
- - name: pinapi
89
- description: Set status of IPFS pinned object polling.
90
- default_value: no
91
- required: false
92
- examples:
93
- folding:
94
- enabled: true
95
- title: "Config"
96
- list:
97
- - name: Basic (default out-of-the-box)
98
- description: A basic example configuration, one job will run at a time. Autodetect mechanism uses it by default.
99
- folding:
100
- enabled: false
101
- config: |
102
- localhost:
103
- name: 'local'
104
- url: 'http://localhost:5001'
105
- repoapi: no
106
- pinapi: no
107
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: ipfs
6
+ monitored_instance:
7
+ name: IPFS
8
+ link: "https://ipfs.tech/"
9
+ categories:
10
+ - data-collection.storage-mount-points-and-filesystems
11
+ icon_filename: "ipfs.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords: []
18
+ most_popular: false
19
+ overview:
20
+ data_collection:
21
+ metrics_description: "This collector monitors IPFS server metrics about its quality and performance."
22
+ method_description: "It connects to an http endpoint of the IPFS server to collect the metrics"
23
+ supported_platforms:
24
+ include: []
25
+ exclude: []
26
+ multi_instance: true
27
+ additional_permissions:
28
+ description: ""
29
+ default_behavior:
30
+ auto_detection:
31
+ description: "If the endpoint is accessible by the Agent, netdata will autodetect it"
32
+ limits:
33
+ description: |
34
+ Calls to the following endpoints are disabled due to IPFS bugs:
35
+
36
+ /api/v0/stats/repo (https://github.com/ipfs/go-ipfs/issues/3874)
37
+ /api/v0/pin/ls (https://github.com/ipfs/go-ipfs/issues/7528)
38
+ performance_impact:
39
+ description: ""
40
+ setup:
41
+ prerequisites:
42
+ list: []
43
+ configuration:
44
+ file:
45
+ name: "python.d/ipfs.conf"
46
+ options:
47
description: |
109
- > **Note**: When you define multiple jobs, their names must be unique.
110
-
111
- Collecting metrics from local and remote instances.
112
- config: |
113
- localhost:
114
- name: 'local'
115
- url: 'http://localhost:5001'
116
- repoapi: no
117
- pinapi: no
118
-
119
- remote_host:
120
- name: 'remote'
121
- url: 'http://192.0.2.1:5001'
122
- repoapi: no
123
- pinapi: no
124
-troubleshooting:
125
- problems:
126
- list: []
127
-alerts:
128
- - name: ipfs_datastore_usage
129
- link: https://github.com/netdata/netdata/blob/master/health/health.d/ipfs.conf
130
- metric: ipfs.repo_size
131
- info: IPFS datastore utilization
132
-metrics:
133
- folding:
134
- title: Metrics
135
- enabled: false
136
- description: ""
137
- availability: []
138
- scopes:
139
- - name: global
140
- description: "These metrics refer to the entire monitored application."
141
- labels: []
142
- metrics:
143
- - name: ipfs.bandwidth
144
- description: IPFS Bandwidth
145
- unit: "kilobits/s"
146
- chart_type: line
147
- dimensions:
148
- - name: in
149
- - name: out
150
- - name: ipfs.peers
151
- description: IPFS Peers
152
- unit: "peers"
153
- chart_type: line
154
- dimensions:
155
- - name: peers
156
- - name: ipfs.repo_size
157
- description: IPFS Repo Size
158
- unit: "GiB"
159
- chart_type: area
160
- dimensions:
161
- - name: avail
162
- - name: size
163
- - name: ipfs.repo_objects
164
- description: IPFS Repo Objects
165
- unit: "objects"
166
- chart_type: line
167
- dimensions:
168
- - name: objects
169
- - name: pinned
170
- - name: recursive_pins
48
+ There are 2 sections:
49
+
50
+ * Global variables
51
+ * One or more JOBS that can define multiple different instances to monitor.
52
+
53
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
54
+
55
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
+
57
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
+ folding:
59
+ title: ""
60
+ enabled: true
61
+ list:
62
+ - name: update_every
63
+ description: Sets the default data collection frequency.
64
+ default_value: 5
65
+ required: false
66
+ - name: priority
67
+ description: Controls the order of charts at the netdata dashboard.
68
+ default_value: 60000
69
+ required: false
70
+ - name: autodetection_retry
71
+ description: Sets the job re-check interval in seconds.
72
+ default_value: 0
73
+ required: false
74
+ - name: penalty
75
+ description: Indicates whether to apply penalty to update_every in case of failures.
76
+ default_value: yes
77
+ required: false
78
+ - name: name
79
+ description: The JOB's name as it will appear at the dashboard (by default is the job_name)
80
+ default_value: job_name
81
+ required: false
82
+ - name: url
83
+ description: URL to the IPFS API
84
+ default_value: no
85
+ required: true
86
+ - name: repoapi
87
+ description: Collect repo metrics.
88
+ default_value: no
89
+ required: false
90
+ - name: pinapi
91
+ description: Set status of IPFS pinned object polling.
92
+ default_value: no
93
+ required: false
94
+ examples:
95
+ folding:
96
+ enabled: true
97
+ title: "Config"
98
+ list:
99
+ - name: Basic (default out-of-the-box)
100
+ description: A basic example configuration, one job will run at a time. Autodetect mechanism uses it by default.
101
+ folding:
102
+ enabled: false
103
+ config: |
104
+ localhost:
105
+ name: 'local'
106
+ url: 'http://localhost:5001'
107
+ repoapi: no
108
+ pinapi: no
109
+ - name: Multi-instance
110
+ description: |
111
+ > **Note**: When you define multiple jobs, their names must be unique.
112
+
113
+ Collecting metrics from local and remote instances.
114
+ config: |
115
+ localhost:
116
+ name: 'local'
117
+ url: 'http://localhost:5001'
118
+ repoapi: no
119
+ pinapi: no
120
+
121
+ remote_host:
122
+ name: 'remote'
123
+ url: 'http://192.0.2.1:5001'
124
+ repoapi: no
125
+ pinapi: no
126
+ troubleshooting:
127
+ problems:
128
+ list: []
129
+ alerts:
130
+ - name: ipfs_datastore_usage
131
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/ipfs.conf
132
+ metric: ipfs.repo_size
133
+ info: IPFS datastore utilization
134
+ metrics:
135
+ folding:
136
+ title: Metrics
137
+ enabled: false
138
+ description: ""
139
+ availability: []
140
+ scopes:
141
+ - name: global
142
+ description: "These metrics refer to the entire monitored application."
143
+ labels: []
144
+ metrics:
145
+ - name: ipfs.bandwidth
146
+ description: IPFS Bandwidth
147
+ unit: "kilobits/s"
148
+ chart_type: line
149
+ dimensions:
150
+ - name: in
151
+ - name: out
152
+ - name: ipfs.peers
153
+ description: IPFS Peers
154
+ unit: "peers"
155
+ chart_type: line
156
+ dimensions:
157
+ - name: peers
158
+ - name: ipfs.repo_size
159
+ description: IPFS Repo Size
160
+ unit: "GiB"
161
+ chart_type: area
162
+ dimensions:
163
+ - name: avail
164
+ - name: size
165
+ - name: ipfs.repo_objects
166
+ description: IPFS Repo Objects
167
+ unit: "objects"
168
+ chart_type: line
169
+ dimensions:
170
+ - name: objects
171
+ - name: pinned
172
+ - name: recursive_pins
collectors/python.d.plugin/litespeed/metadata.yaml
+166
-165
@@ -1,167 +1,168 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: litespeed
5
- monitored_instance:
6
- name: Litespeed
7
- link: "https://www.litespeedtech.com/products/litespeed-web-server"
8
- categories:
9
- - data-collection.web-servers-and-web-proxies
10
- icon_filename: "litespeed.svg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - litespeed
18
- - web
19
- - server
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "Examine Litespeed metrics for insights into web server operations. Analyze request rates, response times, and error rates for efficient web service delivery."
24
- method_description: "The collector uses the statistics under /tmp/lshttpd to gather the metrics."
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: false
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: "If no configuration is present, the collector will attempt to read files under /tmp/lshttpd/."
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list: []
41
- configuration:
42
- file:
43
- name: python.d/litespeed.conf
44
- options:
45
- description: |
46
- There are 2 sections:
47
-
48
- * Global variables
49
- * One or more JOBS that can define multiple different instances to monitor.
50
-
51
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
52
-
53
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
54
-
55
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
56
- folding:
57
- title: "Config options"
58
- enabled: true
59
- list:
60
- - name: update_every
61
- description: Sets the default data collection frequency.
62
- default_value: 5
63
- required: false
64
- - name: priority
65
- description: Controls the order of charts at the netdata dashboard.
66
- default_value: 60000
67
- required: false
68
- - name: autodetection_retry
69
- description: Sets the job re-check interval in seconds.
70
- default_value: 0
71
- required: false
72
- - name: penalty
73
- description: Indicates whether to apply penalty to update_every in case of failures.
74
- default_value: yes
75
- required: false
76
- - name: name
77
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
78
- default_value: ""
79
- required: false
80
- - name: path
81
- description: Use a different path than the default, where the lightspeed stats files reside.
82
- default_value: "/tmp/lshttpd/"
83
- required: false
84
- examples:
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: litespeed
6
+ monitored_instance:
7
+ name: Litespeed
8
+ link: "https://www.litespeedtech.com/products/litespeed-web-server"
9
+ categories:
10
+ - data-collection.web-servers-and-web-proxies
11
+ icon_filename: "litespeed.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - litespeed
19
+ - web
20
+ - server
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "Examine Litespeed metrics for insights into web server operations. Analyze request rates, response times, and error rates for efficient web service delivery."
25
+ method_description: "The collector uses the statistics under /tmp/lshttpd to gather the metrics."
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: false
30
+ additional_permissions:
31
+ description: ""
32
+ default_behavior:
33
+ auto_detection:
34
+ description: "If no configuration is present, the collector will attempt to read files under /tmp/lshttpd/."
35
+ limits:
36
+ description: ""
37
+ performance_impact:
38
+ description: ""
39
+ setup:
40
+ prerequisites:
41
+ list: []
42
+ configuration:
43
+ file:
44
+ name: python.d/litespeed.conf
45
+ options:
46
+ description: |
47
+ There are 2 sections:
48
+
49
+ * Global variables
50
+ * One or more JOBS that can define multiple different instances to monitor.
51
+
52
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
53
+
54
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
+
56
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
+ folding:
58
+ title: "Config options"
59
+ enabled: true
60
+ list:
61
+ - name: update_every
62
+ description: Sets the default data collection frequency.
63
+ default_value: 5
64
+ required: false
65
+ - name: priority
66
+ description: Controls the order of charts at the netdata dashboard.
67
+ default_value: 60000
68
+ required: false
69
+ - name: autodetection_retry
70
+ description: Sets the job re-check interval in seconds.
71
+ default_value: 0
72
+ required: false
73
+ - name: penalty
74
+ description: Indicates whether to apply penalty to update_every in case of failures.
75
+ default_value: yes
76
+ required: false
77
+ - name: name
78
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
+ default_value: ""
80
+ required: false
81
+ - name: path
82
+ description: Use a different path than the default, where the lightspeed stats files reside.
83
+ default_value: "/tmp/lshttpd/"
84
+ required: false
85
+ examples:
86
+ folding:
87
+ enabled: false
88
+ title: "Config"
89
+ list:
90
+ - name: Set the path to statistics
91
+ description: Change the path for the litespeed stats files
92
+ config: |
93
+ localhost:
94
+ name: 'local'
95
+ path: '/tmp/lshttpd'
96
+ troubleshooting:
97
+ problems:
98
+ list: []
99
+ alerts: []
100
+ metrics:
101
folding:
102
+ title: Metrics
103
enabled: false
87
- title: "Config"
88
- list:
89
- - name: Set the path to statistics
90
- description: Change the path for the litespeed stats files
91
- config: |
92
- localhost:
93
- name: 'local'
94
- path: '/tmp/lshttpd'
95
-troubleshooting:
96
- problems:
97
- list: []
98
-alerts: []
99
-metrics:
100
- folding:
101
- title: Metrics
102
- enabled: false
103
- description: ""
104
- availability: []
105
- scopes:
106
- - name: global
107
- description: "These metrics refer to the entire monitored application."
108
- labels: []
109
- metrics:
110
- - name: litespeed.net_throughput
111
- description: Network Throughput HTTP
112
- unit: "kilobits/s"
113
- chart_type: area
114
- dimensions:
115
- - name: in
116
- - name: out
117
- - name: litespeed.net_throughput
118
- description: Network Throughput HTTPS
119
- unit: "kilobits/s"
120
- chart_type: area
121
- dimensions:
122
- - name: in
123
- - name: out
124
- - name: litespeed.connections
125
- description: Connections HTTP
126
- unit: "conns"
127
- chart_type: stacked
128
- dimensions:
129
- - name: free
130
- - name: used
131
- - name: litespeed.connections
132
- description: Connections HTTPS
133
- unit: "conns"
134
- chart_type: stacked
135
- dimensions:
136
- - name: free
137
- - name: used
138
- - name: litespeed.requests
139
- description: Requests
140
- unit: "requests/s"
141
- chart_type: line
142
- dimensions:
143
- - name: requests
144
- - name: litespeed.requests_processing
145
- description: Requests In Processing
146
- unit: "requests"
147
- chart_type: line
148
- dimensions:
149
- - name: processing
150
- - name: litespeed.cache
151
- description: Public Cache Hits
152
- unit: "hits/s"
153
- chart_type: line
154
- dimensions:
155
- - name: hits
156
- - name: litespeed.cache
157
- description: Private Cache Hits
158
- unit: "hits/s"
159
- chart_type: line
160
- dimensions:
161
- - name: hits
162
- - name: litespeed.static
163
- description: Static Hits
164
- unit: "hits/s"
165
- chart_type: line
166
- dimensions:
167
- - name: hits
104
+ description: ""
105
+ availability: []
106
+ scopes:
107
+ - name: global
108
+ description: "These metrics refer to the entire monitored application."
109
+ labels: []
110
+ metrics:
111
+ - name: litespeed.net_throughput
112
+ description: Network Throughput HTTP
113
+ unit: "kilobits/s"
114
+ chart_type: area
115
+ dimensions:
116
+ - name: in
117
+ - name: out
118
+ - name: litespeed.net_throughput
119
+ description: Network Throughput HTTPS
120
+ unit: "kilobits/s"
121
+ chart_type: area
122
+ dimensions:
123
+ - name: in
124
+ - name: out
125
+ - name: litespeed.connections
126
+ description: Connections HTTP
127
+ unit: "conns"
128
+ chart_type: stacked
129
+ dimensions:
130
+ - name: free
131
+ - name: used
132
+ - name: litespeed.connections
133
+ description: Connections HTTPS
134
+ unit: "conns"
135
+ chart_type: stacked
136
+ dimensions:
137
+ - name: free
138
+ - name: used
139
+ - name: litespeed.requests
140
+ description: Requests
141
+ unit: "requests/s"
142
+ chart_type: line
143
+ dimensions:
144
+ - name: requests
145
+ - name: litespeed.requests_processing
146
+ description: Requests In Processing
147
+ unit: "requests"
148
+ chart_type: line
149
+ dimensions:
150
+ - name: processing
151
+ - name: litespeed.cache
152
+ description: Public Cache Hits
153
+ unit: "hits/s"
154
+ chart_type: line
155
+ dimensions:
156
+ - name: hits
157
+ - name: litespeed.cache
158
+ description: Private Cache Hits
159
+ unit: "hits/s"
160
+ chart_type: line
161
+ dimensions:
162
+ - name: hits
163
+ - name: litespeed.static
164
+ description: Static Hits
165
+ unit: "hits/s"
166
+ chart_type: line
167
+ dimensions:
168
+ - name: hits
collectors/python.d.plugin/megacli/metadata.yaml
+192
-191
@@ -1,192 +1,193 @@
1
-# yaml-language-server: $schema=https://raw.githubusercontent.com/netdata/netdata/master/integrations/schemas/collection-single-module.json
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: megacli
5
- monitored_instance:
6
- name: MegaCLI
7
- link: "https://wikitech.wikimedia.org/wiki/MegaCli"
8
- categories:
9
- - data-collection.storage-mount-points-and-filesystems
10
- icon_filename: "hard-drive.svg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - storage
18
- - raid-controller
19
- - manage-disks
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "Examine MegaCLI metrics with Netdata for insights into RAID controller performance. Improve your RAID controller efficiency with real-time MegaCLI metrics."
24
- method_description: |
25
- Collects adapter, physical drives and battery stats using megacli command-line tool
26
-
27
- Executed commands:
28
-
29
- sudo -n megacli -LDPDInfo -aAll
30
- sudo -n megacli -AdpBbuCmd -a0
31
- supported_platforms:
32
- include: []
33
- exclude: []
34
- multi_instance: false
35
- additional_permissions:
36
- description: "The module uses megacli, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute megacli as root without a password."
37
- default_behavior:
38
- auto_detection:
39
- description: "After all the permissions are satisfied, netdata should be to execute commands via the megacli command line utility"
40
- limits:
41
- description: ""
42
- performance_impact:
43
- description: ""
44
-setup:
45
- prerequisites:
46
- list:
47
- - title: Grant permissions for netdata, to run megacli as sudoer
48
- description: |
49
- The module uses megacli, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute megacli as root without a password.
50
-
51
- Add to your /etc/sudoers file:
52
- which megacli shows the full path to the binary.
53
-
54
- ```bash
55
- netdata ALL=(root) NOPASSWD: /path/to/megacli
56
- ```
57
- - title: "Reset Netdata's systemd unit CapabilityBoundingSet (Linux distributions with systemd)"
58
- description: |
59
- The default CapabilityBoundingSet doesn't allow using sudo, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute arcconf using sudo.
60
-
61
- As root user, do the following:
62
-
63
- ```bash
64
- mkdir /etc/systemd/system/netdata.service.d
65
- echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
66
- systemctl daemon-reload
67
- systemctl restart netdata.service
68
- ```
69
- configuration:
70
- file:
71
- name: "python.d/megacli.conf"
72
- options:
73
- description: |
74
- There are 2 sections:
75
-
76
- * Global variables
77
- * One or more JOBS that can define multiple different instances to monitor.
78
-
79
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
80
-
81
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
82
-
83
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
84
- folding:
85
- title: "Config options"
86
- enabled: true
87
- list:
88
- - name: update_every
89
- description: Sets the default data collection frequency.
90
- default_value: 5
91
- required: false
92
- - name: priority
93
- description: Controls the order of charts at the netdata dashboard.
94
- default_value: 60000
95
- required: false
96
- - name: autodetection_retry
97
- description: Sets the job re-check interval in seconds.
98
- default_value: 0
99
- required: false
100
- - name: penalty
101
- description: Indicates whether to apply penalty to update_every in case of failures.
102
- default_value: yes
103
- required: false
104
- - name: do_battery
105
- description: default is no. Battery stats (adds additional call to megacli `megacli -AdpBbuCmd -a0`).
106
- default_value: no
107
- required: false
108
- examples:
109
- folding:
110
- enabled: true
111
- title: "Config"
112
- list:
113
- - name: Basic
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: megacli
6
+ monitored_instance:
7
+ name: MegaCLI
8
+ link: "https://wikitech.wikimedia.org/wiki/MegaCli"
9
+ categories:
10
+ - data-collection.storage-mount-points-and-filesystems
11
+ icon_filename: "hard-drive.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - storage
19
+ - raid-controller
20
+ - manage-disks
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "Examine MegaCLI metrics with Netdata for insights into RAID controller performance. Improve your RAID controller efficiency with real-time MegaCLI metrics."
25
+ method_description: |
26
+ Collects adapter, physical drives and battery stats using megacli command-line tool
27
+
28
+ Executed commands:
29
+
30
+ sudo -n megacli -LDPDInfo -aAll
31
+ sudo -n megacli -AdpBbuCmd -a0
32
+ supported_platforms:
33
+ include: []
34
+ exclude: []
35
+ multi_instance: false
36
+ additional_permissions:
37
+ description: "The module uses megacli, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute megacli as root without a password."
38
+ default_behavior:
39
+ auto_detection:
40
+ description: "After all the permissions are satisfied, netdata should be to execute commands via the megacli command line utility"
41
+ limits:
42
+ description: ""
43
+ performance_impact:
44
+ description: ""
45
+ setup:
46
+ prerequisites:
47
+ list:
48
+ - title: Grant permissions for netdata, to run megacli as sudoer
49
+ description: |
50
+ The module uses megacli, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute megacli as root without a password.
51
+
52
+ Add to your /etc/sudoers file:
53
+ which megacli shows the full path to the binary.
54
+
55
+ ```bash
56
+ netdata ALL=(root) NOPASSWD: /path/to/megacli
57
+ ```
58
+ - title: "Reset Netdata's systemd unit CapabilityBoundingSet (Linux distributions with systemd)"
59
+ description: |
60
+ The default CapabilityBoundingSet doesn't allow using sudo, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute arcconf using sudo.
61
+
62
+ As root user, do the following:
63
+
64
+ ```bash
65
+ mkdir /etc/systemd/system/netdata.service.d
66
+ echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
67
+ systemctl daemon-reload
68
+ systemctl restart netdata.service
69
+ ```
70
+ configuration:
71
+ file:
72
+ name: "python.d/megacli.conf"
73
+ options:
74
+ description: |
75
+ There are 2 sections:
76
+
77
+ * Global variables
78
+ * One or more JOBS that can define multiple different instances to monitor.
79
+
80
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
81
+
82
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
83
+
84
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
85
folding:
115
- enabled: false
116
- description: A basic example configuration per job
117
- config: |
118
- job_name:
119
- name: myname
120
- update_every: 1
121
- priority: 60000
122
- penalty: yes
123
- autodetection_retry: 0
124
-troubleshooting:
125
- problems:
126
- list: []
127
-alerts:
128
- - name: megacli_adapter_state
129
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
130
- metric: megacli.adapter_degraded
131
- info: "adapter is in the degraded state (0: false, 1: true)"
132
- - name: megacli_pd_media_errors
133
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
134
- metric: megacli.pd_media_error
135
- info: number of physical drive media errors
136
- - name: megacli_pd_predictive_failures
137
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
138
- metric: megacli.pd_predictive_failure
139
- info: number of physical drive predictive failures
140
- - name: megacli_bbu_relative_charge
141
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
142
- metric: megacli.bbu_relative_charge
143
- info: average battery backup unit (BBU) relative state of charge over the last 10 seconds
144
- - name: megacli_bbu_cycle_count
145
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
146
- metric: megacli.bbu_cycle_count
147
- info: average battery backup unit (BBU) charge cycles count over the last 10 seconds
148
-metrics:
149
- folding:
150
- title: Metrics
151
- enabled: false
152
- description: ""
153
- availability: []
154
- scopes:
155
- - name: global
156
- description: "These metrics refer to the entire monitored application."
157
- labels: []
158
- metrics:
159
- - name: megacli.adapter_degraded
160
- description: Adapter State
161
- unit: "is degraded"
162
- chart_type: line
163
- dimensions:
164
- - name: a dimension per adapter
165
- - name: megacli.pd_media_error
166
- description: Physical Drives Media Errors
167
- unit: "errors/s"
168
- chart_type: line
169
- dimensions:
170
- - name: a dimension per physical drive
171
- - name: megacli.pd_predictive_failure
172
- description: Physical Drives Predictive Failures
173
- unit: "failures/s"
174
- chart_type: line
175
- dimensions:
176
- - name: a dimension per physical drive
177
- - name: battery
178
- description: "Metrics related to Battery Backup Units, each BBU provides its own set of the following metrics."
179
- labels: []
180
- metrics:
181
- - name: megacli.bbu_relative_charge
182
- description: Relative State of Charge
183
- unit: "percentage"
184
- chart_type: line
185
- dimensions:
186
- - name: adapter {battery id}
187
- - name: megacli.bbu_cycle_count
188
- description: Cycle Count
189
- unit: "cycle count"
190
- chart_type: line
191
- dimensions:
192
- - name: adapter {battery id}
86
+ title: "Config options"
87
+ enabled: true
88
+ list:
89
+ - name: update_every
90
+ description: Sets the default data collection frequency.
91
+ default_value: 5
92
+ required: false
93
+ - name: priority
94
+ description: Controls the order of charts at the netdata dashboard.
95
+ default_value: 60000
96
+ required: false
97
+ - name: autodetection_retry
98
+ description: Sets the job re-check interval in seconds.
99
+ default_value: 0
100
+ required: false
101
+ - name: penalty
102
+ description: Indicates whether to apply penalty to update_every in case of failures.
103
+ default_value: yes
104
+ required: false
105
+ - name: do_battery
106
+ description: default is no. Battery stats (adds additional call to megacli `megacli -AdpBbuCmd -a0`).
107
+ default_value: no
108
+ required: false
109
+ examples:
110
+ folding:
111
+ enabled: true
112
+ title: "Config"
113
+ list:
114
+ - name: Basic
115
+ folding:
116
+ enabled: false
117
+ description: A basic example configuration per job
118
+ config: |
119
+ job_name:
120
+ name: myname
121
+ update_every: 1
122
+ priority: 60000
123
+ penalty: yes
124
+ autodetection_retry: 0
125
+ troubleshooting:
126
+ problems:
127
+ list: []
128
+ alerts:
129
+ - name: megacli_adapter_state
130
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
131
+ metric: megacli.adapter_degraded
132
+ info: "adapter is in the degraded state (0: false, 1: true)"
133
+ - name: megacli_pd_media_errors
134
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
135
+ metric: megacli.pd_media_error
136
+ info: number of physical drive media errors
137
+ - name: megacli_pd_predictive_failures
138
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
139
+ metric: megacli.pd_predictive_failure
140
+ info: number of physical drive predictive failures
141
+ - name: megacli_bbu_relative_charge
142
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
143
+ metric: megacli.bbu_relative_charge
144
+ info: average battery backup unit (BBU) relative state of charge over the last 10 seconds
145
+ - name: megacli_bbu_cycle_count
146
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
147
+ metric: megacli.bbu_cycle_count
148
+ info: average battery backup unit (BBU) charge cycles count over the last 10 seconds
149
+ metrics:
150
+ folding:
151
+ title: Metrics
152
+ enabled: false
153
+ description: ""
154
+ availability: []
155
+ scopes:
156
+ - name: global
157
+ description: "These metrics refer to the entire monitored application."
158
+ labels: []
159
+ metrics:
160
+ - name: megacli.adapter_degraded
161
+ description: Adapter State
162
+ unit: "is degraded"
163
+ chart_type: line
164
+ dimensions:
165
+ - name: a dimension per adapter
166
+ - name: megacli.pd_media_error
167
+ description: Physical Drives Media Errors
168
+ unit: "errors/s"
169
+ chart_type: line
170
+ dimensions:
171
+ - name: a dimension per physical drive
172
+ - name: megacli.pd_predictive_failure
173
+ description: Physical Drives Predictive Failures
174
+ unit: "failures/s"
175
+ chart_type: line
176
+ dimensions:
177
+ - name: a dimension per physical drive
178
+ - name: battery
179
+ description: "Metrics related to Battery Backup Units, each BBU provides its own set of the following metrics."
180
+ labels: []
181
+ metrics:
182
+ - name: megacli.bbu_relative_charge
183
+ description: Relative State of Charge
184
+ unit: "percentage"
185
+ chart_type: line
186
+ dimensions:
187
+ - name: adapter {battery id}
188
+ - name: megacli.bbu_cycle_count
189
+ description: Cycle Count
190
+ unit: "cycle count"
191
+ chart_type: line
192
+ dimensions:
193
+ - name: adapter {battery id}
collectors/python.d.plugin/memcached/metadata.yaml
+243
-243
@@ -1,247 +1,247 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: memcached
6
- monitored_instance:
7
- name: Memcached
8
- link: https://memcached.org/
9
- categories:
10
- - data-collection.database-servers
11
- icon_filename: "memcached.svg"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - memcached
19
- - memcache
20
- - cache
21
- - database
22
- most_popular: false
23
-overview:
24
- data_collection:
25
- metrics_description: "Monitor Memcached metrics for proficient in-memory key-value store operations. Track cache hits, misses, and memory usage for efficient data caching."
26
- method_description: "It reads server response to stats command ([stats interface](https://github.com/memcached/memcached/wiki/Commands#stats))."
27
- supported_platforms:
28
- include: []
29
- exclude: []
30
- multi_instance: true
31
- additional_permissions:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: |
36
- If no configuration is given, collector will attempt to connect to memcached instance on `127.0.0.1:11211` address.
37
- limits:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
-setup:
42
- prerequisites:
43
- list: []
44
- configuration:
45
- file:
46
- name: python.d/memcached.conf
47
- description: ""
48
- options:
49
- description: |
50
- There are 2 sections:
51
-
52
- * Global variables
53
- * One or more JOBS that can define multiple different instances to monitor.
54
-
55
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
-
57
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
-
59
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
- folding:
61
- title: Config options
62
- enabled: true
63
- list:
64
- - name: host
65
- description: the host to connect to.
66
- default_value: "127.0.0.1"
67
- required: false
68
- - name: port
69
- description: the port to connect to.
70
- default_value: "11211"
71
- required: false
72
- - name: update_every
73
- description: Sets the default data collection frequency.
74
- default_value: 10
75
- required: false
76
- - name: priority
77
- description: Controls the order of charts at the netdata dashboard.
78
- default_value: 60000
79
- required: false
80
- - name: autodetection_retry
81
- description: Sets the job re-check interval in seconds.
82
- default_value: 0
83
- required: false
84
- - name: penalty
85
- description: Indicates whether to apply penalty to update_every in case of failures.
86
- default_value: yes
87
- required: false
88
- - name: name
89
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
90
- default_value: ""
91
- required: false
92
- examples:
93
- folding:
94
- enabled: true
95
- title: "Config"
96
- list:
97
- - name: localhost
98
- description: An example configuration for localhost.
99
- folding:
100
- enabled: false
101
- config: |
102
- localhost:
103
- name: 'local'
104
- host: 'localhost'
105
- port: 11211
106
- - name: localipv4
107
- description: An example configuration for localipv4.
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: memcached
6
+ monitored_instance:
7
+ name: Memcached
8
+ link: https://memcached.org/
9
+ categories:
10
+ - data-collection.database-servers
11
+ icon_filename: "memcached.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - memcached
19
+ - memcache
20
+ - cache
21
+ - database
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: "Monitor Memcached metrics for proficient in-memory key-value store operations. Track cache hits, misses, and memory usage for efficient data caching."
26
+ method_description: "It reads server response to stats command ([stats interface](https://github.com/memcached/memcached/wiki/Commands#stats))."
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: |
36
+ If no configuration is given, collector will attempt to connect to memcached instance on `127.0.0.1:11211` address.
37
+ limits:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list: []
44
+ configuration:
45
+ file:
46
+ name: python.d/memcached.conf
47
+ description: ""
48
+ options:
49
+ description: |
50
+ There are 2 sections:
51
+
52
+ * Global variables
53
+ * One or more JOBS that can define multiple different instances to monitor.
54
+
55
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
+
57
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
+
59
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
folding:
61
+ title: Config options
62
enabled: true
110
- config: |
111
- localhost:
112
- name: 'local'
113
- host: '127.0.0.1'
114
- port: 11211
115
- - name: localipv6
116
- description: An example configuration for localipv6.
63
+ list:
64
+ - name: host
65
+ description: the host to connect to.
66
+ default_value: "127.0.0.1"
67
+ required: false
68
+ - name: port
69
+ description: the port to connect to.
70
+ default_value: "11211"
71
+ required: false
72
+ - name: update_every
73
+ description: Sets the default data collection frequency.
74
+ default_value: 10
75
+ required: false
76
+ - name: priority
77
+ description: Controls the order of charts at the netdata dashboard.
78
+ default_value: 60000
79
+ required: false
80
+ - name: autodetection_retry
81
+ description: Sets the job re-check interval in seconds.
82
+ default_value: 0
83
+ required: false
84
+ - name: penalty
85
+ description: Indicates whether to apply penalty to update_every in case of failures.
86
+ default_value: yes
87
+ required: false
88
+ - name: name
89
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
90
+ default_value: ""
91
+ required: false
92
+ examples:
93
folding:
94
enabled: true
119
- config: |
120
- localhost:
121
- name: 'local'
122
- host: '::1'
123
- port: 11211
124
-troubleshooting:
125
- problems:
126
- list: []
127
-alerts:
128
- - name: memcached_cache_memory_usage
129
- link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
130
- metric: memcached.cache
131
- info: cache memory utilization
132
- - name: memcached_cache_fill_rate
133
- link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
134
- metric: memcached.cache
135
- info: average rate the cache fills up (positive), or frees up (negative) space over the last hour
136
- - name: memcached_out_of_cache_space_time
137
- link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
138
- metric: memcached.cache
139
- info: estimated time the cache will run out of space if the system continues to add data at the same rate as the past hour
140
-metrics:
141
- folding:
142
- title: Metrics
143
- enabled: false
144
- description: ""
145
- availability: []
146
- scopes:
147
- - name: global
148
- description: "These metrics refer to the entire monitored application."
149
- labels: []
150
- metrics:
151
- - name: memcached.cache
152
- description: Cache Size
153
- unit: "MiB"
154
- chart_type: stacked
155
- dimensions:
156
- - name: available
157
- - name: used
158
- - name: memcached.net
159
- description: Network
160
- unit: "kilobits/s"
161
- chart_type: area
162
- dimensions:
163
- - name: in
164
- - name: out
165
- - name: memcached.connections
166
- description: Connections
167
- unit: "connections/s"
168
- chart_type: line
169
- dimensions:
170
- - name: current
171
- - name: rejected
172
- - name: total
173
- - name: memcached.items
174
- description: Items
175
- unit: "items"
176
- chart_type: line
177
- dimensions:
178
- - name: current
179
- - name: total
180
- - name: memcached.evicted_reclaimed
181
- description: Evicted and Reclaimed Items
182
- unit: "items"
183
- chart_type: line
184
- dimensions:
185
- - name: reclaimed
186
- - name: evicted
187
- - name: memcached.get
188
- description: Get Requests
189
- unit: "requests"
190
- chart_type: stacked
191
- dimensions:
192
- - name: hints
193
- - name: misses
194
- - name: memcached.get_rate
195
- description: Get Request Rate
196
- unit: "requests/s"
197
- chart_type: line
198
- dimensions:
199
- - name: rate
200
- - name: memcached.set_rate
201
- description: Set Request Rate
202
- unit: "requests/s"
203
- chart_type: line
204
- dimensions:
205
- - name: rate
206
- - name: memcached.delete
207
- description: Delete Requests
208
- unit: "requests"
209
- chart_type: stacked
210
- dimensions:
211
- - name: hits
212
- - name: misses
213
- - name: memcached.cas
214
- description: Check and Set Requests
215
- unit: "requests"
216
- chart_type: stacked
217
- dimensions:
218
- - name: hits
219
- - name: misses
220
- - name: bad value
221
- - name: memcached.increment
222
- description: Increment Requests
223
- unit: "requests"
224
- chart_type: stacked
225
- dimensions:
226
- - name: hits
227
- - name: misses
228
- - name: memcached.decrement
229
- description: Decrement Requests
230
- unit: "requests"
231
- chart_type: stacked
232
- dimensions:
233
- - name: hits
234
- - name: misses
235
- - name: memcached.touch
236
- description: Touch Requests
237
- unit: "requests"
238
- chart_type: stacked
239
- dimensions:
240
- - name: hits
241
- - name: misses
242
- - name: memcached.touch_rate
243
- description: Touch Request Rate
244
- unit: "requests/s"
245
- chart_type: line
246
- dimensions:
247
- - name: rate
95
+ title: "Config"
96
+ list:
97
+ - name: localhost
98
+ description: An example configuration for localhost.
99
+ folding:
100
+ enabled: false
101
+ config: |
102
+ localhost:
103
+ name: 'local'
104
+ host: 'localhost'
105
+ port: 11211
106
+ - name: localipv4
107
+ description: An example configuration for localipv4.
108
+ folding:
109
+ enabled: true
110
+ config: |
111
+ localhost:
112
+ name: 'local'
113
+ host: '127.0.0.1'
114
+ port: 11211
115
+ - name: localipv6
116
+ description: An example configuration for localipv6.
117
+ folding:
118
+ enabled: true
119
+ config: |
120
+ localhost:
121
+ name: 'local'
122
+ host: '::1'
123
+ port: 11211
124
+ troubleshooting:
125
+ problems:
126
+ list: []
127
+ alerts:
128
+ - name: memcached_cache_memory_usage
129
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
130
+ metric: memcached.cache
131
+ info: cache memory utilization
132
+ - name: memcached_cache_fill_rate
133
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
134
+ metric: memcached.cache
135
+ info: average rate the cache fills up (positive), or frees up (negative) space over the last hour
136
+ - name: memcached_out_of_cache_space_time
137
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
138
+ metric: memcached.cache
139
+ info: estimated time the cache will run out of space if the system continues to add data at the same rate as the past hour
140
+ metrics:
141
+ folding:
142
+ title: Metrics
143
+ enabled: false
144
+ description: ""
145
+ availability: []
146
+ scopes:
147
+ - name: global
148
+ description: "These metrics refer to the entire monitored application."
149
+ labels: []
150
+ metrics:
151
+ - name: memcached.cache
152
+ description: Cache Size
153
+ unit: "MiB"
154
+ chart_type: stacked
155
+ dimensions:
156
+ - name: available
157
+ - name: used
158
+ - name: memcached.net
159
+ description: Network
160
+ unit: "kilobits/s"
161
+ chart_type: area
162
+ dimensions:
163
+ - name: in
164
+ - name: out
165
+ - name: memcached.connections
166
+ description: Connections
167
+ unit: "connections/s"
168
+ chart_type: line
169
+ dimensions:
170
+ - name: current
171
+ - name: rejected
172
+ - name: total
173
+ - name: memcached.items
174
+ description: Items
175
+ unit: "items"
176
+ chart_type: line
177
+ dimensions:
178
+ - name: current
179
+ - name: total
180
+ - name: memcached.evicted_reclaimed
181
+ description: Evicted and Reclaimed Items
182
+ unit: "items"
183
+ chart_type: line
184
+ dimensions:
185
+ - name: reclaimed
186
+ - name: evicted
187
+ - name: memcached.get
188
+ description: Get Requests
189
+ unit: "requests"
190
+ chart_type: stacked
191
+ dimensions:
192
+ - name: hints
193
+ - name: misses
194
+ - name: memcached.get_rate
195
+ description: Get Request Rate
196
+ unit: "requests/s"
197
+ chart_type: line
198
+ dimensions:
199
+ - name: rate
200
+ - name: memcached.set_rate
201
+ description: Set Request Rate
202
+ unit: "requests/s"
203
+ chart_type: line
204
+ dimensions:
205
+ - name: rate
206
+ - name: memcached.delete
207
+ description: Delete Requests
208
+ unit: "requests"
209
+ chart_type: stacked
210
+ dimensions:
211
+ - name: hits
212
+ - name: misses
213
+ - name: memcached.cas
214
+ description: Check and Set Requests
215
+ unit: "requests"
216
+ chart_type: stacked
217
+ dimensions:
218
+ - name: hits
219
+ - name: misses
220
+ - name: bad value
221
+ - name: memcached.increment
222
+ description: Increment Requests
223
+ unit: "requests"
224
+ chart_type: stacked
225
+ dimensions:
226
+ - name: hits
227
+ - name: misses
228
+ - name: memcached.decrement
229
+ description: Decrement Requests
230
+ unit: "requests"
231
+ chart_type: stacked
232
+ dimensions:
233
+ - name: hits
234
+ - name: misses
235
+ - name: memcached.touch
236
+ description: Touch Requests
237
+ unit: "requests"
238
+ chart_type: stacked
239
+ dimensions:
240
+ - name: hits
241
+ - name: misses
242
+ - name: memcached.touch_rate
243
+ description: Touch Request Rate
244
+ unit: "requests/s"
245
+ chart_type: line
246
+ dimensions:
247
+ - name: rate
collectors/python.d.plugin/monit/metadata.yaml
+216
-214
@@ -1,215 +1,217 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: monit
4
- monitored_instance:
5
- name: Monit
6
- link: https://mmonit.com/monit/
7
- categories:
8
- - data-collection.synthetic-checks
9
- icon_filename: "monit.png"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - monit
17
- - mmonit
18
- - supervision tool
19
- - monitrc
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: |
24
- This collector monitors Monit targets such as filesystems, directories, files, FIFO pipes and more.
25
- method_description: |
26
- It gathers data from Monit's XML interface.
27
- supported_platforms:
28
- include: []
29
- exclude: []
30
- multi_instance: true
31
- additional_permissions:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: By default, this collector will attempt to connect to Monit at `http://localhost:2812`
36
- limits:
37
- description: ""
38
- performance_impact:
39
- description: ""
40
-setup:
41
- prerequisites:
42
- list: []
43
- configuration:
44
- file:
45
- name: "python.d/monit.conf"
46
- options:
47
- description: |
48
- There are 2 sections:
49
-
50
- * Global variables
51
- * One or more JOBS that can define multiple different instances to monitor.
52
-
53
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
54
-
55
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
-
57
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
- folding:
59
- title: "Config options"
60
- enabled: true
61
- list:
62
- - name: update_every
63
- description: Sets the default data collection frequency.
64
- default_value: 1
65
- required: false
66
- - name: priority
67
- description: Controls the order of charts at the netdata dashboard.
68
- default_value: 60000
69
- required: false
70
- - name: autodetection_retry
71
- description: Sets the job re-check interval in seconds.
72
- default_value: 0
73
- required: false
74
- - name: penalty
75
- description: Indicates whether to apply penalty to update_every in case of failures.
76
- default_value: yes
77
- required: false
78
- - name: name
79
- description: >
80
- Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
- default_value: "local"
82
- required: false
83
- - name: url
84
- description: The URL to fetch Monit's metrics.
85
- default_value: http://localhost:2812
86
- required: true
87
- - name: user
88
- description: Username in case the URL is password protected.
89
- default_value: ""
90
- required: false
91
- - name: pass
92
- description: Password in case the URL is password protected.
93
- default_value: ""
94
- required: false
95
- examples:
96
- folding:
97
- enabled: true
98
- title: "Config"
99
- list:
100
- - name: Basic
101
- description: A basic configuration example.
102
- folding:
103
- enabled: false
104
- config: |
105
- localhost:
106
- name : 'local'
107
- url : 'http://localhost:2812'
108
- - name: Basic Authentication
109
- description: Example using basic username and password in order to authenticate.
110
- config: |
111
- localhost:
112
- name : 'local'
113
- url : 'http://localhost:2812'
114
- user: 'foo'
115
- pass: 'bar'
116
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: monit
6
+ monitored_instance:
7
+ name: Monit
8
+ link: https://mmonit.com/monit/
9
+ categories:
10
+ - data-collection.synthetic-checks
11
+ icon_filename: "monit.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - monit
19
+ - mmonit
20
+ - supervision tool
21
+ - monitrc
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: |
26
+ This collector monitors Monit targets such as filesystems, directories, files, FIFO pipes and more.
27
+ method_description: |
28
+ It gathers data from Monit's XML interface.
29
+ supported_platforms:
30
+ include: []
31
+ exclude: []
32
+ multi_instance: true
33
+ additional_permissions:
34
+ description: ""
35
+ default_behavior:
36
+ auto_detection:
37
+ description: By default, this collector will attempt to connect to Monit at `http://localhost:2812`
38
+ limits:
39
+ description: ""
40
+ performance_impact:
41
+ description: ""
42
+ setup:
43
+ prerequisites:
44
+ list: []
45
+ configuration:
46
+ file:
47
+ name: "python.d/monit.conf"
48
+ options:
49
description: |
118
- > **Note**: When you define multiple jobs, their names must be unique.
119
-
120
- Collecting metrics from local and remote instances.
121
- config: |
122
- localhost:
123
- name: 'local'
124
- url: 'http://localhost:2812'
125
-
126
- remote_job:
127
- name: 'remote'
128
- url: 'http://192.0.2.1:2812'
129
-troubleshooting:
130
- problems:
131
- list: []
132
-alerts: []
133
-metrics:
134
- folding:
135
- title: Metrics
136
- enabled: false
137
- description: ""
138
- availability: []
139
- scopes:
140
- - name: global
141
- description: "These metrics refer to the entire monitored application."
142
- labels: []
143
- metrics:
144
- - name: monit.filesystems
145
- description: Filesystems
146
- unit: "filesystems"
147
- chart_type: line
148
- dimensions:
149
- - name: a dimension per target
150
- - name: monit.directories
151
- description: Directories
152
- unit: "directories"
153
- chart_type: line
154
- dimensions:
155
- - name: a dimension per target
156
- - name: monit.files
157
- description: Files
158
- unit: "files"
159
- chart_type: line
160
- dimensions:
161
- - name: a dimension per target
162
- - name: monit.fifos
163
- description: Pipes (fifo)
164
- unit: "pipes"
165
- chart_type: line
166
- dimensions:
167
- - name: a dimension per target
168
- - name: monit.programs
169
- description: Programs statuses
170
- unit: "programs"
171
- chart_type: line
172
- dimensions:
173
- - name: a dimension per target
174
- - name: monit.services
175
- description: Processes statuses
176
- unit: "processes"
177
- chart_type: line
178
- dimensions:
179
- - name: a dimension per target
180
- - name: monit.process_uptime
181
- description: Processes uptime
182
- unit: "seconds"
183
- chart_type: line
184
- dimensions:
185
- - name: a dimension per target
186
- - name: monit.process_threads
187
- description: Processes threads
188
- unit: "threads"
189
- chart_type: line
190
- dimensions:
191
- - name: a dimension per target
192
- - name: monit.process_childrens
193
- description: Child processes
194
- unit: "children"
195
- chart_type: line
196
- dimensions:
197
- - name: a dimension per target
198
- - name: monit.hosts
199
- description: Hosts
200
- unit: "hosts"
201
- chart_type: line
202
- dimensions:
203
- - name: a dimension per target
204
- - name: monit.host_latency
205
- description: Hosts latency
206
- unit: "milliseconds"
207
- chart_type: line
208
- dimensions:
209
- - name: a dimension per target
210
- - name: monit.networks
211
- description: Network interfaces and addresses
212
- unit: "interfaces"
213
- chart_type: line
214
- dimensions:
215
- - name: a dimension per target
50
+ There are 2 sections:
51
+
52
+ * Global variables
53
+ * One or more JOBS that can define multiple different instances to monitor.
54
+
55
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
+
57
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
+
59
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
+ folding:
61
+ title: "Config options"
62
+ enabled: true
63
+ list:
64
+ - name: update_every
65
+ description: Sets the default data collection frequency.
66
+ default_value: 1
67
+ required: false
68
+ - name: priority
69
+ description: Controls the order of charts at the netdata dashboard.
70
+ default_value: 60000
71
+ required: false
72
+ - name: autodetection_retry
73
+ description: Sets the job re-check interval in seconds.
74
+ default_value: 0
75
+ required: false
76
+ - name: penalty
77
+ description: Indicates whether to apply penalty to update_every in case of failures.
78
+ default_value: yes
79
+ required: false
80
+ - name: name
81
+ description: >
82
+ Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
83
+ default_value: "local"
84
+ required: false
85
+ - name: url
86
+ description: The URL to fetch Monit's metrics.
87
+ default_value: http://localhost:2812
88
+ required: true
89
+ - name: user
90
+ description: Username in case the URL is password protected.
91
+ default_value: ""
92
+ required: false
93
+ - name: pass
94
+ description: Password in case the URL is password protected.
95
+ default_value: ""
96
+ required: false
97
+ examples:
98
+ folding:
99
+ enabled: true
100
+ title: "Config"
101
+ list:
102
+ - name: Basic
103
+ description: A basic configuration example.
104
+ folding:
105
+ enabled: false
106
+ config: |
107
+ localhost:
108
+ name : 'local'
109
+ url : 'http://localhost:2812'
110
+ - name: Basic Authentication
111
+ description: Example using basic username and password in order to authenticate.
112
+ config: |
113
+ localhost:
114
+ name : 'local'
115
+ url : 'http://localhost:2812'
116
+ user: 'foo'
117
+ pass: 'bar'
118
+ - name: Multi-instance
119
+ description: |
120
+ > **Note**: When you define multiple jobs, their names must be unique.
121
+
122
+ Collecting metrics from local and remote instances.
123
+ config: |
124
+ localhost:
125
+ name: 'local'
126
+ url: 'http://localhost:2812'
127
+
128
+ remote_job:
129
+ name: 'remote'
130
+ url: 'http://192.0.2.1:2812'
131
+ troubleshooting:
132
+ problems:
133
+ list: []
134
+ alerts: []
135
+ metrics:
136
+ folding:
137
+ title: Metrics
138
+ enabled: false
139
+ description: ""
140
+ availability: []
141
+ scopes:
142
+ - name: global
143
+ description: "These metrics refer to the entire monitored application."
144
+ labels: []
145
+ metrics:
146
+ - name: monit.filesystems
147
+ description: Filesystems
148
+ unit: "filesystems"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: a dimension per target
152
+ - name: monit.directories
153
+ description: Directories
154
+ unit: "directories"
155
+ chart_type: line
156
+ dimensions:
157
+ - name: a dimension per target
158
+ - name: monit.files
159
+ description: Files
160
+ unit: "files"
161
+ chart_type: line
162
+ dimensions:
163
+ - name: a dimension per target
164
+ - name: monit.fifos
165
+ description: Pipes (fifo)
166
+ unit: "pipes"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: a dimension per target
170
+ - name: monit.programs
171
+ description: Programs statuses
172
+ unit: "programs"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: a dimension per target
176
+ - name: monit.services
177
+ description: Processes statuses
178
+ unit: "processes"
179
+ chart_type: line
180
+ dimensions:
181
+ - name: a dimension per target
182
+ - name: monit.process_uptime
183
+ description: Processes uptime
184
+ unit: "seconds"
185
+ chart_type: line
186
+ dimensions:
187
+ - name: a dimension per target
188
+ - name: monit.process_threads
189
+ description: Processes threads
190
+ unit: "threads"
191
+ chart_type: line
192
+ dimensions:
193
+ - name: a dimension per target
194
+ - name: monit.process_childrens
195
+ description: Child processes
196
+ unit: "children"
197
+ chart_type: line
198
+ dimensions:
199
+ - name: a dimension per target
200
+ - name: monit.hosts
201
+ description: Hosts
202
+ unit: "hosts"
203
+ chart_type: line
204
+ dimensions:
205
+ - name: a dimension per target
206
+ - name: monit.host_latency
207
+ description: Hosts latency
208
+ unit: "milliseconds"
209
+ chart_type: line
210
+ dimensions:
211
+ - name: a dimension per target
212
+ - name: monit.networks
213
+ description: Network interfaces and addresses
214
+ unit: "interfaces"
215
+ chart_type: line
216
+ dimensions:
217
+ - name: a dimension per target
collectors/python.d.plugin/nsd/metadata.yaml
+195
-193
@@ -1,196 +1,198 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: nsd
4
- monitored_instance:
5
- name: Name Server Daemon
6
- link: https://nsd.docs.nlnetlabs.nl/en/latest/#
7
- categories:
8
- - data-collection.dns-and-dhcp-servers
9
- icon_filename: "nsd.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - nsd
17
- - name server daemon
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: |
22
- This collector monitors NSD statistics like queries, zones, protocols, query types and more.
23
- method_description: |
24
- It uses the `nsd-control stats_noreset` command to gather metrics.
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: false
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: If permissions are satisfied, the collector will be able to run `nsd-control stats_noreset`, thus collecting metrics.
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: Provide Netdata the permissions to run the command
42
- description: |
43
- Netdata must have permissions to run the `nsd-control stats_noreset` command.
44
-
45
- You can:
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: nsd
6
+ monitored_instance:
7
+ name: Name Server Daemon
8
+ link: https://nsd.docs.nlnetlabs.nl/en/latest/#
9
+ categories:
10
+ - data-collection.dns-and-dhcp-servers
11
+ icon_filename: "nsd.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - nsd
19
+ - name server daemon
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: |
24
+ This collector monitors NSD statistics like queries, zones, protocols, query types and more.
25
+ method_description: |
26
+ It uses the `nsd-control stats_noreset` command to gather metrics.
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: false
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: If permissions are satisfied, the collector will be able to run `nsd-control stats_noreset`, thus collecting metrics.
36
+ limits:
37
+ description: ""
38
+ performance_impact:
39
+ description: ""
40
+ setup:
41
+ prerequisites:
42
+ list:
43
+ - title: Provide Netdata the permissions to run the command
44
+ description: |
45
+ Netdata must have permissions to run the `nsd-control stats_noreset` command.
46
+
47
+ You can:
48
+
49
+ - Add "netdata" user to "nsd" group:
50
+ ```
51
+ usermod -aG nsd netdata
52
+ ```
53
+ - Add Netdata to sudoers
54
+ 1. Edit the sudoers file:
55
+ ```
56
+ visudo -f /etc/sudoers.d/netdata
57
+ ```
58
+ 2. Add the entry:
59
+ ```
60
+ Defaults:netdata !requiretty
61
+ netdata ALL=(ALL) NOPASSWD: /usr/sbin/nsd-control stats_noreset
62
+ ```
63
+
64
+ > Note that you will need to set the `command` option to `sudo /usr/sbin/nsd-control stats_noreset` if you use this method.
65
47
- - Add "netdata" user to "nsd" group:
48
- ```
49
- usermod -aG nsd netdata
50
- ```
51
- - Add Netdata to sudoers
52
- 1. Edit the sudoers file:
53
- ```
54
- visudo -f /etc/sudoers.d/netdata
55
- ```
56
- 2. Add the entry:
57
- ```
58
- Defaults:netdata !requiretty
59
- netdata ALL=(ALL) NOPASSWD: /usr/sbin/nsd-control stats_noreset
60
- ```
66
+ configuration:
67
+ file:
68
+ name: "python.d/nsd.conf"
69
+ options:
70
+ description: |
71
+ This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.
72
62
- > Note that you will need to set the `command` option to `sudo /usr/sbin/nsd-control stats_noreset` if you use this method.
63
-
64
- configuration:
65
- file:
66
- name: "python.d/nsd.conf"
67
- options:
68
- description: |
69
- This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.
70
-
71
- There are 2 sections:
72
-
73
- * Global variables
74
- * One or more JOBS that can define multiple different instances to monitor.
75
-
76
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
77
-
78
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
79
-
80
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
81
- folding:
82
- title: "Config options"
83
- enabled: true
84
- list:
85
- - name: update_every
86
- description: Sets the default data collection frequency.
87
- default_value: 30
88
- required: false
89
- - name: priority
90
- description: Controls the order of charts at the netdata dashboard.
91
- default_value: 60000
92
- required: false
93
- - name: autodetection_retry
94
- description: Sets the job re-check interval in seconds.
95
- default_value: 0
96
- required: false
97
- - name: penalty
98
- description: Indicates whether to apply penalty to update_every in case of failures.
99
- default_value: yes
100
- required: false
101
- - name: name
102
- description: >
103
- Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed
104
- running at any time. This allows autodetection to try several alternatives and pick the one that works.
105
- default_value: ""
106
- required: false
107
- - name: command
108
- description: The command to run
109
- default_value: "nsd-control stats_noreset"
110
- required: false
111
- examples:
112
- folding:
113
- enabled: true
114
- title: "Config"
115
- list:
116
- - name: Basic
117
- description: A basic configuration example.
73
+ There are 2 sections:
74
+
75
+ * Global variables
76
+ * One or more JOBS that can define multiple different instances to monitor.
77
+
78
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
79
+
80
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
81
+
82
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
83
+ folding:
84
+ title: "Config options"
85
+ enabled: true
86
+ list:
87
+ - name: update_every
88
+ description: Sets the default data collection frequency.
89
+ default_value: 30
90
+ required: false
91
+ - name: priority
92
+ description: Controls the order of charts at the netdata dashboard.
93
+ default_value: 60000
94
+ required: false
95
+ - name: autodetection_retry
96
+ description: Sets the job re-check interval in seconds.
97
+ default_value: 0
98
+ required: false
99
+ - name: penalty
100
+ description: Indicates whether to apply penalty to update_every in case of failures.
101
+ default_value: yes
102
+ required: false
103
+ - name: name
104
+ description: >
105
+ Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed
106
+ running at any time. This allows autodetection to try several alternatives and pick the one that works.
107
+ default_value: ""
108
+ required: false
109
+ - name: command
110
+ description: The command to run
111
+ default_value: "nsd-control stats_noreset"
112
+ required: false
113
+ examples:
114
folding:
119
- enabled: false
120
- config: |
121
- local:
122
- name: 'nsd_local'
123
- command: 'nsd-control stats_noreset'
124
-troubleshooting:
125
- problems:
126
- list: []
127
-alerts: []
128
-metrics:
129
- folding:
130
- title: Metrics
131
- enabled: false
132
- description: ""
133
- availability: []
134
- scopes:
135
- - name: global
136
- description: "These metrics refer to the entire monitored application."
137
- labels: []
138
- metrics:
139
- - name: nsd.queries
140
- description: queries
141
- unit: "queries/s"
142
- chart_type: line
143
- dimensions:
144
- - name: queries
145
- - name: nsd.zones
146
- description: zones
147
- unit: "zones"
148
- chart_type: stacked
149
- dimensions:
150
- - name: master
151
- - name: slave
152
- - name: nsd.protocols
153
- description: protocol
154
- unit: "queries/s"
155
- chart_type: stacked
156
- dimensions:
157
- - name: udp
158
- - name: udp6
159
- - name: tcp
160
- - name: tcp6
161
- - name: nsd.type
162
- description: query type
163
- unit: "queries/s"
164
- chart_type: stacked
165
- dimensions:
166
- - name: A
167
- - name: NS
168
- - name: CNAME
169
- - name: SOA
170
- - name: PTR
171
- - name: HINFO
172
- - name: MX
173
- - name: NAPTR
174
- - name: TXT
175
- - name: AAAA
176
- - name: SRV
177
- - name: ANY
178
- - name: nsd.transfer
179
- description: transfer
180
- unit: "queries/s"
181
- chart_type: stacked
182
- dimensions:
183
- - name: NOTIFY
184
- - name: AXFR
185
- - name: nsd.rcode
186
- description: return code
187
- unit: "queries/s"
188
- chart_type: stacked
189
- dimensions:
190
- - name: NOERROR
191
- - name: FORMERR
192
- - name: SERVFAIL
193
- - name: NXDOMAIN
194
- - name: NOTIMP
195
- - name: REFUSED
196
- - name: YXDOMAIN
115
+ enabled: true
116
+ title: "Config"
117
+ list:
118
+ - name: Basic
119
+ description: A basic configuration example.
120
+ folding:
121
+ enabled: false
122
+ config: |
123
+ local:
124
+ name: 'nsd_local'
125
+ command: 'nsd-control stats_noreset'
126
+ troubleshooting:
127
+ problems:
128
+ list: []
129
+ alerts: []
130
+ metrics:
131
+ folding:
132
+ title: Metrics
133
+ enabled: false
134
+ description: ""
135
+ availability: []
136
+ scopes:
137
+ - name: global
138
+ description: "These metrics refer to the entire monitored application."
139
+ labels: []
140
+ metrics:
141
+ - name: nsd.queries
142
+ description: queries
143
+ unit: "queries/s"
144
+ chart_type: line
145
+ dimensions:
146
+ - name: queries
147
+ - name: nsd.zones
148
+ description: zones
149
+ unit: "zones"
150
+ chart_type: stacked
151
+ dimensions:
152
+ - name: master
153
+ - name: slave
154
+ - name: nsd.protocols
155
+ description: protocol
156
+ unit: "queries/s"
157
+ chart_type: stacked
158
+ dimensions:
159
+ - name: udp
160
+ - name: udp6
161
+ - name: tcp
162
+ - name: tcp6
163
+ - name: nsd.type
164
+ description: query type
165
+ unit: "queries/s"
166
+ chart_type: stacked
167
+ dimensions:
168
+ - name: A
169
+ - name: NS
170
+ - name: CNAME
171
+ - name: SOA
172
+ - name: PTR
173
+ - name: HINFO
174
+ - name: MX
175
+ - name: NAPTR
176
+ - name: TXT
177
+ - name: AAAA
178
+ - name: SRV
179
+ - name: ANY
180
+ - name: nsd.transfer
181
+ description: transfer
182
+ unit: "queries/s"
183
+ chart_type: stacked
184
+ dimensions:
185
+ - name: NOTIFY
186
+ - name: AXFR
187
+ - name: nsd.rcode
188
+ description: return code
189
+ unit: "queries/s"
190
+ chart_type: stacked
191
+ dimensions:
192
+ - name: NOERROR
193
+ - name: FORMERR
194
+ - name: SERVFAIL
195
+ - name: NXDOMAIN
196
+ - name: NOTIMP
197
+ - name: REFUSED
198
+ - name: YXDOMAIN
collectors/python.d.plugin/openldap/metadata.yaml
+224
-223
@@ -1,224 +1,225 @@
1
-# "$schema": "https://github.com/netdata/netdata/blob/master/integrations/schemas/collection-single-module.json"
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: openldap
5
- monitored_instance:
6
- name: OpenLDAP
7
- link: "https://www.openldap.org/"
8
- categories:
9
- - data-collection.authentication-and-authorization
10
- icon_filename: "statsd.png"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - openldap
18
- - RBAC
19
- - Directory access
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "This collector monitors OpenLDAP metrics about connections, operations, referrals and more."
24
- method_description: |
25
- Statistics are taken from the monitoring interface of a openLDAP (slapd) server
26
- supported_platforms:
27
- include: []
28
- exclude: []
29
- multi_instance: false
30
- additional_permissions:
31
- description: ""
32
- default_behavior:
33
- auto_detection:
34
- description: |
35
- This collector doesn't work until all the prerequisites are checked.
36
- limits:
37
- description: ""
38
- performance_impact:
39
- description: ""
40
-setup:
41
- prerequisites:
42
- list:
43
- - title: Configure the openLDAP server to expose metrics to monitor it.
44
- description: |
45
- Follow instructions from https://www.openldap.org/doc/admin24/monitoringslapd.html to activate monitoring interface.
46
- - title: Install python-ldap module
47
- description: |
48
- Install python ldap module
49
-
50
- 1. From pip package manager
51
-
52
- ```bash
53
- pip install ldap
54
- ```
55
-
56
- 2. With apt package manager (in most deb based distros)
57
-
58
-
59
- ```bash
60
- apt-get install python-ldap
61
- ```
62
-
63
-
64
- 3. With yum package manager (in most rpm based distros)
65
-
66
-
67
- ```bash
68
- yum install python-ldap
69
- ```
70
- - title: Insert credentials for Netdata to access openLDAP server
71
- description: |
72
- Use the `ldappasswd` utility to set a password for the username you will use.
73
- configuration:
74
- file:
75
- name: "python.d/openldap.conf"
76
- options:
77
- description: |
78
- There are 2 sections:
79
-
80
- * Global variables
81
- * One or more JOBS that can define multiple different instances to monitor.
82
-
83
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
84
-
85
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
86
-
87
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
88
- folding:
89
- title: "Config options"
90
- enabled: true
91
- list:
92
- - name: update_every
93
- description: Sets the default data collection frequency.
94
- default_value: 5
95
- required: false
96
- - name: priority
97
- description: Controls the order of charts at the netdata dashboard.
98
- default_value: 60000
99
- required: false
100
- - name: autodetection_retry
101
- description: Sets the job re-check interval in seconds.
102
- default_value: 0
103
- required: false
104
- - name: penalty
105
- description: Indicates whether to apply penalty to update_every in case of failures.
106
- default_value: yes
107
- required: false
108
- - name: name
109
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
110
- default_value: ""
111
- required: false
112
- - name: username
113
- description: The bind user with right to access monitor statistics
114
- default_value: ""
115
- required: true
116
- - name: password
117
- description: The password for the binded user
118
- default_value: ""
119
- required: true
120
- - name: server
121
- description: The listening address of the LDAP server. In case of TLS, use the hostname which the certificate is published for.
122
- default_value: ""
123
- required: true
124
- - name: port
125
- description: The listening port of the LDAP server. Change to 636 port in case of TLS connection.
126
- default_value: "389"
127
- required: true
128
- - name: use_tls
129
- description: Make True if a TLS connection is used over ldaps://
130
- default_value: False
131
- required: false
132
- - name: use_start_tls
133
- description: Make True if a TLS connection is used over ldap://
134
- default_value: False
135
- required: false
136
- - name: cert_check
137
- description: False if you want to ignore certificate check
138
- default_value: "True"
139
- required: true
140
- - name: timeout
141
- description: Seconds to timeout if no connection exist
142
- default_value: ""
143
- required: true
144
- examples:
145
- folding:
146
- enabled: true
147
- title: "Config"
148
- list:
149
- - name: Basic
150
- description: A basic example configuration.
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: openldap
6
+ monitored_instance:
7
+ name: OpenLDAP
8
+ link: "https://www.openldap.org/"
9
+ categories:
10
+ - data-collection.authentication-and-authorization
11
+ icon_filename: "statsd.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - openldap
19
+ - RBAC
20
+ - Directory access
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "This collector monitors OpenLDAP metrics about connections, operations, referrals and more."
25
+ method_description: |
26
+ Statistics are taken from the monitoring interface of a openLDAP (slapd) server
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: false
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: |
36
+ This collector doesn't work until all the prerequisites are checked.
37
+ limits:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list:
44
+ - title: Configure the openLDAP server to expose metrics to monitor it.
45
+ description: |
46
+ Follow instructions from https://www.openldap.org/doc/admin24/monitoringslapd.html to activate monitoring interface.
47
+ - title: Install python-ldap module
48
+ description: |
49
+ Install python ldap module
50
+
51
+ 1. From pip package manager
52
+
53
+ ```bash
54
+ pip install ldap
55
+ ```
56
+
57
+ 2. With apt package manager (in most deb based distros)
58
+
59
+
60
+ ```bash
61
+ apt-get install python-ldap
62
+ ```
63
+
64
+
65
+ 3. With yum package manager (in most rpm based distros)
66
+
67
+
68
+ ```bash
69
+ yum install python-ldap
70
+ ```
71
+ - title: Insert credentials for Netdata to access openLDAP server
72
+ description: |
73
+ Use the `ldappasswd` utility to set a password for the username you will use.
74
+ configuration:
75
+ file:
76
+ name: "python.d/openldap.conf"
77
+ options:
78
+ description: |
79
+ There are 2 sections:
80
+
81
+ * Global variables
82
+ * One or more JOBS that can define multiple different instances to monitor.
83
+
84
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
85
+
86
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
87
+
88
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
89
folding:
152
- enabled: false
153
- config: |
154
- username: "cn=admin"
155
- password: "pass"
156
- server: "localhost"
157
- port: "389"
158
- check_cert: True
159
- timeout: 1
160
-troubleshooting:
161
- problems:
162
- list: []
163
-alerts: []
164
-metrics:
165
- folding:
166
- title: Metrics
167
- enabled: false
168
- description: ""
169
- availability: []
170
- scopes:
171
- - name: global
172
- description: "These metrics refer to the entire monitored application."
173
- labels: []
174
- metrics:
175
- - name: openldap.total_connections
176
- description: Total Connections
177
- unit: "connections/s"
178
- chart_type: line
179
- dimensions:
180
- - name: connections
181
- - name: openldap.traffic_stats
182
- description: Traffic
183
- unit: "KiB/s"
184
- chart_type: line
185
- dimensions:
186
- - name: sent
187
- - name: openldap.operations_status
188
- description: Operations Status
189
- unit: "ops/s"
190
- chart_type: line
191
- dimensions:
192
- - name: completed
193
- - name: initiated
194
- - name: openldap.referrals
195
- description: Referrals
196
- unit: "referrals/s"
197
- chart_type: line
198
- dimensions:
199
- - name: sent
200
- - name: openldap.entries
201
- description: Entries
202
- unit: "entries/s"
203
- chart_type: line
204
- dimensions:
205
- - name: sent
206
- - name: openldap.ldap_operations
207
- description: Operations
208
- unit: "ops/s"
209
- chart_type: line
210
- dimensions:
211
- - name: bind
212
- - name: search
213
- - name: unbind
214
- - name: add
215
- - name: delete
216
- - name: modify
217
- - name: compare
218
- - name: openldap.waiters
219
- description: Waiters
220
- unit: "waiters/s"
221
- chart_type: line
222
- dimensions:
223
- - name: write
224
- - name: read
90
+ title: "Config options"
91
+ enabled: true
92
+ list:
93
+ - name: update_every
94
+ description: Sets the default data collection frequency.
95
+ default_value: 5
96
+ required: false
97
+ - name: priority
98
+ description: Controls the order of charts at the netdata dashboard.
99
+ default_value: 60000
100
+ required: false
101
+ - name: autodetection_retry
102
+ description: Sets the job re-check interval in seconds.
103
+ default_value: 0
104
+ required: false
105
+ - name: penalty
106
+ description: Indicates whether to apply penalty to update_every in case of failures.
107
+ default_value: yes
108
+ required: false
109
+ - name: name
110
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
111
+ default_value: ""
112
+ required: false
113
+ - name: username
114
+ description: The bind user with right to access monitor statistics
115
+ default_value: ""
116
+ required: true
117
+ - name: password
118
+ description: The password for the binded user
119
+ default_value: ""
120
+ required: true
121
+ - name: server
122
+ description: The listening address of the LDAP server. In case of TLS, use the hostname which the certificate is published for.
123
+ default_value: ""
124
+ required: true
125
+ - name: port
126
+ description: The listening port of the LDAP server. Change to 636 port in case of TLS connection.
127
+ default_value: "389"
128
+ required: true
129
+ - name: use_tls
130
+ description: Make True if a TLS connection is used over ldaps://
131
+ default_value: False
132
+ required: false
133
+ - name: use_start_tls
134
+ description: Make True if a TLS connection is used over ldap://
135
+ default_value: False
136
+ required: false
137
+ - name: cert_check
138
+ description: False if you want to ignore certificate check
139
+ default_value: "True"
140
+ required: true
141
+ - name: timeout
142
+ description: Seconds to timeout if no connection exist
143
+ default_value: ""
144
+ required: true
145
+ examples:
146
+ folding:
147
+ enabled: true
148
+ title: "Config"
149
+ list:
150
+ - name: Basic
151
+ description: A basic example configuration.
152
+ folding:
153
+ enabled: false
154
+ config: |
155
+ username: "cn=admin"
156
+ password: "pass"
157
+ server: "localhost"
158
+ port: "389"
159
+ check_cert: True
160
+ timeout: 1
161
+ troubleshooting:
162
+ problems:
163
+ list: []
164
+ alerts: []
165
+ metrics:
166
+ folding:
167
+ title: Metrics
168
+ enabled: false
169
+ description: ""
170
+ availability: []
171
+ scopes:
172
+ - name: global
173
+ description: "These metrics refer to the entire monitored application."
174
+ labels: []
175
+ metrics:
176
+ - name: openldap.total_connections
177
+ description: Total Connections
178
+ unit: "connections/s"
179
+ chart_type: line
180
+ dimensions:
181
+ - name: connections
182
+ - name: openldap.traffic_stats
183
+ description: Traffic
184
+ unit: "KiB/s"
185
+ chart_type: line
186
+ dimensions:
187
+ - name: sent
188
+ - name: openldap.operations_status
189
+ description: Operations Status
190
+ unit: "ops/s"
191
+ chart_type: line
192
+ dimensions:
193
+ - name: completed
194
+ - name: initiated
195
+ - name: openldap.referrals
196
+ description: Referrals
197
+ unit: "referrals/s"
198
+ chart_type: line
199
+ dimensions:
200
+ - name: sent
201
+ - name: openldap.entries
202
+ description: Entries
203
+ unit: "entries/s"
204
+ chart_type: line
205
+ dimensions:
206
+ - name: sent
207
+ - name: openldap.ldap_operations
208
+ description: Operations
209
+ unit: "ops/s"
210
+ chart_type: line
211
+ dimensions:
212
+ - name: bind
213
+ - name: search
214
+ - name: unbind
215
+ - name: add
216
+ - name: delete
217
+ - name: modify
218
+ - name: compare
219
+ - name: openldap.waiters
220
+ description: Waiters
221
+ unit: "waiters/s"
222
+ chart_type: line
223
+ dimensions:
224
+ - name: write
225
+ - name: read
collectors/python.d.plugin/oracledb/metadata.yaml
+307
-306
@@ -1,308 +1,309 @@
1
-# yaml-language-server: $schema=https://raw.githubusercontent.com/netdata/netdata/master/integrations/schemas/collection-single-module.json
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: oracledb
5
- monitored_instance:
6
- name: Oracle DB
7
- link: "https://docs.oracle.com/en/database/oracle/oracle-database/"
8
- categories:
9
- - data-collection.database-servers
10
- icon_filename: "oracle.svg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - database
18
- - oracle
19
- - data warehouse
20
- - SQL
21
- most_popular: false
22
-overview:
23
- data_collection:
24
- metrics_description: "This collector monitors OracleDB database metrics about sessions, tables, memory and more."
25
- method_description: "It collects the metrics via the supported database client library"
26
- supported_platforms:
27
- include: []
28
- exclude: []
29
- multi_instance: true
30
- additional_permissions:
31
- description: |
32
- In order for this collector to work, it needs a read-only user `netdata` in the RDBMS.
33
- default_behavior:
34
- auto_detection:
35
- description: "When the requirements are met, databases on the local host on port 1521 will be auto-detected"
36
- limits:
37
- description: ""
38
- performance_impact:
39
- description: ""
40
-setup:
41
- prerequisites:
42
- list:
43
- - title: Install the python-oracledb package
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: oracledb
6
+ monitored_instance:
7
+ name: Oracle DB
8
+ link: "https://docs.oracle.com/en/database/oracle/oracle-database/"
9
+ categories:
10
+ - data-collection.database-servers
11
+ icon_filename: "oracle.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - database
19
+ - oracle
20
+ - data warehouse
21
+ - SQL
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: "This collector monitors OracleDB database metrics about sessions, tables, memory and more."
26
+ method_description: "It collects the metrics via the supported database client library"
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
description: |
45
- You can follow the official guide below to install the required package:
46
-
47
- Source: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
48
- - title: Create a read only user for netdata
49
- description: |
50
- Follow the official instructions for your oracle RDBMS to create a read-only user for netdata. The operation may follow this approach
51
-
52
- Connect to your Oracle database with an administrative user and execute:
53
-
54
- ```bash
55
- CREATE USER netdata IDENTIFIED BY <PASSWORD>;
56
-
57
- GRANT CONNECT TO netdata;
58
- GRANT SELECT_CATALOG_ROLE TO netdata;
59
- ```
60
- - title: Edit the configuration
61
- description: |
62
- Edit the configuration troubleshooting:
63
-
64
- 1. Provide a valid user for the netdata collector to access the database
65
- 2. Specify the network target this database is listening.
66
- configuration:
67
- file:
68
- name: "python.d/oracledb.conf"
69
- options:
70
- description: |
71
- There are 2 sections:
72
-
73
- * Global variables
74
- * One or more JOBS that can define multiple different instances to monitor.
75
-
76
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
77
-
78
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
79
-
80
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
81
- folding:
82
- title: "Config options"
83
- enabled: true
84
- list:
85
- - name: update_every
86
- description: Sets the default data collection frequency.
87
- default_value: 5
88
- required: false
89
- - name: priority
90
- description: Controls the order of charts at the netdata dashboard.
91
- default_value: 60000
92
- required: false
93
- - name: autodetection_retry
94
- description: Sets the job re-check interval in seconds.
95
- default_value: 0
96
- required: false
97
- - name: penalty
98
- description: Indicates whether to apply penalty to update_every in case of failures.
99
- default_value: yes
100
- required: false
101
- - name: user
102
- description: The username for the user account.
103
- default_value: no
104
- required: true
105
- - name: password
106
- description: The password for the user account.
107
- default_value: no
108
- required: true
109
- - name: server
110
- description: The IP address or hostname (and port) of the Oracle Database Server.
111
- default_value: no
112
- required: true
113
- - name: service
114
- description: The Oracle Database service name. To view the services available on your server run this query, `select SERVICE_NAME from gv$session where sid in (select sid from V$MYSTAT)`.
115
- default_value: no
116
- required: true
117
- - name: protocol
118
- description: one of the strings "tcp" or "tcps" indicating whether to use unencrypted network traffic or encrypted network traffic
119
- default_value: no
120
- required: true
121
- examples:
122
- folding:
123
- enabled: true
124
- title: "Config"
125
- list:
126
- - name: Basic
33
+ In order for this collector to work, it needs a read-only user `netdata` in the RDBMS.
34
+ default_behavior:
35
+ auto_detection:
36
+ description: "When the requirements are met, databases on the local host on port 1521 will be auto-detected"
37
+ limits:
38
+ description: ""
39
+ performance_impact:
40
+ description: ""
41
+ setup:
42
+ prerequisites:
43
+ list:
44
+ - title: Install the python-oracledb package
45
+ description: |
46
+ You can follow the official guide below to install the required package:
47
+
48
+ Source: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
49
+ - title: Create a read only user for netdata
50
+ description: |
51
+ Follow the official instructions for your oracle RDBMS to create a read-only user for netdata. The operation may follow this approach
52
+
53
+ Connect to your Oracle database with an administrative user and execute:
54
+
55
+ ```bash
56
+ CREATE USER netdata IDENTIFIED BY <PASSWORD>;
57
+
58
+ GRANT CONNECT TO netdata;
59
+ GRANT SELECT_CATALOG_ROLE TO netdata;
60
+ ```
61
+ - title: Edit the configuration
62
+ description: |
63
+ Edit the configuration troubleshooting:
64
+
65
+ 1. Provide a valid user for the netdata collector to access the database
66
+ 2. Specify the network target this database is listening.
67
+ configuration:
68
+ file:
69
+ name: "python.d/oracledb.conf"
70
+ options:
71
+ description: |
72
+ There are 2 sections:
73
+
74
+ * Global variables
75
+ * One or more JOBS that can define multiple different instances to monitor.
76
+
77
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
78
+
79
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
80
+
81
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
82
+ folding:
83
+ title: "Config options"
84
+ enabled: true
85
+ list:
86
+ - name: update_every
87
+ description: Sets the default data collection frequency.
88
+ default_value: 5
89
+ required: false
90
+ - name: priority
91
+ description: Controls the order of charts at the netdata dashboard.
92
+ default_value: 60000
93
+ required: false
94
+ - name: autodetection_retry
95
+ description: Sets the job re-check interval in seconds.
96
+ default_value: 0
97
+ required: false
98
+ - name: penalty
99
+ description: Indicates whether to apply penalty to update_every in case of failures.
100
+ default_value: yes
101
+ required: false
102
+ - name: user
103
+ description: The username for the user account.
104
+ default_value: no
105
+ required: true
106
+ - name: password
107
+ description: The password for the user account.
108
+ default_value: no
109
+ required: true
110
+ - name: server
111
+ description: The IP address or hostname (and port) of the Oracle Database Server.
112
+ default_value: no
113
+ required: true
114
+ - name: service
115
+ description: The Oracle Database service name. To view the services available on your server run this query, `select SERVICE_NAME from gv$session where sid in (select sid from V$MYSTAT)`.
116
+ default_value: no
117
+ required: true
118
+ - name: protocol
119
+ description: one of the strings "tcp" or "tcps" indicating whether to use unencrypted network traffic or encrypted network traffic
120
+ default_value: no
121
+ required: true
122
+ examples:
123
folding:
128
- enabled: false
129
- description: A basic example configuration, two jobs described for two databases.
130
- config: |
131
- local:
132
- user: 'netdata'
133
- password: 'secret'
134
- server: 'localhost:1521'
135
- service: 'XE'
136
- protocol: 'tcps'
137
-
138
- remote:
139
- user: 'netdata'
140
- password: 'secret'
141
- server: '10.0.0.1:1521'
142
- service: 'XE'
143
- protocol: 'tcps'
144
-troubleshooting:
145
- problems:
146
- list: []
147
-alerts: []
148
-metrics:
149
- folding:
150
- title: Metrics
151
- enabled: false
152
- description: "These metrics refer to the entire monitored application."
153
- availability: []
154
- scopes:
155
- - name: global
156
- description: ""
157
- labels: []
158
- metrics:
159
- - name: oracledb.session_count
160
- description: Session Count
161
- unit: "sessions"
162
- chart_type: line
163
- dimensions:
164
- - name: total
165
- - name: active
166
- - name: oracledb.session_limit_usage
167
- description: Session Limit Usage
168
- unit: "%"
169
- chart_type: area
170
- dimensions:
171
- - name: usage
172
- - name: oracledb.logons
173
- description: Logons
174
- unit: "events/s"
175
- chart_type: area
176
- dimensions:
177
- - name: logons
178
- - name: oracledb.physical_disk_read_writes
179
- description: Physical Disk Reads/Writes
180
- unit: "events/s"
181
- chart_type: area
182
- dimensions:
183
- - name: reads
184
- - name: writes
185
- - name: oracledb.sorts_on_disks
186
- description: Sorts On Disk
187
- unit: "events/s"
188
- chart_type: line
189
- dimensions:
190
- - name: sorts
191
- - name: oracledb.full_table_scans
192
- description: Full Table Scans
193
- unit: "events/s"
194
- chart_type: line
195
- dimensions:
196
- - name: full table scans
197
- - name: oracledb.database_wait_time_ratio
198
- description: Database Wait Time Ratio
199
- unit: "%"
200
- chart_type: line
201
- dimensions:
202
- - name: wait time ratio
203
- - name: oracledb.shared_pool_free_memory
204
- description: Shared Pool Free Memory
205
- unit: "%"
206
- chart_type: line
207
- dimensions:
208
- - name: free memory
209
- - name: oracledb.in_memory_sorts_ratio
210
- description: In-Memory Sorts Ratio
211
- unit: "%"
212
- chart_type: line
213
- dimensions:
214
- - name: in-memory sorts
215
- - name: oracledb.sql_service_response_time
216
- description: SQL Service Response Time
217
- unit: "seconds"
218
- chart_type: line
219
- dimensions:
220
- - name: time
221
- - name: oracledb.user_rollbacks
222
- description: User Rollbacks
223
- unit: "events/s"
224
- chart_type: line
225
- dimensions:
226
- - name: rollbacks
227
- - name: oracledb.enqueue_timeouts
228
- description: Enqueue Timeouts
229
- unit: "events/s"
230
- chart_type: line
231
- dimensions:
232
- - name: enqueue timeouts
233
- - name: oracledb.cache_hit_ration
234
- description: Cache Hit Ratio
235
- unit: "%"
236
- chart_type: stacked
237
- dimensions:
238
- - name: buffer
239
- - name: cursor
240
- - name: library
241
- - name: row
242
- - name: oracledb.global_cache_blocks
243
- description: Global Cache Blocks Events
244
- unit: "events/s"
245
- chart_type: area
246
- dimensions:
247
- - name: corrupted
248
- - name: lost
249
- - name: oracledb.activity
250
- description: Activities
251
- unit: "events/s"
252
- chart_type: stacked
253
- dimensions:
254
- - name: parse count
255
- - name: execute count
256
- - name: user commits
257
- - name: user rollbacks
258
- - name: oracledb.wait_time
259
- description: Wait Time
260
- unit: "ms"
261
- chart_type: stacked
262
- dimensions:
263
- - name: application
264
- - name: configuration
265
- - name: administrative
266
- - name: concurrency
267
- - name: commit
268
- - name: network
269
- - name: user I/O
270
- - name: system I/O
271
- - name: scheduler
272
- - name: other
273
- - name: oracledb.tablespace_size
274
- description: Size
275
- unit: "KiB"
276
- chart_type: line
277
- dimensions:
278
- - name: a dimension per active tablespace
279
- - name: oracledb.tablespace_usage
280
- description: Usage
281
- unit: "KiB"
282
- chart_type: line
283
- dimensions:
284
- - name: a dimension per active tablespace
285
- - name: oracledb.tablespace_usage_in_percent
286
- description: Usage
287
- unit: "%"
288
- chart_type: line
289
- dimensions:
290
- - name: a dimension per active tablespace
291
- - name: oracledb.allocated_size
292
- description: Size
293
- unit: "B"
294
- chart_type: line
295
- dimensions:
296
- - name: a dimension per active tablespace
297
- - name: oracledb.allocated_usage
298
- description: Usage
299
- unit: "B"
300
- chart_type: line
301
- dimensions:
302
- - name: a dimension per active tablespace
303
- - name: oracledb.allocated_usage_in_percent
304
- description: Usage
305
- unit: "%"
306
- chart_type: line
307
- dimensions:
308
- - name: a dimension per active tablespace
124
+ enabled: true
125
+ title: "Config"
126
+ list:
127
+ - name: Basic
128
+ folding:
129
+ enabled: false
130
+ description: A basic example configuration, two jobs described for two databases.
131
+ config: |
132
+ local:
133
+ user: 'netdata'
134
+ password: 'secret'
135
+ server: 'localhost:1521'
136
+ service: 'XE'
137
+ protocol: 'tcps'
138
+
139
+ remote:
140
+ user: 'netdata'
141
+ password: 'secret'
142
+ server: '10.0.0.1:1521'
143
+ service: 'XE'
144
+ protocol: 'tcps'
145
+ troubleshooting:
146
+ problems:
147
+ list: []
148
+ alerts: []
149
+ metrics:
150
+ folding:
151
+ title: Metrics
152
+ enabled: false
153
+ description: "These metrics refer to the entire monitored application."
154
+ availability: []
155
+ scopes:
156
+ - name: global
157
+ description: ""
158
+ labels: []
159
+ metrics:
160
+ - name: oracledb.session_count
161
+ description: Session Count
162
+ unit: "sessions"
163
+ chart_type: line
164
+ dimensions:
165
+ - name: total
166
+ - name: active
167
+ - name: oracledb.session_limit_usage
168
+ description: Session Limit Usage
169
+ unit: "%"
170
+ chart_type: area
171
+ dimensions:
172
+ - name: usage
173
+ - name: oracledb.logons
174
+ description: Logons
175
+ unit: "events/s"
176
+ chart_type: area
177
+ dimensions:
178
+ - name: logons
179
+ - name: oracledb.physical_disk_read_writes
180
+ description: Physical Disk Reads/Writes
181
+ unit: "events/s"
182
+ chart_type: area
183
+ dimensions:
184
+ - name: reads
185
+ - name: writes
186
+ - name: oracledb.sorts_on_disks
187
+ description: Sorts On Disk
188
+ unit: "events/s"
189
+ chart_type: line
190
+ dimensions:
191
+ - name: sorts
192
+ - name: oracledb.full_table_scans
193
+ description: Full Table Scans
194
+ unit: "events/s"
195
+ chart_type: line
196
+ dimensions:
197
+ - name: full table scans
198
+ - name: oracledb.database_wait_time_ratio
199
+ description: Database Wait Time Ratio
200
+ unit: "%"
201
+ chart_type: line
202
+ dimensions:
203
+ - name: wait time ratio
204
+ - name: oracledb.shared_pool_free_memory
205
+ description: Shared Pool Free Memory
206
+ unit: "%"
207
+ chart_type: line
208
+ dimensions:
209
+ - name: free memory
210
+ - name: oracledb.in_memory_sorts_ratio
211
+ description: In-Memory Sorts Ratio
212
+ unit: "%"
213
+ chart_type: line
214
+ dimensions:
215
+ - name: in-memory sorts
216
+ - name: oracledb.sql_service_response_time
217
+ description: SQL Service Response Time
218
+ unit: "seconds"
219
+ chart_type: line
220
+ dimensions:
221
+ - name: time
222
+ - name: oracledb.user_rollbacks
223
+ description: User Rollbacks
224
+ unit: "events/s"
225
+ chart_type: line
226
+ dimensions:
227
+ - name: rollbacks
228
+ - name: oracledb.enqueue_timeouts
229
+ description: Enqueue Timeouts
230
+ unit: "events/s"
231
+ chart_type: line
232
+ dimensions:
233
+ - name: enqueue timeouts
234
+ - name: oracledb.cache_hit_ration
235
+ description: Cache Hit Ratio
236
+ unit: "%"
237
+ chart_type: stacked
238
+ dimensions:
239
+ - name: buffer
240
+ - name: cursor
241
+ - name: library
242
+ - name: row
243
+ - name: oracledb.global_cache_blocks
244
+ description: Global Cache Blocks Events
245
+ unit: "events/s"
246
+ chart_type: area
247
+ dimensions:
248
+ - name: corrupted
249
+ - name: lost
250
+ - name: oracledb.activity
251
+ description: Activities
252
+ unit: "events/s"
253
+ chart_type: stacked
254
+ dimensions:
255
+ - name: parse count
256
+ - name: execute count
257
+ - name: user commits
258
+ - name: user rollbacks
259
+ - name: oracledb.wait_time
260
+ description: Wait Time
261
+ unit: "ms"
262
+ chart_type: stacked
263
+ dimensions:
264
+ - name: application
265
+ - name: configuration
266
+ - name: administrative
267
+ - name: concurrency
268
+ - name: commit
269
+ - name: network
270
+ - name: user I/O
271
+ - name: system I/O
272
+ - name: scheduler
273
+ - name: other
274
+ - name: oracledb.tablespace_size
275
+ description: Size
276
+ unit: "KiB"
277
+ chart_type: line
278
+ dimensions:
279
+ - name: a dimension per active tablespace
280
+ - name: oracledb.tablespace_usage
281
+ description: Usage
282
+ unit: "KiB"
283
+ chart_type: line
284
+ dimensions:
285
+ - name: a dimension per active tablespace
286
+ - name: oracledb.tablespace_usage_in_percent
287
+ description: Usage
288
+ unit: "%"
289
+ chart_type: line
290
+ dimensions:
291
+ - name: a dimension per active tablespace
292
+ - name: oracledb.allocated_size
293
+ description: Size
294
+ unit: "B"
295
+ chart_type: line
296
+ dimensions:
297
+ - name: a dimension per active tablespace
298
+ - name: oracledb.allocated_usage
299
+ description: Usage
300
+ unit: "B"
301
+ chart_type: line
302
+ dimensions:
303
+ - name: a dimension per active tablespace
304
+ - name: oracledb.allocated_usage_in_percent
305
+ description: Usage
306
+ unit: "%"
307
+ chart_type: line
308
+ dimensions:
309
+ - name: a dimension per active tablespace
collectors/python.d.plugin/pandas/metadata.yaml
+305
-305
@@ -1,310 +1,310 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: pandas
6
- monitored_instance:
7
- name: Pandas
8
- link: https://learn.netdata.cloud/docs/data-collection/generic-data-collection/structured-data-pandas
9
- categories:
10
- - data-collection.other
11
- icon_filename: pandas.png
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - pandas
19
- - python
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: |
24
- [Pandas](https://pandas.pydata.org/) is a de-facto standard in reading and processing most types of structured data in Python.
25
- If you have metrics appearing in a CSV, JSON, XML, HTML, or [other supported format](https://pandas.pydata.org/docs/user_guide/io.html),
26
- either locally or via some HTTP endpoint, you can easily ingest and present those metrics in Netdata, by leveraging the Pandas collector.
27
-
28
- This collector can be used to collect pretty much anything that can be read by Pandas, and then processed by Pandas.
29
-
30
- More detailed information can be found in the Netdata documentation [here](https://learn.netdata.cloud/docs/data-collection/generic-data-collection/structured-data-pandas).
31
- method_description: |
32
- The collector uses [pandas](https://pandas.pydata.org/) to pull data and do pandas-based preprocessing, before feeding to Netdata.
33
- supported_platforms:
34
- include: []
35
- exclude: []
36
- multi_instance: true
37
- additional_permissions:
38
- description: ""
39
- default_behavior:
40
- auto_detection:
41
- description: ""
42
- limits:
43
- description: ""
44
- performance_impact:
45
- description: ""
46
-setup:
47
- prerequisites:
48
- list:
49
- - title: Python Requirements
50
- description: |
51
- This collector depends on some Python (Python 3 only) packages that can usually be installed via `pip` or `pip3`.
52
-
53
- ```bash
54
- sudo pip install pandas requests
55
- ```
56
-
57
- Note: If you would like to use [`pandas.read_sql`](https://pandas.pydata.org/docs/reference/api/pandas.read_sql.html) to query a database, you will need to install the below packages as well.
58
-
59
- ```bash
60
- sudo pip install 'sqlalchemy<2.0' psycopg2-binary
61
- ```
62
- configuration:
63
- file:
64
- name: python.d/pandas.conf
65
- description: ""
66
- options:
67
- description: |
68
- There are 2 sections:
69
-
70
- * Global variables
71
- * One or more JOBS that can define multiple different instances to monitor.
72
-
73
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
74
-
75
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
76
-
77
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
78
- folding:
79
- title: Config options
80
- enabled: true
81
- list:
82
- - name: chart_configs
83
- description: an array of chart configuration dictionaries
84
- default_value: []
85
- required: true
86
- - name: chart_configs.name
87
- description: name of the chart to be displayed in the dashboard.
88
- default_value: None
89
- required: true
90
- - name: chart_configs.title
91
- description: title of the chart to be displayed in the dashboard.
92
- default_value: None
93
- required: true
94
- - name: chart_configs.family
95
- description: "[family](https://learn.netdata.cloud/docs/data-collection/chart-dimensions-contexts-and-families#family) of the chart to be displayed in the dashboard."
96
- default_value: None
97
- required: true
98
- - name: chart_configs.context
99
- description: "[context](https://learn.netdata.cloud/docs/data-collection/chart-dimensions-contexts-and-families#context) of the chart to be displayed in the dashboard."
100
- default_value: None
101
- required: true
102
- - name: chart_configs.type
103
- description: the type of the chart to be displayed in the dashboard.
104
- default_value: None
105
- required: true
106
- - name: chart_configs.units
107
- description: the units of the chart to be displayed in the dashboard.
108
- default_value: None
109
- required: true
110
- - name: chart_configs.df_steps
111
- description: a series of pandas operations (one per line) that each returns a dataframe.
112
- default_value: None
113
- required: true
114
- - name: update_every
115
- description: Sets the default data collection frequency.
116
- default_value: 5
117
- required: false
118
- - name: priority
119
- description: Controls the order of charts at the netdata dashboard.
120
- default_value: 60000
121
- required: false
122
- - name: autodetection_retry
123
- description: Sets the job re-check interval in seconds.
124
- default_value: 0
125
- required: false
126
- - name: penalty
127
- description: Indicates whether to apply penalty to update_every in case of failures.
128
- default_value: yes
129
- required: false
130
- - name: name
131
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
132
- default_value: ""
133
- required: false
134
- examples:
135
- folding:
136
- enabled: true
137
- title: Config
138
- list:
139
- - name: Temperature API Example
140
- folding:
141
- enabled: true
142
- description: example pulling some hourly temperature data, a chart for today forecast (mean,min,max) and another chart for current.
143
- config: |
144
- temperature:
145
- name: "temperature"
146
- update_every: 5
147
- chart_configs:
148
- - name: "temperature_forecast_by_city"
149
- title: "Temperature By City - Today Forecast"
150
- family: "temperature.today"
151
- context: "pandas.temperature"
152
- type: "line"
153
- units: "Celsius"
154
- df_steps: >
155
- pd.DataFrame.from_dict(
156
- {city: requests.get(f'https://api.open-meteo.com/v1/forecast?latitude={lat}&longitude={lng}&hourly=temperature_2m').json()['hourly']['temperature_2m']
157
- for (city,lat,lng)
158
- in [
159
- ('dublin', 53.3441, -6.2675),
160
- ('athens', 37.9792, 23.7166),
161
- ('london', 51.5002, -0.1262),
162
- ('berlin', 52.5235, 13.4115),
163
- ('paris', 48.8567, 2.3510),
164
- ('madrid', 40.4167, -3.7033),
165
- ('new_york', 40.71, -74.01),
166
- ('los_angeles', 34.05, -118.24),
167
- ]
168
- }
169
- );
170
- df.describe(); # get aggregate stats for each city;
171
- df.transpose()[['mean', 'max', 'min']].reset_index(); # just take mean, min, max;
172
- df.rename(columns={'index':'city'}); # some column renaming;
173
- df.pivot(columns='city').mean().to_frame().reset_index(); # force to be one row per city;
174
- df.rename(columns={0:'degrees'}); # some column renaming;
175
- pd.concat([df, df['city']+'_'+df['level_0']], axis=1); # add new column combining city and summary measurement label;
176
- df.rename(columns={0:'measurement'}); # some column renaming;
177
- df[['measurement', 'degrees']].set_index('measurement'); # just take two columns we want;
178
- df.sort_index(); # sort by city name;
179
- df.transpose(); # transpose so its just one wide row;
180
- - name: "temperature_current_by_city"
181
- title: "Temperature By City - Current"
182
- family: "temperature.current"
183
- context: "pandas.temperature"
184
- type: "line"
185
- units: "Celsius"
186
- df_steps: >
187
- pd.DataFrame.from_dict(
188
- {city: requests.get(f'https://api.open-meteo.com/v1/forecast?latitude={lat}&longitude={lng}¤t_weather=true').json()['current_weather']
189
- for (city,lat,lng)
190
- in [
191
- ('dublin', 53.3441, -6.2675),
192
- ('athens', 37.9792, 23.7166),
193
- ('london', 51.5002, -0.1262),
194
- ('berlin', 52.5235, 13.4115),
195
- ('paris', 48.8567, 2.3510),
196
- ('madrid', 40.4167, -3.7033),
197
- ('new_york', 40.71, -74.01),
198
- ('los_angeles', 34.05, -118.24),
199
- ]
200
- }
201
- );
202
- df.transpose();
203
- df[['temperature']];
204
- df.transpose();
205
- - name: API CSV Example
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: pandas
6
+ monitored_instance:
7
+ name: Pandas
8
+ link: https://learn.netdata.cloud/docs/data-collection/generic-data-collection/structured-data-pandas
9
+ categories:
10
+ - data-collection.other
11
+ icon_filename: pandas.png
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - pandas
19
+ - python
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: |
24
+ [Pandas](https://pandas.pydata.org/) is a de-facto standard in reading and processing most types of structured data in Python.
25
+ If you have metrics appearing in a CSV, JSON, XML, HTML, or [other supported format](https://pandas.pydata.org/docs/user_guide/io.html),
26
+ either locally or via some HTTP endpoint, you can easily ingest and present those metrics in Netdata, by leveraging the Pandas collector.
27
+
28
+ This collector can be used to collect pretty much anything that can be read by Pandas, and then processed by Pandas.
29
+
30
+ More detailed information can be found in the Netdata documentation [here](https://learn.netdata.cloud/docs/data-collection/generic-data-collection/structured-data-pandas).
31
+ method_description: |
32
+ The collector uses [pandas](https://pandas.pydata.org/) to pull data and do pandas-based preprocessing, before feeding to Netdata.
33
+ supported_platforms:
34
+ include: []
35
+ exclude: []
36
+ multi_instance: true
37
+ additional_permissions:
38
+ description: ""
39
+ default_behavior:
40
+ auto_detection:
41
+ description: ""
42
+ limits:
43
+ description: ""
44
+ performance_impact:
45
+ description: ""
46
+ setup:
47
+ prerequisites:
48
+ list:
49
+ - title: Python Requirements
50
+ description: |
51
+ This collector depends on some Python (Python 3 only) packages that can usually be installed via `pip` or `pip3`.
52
+
53
+ ```bash
54
+ sudo pip install pandas requests
55
+ ```
56
+
57
+ Note: If you would like to use [`pandas.read_sql`](https://pandas.pydata.org/docs/reference/api/pandas.read_sql.html) to query a database, you will need to install the below packages as well.
58
+
59
+ ```bash
60
+ sudo pip install 'sqlalchemy<2.0' psycopg2-binary
61
+ ```
62
+ configuration:
63
+ file:
64
+ name: python.d/pandas.conf
65
+ description: ""
66
+ options:
67
+ description: |
68
+ There are 2 sections:
69
+
70
+ * Global variables
71
+ * One or more JOBS that can define multiple different instances to monitor.
72
+
73
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
74
+
75
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
76
+
77
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
78
folding:
79
+ title: Config options
80
enabled: true
208
- description: example showing a read_csv from a url and some light pandas data wrangling.
209
- config: |
210
- example_csv:
211
- name: "example_csv"
212
- update_every: 2
213
- chart_configs:
214
- - name: "london_system_cpu"
215
- title: "London System CPU - Ratios"
216
- family: "london_system_cpu"
217
- context: "pandas"
218
- type: "line"
219
- units: "n"
220
- df_steps: >
221
- pd.read_csv('https://london.my-netdata.io/api/v1/data?chart=system.cpu&format=csv&after=-60', storage_options={'User-Agent': 'netdata'});
222
- df.drop('time', axis=1);
223
- df.mean().to_frame().transpose();
224
- df.apply(lambda row: (row.user / row.system), axis = 1).to_frame();
225
- df.rename(columns={0:'average_user_system_ratio'});
226
- df*100;
227
- - name: API JSON Example
81
+ list:
82
+ - name: chart_configs
83
+ description: an array of chart configuration dictionaries
84
+ default_value: "[]"
85
+ required: true
86
+ - name: chart_configs.name
87
+ description: name of the chart to be displayed in the dashboard.
88
+ default_value: None
89
+ required: true
90
+ - name: chart_configs.title
91
+ description: title of the chart to be displayed in the dashboard.
92
+ default_value: None
93
+ required: true
94
+ - name: chart_configs.family
95
+ description: "[family](https://learn.netdata.cloud/docs/data-collection/chart-dimensions-contexts-and-families#family) of the chart to be displayed in the dashboard."
96
+ default_value: None
97
+ required: true
98
+ - name: chart_configs.context
99
+ description: "[context](https://learn.netdata.cloud/docs/data-collection/chart-dimensions-contexts-and-families#context) of the chart to be displayed in the dashboard."
100
+ default_value: None
101
+ required: true
102
+ - name: chart_configs.type
103
+ description: the type of the chart to be displayed in the dashboard.
104
+ default_value: None
105
+ required: true
106
+ - name: chart_configs.units
107
+ description: the units of the chart to be displayed in the dashboard.
108
+ default_value: None
109
+ required: true
110
+ - name: chart_configs.df_steps
111
+ description: a series of pandas operations (one per line) that each returns a dataframe.
112
+ default_value: None
113
+ required: true
114
+ - name: update_every
115
+ description: Sets the default data collection frequency.
116
+ default_value: 5
117
+ required: false
118
+ - name: priority
119
+ description: Controls the order of charts at the netdata dashboard.
120
+ default_value: 60000
121
+ required: false
122
+ - name: autodetection_retry
123
+ description: Sets the job re-check interval in seconds.
124
+ default_value: 0
125
+ required: false
126
+ - name: penalty
127
+ description: Indicates whether to apply penalty to update_every in case of failures.
128
+ default_value: yes
129
+ required: false
130
+ - name: name
131
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
132
+ default_value: ""
133
+ required: false
134
+ examples:
135
folding:
136
enabled: true
230
- description: example showing a read_json from a url and some light pandas data wrangling.
231
- config: |
232
- example_json:
233
- name: "example_json"
234
- update_every: 2
235
- chart_configs:
236
- - name: "london_system_net"
237
- title: "London System Net - Total Bandwidth"
238
- family: "london_system_net"
239
- context: "pandas"
240
- type: "area"
241
- units: "kilobits/s"
242
- df_steps: >
243
- pd.DataFrame(requests.get('https://london.my-netdata.io/api/v1/data?chart=system.net&format=json&after=-1').json()['data'], columns=requests.get('https://london.my-netdata.io/api/v1/data?chart=system.net&format=json&after=-1').json()['labels']);
244
- df.drop('time', axis=1);
245
- abs(df);
246
- df.sum(axis=1).to_frame();
247
- df.rename(columns={0:'total_bandwidth'});
248
- - name: XML Example
249
- folding:
250
- enabled: true
251
- description: example showing a read_xml from a url and some light pandas data wrangling.
252
- config: |
253
- example_xml:
254
- name: "example_xml"
255
- update_every: 2
256
- line_sep: "|"
257
- chart_configs:
258
- - name: "temperature_forcast"
259
- title: "Temperature Forecast"
260
- family: "temp"
261
- context: "pandas.temp"
262
- type: "line"
263
- units: "celsius"
264
- df_steps: >
265
- pd.read_xml('http://metwdb-openaccess.ichec.ie/metno-wdb2ts/locationforecast?lat=54.7210798611;long=-8.7237392806', xpath='./product/time[1]/location/temperature', parser='etree')|
266
- df.rename(columns={'value': 'dublin'})|
267
- df[['dublin']]|
268
- - name: SQL Example
269
- folding:
270
- enabled: true
271
- description: example showing a read_sql from a postgres database using sqlalchemy.
272
- config: |
273
- sql:
274
- name: "sql"
275
- update_every: 5
276
- chart_configs:
277
- - name: "sql"
278
- title: "SQL Example"
279
- family: "sql.example"
280
- context: "example"
281
- type: "line"
282
- units: "percent"
283
- df_steps: >
284
- pd.read_sql_query(
285
- sql='\
286
- select \
287
- random()*100 as metric_1, \
288
- random()*100 as metric_2 \
289
- ',
290
- con=create_engine('postgresql://localhost/postgres?user=netdata&password=netdata')
291
- );
292
-troubleshooting:
293
- problems:
294
- list: []
295
-alerts: []
296
-metrics:
297
- folding:
298
- title: Metrics
299
- enabled: false
300
- description: |
301
- This collector is expecting one row in the final pandas DataFrame. It is that first row that will be taken
302
- as the most recent values for each dimension on each chart using (`df.to_dict(orient='records')[0]`).
303
- See [pd.to_dict()](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_dict.html)."
304
- availability: []
305
- scopes:
306
- - name: global
137
+ title: Config
138
+ list:
139
+ - name: Temperature API Example
140
+ folding:
141
+ enabled: true
142
+ description: example pulling some hourly temperature data, a chart for today forecast (mean,min,max) and another chart for current.
143
+ config: |
144
+ temperature:
145
+ name: "temperature"
146
+ update_every: 5
147
+ chart_configs:
148
+ - name: "temperature_forecast_by_city"
149
+ title: "Temperature By City - Today Forecast"
150
+ family: "temperature.today"
151
+ context: "pandas.temperature"
152
+ type: "line"
153
+ units: "Celsius"
154
+ df_steps: >
155
+ pd.DataFrame.from_dict(
156
+ {city: requests.get(f'https://api.open-meteo.com/v1/forecast?latitude={lat}&longitude={lng}&hourly=temperature_2m').json()['hourly']['temperature_2m']
157
+ for (city,lat,lng)
158
+ in [
159
+ ('dublin', 53.3441, -6.2675),
160
+ ('athens', 37.9792, 23.7166),
161
+ ('london', 51.5002, -0.1262),
162
+ ('berlin', 52.5235, 13.4115),
163
+ ('paris', 48.8567, 2.3510),
164
+ ('madrid', 40.4167, -3.7033),
165
+ ('new_york', 40.71, -74.01),
166
+ ('los_angeles', 34.05, -118.24),
167
+ ]
168
+ }
169
+ );
170
+ df.describe(); # get aggregate stats for each city;
171
+ df.transpose()[['mean', 'max', 'min']].reset_index(); # just take mean, min, max;
172
+ df.rename(columns={'index':'city'}); # some column renaming;
173
+ df.pivot(columns='city').mean().to_frame().reset_index(); # force to be one row per city;
174
+ df.rename(columns={0:'degrees'}); # some column renaming;
175
+ pd.concat([df, df['city']+'_'+df['level_0']], axis=1); # add new column combining city and summary measurement label;
176
+ df.rename(columns={0:'measurement'}); # some column renaming;
177
+ df[['measurement', 'degrees']].set_index('measurement'); # just take two columns we want;
178
+ df.sort_index(); # sort by city name;
179
+ df.transpose(); # transpose so its just one wide row;
180
+ - name: "temperature_current_by_city"
181
+ title: "Temperature By City - Current"
182
+ family: "temperature.current"
183
+ context: "pandas.temperature"
184
+ type: "line"
185
+ units: "Celsius"
186
+ df_steps: >
187
+ pd.DataFrame.from_dict(
188
+ {city: requests.get(f'https://api.open-meteo.com/v1/forecast?latitude={lat}&longitude={lng}¤t_weather=true').json()['current_weather']
189
+ for (city,lat,lng)
190
+ in [
191
+ ('dublin', 53.3441, -6.2675),
192
+ ('athens', 37.9792, 23.7166),
193
+ ('london', 51.5002, -0.1262),
194
+ ('berlin', 52.5235, 13.4115),
195
+ ('paris', 48.8567, 2.3510),
196
+ ('madrid', 40.4167, -3.7033),
197
+ ('new_york', 40.71, -74.01),
198
+ ('los_angeles', 34.05, -118.24),
199
+ ]
200
+ }
201
+ );
202
+ df.transpose();
203
+ df[['temperature']];
204
+ df.transpose();
205
+ - name: API CSV Example
206
+ folding:
207
+ enabled: true
208
+ description: example showing a read_csv from a url and some light pandas data wrangling.
209
+ config: |
210
+ example_csv:
211
+ name: "example_csv"
212
+ update_every: 2
213
+ chart_configs:
214
+ - name: "london_system_cpu"
215
+ title: "London System CPU - Ratios"
216
+ family: "london_system_cpu"
217
+ context: "pandas"
218
+ type: "line"
219
+ units: "n"
220
+ df_steps: >
221
+ pd.read_csv('https://london.my-netdata.io/api/v1/data?chart=system.cpu&format=csv&after=-60', storage_options={'User-Agent': 'netdata'});
222
+ df.drop('time', axis=1);
223
+ df.mean().to_frame().transpose();
224
+ df.apply(lambda row: (row.user / row.system), axis = 1).to_frame();
225
+ df.rename(columns={0:'average_user_system_ratio'});
226
+ df*100;
227
+ - name: API JSON Example
228
+ folding:
229
+ enabled: true
230
+ description: example showing a read_json from a url and some light pandas data wrangling.
231
+ config: |
232
+ example_json:
233
+ name: "example_json"
234
+ update_every: 2
235
+ chart_configs:
236
+ - name: "london_system_net"
237
+ title: "London System Net - Total Bandwidth"
238
+ family: "london_system_net"
239
+ context: "pandas"
240
+ type: "area"
241
+ units: "kilobits/s"
242
+ df_steps: >
243
+ pd.DataFrame(requests.get('https://london.my-netdata.io/api/v1/data?chart=system.net&format=json&after=-1').json()['data'], columns=requests.get('https://london.my-netdata.io/api/v1/data?chart=system.net&format=json&after=-1').json()['labels']);
244
+ df.drop('time', axis=1);
245
+ abs(df);
246
+ df.sum(axis=1).to_frame();
247
+ df.rename(columns={0:'total_bandwidth'});
248
+ - name: XML Example
249
+ folding:
250
+ enabled: true
251
+ description: example showing a read_xml from a url and some light pandas data wrangling.
252
+ config: |
253
+ example_xml:
254
+ name: "example_xml"
255
+ update_every: 2
256
+ line_sep: "|"
257
+ chart_configs:
258
+ - name: "temperature_forcast"
259
+ title: "Temperature Forecast"
260
+ family: "temp"
261
+ context: "pandas.temp"
262
+ type: "line"
263
+ units: "celsius"
264
+ df_steps: >
265
+ pd.read_xml('http://metwdb-openaccess.ichec.ie/metno-wdb2ts/locationforecast?lat=54.7210798611;long=-8.7237392806', xpath='./product/time[1]/location/temperature', parser='etree')|
266
+ df.rename(columns={'value': 'dublin'})|
267
+ df[['dublin']]|
268
+ - name: SQL Example
269
+ folding:
270
+ enabled: true
271
+ description: example showing a read_sql from a postgres database using sqlalchemy.
272
+ config: |
273
+ sql:
274
+ name: "sql"
275
+ update_every: 5
276
+ chart_configs:
277
+ - name: "sql"
278
+ title: "SQL Example"
279
+ family: "sql.example"
280
+ context: "example"
281
+ type: "line"
282
+ units: "percent"
283
+ df_steps: >
284
+ pd.read_sql_query(
285
+ sql='\
286
+ select \
287
+ random()*100 as metric_1, \
288
+ random()*100 as metric_2 \
289
+ ',
290
+ con=create_engine('postgresql://localhost/postgres?user=netdata&password=netdata')
291
+ );
292
+ troubleshooting:
293
+ problems:
294
+ list: []
295
+ alerts: []
296
+ metrics:
297
+ folding:
298
+ title: Metrics
299
+ enabled: false
300
description: |
308
- These metrics refer to the entire monitored application.
309
- labels: []
310
- metrics: []
301
+ This collector is expecting one row in the final pandas DataFrame. It is that first row that will be taken
302
+ as the most recent values for each dimension on each chart using (`df.to_dict(orient='records')[0]`).
303
+ See [pd.to_dict()](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_dict.html)."
304
+ availability: []
305
+ scopes:
306
+ - name: global
307
+ description: |
308
+ These metrics refer to the entire monitored application.
309
+ labels: []
310
+ metrics: []
collectors/python.d.plugin/postfix/metadata.yaml
+123
-123
@@ -1,124 +1,124 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: postfix
6
- monitored_instance:
7
- name: Postfix
8
- link: https://www.postfix.org/
9
- categories:
10
- - data-collection.mail-servers
11
- icon_filename: "postfix.svg"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - postfix
19
- - mail
20
- - mail server
21
- most_popular: false
22
-overview:
23
- data_collection:
24
- metrics_description: >
25
- Keep an eye on Postfix metrics for efficient mail server operations.
26
-
27
- Improve your mail server performance with Netdata's real-time metrics and built-in alerts.
28
- method_description: >
29
- Monitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.
30
- supported_platforms:
31
- include: []
32
- exclude: []
33
- multi_instance: true
34
- additional_permissions:
35
- description: >
36
- Postfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view
37
- the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to
38
- view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.
39
-
40
- See the `authorized_mailq_users` setting in
41
- the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.
42
- default_behavior:
43
- auto_detection:
44
- description: "The collector executes `postqueue -p` to get Postfix queue statistics."
45
- limits:
46
- description: ""
47
- performance_impact:
48
- description: ""
49
-setup:
50
- prerequisites:
51
- list: []
52
- configuration:
53
- file:
54
- name: ""
55
- description: ""
56
- options:
57
- description: |
58
- There are 2 sections:
59
-
60
- * Global variables
61
- * One or more JOBS that can define multiple different instances to monitor.
62
-
63
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
64
-
65
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
66
-
67
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: postfix
6
+ monitored_instance:
7
+ name: Postfix
8
+ link: https://www.postfix.org/
9
+ categories:
10
+ - data-collection.mail-servers
11
+ icon_filename: "postfix.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - postfix
19
+ - mail
20
+ - mail server
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: >
25
+ Keep an eye on Postfix metrics for efficient mail server operations.
26
+
27
+ Improve your mail server performance with Netdata's real-time metrics and built-in alerts.
28
+ method_description: >
29
+ Monitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.
30
+ supported_platforms:
31
+ include: []
32
+ exclude: []
33
+ multi_instance: true
34
+ additional_permissions:
35
+ description: >
36
+ Postfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view
37
+ the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to
38
+ view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.
39
+
40
+ See the `authorized_mailq_users` setting in
41
+ the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.
42
+ default_behavior:
43
+ auto_detection:
44
+ description: "The collector executes `postqueue -p` to get Postfix queue statistics."
45
+ limits:
46
+ description: ""
47
+ performance_impact:
48
+ description: ""
49
+ setup:
50
+ prerequisites:
51
+ list: []
52
+ configuration:
53
+ file:
54
+ name: ""
55
+ description: ""
56
+ options:
57
+ description: |
58
+ There are 2 sections:
59
+
60
+ * Global variables
61
+ * One or more JOBS that can define multiple different instances to monitor.
62
+
63
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
64
+
65
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
66
+
67
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
68
+ folding:
69
+ title: Config options
70
+ enabled: true
71
+ list:
72
+ - name: update_every
73
+ description: Sets the default data collection frequency.
74
+ default_value: 1
75
+ required: false
76
+ - name: priority
77
+ description: Controls the order of charts at the netdata dashboard.
78
+ default_value: 60000
79
+ required: false
80
+ - name: autodetection_retry
81
+ description: Sets the job re-check interval in seconds.
82
+ default_value: 0
83
+ required: false
84
+ - name: penalty
85
+ description: Indicates whether to apply penalty to update_every in case of failures.
86
+ default_value: yes
87
+ required: false
88
+ - name: name
89
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
90
+ default_value: ""
91
+ required: false
92
+ examples:
93
+ folding:
94
+ enabled: true
95
+ title: ""
96
+ list: []
97
+ troubleshooting:
98
+ problems:
99
+ list: []
100
+ alerts: []
101
+ metrics:
102
folding:
69
- title: Config options
70
- enabled: true
71
- list:
72
- - name: update_every
73
- description: Sets the default data collection frequency.
74
- default_value: 1
75
- required: false
76
- - name: priority
77
- description: Controls the order of charts at the netdata dashboard.
78
- default_value: 60000
79
- required: false
80
- - name: autodetection_retry
81
- description: Sets the job re-check interval in seconds.
82
- default_value: 0
83
- required: false
84
- - name: penalty
85
- description: Indicates whether to apply penalty to update_every in case of failures.
86
- default_value: yes
87
- required: false
88
- - name: name
89
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
90
- default_value: ""
91
- required: false
92
- examples:
93
- folding:
94
- enabled: true
95
- title: ""
96
- list: []
97
-troubleshooting:
98
- problems:
99
- list: []
100
-alerts: []
101
-metrics:
102
- folding:
103
- title: Metrics
104
- enabled: false
105
- description: ""
106
- availability: []
107
- scopes:
108
- - name: global
109
- description: |
110
- These metrics refer to the entire monitored application.
111
- labels: []
112
- metrics:
113
- - name: postfix.qemails
114
- description: Postfix Queue Emails
115
- unit: "emails"
116
- chart_type: line
117
- dimensions:
118
- - name: emails
119
- - name: postfix.qsize
120
- description: Postfix Queue Emails Size
121
- unit: "KiB"
122
- chart_type: area
123
- dimensions:
124
- - name: size
103
+ title: Metrics
104
+ enabled: false
105
+ description: ""
106
+ availability: []
107
+ scopes:
108
+ - name: global
109
+ description: |
110
+ These metrics refer to the entire monitored application.
111
+ labels: []
112
+ metrics:
113
+ - name: postfix.qemails
114
+ description: Postfix Queue Emails
115
+ unit: "emails"
116
+ chart_type: line
117
+ dimensions:
118
+ - name: emails
119
+ - name: postfix.qsize
120
+ description: Postfix Queue Emails Size
121
+ unit: "KiB"
122
+ chart_type: area
123
+ dimensions:
124
+ - name: size
collectors/python.d.plugin/puppet/metadata.yaml
+184
-182
@@ -1,183 +1,185 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: puppet
4
- monitored_instance:
5
- name: Puppet
6
- link: "https://www.puppet.com/"
7
- categories:
8
- - data-collection.provisioning-systems
9
- icon_filename: "puppet.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - puppet
17
- - jvm heap
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: |
22
- This collector monitors Puppet metrics about JVM Heap, Non-Heap, CPU usage and file descriptors.'
23
- method_description: |
24
- It uses Puppet's metrics API endpoint to gather the metrics.
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: true
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: By default, this collector will use `https://fqdn.example.com:8140` as the URL to look for metrics.
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list: []
41
- configuration:
42
- file:
43
- name: "python.d/puppet.conf"
44
- options:
45
- description: |
46
- This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.
47
-
48
- There are 2 sections:
49
-
50
- * Global variables
51
- * One or more JOBS that can define multiple different instances to monitor.
52
-
53
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
54
-
55
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
-
57
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
-
59
- > Notes:
60
- > - Exact Fully Qualified Domain Name of the node should be used.
61
- > - Usually Puppet Server/DB startup time is VERY long. So, there should be quite reasonable retry count.
62
- > - A secured PuppetDB config may require a client certificate. This does not apply to the default PuppetDB configuration though.
63
- folding:
64
- title: "Config options"
65
- enabled: true
66
- list:
67
- - name: url
68
- description: HTTP or HTTPS URL, exact Fully Qualified Domain Name of the node should be used.
69
- default_value: https://fqdn.example.com:8081
70
- required: true
71
- - name: tls_verify
72
- description: Control HTTPS server certificate verification.
73
- default_value: "False"
74
- required: false
75
- - name: tls_ca_file
76
- description: Optional CA (bundle) file to use
77
- default_value: ""
78
- required: false
79
- - name: tls_cert_file
80
- description: Optional client certificate file
81
- default_value: ""
82
- required: false
83
- - name: tls_key_file
84
- description: Optional client key file
85
- default_value: ""
86
- required: false
87
- - name: update_every
88
- description: Sets the default data collection frequency.
89
- default_value: 30
90
- required: false
91
- - name: priority
92
- description: Controls the order of charts at the netdata dashboard.
93
- default_value: 60000
94
- required: false
95
- - name: autodetection_retry
96
- description: Sets the job re-check interval in seconds.
97
- default_value: 0
98
- required: false
99
- - name: penalty
100
- description: Indicates whether to apply penalty to update_every in case of failures.
101
- default_value: yes
102
- required: false
103
- - name: name
104
- description: >
105
- Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
106
- default_value: ""
107
- required: false
108
- examples:
109
- folding:
110
- enabled: true
111
- title: "Config"
112
- list:
113
- - name: Basic
114
- description: A basic example configuration
115
- folding:
116
- enabled: false
117
- config: |
118
- puppetserver:
119
- url: 'https://fqdn.example.com:8140'
120
- autodetection_retry: 1
121
- - name: TLS Certificate
122
- description: An example using a TLS certificate
123
- config: |
124
- puppetdb:
125
- url: 'https://fqdn.example.com:8081'
126
- tls_cert_file: /path/to/client.crt
127
- tls_key_file: /path/to/client.key
128
- autodetection_retry: 1
129
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: puppet
6
+ monitored_instance:
7
+ name: Puppet
8
+ link: "https://www.puppet.com/"
9
+ categories:
10
+ - data-collection.provisioning-systems
11
+ icon_filename: "puppet.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - puppet
19
+ - jvm heap
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: |
24
+ This collector monitors Puppet metrics about JVM Heap, Non-Heap, CPU usage and file descriptors.'
25
+ method_description: |
26
+ It uses Puppet's metrics API endpoint to gather the metrics.
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: By default, this collector will use `https://fqdn.example.com:8140` as the URL to look for metrics.
36
+ limits:
37
+ description: ""
38
+ performance_impact:
39
+ description: ""
40
+ setup:
41
+ prerequisites:
42
+ list: []
43
+ configuration:
44
+ file:
45
+ name: "python.d/puppet.conf"
46
+ options:
47
description: |
131
- > **Note**: When you define multiple jobs, their names must be unique.
132
-
133
- Collecting metrics from local and remote instances.
134
- config: |
135
- puppetserver1:
136
- url: 'https://fqdn.example.com:8140'
137
- autodetection_retry: 1
138
-
139
- puppetserver2:
140
- url: 'https://fqdn.example2.com:8140'
141
- autodetection_retry: 1
142
-troubleshooting:
143
- problems:
144
- list: []
145
-alerts: []
146
-metrics:
147
- folding:
148
- title: Metrics
149
- enabled: false
150
- description: ""
151
- availability: []
152
- scopes:
153
- - name: global
154
- description: "These metrics refer to the entire monitored application."
155
- labels: []
156
- metrics:
157
- - name: puppet.jvm
158
- description: JVM Heap
159
- unit: "MiB"
160
- chart_type: area
161
- dimensions:
162
- - name: committed
163
- - name: used
164
- - name: puppet.jvm
165
- description: JVM Non-Heap
166
- unit: "MiB"
167
- chart_type: area
168
- dimensions:
169
- - name: committed
170
- - name: used
171
- - name: puppet.cpu
172
- description: CPU usage
173
- unit: "percentage"
174
- chart_type: stacked
175
- dimensions:
176
- - name: execution
177
- - name: GC
178
- - name: puppet.fdopen
179
- description: File Descriptors
180
- unit: "descriptors"
181
- chart_type: line
182
- dimensions:
183
- - name: used
48
+ This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.
49
+
50
+ There are 2 sections:
51
+
52
+ * Global variables
53
+ * One or more JOBS that can define multiple different instances to monitor.
54
+
55
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
+
57
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
+
59
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
+
61
+ > Notes:
62
+ > - Exact Fully Qualified Domain Name of the node should be used.
63
+ > - Usually Puppet Server/DB startup time is VERY long. So, there should be quite reasonable retry count.
64
+ > - A secured PuppetDB config may require a client certificate. This does not apply to the default PuppetDB configuration though.
65
+ folding:
66
+ title: "Config options"
67
+ enabled: true
68
+ list:
69
+ - name: url
70
+ description: HTTP or HTTPS URL, exact Fully Qualified Domain Name of the node should be used.
71
+ default_value: https://fqdn.example.com:8081
72
+ required: true
73
+ - name: tls_verify
74
+ description: Control HTTPS server certificate verification.
75
+ default_value: "False"
76
+ required: false
77
+ - name: tls_ca_file
78
+ description: Optional CA (bundle) file to use
79
+ default_value: ""
80
+ required: false
81
+ - name: tls_cert_file
82
+ description: Optional client certificate file
83
+ default_value: ""
84
+ required: false
85
+ - name: tls_key_file
86
+ description: Optional client key file
87
+ default_value: ""
88
+ required: false
89
+ - name: update_every
90
+ description: Sets the default data collection frequency.
91
+ default_value: 30
92
+ required: false
93
+ - name: priority
94
+ description: Controls the order of charts at the netdata dashboard.
95
+ default_value: 60000
96
+ required: false
97
+ - name: autodetection_retry
98
+ description: Sets the job re-check interval in seconds.
99
+ default_value: 0
100
+ required: false
101
+ - name: penalty
102
+ description: Indicates whether to apply penalty to update_every in case of failures.
103
+ default_value: yes
104
+ required: false
105
+ - name: name
106
+ description: >
107
+ Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
108
+ default_value: ""
109
+ required: false
110
+ examples:
111
+ folding:
112
+ enabled: true
113
+ title: "Config"
114
+ list:
115
+ - name: Basic
116
+ description: A basic example configuration
117
+ folding:
118
+ enabled: false
119
+ config: |
120
+ puppetserver:
121
+ url: 'https://fqdn.example.com:8140'
122
+ autodetection_retry: 1
123
+ - name: TLS Certificate
124
+ description: An example using a TLS certificate
125
+ config: |
126
+ puppetdb:
127
+ url: 'https://fqdn.example.com:8081'
128
+ tls_cert_file: /path/to/client.crt
129
+ tls_key_file: /path/to/client.key
130
+ autodetection_retry: 1
131
+ - name: Multi-instance
132
+ description: |
133
+ > **Note**: When you define multiple jobs, their names must be unique.
134
+
135
+ Collecting metrics from local and remote instances.
136
+ config: |
137
+ puppetserver1:
138
+ url: 'https://fqdn.example.com:8140'
139
+ autodetection_retry: 1
140
+
141
+ puppetserver2:
142
+ url: 'https://fqdn.example2.com:8140'
143
+ autodetection_retry: 1
144
+ troubleshooting:
145
+ problems:
146
+ list: []
147
+ alerts: []
148
+ metrics:
149
+ folding:
150
+ title: Metrics
151
+ enabled: false
152
+ description: ""
153
+ availability: []
154
+ scopes:
155
+ - name: global
156
+ description: "These metrics refer to the entire monitored application."
157
+ labels: []
158
+ metrics:
159
+ - name: puppet.jvm
160
+ description: JVM Heap
161
+ unit: "MiB"
162
+ chart_type: area
163
+ dimensions:
164
+ - name: committed
165
+ - name: used
166
+ - name: puppet.jvm
167
+ description: JVM Non-Heap
168
+ unit: "MiB"
169
+ chart_type: area
170
+ dimensions:
171
+ - name: committed
172
+ - name: used
173
+ - name: puppet.cpu
174
+ description: CPU usage
175
+ unit: "percentage"
176
+ chart_type: stacked
177
+ dimensions:
178
+ - name: execution
179
+ - name: GC
180
+ - name: puppet.fdopen
181
+ description: File Descriptors
182
+ unit: "descriptors"
183
+ chart_type: line
184
+ dimensions:
185
+ - name: used
collectors/python.d.plugin/rethinkdbs/metadata.yaml
+185
-183
@@ -1,186 +1,188 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: rethinkdbs
4
- monitored_instance:
5
- name: RethinkDB
6
- link: 'https://rethinkdb.com/'
7
- categories:
8
- - data-collection.database-servers
9
- icon_filename: 'rethinkdb.png'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - rethinkdb
17
- - database
18
- - db
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: 'This collector monitors metrics about RethinkDB clusters and database servers.'
23
- method_description: 'It uses the `rethinkdb` python module to connect to a RethinkDB server instance and gather statistics.'
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ''
30
- default_behavior:
31
- auto_detection:
32
- description: 'When no configuration file is found, the collector tries to connect to 127.0.0.1:28015.'
33
- limits:
34
- description: ''
35
- performance_impact:
36
- description: ''
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: 'Required python module'
41
- description: 'The collector requires the `rethinkdb` python module to be installed.'
42
- configuration:
43
- file:
44
- name: python.d/rethinkdbs.conf
45
- options:
46
- description: |
47
- There are 2 sections:
48
-
49
- * Global variables
50
- * One or more JOBS that can define multiple different instances to monitor.
51
-
52
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
53
-
54
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
-
56
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
- folding:
58
- title: "Config options"
59
- enabled: true
60
- list:
61
- - name: update_every
62
- description: Sets the default data collection frequency.
63
- default_value: 5
64
- required: false
65
- - name: priority
66
- description: Controls the order of charts at the netdata dashboard.
67
- default_value: 60000
68
- required: false
69
- - name: autodetection_retry
70
- description: Sets the job re-check interval in seconds.
71
- default_value: 0
72
- required: false
73
- - name: penalty
74
- description: Indicates whether to apply penalty to update_every in case of failures.
75
- default_value: yes
76
- required: false
77
- - name: name
78
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
- default_value: ''
80
- required: false
81
- - name: host
82
- description: Hostname or ip of the RethinkDB server.
83
- default_value: 'localhost'
84
- required: false
85
- - name: port
86
- description: Port to connect to the RethinkDB server.
87
- default_value: '28015'
88
- required: false
89
- - name: user
90
- description: The username to use to connect to the RethinkDB server.
91
- default_value: 'admin'
92
- required: false
93
- - name: password
94
- description: The password to use to connect to the RethinkDB server.
95
- default_value: ''
96
- required: false
97
- - name: timeout
98
- description: Set a connect timeout to the RethinkDB server.
99
- default_value: '2'
100
- required: false
101
- examples:
102
- folding:
103
- enabled: false
104
- title: "Config"
105
- list:
106
- - name: Local RethinkDB server
107
- description: An example of a configuration for a local RethinkDB server
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: rethinkdbs
6
+ monitored_instance:
7
+ name: RethinkDB
8
+ link: 'https://rethinkdb.com/'
9
+ categories:
10
+ - data-collection.database-servers
11
+ icon_filename: 'rethinkdb.png'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - rethinkdb
19
+ - database
20
+ - db
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: 'This collector monitors metrics about RethinkDB clusters and database servers.'
25
+ method_description: 'It uses the `rethinkdb` python module to connect to a RethinkDB server instance and gather statistics.'
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: true
30
+ additional_permissions:
31
+ description: ''
32
+ default_behavior:
33
+ auto_detection:
34
+ description: 'When no configuration file is found, the collector tries to connect to 127.0.0.1:28015.'
35
+ limits:
36
+ description: ''
37
+ performance_impact:
38
+ description: ''
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: 'Required python module'
43
+ description: 'The collector requires the `rethinkdb` python module to be installed.'
44
+ configuration:
45
+ file:
46
+ name: python.d/rethinkdbs.conf
47
+ options:
48
+ description: |
49
+ There are 2 sections:
50
+
51
+ * Global variables
52
+ * One or more JOBS that can define multiple different instances to monitor.
53
+
54
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
55
+
56
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
+
58
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
+ folding:
60
+ title: "Config options"
61
+ enabled: true
62
+ list:
63
+ - name: update_every
64
+ description: Sets the default data collection frequency.
65
+ default_value: 5
66
+ required: false
67
+ - name: priority
68
+ description: Controls the order of charts at the netdata dashboard.
69
+ default_value: 60000
70
+ required: false
71
+ - name: autodetection_retry
72
+ description: Sets the job re-check interval in seconds.
73
+ default_value: 0
74
+ required: false
75
+ - name: penalty
76
+ description: Indicates whether to apply penalty to update_every in case of failures.
77
+ default_value: yes
78
+ required: false
79
+ - name: name
80
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
+ default_value: ''
82
+ required: false
83
+ - name: host
84
+ description: Hostname or ip of the RethinkDB server.
85
+ default_value: 'localhost'
86
+ required: false
87
+ - name: port
88
+ description: Port to connect to the RethinkDB server.
89
+ default_value: '28015'
90
+ required: false
91
+ - name: user
92
+ description: The username to use to connect to the RethinkDB server.
93
+ default_value: 'admin'
94
+ required: false
95
+ - name: password
96
+ description: The password to use to connect to the RethinkDB server.
97
+ default_value: ''
98
+ required: false
99
+ - name: timeout
100
+ description: Set a connect timeout to the RethinkDB server.
101
+ default_value: '2'
102
+ required: false
103
+ examples:
104
folding:
105
enabled: false
110
- config: |
111
- localhost:
112
- name: 'local'
113
- host: '127.0.0.1'
114
- port: 28015
115
- user: "user"
116
- password: "pass"
117
-troubleshooting:
118
- problems:
119
- list: []
120
-alerts: []
121
-metrics:
122
- folding:
123
- title: Metrics
124
- enabled: false
125
- description: ""
126
- availability: []
127
- scopes:
128
- - name: global
129
- description: "These metrics refer to the entire monitored application."
130
- labels: []
106
+ title: "Config"
107
+ list:
108
+ - name: Local RethinkDB server
109
+ description: An example of a configuration for a local RethinkDB server
110
+ folding:
111
+ enabled: false
112
+ config: |
113
+ localhost:
114
+ name: 'local'
115
+ host: '127.0.0.1'
116
+ port: 28015
117
+ user: "user"
118
+ password: "pass"
119
+ troubleshooting:
120
+ problems:
121
+ list: []
122
+ alerts: []
123
metrics:
132
- - name: rethinkdb.cluster_connected_servers
133
- description: Connected Servers
134
- unit: "servers"
135
- chart_type: stacked
136
- dimensions:
137
- - name: connected
138
- - name: missing
139
- - name: rethinkdb.cluster_clients_active
140
- description: Active Clients
141
- unit: "clients"
142
- chart_type: line
143
- dimensions:
144
- - name: active
145
- - name: rethinkdb.cluster_queries
146
- description: Queries
147
- unit: "queries/s"
148
- chart_type: line
149
- dimensions:
150
- - name: queries
151
- - name: rethinkdb.cluster_documents
152
- description: Documents
153
- unit: "documents/s"
154
- chart_type: line
155
- dimensions:
156
- - name: reads
157
- - name: writes
158
- - name: database server
159
- description: ""
160
- labels: []
161
- metrics:
162
- - name: rethinkdb.client_connections
163
- description: Client Connections
164
- unit: "connections"
165
- chart_type: line
166
- dimensions:
167
- - name: connections
168
- - name: rethinkdb.clients_active
169
- description: Active Clients
170
- unit: "clients"
171
- chart_type: line
172
- dimensions:
173
- - name: active
174
- - name: rethinkdb.queries
175
- description: Queries
176
- unit: "queries/s"
177
- chart_type: line
178
- dimensions:
179
- - name: queries
180
- - name: rethinkdb.documents
181
- description: Documents
182
- unit: "documents/s"
183
- chart_type: line
184
- dimensions:
185
- - name: reads
186
- - name: writes
124
+ folding:
125
+ title: Metrics
126
+ enabled: false
127
+ description: ""
128
+ availability: []
129
+ scopes:
130
+ - name: global
131
+ description: "These metrics refer to the entire monitored application."
132
+ labels: []
133
+ metrics:
134
+ - name: rethinkdb.cluster_connected_servers
135
+ description: Connected Servers
136
+ unit: "servers"
137
+ chart_type: stacked
138
+ dimensions:
139
+ - name: connected
140
+ - name: missing
141
+ - name: rethinkdb.cluster_clients_active
142
+ description: Active Clients
143
+ unit: "clients"
144
+ chart_type: line
145
+ dimensions:
146
+ - name: active
147
+ - name: rethinkdb.cluster_queries
148
+ description: Queries
149
+ unit: "queries/s"
150
+ chart_type: line
151
+ dimensions:
152
+ - name: queries
153
+ - name: rethinkdb.cluster_documents
154
+ description: Documents
155
+ unit: "documents/s"
156
+ chart_type: line
157
+ dimensions:
158
+ - name: reads
159
+ - name: writes
160
+ - name: database server
161
+ description: ""
162
+ labels: []
163
+ metrics:
164
+ - name: rethinkdb.client_connections
165
+ description: Client Connections
166
+ unit: "connections"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: connections
170
+ - name: rethinkdb.clients_active
171
+ description: Active Clients
172
+ unit: "clients"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: active
176
+ - name: rethinkdb.queries
177
+ description: Queries
178
+ unit: "queries/s"
179
+ chart_type: line
180
+ dimensions:
181
+ - name: queries
182
+ - name: rethinkdb.documents
183
+ description: Documents
184
+ unit: "documents/s"
185
+ chart_type: line
186
+ dimensions:
187
+ - name: reads
188
+ - name: writes
collectors/python.d.plugin/retroshare/metadata.yaml
+142
-141
@@ -1,143 +1,144 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: retroshare
5
- monitored_instance:
6
- name: RetroShare
7
- link: "https://retroshare.cc/"
8
- categories:
9
- - data-collection.p2p
10
- icon_filename: "retroshare.png"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - retroshare
18
- - p2p
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: "This collector monitors RetroShare statistics such as application bandwidth, peers, and DHT metrics."
23
- method_description: "It connects to the RetroShare web interface to gather metrics."
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ""
30
- default_behavior:
31
- auto_detection:
32
- description: "The collector will attempt to connect and detect a RetroShare web interface through http://localhost:9090, even without any configuration."
33
- limits:
34
- description: ""
35
- performance_impact:
36
- description: ""
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: "RetroShare web interface"
41
- description: |
42
- RetroShare needs to be configured to enable the RetroShare WEB Interface and allow access from the Netdata host.
43
- configuration:
44
- file:
45
- name: python.d/retroshare.conf
46
- options:
47
- description: |
48
- There are 2 sections:
49
-
50
- * Global variables
51
- * One or more JOBS that can define multiple different instances to monitor.
52
-
53
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: retroshare
6
+ monitored_instance:
7
+ name: RetroShare
8
+ link: "https://retroshare.cc/"
9
+ categories:
10
+ - data-collection.p2p
11
+ icon_filename: "retroshare.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - retroshare
19
+ - p2p
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: "This collector monitors RetroShare statistics such as application bandwidth, peers, and DHT metrics."
24
+ method_description: "It connects to the RetroShare web interface to gather metrics."
25
+ supported_platforms:
26
+ include: []
27
+ exclude: []
28
+ multi_instance: true
29
+ additional_permissions:
30
+ description: ""
31
+ default_behavior:
32
+ auto_detection:
33
+ description: "The collector will attempt to connect and detect a RetroShare web interface through http://localhost:9090, even without any configuration."
34
+ limits:
35
+ description: ""
36
+ performance_impact:
37
+ description: ""
38
+ setup:
39
+ prerequisites:
40
+ list:
41
+ - title: "RetroShare web interface"
42
+ description: |
43
+ RetroShare needs to be configured to enable the RetroShare WEB Interface and allow access from the Netdata host.
44
+ configuration:
45
+ file:
46
+ name: python.d/retroshare.conf
47
+ options:
48
+ description: |
49
+ There are 2 sections:
50
+
51
+ * Global variables
52
+ * One or more JOBS that can define multiple different instances to monitor.
53
+
54
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
55
+
56
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
+
58
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
+ folding:
60
+ title: "Config options"
61
+ enabled: true
62
+ list:
63
+ - name: update_every
64
+ description: Sets the default data collection frequency.
65
+ default_value: 5
66
+ required: false
67
+ - name: priority
68
+ description: Controls the order of charts at the netdata dashboard.
69
+ default_value: 60000
70
+ required: false
71
+ - name: autodetection_retry
72
+ description: Sets the job re-check interval in seconds.
73
+ default_value: 0
74
+ required: false
75
+ - name: penalty
76
+ description: Indicates whether to apply penalty to update_every in case of failures.
77
+ default_value: yes
78
+ required: false
79
+ - name: name
80
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
+ default_value: ""
82
+ required: false
83
+ - name: url
84
+ description: The URL to the RetroShare Web UI.
85
+ default_value: "http://localhost:9090"
86
+ required: false
87
+ examples:
88
+ folding:
89
+ enabled: true
90
+ title: "Config"
91
+ list:
92
+ - name: Local RetroShare Web UI
93
+ description: A basic configuration for a RetroShare server running on localhost.
94
+ config: |
95
+ localhost:
96
+ name: 'local retroshare'
97
+ url: 'http://localhost:9090'
98
+ - name: Remote RetroShare Web UI
99
+ description: A basic configuration for a remote RetroShare server.
100
+ config: |
101
+ remote:
102
+ name: 'remote retroshare'
103
+ url: 'http://1.2.3.4:9090'
104
55
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
-
57
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
- folding:
59
- title: "Config options"
60
- enabled: true
61
- list:
62
- - name: update_every
63
- description: Sets the default data collection frequency.
64
- default_value: 5
65
- required: false
66
- - name: priority
67
- description: Controls the order of charts at the netdata dashboard.
68
- default_value: 60000
69
- required: false
70
- - name: autodetection_retry
71
- description: Sets the job re-check interval in seconds.
72
- default_value: 0
73
- required: false
74
- - name: penalty
75
- description: Indicates whether to apply penalty to update_every in case of failures.
76
- default_value: yes
77
- required: false
78
- - name: name
79
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
80
- default_value: ""
81
- required: false
82
- - name: url
83
- description: The URL to the RetroShare Web UI.
84
- default_value: "http://localhost:9090"
85
- required: false
86
- examples:
105
+ troubleshooting:
106
+ problems:
107
+ list: []
108
+ alerts:
109
+ - name: retroshare_dht_working
110
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/retroshare.conf
111
+ metric: retroshare.dht
112
+ info: number of DHT peers
113
+ metrics:
114
folding:
88
- enabled: true
89
- title: "Config"
90
- list:
91
- - name: Local RetroShare Web UI
92
- description: A basic configuration for a RetroShare server running on localhost.
93
- config: |
94
- localhost:
95
- name: 'local retroshare'
96
- url: 'http://localhost:9090'
97
- - name: Remote RetroShare Web UI
98
- description: A basic configuration for a remote RetroShare server.
99
- config: |
100
- remote:
101
- name: 'remote retroshare'
102
- url: 'http://1.2.3.4:9090'
103
-
104
-troubleshooting:
105
- problems:
106
- list: []
107
-alerts:
108
- - name: retroshare_dht_working
109
- link: https://github.com/netdata/netdata/blob/master/health/health.d/retroshare.conf
110
- metric: retroshare.dht
111
- info: number of DHT peers
112
-metrics:
113
- folding:
114
- title: Metrics
115
- enabled: false
116
- description: ""
117
- availability: []
118
- scopes:
119
- - name: global
120
- description: "These metrics refer to the entire monitored application."
121
- labels: []
122
- metrics:
123
- - name: retroshare.bandwidth
124
- description: RetroShare Bandwidth
125
- unit: "kilobits/s"
126
- chart_type: area
127
- dimensions:
128
- - name: Upload
129
- - name: Download
130
- - name: retroshare.peers
131
- description: RetroShare Peers
132
- unit: "peers"
133
- chart_type: line
134
- dimensions:
135
- - name: All friends
136
- - name: Connected friends
137
- - name: retroshare.dht
138
- description: Retroshare DHT
139
- unit: "peers"
140
- chart_type: line
141
- dimensions:
142
- - name: DHT nodes estimated
143
- - name: RS nodes estimated
115
+ title: Metrics
116
+ enabled: false
117
+ description: ""
118
+ availability: []
119
+ scopes:
120
+ - name: global
121
+ description: "These metrics refer to the entire monitored application."
122
+ labels: []
123
+ metrics:
124
+ - name: retroshare.bandwidth
125
+ description: RetroShare Bandwidth
126
+ unit: "kilobits/s"
127
+ chart_type: area
128
+ dimensions:
129
+ - name: Upload
130
+ - name: Download
131
+ - name: retroshare.peers
132
+ description: RetroShare Peers
133
+ unit: "peers"
134
+ chart_type: line
135
+ dimensions:
136
+ - name: All friends
137
+ - name: Connected friends
138
+ - name: retroshare.dht
139
+ description: Retroshare DHT
140
+ unit: "peers"
141
+ chart_type: line
142
+ dimensions:
143
+ - name: DHT nodes estimated
144
+ - name: RS nodes estimated
collectors/python.d.plugin/riakkv/metadata.yaml
+357
-356
@@ -1,357 +1,358 @@
1
-# yaml-language-server: $schema=https://raw.githubusercontent.com/netdata/netdata/master/integrations/schemas/collection-single-module.json
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: riakkv
5
- monitored_instance:
6
- name: RiakKV
7
- link: "https://riak.com/products/riak-kv/index.html"
8
- categories:
9
- - data-collection.database-servers
10
- icon_filename: "riak.svg"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - database
18
- - nosql
19
- - big data
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: |
24
- This collector monitors RiakKV metrics about throughput, latency, resources and more.'
25
- method_description: "This collector reads the database stats from the `/stats` endpoint."
26
- supported_platforms:
27
- include: []
28
- exclude: []
29
- multi_instance: true
30
- additional_permissions:
31
- description: ""
32
- default_behavior:
33
- auto_detection:
34
- description: "If the /stats endpoint is accessible, RiakKV instances on the local host running on port 8098 will be autodetected."
35
- limits:
36
- description: ""
37
- performance_impact:
38
- description: ""
39
-setup:
40
- prerequisites:
41
- list:
42
- - title: Configure RiakKV to enable /stats endpoint
43
- description: |
44
- You can follow the RiakKV configuration reference documentation for how to enable this.
45
-
46
- Source : https://docs.riak.com/riak/kv/2.2.3/configuring/reference/#client-interfaces
47
- configuration:
48
- file:
49
- name: "python.d/riakkv.conf"
50
- options:
51
- description: |
52
- There are 2 sections:
53
-
54
- * Global variables
55
- * One or more JOBS that can define multiple different instances to monitor.
56
-
57
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
58
-
59
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
60
-
61
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
62
- folding:
63
- title: "Config options"
64
- enabled: true
65
- list:
66
- - name: update_every
67
- description: Sets the default data collection frequency.
68
- default_value: 5
69
- required: false
70
- - name: priority
71
- description: Controls the order of charts at the netdata dashboard.
72
- default_value: 60000
73
- required: false
74
- - name: autodetection_retry
75
- description: Sets the job re-check interval in seconds.
76
- default_value: 0
77
- required: false
78
- - name: penalty
79
- description: Indicates whether to apply penalty to update_every in case of failures.
80
- default_value: yes
81
- required: false
82
- - name: url
83
- description: The url of the server
84
- default_value: no
85
- required: true
86
- examples:
87
- folding:
88
- enabled: true
89
- title: "Config"
90
- list:
91
- - name: Basic (default)
92
- folding:
93
- enabled: false
94
- description: A basic example configuration per job
95
- config: |
96
- local:
97
- url: 'http://localhost:8098/stats'
98
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: riakkv
6
+ monitored_instance:
7
+ name: RiakKV
8
+ link: "https://riak.com/products/riak-kv/index.html"
9
+ categories:
10
+ - data-collection.database-servers
11
+ icon_filename: "riak.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - database
19
+ - nosql
20
+ - big data
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: |
25
+ This collector monitors RiakKV metrics about throughput, latency, resources and more.'
26
+ method_description: "This collector reads the database stats from the `/stats` endpoint."
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: "If the /stats endpoint is accessible, RiakKV instances on the local host running on port 8098 will be autodetected."
36
+ limits:
37
+ description: ""
38
+ performance_impact:
39
+ description: ""
40
+ setup:
41
+ prerequisites:
42
+ list:
43
+ - title: Configure RiakKV to enable /stats endpoint
44
+ description: |
45
+ You can follow the RiakKV configuration reference documentation for how to enable this.
46
+
47
+ Source : https://docs.riak.com/riak/kv/2.2.3/configuring/reference/#client-interfaces
48
+ configuration:
49
+ file:
50
+ name: "python.d/riakkv.conf"
51
+ options:
52
description: |
100
- > **Note**: When you define multiple jobs, their names must be unique.
101
-
102
- Collecting metrics from local and remote instances.
103
- config: |
104
- local:
105
- url: 'http://localhost:8098/stats'
106
-
107
- remote:
108
- url: 'http://192.0.2.1:8098/stats'
109
-troubleshooting:
110
- problems:
111
- list: []
112
-alerts:
113
- - name: riakkv_1h_kv_get_mean_latency
114
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
115
- metric: riak.kv.latency.get
116
- info: average time between reception of client GET request and subsequent response to client over the last hour
117
- - name: riakkv_kv_get_slow
118
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
119
- metric: riak.kv.latency.get
120
- info: average time between reception of client GET request and subsequent response to the client over the last 3 minutes, compared to the average over the last hour
121
- - name: riakkv_1h_kv_put_mean_latency
122
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
123
- metric: riak.kv.latency.put
124
- info: average time between reception of client PUT request and subsequent response to the client over the last hour
125
- - name: riakkv_kv_put_slow
126
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
127
- metric: riak.kv.latency.put
128
- info: average time between reception of client PUT request and subsequent response to the client over the last 3 minutes, compared to the average over the last hour
129
- - name: riakkv_vm_high_process_count
130
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
131
- metric: riak.vm
132
- info: number of processes running in the Erlang VM
133
- - name: riakkv_list_keys_active
134
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
135
- metric: riak.core.fsm_active
136
- info: number of currently running list keys finite state machines
137
-metrics:
138
- folding:
139
- title: Metrics
140
- enabled: false
141
- description: ""
142
- availability: []
143
- scopes:
144
- - name: global
145
- description: "These metrics refer to the entire monitored application."
146
- labels: []
147
- metrics:
148
- - name: riak.kv.throughput
149
- description: Reads & writes coordinated by this node
150
- unit: "operations/s"
151
- chart_type: line
152
- dimensions:
153
- - name: gets
154
- - name: puts
155
- - name: riak.dt.vnode_updates
156
- description: Update operations coordinated by local vnodes by data type
157
- unit: "operations/s"
158
- chart_type: line
159
- dimensions:
160
- - name: counters
161
- - name: sets
162
- - name: maps
163
- - name: riak.search
164
- description: Search queries on the node
165
- unit: "queries/s"
166
- chart_type: line
167
- dimensions:
168
- - name: queries
169
- - name: riak.search.documents
170
- description: Documents indexed by search
171
- unit: "documents/s"
172
- chart_type: line
173
- dimensions:
174
- - name: indexed
175
- - name: riak.consistent.operations
176
- description: Consistent node operations
177
- unit: "operations/s"
178
- chart_type: line
179
- dimensions:
180
- - name: gets
181
- - name: puts
182
- - name: riak.kv.latency.get
183
- description: Time between reception of a client GET request and subsequent response to client
184
- unit: "ms"
185
- chart_type: line
186
- dimensions:
187
- - name: mean
188
- - name: median
189
- - name: "95"
190
- - name: "99"
191
- - name: "100"
192
- - name: riak.kv.latency.put
193
- description: Time between reception of a client PUT request and subsequent response to client
194
- unit: "ms"
195
- chart_type: line
196
- dimensions:
197
- - name: mean
198
- - name: median
199
- - name: "95"
200
- - name: "99"
201
- - name: "100"
202
- - name: riak.dt.latency.counter_merge
203
- description: Time it takes to perform an Update Counter operation
204
- unit: "ms"
205
- chart_type: line
206
- dimensions:
207
- - name: mean
208
- - name: median
209
- - name: "95"
210
- - name: "99"
211
- - name: "100"
212
- - name: riak.dt.latency.set_merge
213
- description: Time it takes to perform an Update Set operation
214
- unit: "ms"
215
- chart_type: line
216
- dimensions:
217
- - name: mean
218
- - name: median
219
- - name: "95"
220
- - name: "99"
221
- - name: "100"
222
- - name: riak.dt.latency.map_merge
223
- description: Time it takes to perform an Update Map operation
224
- unit: "ms"
225
- chart_type: line
226
- dimensions:
227
- - name: mean
228
- - name: median
229
- - name: "95"
230
- - name: "99"
231
- - name: "100"
232
- - name: riak.search.latency.query
233
- description: Search query latency
234
- unit: "ms"
235
- chart_type: line
236
- dimensions:
237
- - name: median
238
- - name: min
239
- - name: "95"
240
- - name: "99"
241
- - name: "999"
242
- - name: max
243
- - name: riak.search.latency.index
244
- description: Time it takes Search to index a new document
245
- unit: "ms"
246
- chart_type: line
247
- dimensions:
248
- - name: median
249
- - name: min
250
- - name: "95"
251
- - name: "99"
252
- - name: "999"
253
- - name: max
254
- - name: riak.consistent.latency.get
255
- description: Strongly consistent read latency
256
- unit: "ms"
257
- chart_type: line
258
- dimensions:
259
- - name: mean
260
- - name: median
261
- - name: "95"
262
- - name: "99"
263
- - name: "100"
264
- - name: riak.consistent.latency.put
265
- description: Strongly consistent write latency
266
- unit: "ms"
267
- chart_type: line
268
- dimensions:
269
- - name: mean
270
- - name: median
271
- - name: "95"
272
- - name: "99"
273
- - name: "100"
274
- - name: riak.vm
275
- description: Total processes running in the Erlang VM
276
- unit: "total"
277
- chart_type: line
278
- dimensions:
279
- - name: processes
280
- - name: riak.vm.memory.processes
281
- description: Memory allocated & used by Erlang processes
282
- unit: "MB"
283
- chart_type: line
284
- dimensions:
285
- - name: allocated
286
- - name: used
287
- - name: riak.kv.siblings_encountered.get
288
- description: Number of siblings encountered during GET operations by this node during the past minute
289
- unit: "siblings"
290
- chart_type: line
291
- dimensions:
292
- - name: mean
293
- - name: median
294
- - name: "95"
295
- - name: "99"
296
- - name: "100"
297
- - name: riak.kv.objsize.get
298
- description: Object size encountered by this node during the past minute
299
- unit: "KB"
300
- chart_type: line
301
- dimensions:
302
- - name: mean
303
- - name: median
304
- - name: "95"
305
- - name: "99"
306
- - name: "100"
307
- - name: riak.search.vnodeq_size
308
- description: Number of unprocessed messages in the vnode message queues of Search on this node in the past minute
309
- unit: "messages"
310
- chart_type: line
311
- dimensions:
312
- - name: mean
313
- - name: median
314
- - name: "95"
315
- - name: "99"
316
- - name: "100"
317
- - name: riak.search.index
318
- description: Number of document index errors encountered by Search
319
- unit: "errors"
320
- chart_type: line
321
- dimensions:
322
- - name: errors
323
- - name: riak.core.protobuf_connections
324
- description: Protocol buffer connections by status
325
- unit: "connections"
326
- chart_type: line
327
- dimensions:
328
- - name: active
329
- - name: riak.core.repairs
330
- description: Number of repair operations this node has coordinated
331
- unit: "repairs"
332
- chart_type: line
333
- dimensions:
334
- - name: read
335
- - name: riak.core.fsm_active
336
- description: Active finite state machines by kind
337
- unit: "fsms"
338
- chart_type: line
339
- dimensions:
340
- - name: get
341
- - name: put
342
- - name: secondary index
343
- - name: list keys
344
- - name: riak.core.fsm_rejected
345
- description: Finite state machines being rejected by Sidejobs overload protection
346
- unit: "fsms"
347
- chart_type: line
348
- dimensions:
349
- - name: get
350
- - name: put
351
- - name: riak.search.index
352
- description: Number of writes to Search failed due to bad data format by reason
353
- unit: "writes"
354
- chart_type: line
355
- dimensions:
356
- - name: bad_entry
357
- - name: extract_fail
53
+ There are 2 sections:
54
+
55
+ * Global variables
56
+ * One or more JOBS that can define multiple different instances to monitor.
57
+
58
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
59
+
60
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
61
+
62
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
63
+ folding:
64
+ title: "Config options"
65
+ enabled: true
66
+ list:
67
+ - name: update_every
68
+ description: Sets the default data collection frequency.
69
+ default_value: 5
70
+ required: false
71
+ - name: priority
72
+ description: Controls the order of charts at the netdata dashboard.
73
+ default_value: 60000
74
+ required: false
75
+ - name: autodetection_retry
76
+ description: Sets the job re-check interval in seconds.
77
+ default_value: 0
78
+ required: false
79
+ - name: penalty
80
+ description: Indicates whether to apply penalty to update_every in case of failures.
81
+ default_value: yes
82
+ required: false
83
+ - name: url
84
+ description: The url of the server
85
+ default_value: no
86
+ required: true
87
+ examples:
88
+ folding:
89
+ enabled: true
90
+ title: "Config"
91
+ list:
92
+ - name: Basic (default)
93
+ folding:
94
+ enabled: false
95
+ description: A basic example configuration per job
96
+ config: |
97
+ local:
98
+ url: 'http://localhost:8098/stats'
99
+ - name: Multi-instance
100
+ description: |
101
+ > **Note**: When you define multiple jobs, their names must be unique.
102
+
103
+ Collecting metrics from local and remote instances.
104
+ config: |
105
+ local:
106
+ url: 'http://localhost:8098/stats'
107
+
108
+ remote:
109
+ url: 'http://192.0.2.1:8098/stats'
110
+ troubleshooting:
111
+ problems:
112
+ list: []
113
+ alerts:
114
+ - name: riakkv_1h_kv_get_mean_latency
115
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
116
+ metric: riak.kv.latency.get
117
+ info: average time between reception of client GET request and subsequent response to client over the last hour
118
+ - name: riakkv_kv_get_slow
119
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
120
+ metric: riak.kv.latency.get
121
+ info: average time between reception of client GET request and subsequent response to the client over the last 3 minutes, compared to the average over the last hour
122
+ - name: riakkv_1h_kv_put_mean_latency
123
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
124
+ metric: riak.kv.latency.put
125
+ info: average time between reception of client PUT request and subsequent response to the client over the last hour
126
+ - name: riakkv_kv_put_slow
127
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
128
+ metric: riak.kv.latency.put
129
+ info: average time between reception of client PUT request and subsequent response to the client over the last 3 minutes, compared to the average over the last hour
130
+ - name: riakkv_vm_high_process_count
131
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
132
+ metric: riak.vm
133
+ info: number of processes running in the Erlang VM
134
+ - name: riakkv_list_keys_active
135
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
136
+ metric: riak.core.fsm_active
137
+ info: number of currently running list keys finite state machines
138
+ metrics:
139
+ folding:
140
+ title: Metrics
141
+ enabled: false
142
+ description: ""
143
+ availability: []
144
+ scopes:
145
+ - name: global
146
+ description: "These metrics refer to the entire monitored application."
147
+ labels: []
148
+ metrics:
149
+ - name: riak.kv.throughput
150
+ description: Reads & writes coordinated by this node
151
+ unit: "operations/s"
152
+ chart_type: line
153
+ dimensions:
154
+ - name: gets
155
+ - name: puts
156
+ - name: riak.dt.vnode_updates
157
+ description: Update operations coordinated by local vnodes by data type
158
+ unit: "operations/s"
159
+ chart_type: line
160
+ dimensions:
161
+ - name: counters
162
+ - name: sets
163
+ - name: maps
164
+ - name: riak.search
165
+ description: Search queries on the node
166
+ unit: "queries/s"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: queries
170
+ - name: riak.search.documents
171
+ description: Documents indexed by search
172
+ unit: "documents/s"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: indexed
176
+ - name: riak.consistent.operations
177
+ description: Consistent node operations
178
+ unit: "operations/s"
179
+ chart_type: line
180
+ dimensions:
181
+ - name: gets
182
+ - name: puts
183
+ - name: riak.kv.latency.get
184
+ description: Time between reception of a client GET request and subsequent response to client
185
+ unit: "ms"
186
+ chart_type: line
187
+ dimensions:
188
+ - name: mean
189
+ - name: median
190
+ - name: "95"
191
+ - name: "99"
192
+ - name: "100"
193
+ - name: riak.kv.latency.put
194
+ description: Time between reception of a client PUT request and subsequent response to client
195
+ unit: "ms"
196
+ chart_type: line
197
+ dimensions:
198
+ - name: mean
199
+ - name: median
200
+ - name: "95"
201
+ - name: "99"
202
+ - name: "100"
203
+ - name: riak.dt.latency.counter_merge
204
+ description: Time it takes to perform an Update Counter operation
205
+ unit: "ms"
206
+ chart_type: line
207
+ dimensions:
208
+ - name: mean
209
+ - name: median
210
+ - name: "95"
211
+ - name: "99"
212
+ - name: "100"
213
+ - name: riak.dt.latency.set_merge
214
+ description: Time it takes to perform an Update Set operation
215
+ unit: "ms"
216
+ chart_type: line
217
+ dimensions:
218
+ - name: mean
219
+ - name: median
220
+ - name: "95"
221
+ - name: "99"
222
+ - name: "100"
223
+ - name: riak.dt.latency.map_merge
224
+ description: Time it takes to perform an Update Map operation
225
+ unit: "ms"
226
+ chart_type: line
227
+ dimensions:
228
+ - name: mean
229
+ - name: median
230
+ - name: "95"
231
+ - name: "99"
232
+ - name: "100"
233
+ - name: riak.search.latency.query
234
+ description: Search query latency
235
+ unit: "ms"
236
+ chart_type: line
237
+ dimensions:
238
+ - name: median
239
+ - name: min
240
+ - name: "95"
241
+ - name: "99"
242
+ - name: "999"
243
+ - name: max
244
+ - name: riak.search.latency.index
245
+ description: Time it takes Search to index a new document
246
+ unit: "ms"
247
+ chart_type: line
248
+ dimensions:
249
+ - name: median
250
+ - name: min
251
+ - name: "95"
252
+ - name: "99"
253
+ - name: "999"
254
+ - name: max
255
+ - name: riak.consistent.latency.get
256
+ description: Strongly consistent read latency
257
+ unit: "ms"
258
+ chart_type: line
259
+ dimensions:
260
+ - name: mean
261
+ - name: median
262
+ - name: "95"
263
+ - name: "99"
264
+ - name: "100"
265
+ - name: riak.consistent.latency.put
266
+ description: Strongly consistent write latency
267
+ unit: "ms"
268
+ chart_type: line
269
+ dimensions:
270
+ - name: mean
271
+ - name: median
272
+ - name: "95"
273
+ - name: "99"
274
+ - name: "100"
275
+ - name: riak.vm
276
+ description: Total processes running in the Erlang VM
277
+ unit: "total"
278
+ chart_type: line
279
+ dimensions:
280
+ - name: processes
281
+ - name: riak.vm.memory.processes
282
+ description: Memory allocated & used by Erlang processes
283
+ unit: "MB"
284
+ chart_type: line
285
+ dimensions:
286
+ - name: allocated
287
+ - name: used
288
+ - name: riak.kv.siblings_encountered.get
289
+ description: Number of siblings encountered during GET operations by this node during the past minute
290
+ unit: "siblings"
291
+ chart_type: line
292
+ dimensions:
293
+ - name: mean
294
+ - name: median
295
+ - name: "95"
296
+ - name: "99"
297
+ - name: "100"
298
+ - name: riak.kv.objsize.get
299
+ description: Object size encountered by this node during the past minute
300
+ unit: "KB"
301
+ chart_type: line
302
+ dimensions:
303
+ - name: mean
304
+ - name: median
305
+ - name: "95"
306
+ - name: "99"
307
+ - name: "100"
308
+ - name: riak.search.vnodeq_size
309
+ description: Number of unprocessed messages in the vnode message queues of Search on this node in the past minute
310
+ unit: "messages"
311
+ chart_type: line
312
+ dimensions:
313
+ - name: mean
314
+ - name: median
315
+ - name: "95"
316
+ - name: "99"
317
+ - name: "100"
318
+ - name: riak.search.index
319
+ description: Number of document index errors encountered by Search
320
+ unit: "errors"
321
+ chart_type: line
322
+ dimensions:
323
+ - name: errors
324
+ - name: riak.core.protobuf_connections
325
+ description: Protocol buffer connections by status
326
+ unit: "connections"
327
+ chart_type: line
328
+ dimensions:
329
+ - name: active
330
+ - name: riak.core.repairs
331
+ description: Number of repair operations this node has coordinated
332
+ unit: "repairs"
333
+ chart_type: line
334
+ dimensions:
335
+ - name: read
336
+ - name: riak.core.fsm_active
337
+ description: Active finite state machines by kind
338
+ unit: "fsms"
339
+ chart_type: line
340
+ dimensions:
341
+ - name: get
342
+ - name: put
343
+ - name: secondary index
344
+ - name: list keys
345
+ - name: riak.core.fsm_rejected
346
+ description: Finite state machines being rejected by Sidejobs overload protection
347
+ unit: "fsms"
348
+ chart_type: line
349
+ dimensions:
350
+ - name: get
351
+ - name: put
352
+ - name: riak.search.index
353
+ description: Number of writes to Search failed due to bad data format by reason
354
+ unit: "writes"
355
+ chart_type: line
356
+ dimensions:
357
+ - name: bad_entry
358
+ - name: extract_fail
collectors/python.d.plugin/samba/metadata.yaml
+194
-192
@@ -1,194 +1,196 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: samba
4
- monitored_instance:
5
- name: Samba
6
- link: https://www.samba.org/samba/
7
- categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: "samba.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - samba
17
- - file sharing
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: "This collector monitors the performance metrics of Samba file sharing."
22
- method_description: |
23
- It is using the `smbstatus` command-line tool.
24
-
25
- Executed commands:
26
-
27
- - `sudo -n smbstatus -P`
28
- supported_platforms:
29
- include: []
30
- exclude: []
31
- multi_instance: false
32
- additional_permissions:
33
- description: |
34
- `smbstatus` is used, which can only be executed by `root`. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `smbstatus` as root without a password.
35
- default_behavior:
36
- auto_detection:
37
- description: "After all the permissions are satisfied, the `smbstatus -P` binary is executed."
38
- limits:
39
- description: ""
40
- performance_impact:
41
- description: ""
42
-setup:
43
- prerequisites:
44
- list:
45
- - title: Permissions and programs
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: samba
6
+ monitored_instance:
7
+ name: Samba
8
+ link: https://www.samba.org/samba/
9
+ categories:
10
+ - data-collection.storage-mount-points-and-filesystems
11
+ icon_filename: "samba.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - samba
19
+ - file sharing
20
+ most_popular: false
21
+ overview:
22
+ data_collection:
23
+ metrics_description: "This collector monitors the performance metrics of Samba file sharing."
24
+ method_description: |
25
+ It is using the `smbstatus` command-line tool.
26
+
27
+ Executed commands:
28
+
29
+ - `sudo -n smbstatus -P`
30
+ supported_platforms:
31
+ include: []
32
+ exclude: []
33
+ multi_instance: false
34
+ additional_permissions:
35
description: |
47
- To run the collector you need:
48
-
49
- - `smbstatus` program
50
- - `sudo` program
51
- - `smbd` must be compiled with profiling enabled
52
- - `smbd` must be started either with the `-P 1` option or inside `smb.conf` using `smbd profiling level`
53
-
54
- The module uses `smbstatus`, which can only be executed by `root`. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `smbstatus` as root without a password.
55
-
56
- - add to your `/etc/sudoers` file:
57
-
58
- `which smbstatus` shows the full path to the binary.
59
-
60
- ```bash
61
- netdata ALL=(root) NOPASSWD: /path/to/smbstatus
62
- ```
63
-
64
- - Reset Netdata's systemd unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux distributions with systemd)
65
-
66
- The default CapabilityBoundingSet doesn't allow using `sudo`, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute `smbstatus` using `sudo`.
67
-
68
-
69
- As the `root` user, do the following:
70
-
71
- ```cmd
72
- mkdir /etc/systemd/system/netdata.service.d
73
- echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
74
- systemctl daemon-reload
75
- systemctl restart netdata.service
76
- ```
77
- configuration:
78
- file:
79
- name: python.d/samba.conf
80
- options:
81
- description: |
82
- There are 2 sections:
83
-
84
- * Global variables
85
- * One or more JOBS that can define multiple different instances to monitor.
86
-
87
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
88
-
89
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
90
-
91
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
36
+ `smbstatus` is used, which can only be executed by `root`. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `smbstatus` as root without a password.
37
+ default_behavior:
38
+ auto_detection:
39
+ description: "After all the permissions are satisfied, the `smbstatus -P` binary is executed."
40
+ limits:
41
+ description: ""
42
+ performance_impact:
43
+ description: ""
44
+ setup:
45
+ prerequisites:
46
+ list:
47
+ - title: Permissions and programs
48
+ description: |
49
+ To run the collector you need:
50
+
51
+ - `smbstatus` program
52
+ - `sudo` program
53
+ - `smbd` must be compiled with profiling enabled
54
+ - `smbd` must be started either with the `-P 1` option or inside `smb.conf` using `smbd profiling level`
55
+
56
+ The module uses `smbstatus`, which can only be executed by `root`. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `smbstatus` as root without a password.
57
+
58
+ - add to your `/etc/sudoers` file:
59
+
60
+ `which smbstatus` shows the full path to the binary.
61
+
62
+ ```bash
63
+ netdata ALL=(root) NOPASSWD: /path/to/smbstatus
64
+ ```
65
+
66
+ - Reset Netdata's systemd unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux distributions with systemd)
67
+
68
+ The default CapabilityBoundingSet doesn't allow using `sudo`, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute `smbstatus` using `sudo`.
69
+
70
+
71
+ As the `root` user, do the following:
72
+
73
+ ```cmd
74
+ mkdir /etc/systemd/system/netdata.service.d
75
+ echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
76
+ systemctl daemon-reload
77
+ systemctl restart netdata.service
78
+ ```
79
+ configuration:
80
+ file:
81
+ name: python.d/samba.conf
82
+ options:
83
+ description: |
84
+ There are 2 sections:
85
+
86
+ * Global variables
87
+ * One or more JOBS that can define multiple different instances to monitor.
88
+
89
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
90
+
91
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
92
+
93
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
94
+ folding:
95
+ title: "Config options"
96
+ enabled: true
97
+ list:
98
+ - name: update_every
99
+ description: Sets the default data collection frequency.
100
+ default_value: 5
101
+ required: false
102
+ - name: priority
103
+ description: Controls the order of charts at the netdata dashboard.
104
+ default_value: 60000
105
+ required: false
106
+ - name: autodetection_retry
107
+ description: Sets the job re-check interval in seconds.
108
+ default_value: 0
109
+ required: false
110
+ - name: penalty
111
+ description: Indicates whether to apply penalty to update_every in case of failures.
112
+ default_value: yes
113
+ required: false
114
+ examples:
115
+ folding:
116
+ enabled: true
117
+ title: "Config"
118
+ list:
119
+ - name: Basic
120
+ description: A basic example configuration.
121
+ config: |
122
+ my_job_name:
123
+ name: my_name
124
+ update_every: 1
125
+ troubleshooting:
126
+ problems:
127
+ list: []
128
+ alerts: []
129
+ metrics:
130
folding:
93
- title: "Config options"
94
- enabled: true
95
- list:
96
- - name: update_every
97
- description: Sets the default data collection frequency.
98
- default_value: 5
99
- required: false
100
- - name: priority
101
- description: Controls the order of charts at the netdata dashboard.
102
- default_value: 60000
103
- required: false
104
- - name: autodetection_retry
105
- description: Sets the job re-check interval in seconds.
106
- default_value: 0
107
- required: false
108
- - name: penalty
109
- description: Indicates whether to apply penalty to update_every in case of failures.
110
- default_value: yes
111
- required: false
112
- examples:
113
- folding:
114
- enabled: true
115
- title: "Config"
116
- list:
117
- - name: Basic
118
- description: A basic example configuration.
119
- config: |
120
- my_job_name:
121
- name: my_name
122
- update_every: 1
123
-troubleshooting:
124
- problems:
125
- list: []
126
-alerts: []
127
-metrics:
128
- folding:
129
- title: Metrics
130
- enabled: false
131
- description: ""
132
- availability: []
133
- scopes:
134
- - name: global
135
- description: "These metrics refer to the entire monitored application."
136
- labels: []
137
- metrics:
138
- - name: syscall.rw
139
- description: R/Ws
140
- unit: "KiB/s"
141
- chart_type: area
142
- dimensions:
143
- - name: sendfile
144
- - name: recvfile
145
- - name: smb2.rw
146
- description: R/Ws
147
- unit: "KiB/s"
148
- chart_type: area
149
- dimensions:
150
- - name: readout
151
- - name: writein
152
- - name: readin
153
- - name: writeout
154
- - name: smb2.create_close
155
- description: Create/Close
156
- unit: "operations/s"
157
- chart_type: line
158
- dimensions:
159
- - name: create
160
- - name: close
161
- - name: smb2.get_set_info
162
- description: Info
163
- unit: "operations/s"
164
- chart_type: line
165
- dimensions:
166
- - name: getinfo
167
- - name: setinfo
168
- - name: smb2.find
169
- description: Find
170
- unit: "operations/s"
171
- chart_type: line
172
- dimensions:
173
- - name: find
174
- - name: smb2.notify
175
- description: Notify
176
- unit: "operations/s"
177
- chart_type: line
178
- dimensions:
179
- - name: notify
180
- - name: smb2.sm_counters
181
- description: Lesser Ops
182
- unit: "count"
183
- chart_type: stacked
184
- dimensions:
185
- - name: tcon
186
- - name: negprot
187
- - name: tdis
188
- - name: cancel
189
- - name: logoff
190
- - name: flush
191
- - name: lock
192
- - name: keepalive
193
- - name: break
194
- - name: sessetup
131
+ title: Metrics
132
+ enabled: false
133
+ description: ""
134
+ availability: []
135
+ scopes:
136
+ - name: global
137
+ description: "These metrics refer to the entire monitored application."
138
+ labels: []
139
+ metrics:
140
+ - name: syscall.rw
141
+ description: R/Ws
142
+ unit: "KiB/s"
143
+ chart_type: area
144
+ dimensions:
145
+ - name: sendfile
146
+ - name: recvfile
147
+ - name: smb2.rw
148
+ description: R/Ws
149
+ unit: "KiB/s"
150
+ chart_type: area
151
+ dimensions:
152
+ - name: readout
153
+ - name: writein
154
+ - name: readin
155
+ - name: writeout
156
+ - name: smb2.create_close
157
+ description: Create/Close
158
+ unit: "operations/s"
159
+ chart_type: line
160
+ dimensions:
161
+ - name: create
162
+ - name: close
163
+ - name: smb2.get_set_info
164
+ description: Info
165
+ unit: "operations/s"
166
+ chart_type: line
167
+ dimensions:
168
+ - name: getinfo
169
+ - name: setinfo
170
+ - name: smb2.find
171
+ description: Find
172
+ unit: "operations/s"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: find
176
+ - name: smb2.notify
177
+ description: Notify
178
+ unit: "operations/s"
179
+ chart_type: line
180
+ dimensions:
181
+ - name: notify
182
+ - name: smb2.sm_counters
183
+ description: Lesser Ops
184
+ unit: "count"
185
+ chart_type: stacked
186
+ dimensions:
187
+ - name: tcon
188
+ - name: negprot
189
+ - name: tdis
190
+ - name: cancel
191
+ - name: logoff
192
+ - name: flush
193
+ - name: lock
194
+ - name: keepalive
195
+ - name: break
196
+ - name: sessetup
collectors/python.d.plugin/sensors/metadata.yaml
+168
-168
@@ -1,175 +1,175 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: sensors
6
- monitored_instance:
7
- name: Linux Sensors (lm-sensors)
8
- link: https://hwmon.wiki.kernel.org/lm_sensors
9
- categories:
10
- - data-collection.hardware-devices-and-sensors
11
- icon_filename: "microchip.svg"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - sensors
19
- - temperature
20
- - voltage
21
- - current
22
- - power
23
- - fan
24
- - energy
25
- - humidity
26
- most_popular: false
27
-overview:
28
- data_collection:
29
- metrics_description: |
30
- Examine Linux Sensors metrics with Netdata for insights into hardware health and performance.
31
-
32
- Enhance your system's reliability with real-time hardware health insights.
33
- method_description: >
34
- Reads system sensors information (temperature, voltage, electric current, power, etc.) via [lm-sensors](https://hwmon.wiki.kernel.org/lm_sensors).
35
- supported_platforms:
36
- include: []
37
- exclude: []
38
- multi_instance: true
39
- additional_permissions:
40
- description: ""
41
- default_behavior:
42
- auto_detection:
43
- description: >
44
- The following type of sensors are auto-detected:
45
-
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: sensors
6
+ monitored_instance:
7
+ name: Linux Sensors (lm-sensors)
8
+ link: https://hwmon.wiki.kernel.org/lm_sensors
9
+ categories:
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: "microchip.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - sensors
19
- temperature
47
- - fan
20
- voltage
21
- current
22
- power
23
+ - fan
24
- energy
25
- humidity
53
- limits:
54
- description: ""
55
- performance_impact:
56
- description: ""
57
-setup:
58
- prerequisites:
59
- list: []
60
- configuration:
61
- file:
62
- name: python.d/sensors.conf
63
- description: ""
64
- options:
65
- description: |
66
- There are 2 sections:
67
-
68
- * Global variables
69
- * One or more JOBS that can define multiple different instances to monitor.
70
-
71
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
72
-
73
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
74
-
75
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
76
- folding:
77
- title: Config options
78
- enabled: true
79
- list:
80
- - name: types
81
- description: The types of sensors to collect.
82
- default_value: "temperature, fan, voltage, current, power, energy, humidity"
83
- required: true
84
- - name: update_every
85
- description: Sets the default data collection frequency.
86
- default_value: 1
87
- required: false
88
- - name: priority
89
- description: Controls the order of charts at the netdata dashboard.
90
- default_value: 60000
91
- required: false
92
- - name: autodetection_retry
93
- description: Sets the job re-check interval in seconds.
94
- default_value: 0
95
- required: false
96
- - name: penalty
97
- description: Indicates whether to apply penalty to update_every in case of failures.
98
- default_value: yes
99
- required: false
100
- examples:
101
- folding:
102
- enabled: true
103
- title: Config
104
- list:
105
- - name: Default
26
+ most_popular: false
27
+ overview:
28
+ data_collection:
29
+ metrics_description: |
30
+ Examine Linux Sensors metrics with Netdata for insights into hardware health and performance.
31
+
32
+ Enhance your system's reliability with real-time hardware health insights.
33
+ method_description: >
34
+ Reads system sensors information (temperature, voltage, electric current, power, etc.) via [lm-sensors](https://hwmon.wiki.kernel.org/lm_sensors).
35
+ supported_platforms:
36
+ include: []
37
+ exclude: []
38
+ multi_instance: true
39
+ additional_permissions:
40
+ description: ""
41
+ default_behavior:
42
+ auto_detection:
43
+ description: >
44
+ The following type of sensors are auto-detected:
45
+
46
+ - temperature
47
+ - fan
48
+ - voltage
49
+ - current
50
+ - power
51
+ - energy
52
+ - humidity
53
+ limits:
54
+ description: ""
55
+ performance_impact:
56
+ description: ""
57
+ setup:
58
+ prerequisites:
59
+ list: []
60
+ configuration:
61
+ file:
62
+ name: python.d/sensors.conf
63
+ description: ""
64
+ options:
65
+ description: |
66
+ There are 2 sections:
67
+
68
+ * Global variables
69
+ * One or more JOBS that can define multiple different instances to monitor.
70
+
71
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
72
+
73
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
74
+
75
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
76
+ folding:
77
+ title: Config options
78
+ enabled: true
79
+ list:
80
+ - name: types
81
+ description: The types of sensors to collect.
82
+ default_value: "temperature, fan, voltage, current, power, energy, humidity"
83
+ required: true
84
+ - name: update_every
85
+ description: Sets the default data collection frequency.
86
+ default_value: 1
87
+ required: false
88
+ - name: priority
89
+ description: Controls the order of charts at the netdata dashboard.
90
+ default_value: 60000
91
+ required: false
92
+ - name: autodetection_retry
93
+ description: Sets the job re-check interval in seconds.
94
+ default_value: 0
95
+ required: false
96
+ - name: penalty
97
+ description: Indicates whether to apply penalty to update_every in case of failures.
98
+ default_value: yes
99
+ required: false
100
+ examples:
101
folding:
107
- enabled: false
108
- description: Default configuration.
109
- config: |
110
- types:
111
- - temperature
112
- - fan
113
- - voltage
114
- - current
115
- - power
116
- - energy
117
- - humidity
118
-troubleshooting:
119
- problems:
120
- list: []
121
-alerts: []
122
-metrics:
123
- folding:
124
- title: Metrics
125
- enabled: false
126
- description: ""
127
- availability: []
128
- scopes:
129
- - name: chip
130
- description: >
131
- Metrics related to chips. Each chip provides a set of the following metrics, each having the chip name in the metric name as reported by `sensors -u`.
132
- labels: []
133
- metrics:
134
- - name: sensors.temperature
135
- description: Temperature
136
- unit: "Celsius"
137
- chart_type: line
138
- dimensions:
139
- - name: a dimension per sensor
140
- - name: sensors.voltage
141
- description: Voltage
142
- unit: "Volts"
143
- chart_type: line
144
- dimensions:
145
- - name: a dimension per sensor
146
- - name: sensors.current
147
- description: Current
148
- unit: "Ampere"
149
- chart_type: line
150
- dimensions:
151
- - name: a dimension per sensor
152
- - name: sensors.power
153
- description: Power
154
- unit: "Watt"
155
- chart_type: line
156
- dimensions:
157
- - name: a dimension per sensor
158
- - name: sensors.fan
159
- description: Fans speed
160
- unit: "Rotations/min"
161
- chart_type: line
162
- dimensions:
163
- - name: a dimension per sensor
164
- - name: sensors.energy
165
- description: Energy
166
- unit: "Joule"
167
- chart_type: line
168
- dimensions:
169
- - name: a dimension per sensor
170
- - name: sensors.humidity
171
- description: Humidity
172
- unit: "Percent"
173
- chart_type: line
174
- dimensions:
175
- - name: a dimension per sensor
102
+ enabled: true
103
+ title: Config
104
+ list:
105
+ - name: Default
106
+ folding:
107
+ enabled: false
108
+ description: Default configuration.
109
+ config: |
110
+ types:
111
+ - temperature
112
+ - fan
113
+ - voltage
114
+ - current
115
+ - power
116
+ - energy
117
+ - humidity
118
+ troubleshooting:
119
+ problems:
120
+ list: []
121
+ alerts: []
122
+ metrics:
123
+ folding:
124
+ title: Metrics
125
+ enabled: false
126
+ description: ""
127
+ availability: []
128
+ scopes:
129
+ - name: chip
130
+ description: >
131
+ Metrics related to chips. Each chip provides a set of the following metrics, each having the chip name in the metric name as reported by `sensors -u`.
132
+ labels: []
133
+ metrics:
134
+ - name: sensors.temperature
135
+ description: Temperature
136
+ unit: "Celsius"
137
+ chart_type: line
138
+ dimensions:
139
+ - name: a dimension per sensor
140
+ - name: sensors.voltage
141
+ description: Voltage
142
+ unit: "Volts"
143
+ chart_type: line
144
+ dimensions:
145
+ - name: a dimension per sensor
146
+ - name: sensors.current
147
+ description: Current
148
+ unit: "Ampere"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: a dimension per sensor
152
+ - name: sensors.power
153
+ description: Power
154
+ unit: "Watt"
155
+ chart_type: line
156
+ dimensions:
157
+ - name: a dimension per sensor
158
+ - name: sensors.fan
159
+ description: Fans speed
160
+ unit: "Rotations/min"
161
+ chart_type: line
162
+ dimensions:
163
+ - name: a dimension per sensor
164
+ - name: sensors.energy
165
+ description: Energy
166
+ unit: "Joule"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: a dimension per sensor
170
+ - name: sensors.humidity
171
+ description: Humidity
172
+ unit: "Percent"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: a dimension per sensor
collectors/python.d.plugin/smartd_log/metadata.yaml
+428
-426
@@ -1,427 +1,429 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: smartd_log
4
- monitored_instance:
5
- name: S.M.A.R.T.
6
- link: "https://linux.die.net/man/8/smartd"
7
- categories:
8
- - data-collection.hardware-devices-and-sensors
9
- icon_filename: "smart.png"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - smart
17
- - S.M.A.R.T.
18
- - SCSI devices
19
- - ATA devices
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: |
24
- This collector monitors HDD/SSD S.M.A.R.T. metrics about drive health and performance.
25
- method_description: |
26
- It reads `smartd` log files to collect the metrics.
27
- supported_platforms:
28
- include: []
29
- exclude: []
30
- multi_instance: false
31
- additional_permissions:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: Upon satisfying the prerequisites, the collector will auto-detect metrics if written in either `/var/log/smartd/` or `/var/lib/smartmontools/`.
36
- limits:
37
- description: ""
38
- performance_impact:
39
- description: ""
40
-setup:
41
- prerequisites:
42
- list:
43
- - title: Configure `smartd` to write attribute information to files.
44
- description: |
45
- `smartd` must be running with `-A` option to write `smartd` attribute information to files.
46
-
47
- For this you need to set `smartd_opts` (or `SMARTD_ARGS`, check _smartd.service_ content) in `/etc/default/smartmontools`:
48
-
49
- ```
50
- # dump smartd attrs info every 600 seconds
51
- smartd_opts="-A /var/log/smartd/ -i 600"
52
- ```
53
-
54
- You may need to create the smartd directory before smartd will write to it:
55
-
56
- ```sh
57
- mkdir -p /var/log/smartd
58
- ```
59
-
60
- Otherwise, all the smartd `.csv` files may get written to `/var/lib/smartmontools` (default location). See also <https://linux.die.net/man/8/smartd> for more info on the `-A --attributelog=PREFIX` command.
61
-
62
- `smartd` appends logs at every run. It's strongly recommended to use `logrotate` for smartd files.
63
- configuration:
64
- file:
65
- name: "python.d/smartd_log.conf"
66
- options:
67
- description: |
68
- This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.
69
-
70
- There are 2 sections:
71
-
72
- * Global variables
73
- * One or more JOBS that can define multiple different instances to monitor.
74
-
75
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
76
-
77
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
78
-
79
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
80
- folding:
81
- title: "Config options"
82
- enabled: true
83
- list:
84
- - name: log_path
85
- description: path to smartd log files.
86
- default_value: /var/log/smartd
87
- required: true
88
- - name: exclude_disks
89
- description: Space-separated patterns. If the pattern is in the drive name, the module will not collect data for it.
90
- default_value: ""
91
- required: false
92
- - name: age
93
- description: Time in minutes since the last dump to file.
94
- default_value: 30
95
- required: false
96
- - name: update_every
97
- description: Sets the default data collection frequency.
98
- default_value: 1
99
- required: false
100
- - name: priority
101
- description: Controls the order of charts at the netdata dashboard.
102
- default_value: 60000
103
- required: false
104
- - name: autodetection_retry
105
- description: Sets the job re-check interval in seconds.
106
- default_value: 0
107
- required: false
108
- - name: penalty
109
- description: Indicates whether to apply penalty to update_every in case of failures.
110
- default_value: yes
111
- required: false
112
- - name: name
113
- description: >
114
- Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
115
- default_value: ""
116
- required: false
117
- examples:
118
- folding:
119
- enabled: true
120
- title: "Config"
121
- list:
122
- - name: Basic
123
- description: A basic configuration example.
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: smartd_log
6
+ monitored_instance:
7
+ name: S.M.A.R.T.
8
+ link: "https://linux.die.net/man/8/smartd"
9
+ categories:
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: "smart.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - smart
19
+ - S.M.A.R.T.
20
+ - SCSI devices
21
+ - ATA devices
22
+ most_popular: false
23
+ overview:
24
+ data_collection:
25
+ metrics_description: |
26
+ This collector monitors HDD/SSD S.M.A.R.T. metrics about drive health and performance.
27
+ method_description: |
28
+ It reads `smartd` log files to collect the metrics.
29
+ supported_platforms:
30
+ include: []
31
+ exclude: []
32
+ multi_instance: false
33
+ additional_permissions:
34
+ description: ""
35
+ default_behavior:
36
+ auto_detection:
37
+ description: Upon satisfying the prerequisites, the collector will auto-detect metrics if written in either `/var/log/smartd/` or `/var/lib/smartmontools/`.
38
+ limits:
39
+ description: ""
40
+ performance_impact:
41
+ description: ""
42
+ setup:
43
+ prerequisites:
44
+ list:
45
+ - title: Configure `smartd` to write attribute information to files.
46
+ description: |
47
+ `smartd` must be running with `-A` option to write `smartd` attribute information to files.
48
+
49
+ For this you need to set `smartd_opts` (or `SMARTD_ARGS`, check _smartd.service_ content) in `/etc/default/smartmontools`:
50
+
51
+ ```
52
+ # dump smartd attrs info every 600 seconds
53
+ smartd_opts="-A /var/log/smartd/ -i 600"
54
+ ```
55
+
56
+ You may need to create the smartd directory before smartd will write to it:
57
+
58
+ ```sh
59
+ mkdir -p /var/log/smartd
60
+ ```
61
+
62
+ Otherwise, all the smartd `.csv` files may get written to `/var/lib/smartmontools` (default location). See also <https://linux.die.net/man/8/smartd> for more info on the `-A --attributelog=PREFIX` command.
63
+
64
+ `smartd` appends logs at every run. It's strongly recommended to use `logrotate` for smartd files.
65
+ configuration:
66
+ file:
67
+ name: "python.d/smartd_log.conf"
68
+ options:
69
+ description: |
70
+ This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.
71
+
72
+ There are 2 sections:
73
+
74
+ * Global variables
75
+ * One or more JOBS that can define multiple different instances to monitor.
76
+
77
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
78
+
79
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
80
+
81
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
82
folding:
125
- enabled: false
126
- config: |
127
- custom:
128
- name: smartd_log
129
- log_path: '/var/log/smartd/'
130
-troubleshooting:
131
- problems:
132
- list: []
133
-alerts: []
134
-metrics:
135
- folding:
136
- title: Metrics
137
- enabled: false
138
- description: "The metrics listed below are split in terms of availability on device type, SCSI or ATA."
139
- availability:
140
- - "SCSI"
141
- - "ATA"
142
- scopes:
143
- - name: global
144
- description: "These metrics refer to the entire monitored application."
145
- labels: []
146
- metrics:
147
- - name: smartd_log.read_error_rate
148
- description: Read Error Rate
149
- availability:
150
- - ATA
151
- unit: "value"
152
- chart_type: line
153
- dimensions:
154
- - name: a dimension per device
155
- - name: smartd_log.seek_error_rate
156
- description: Seek Error Rate
157
- availability:
158
- - ATA
159
- unit: "value"
160
- chart_type: line
161
- dimensions:
162
- - name: a dimension per device
163
- - name: smartd_log.soft_read_error_rate
164
- description: Soft Read Error Rate
165
- availability:
166
- - ATA
167
- unit: "errors"
168
- chart_type: line
169
- dimensions:
170
- - name: a dimension per device
171
- - name: smartd_log.write_error_rate
172
- description: Write Error Rate
173
- availability:
174
- - ATA
175
- unit: "value"
176
- chart_type: line
177
- dimensions:
178
- - name: a dimension per device
179
- - name: smartd_log.read_total_err_corrected
180
- description: Read Error Corrected
181
- availability:
182
- - SCSI
183
- unit: "errors"
184
- chart_type: line
185
- dimensions:
186
- - name: a dimension per device
187
- - name: smartd_log.read_total_unc_errors
188
- description: Read Error Uncorrected
189
- availability:
190
- - SCSI
191
- unit: "errors"
192
- chart_type: line
193
- dimensions:
194
- - name: a dimension per device
195
- - name: smartd_log.write_total_err_corrected
196
- description: Write Error Corrected
197
- availability:
198
- - SCSI
199
- unit: "errors"
200
- chart_type: line
201
- dimensions:
202
- - name: a dimension per device
203
- - name: smartd_log.write_total_unc_errors
204
- description: Write Error Uncorrected
205
- availability:
206
- - SCSI
207
- unit: "errors"
208
- chart_type: line
209
- dimensions:
210
- - name: a dimension per device
211
- - name: smartd_log.verify_total_err_corrected
212
- description: Verify Error Corrected
213
- availability:
214
- - SCSI
215
- unit: "errors"
216
- chart_type: line
217
- dimensions:
218
- - name: a dimension per device
219
- - name: smartd_log.verify_total_unc_errors
220
- description: Verify Error Uncorrected
221
- availability:
222
- - SCSI
223
- unit: "errors"
224
- chart_type: line
225
- dimensions:
226
- - name: a dimension per device
227
- - name: smartd_log.sata_interface_downshift
228
- description: SATA Interface Downshift
229
- availability:
230
- - ATA
231
- unit: "events"
232
- chart_type: line
233
- dimensions:
234
- - name: a dimension per device
235
- - name: smartd_log.udma_crc_error_count
236
- description: UDMA CRC Error Count
237
- availability:
238
- - ATA
239
- unit: "errors"
240
- chart_type: line
241
- dimensions:
242
- - name: a dimension per device
243
- - name: smartd_log.throughput_performance
244
- description: Throughput Performance
245
- availability:
246
- - ATA
247
- unit: "value"
248
- chart_type: line
249
- dimensions:
250
- - name: a dimension per device
251
- - name: smartd_log.seek_time_performance
252
- description: Seek Time Performance
253
- availability:
254
- - ATA
255
- unit: "value"
256
- chart_type: line
257
- dimensions:
258
- - name: a dimension per device
259
- - name: smartd_log.start_stop_count
260
- description: Start/Stop Count
261
- availability:
262
- - ATA
263
- unit: "events"
264
- chart_type: line
265
- dimensions:
266
- - name: a dimension per device
267
- - name: smartd_log.power_on_hours_count
268
- description: Power-On Hours Count
269
- availability:
270
- - ATA
271
- unit: "hours"
272
- chart_type: line
273
- dimensions:
274
- - name: a dimension per device
275
- - name: smartd_log.power_cycle_count
276
- description: Power Cycle Count
277
- availability:
278
- - ATA
279
- unit: "events"
280
- chart_type: line
281
- dimensions:
282
- - name: a dimension per device
283
- - name: smartd_log.unexpected_power_loss
284
- description: Unexpected Power Loss
285
- availability:
286
- - ATA
287
- unit: "events"
288
- chart_type: line
289
- dimensions:
290
- - name: a dimension per device
291
- - name: smartd_log.spin_up_time
292
- description: Spin-Up Time
293
- availability:
294
- - ATA
295
- unit: "ms"
296
- chart_type: line
297
- dimensions:
298
- - name: a dimension per device
299
- - name: smartd_log.spin_up_retries
300
- description: Spin-up Retries
301
- availability:
302
- - ATA
303
- unit: "retries"
304
- chart_type: line
305
- dimensions:
306
- - name: a dimension per device
307
- - name: smartd_log.calibration_retries
308
- description: Calibration Retries
309
- availability:
310
- - ATA
311
- unit: "retries"
312
- chart_type: line
313
- dimensions:
314
- - name: a dimension per device
315
- - name: smartd_log.airflow_temperature_celsius
316
- description: Airflow Temperature Celsius
317
- availability:
318
- - ATA
319
- unit: "celsius"
320
- chart_type: line
321
- dimensions:
322
- - name: a dimension per device
323
- - name: smartd_log.temperature_celsius
324
- description: Temperature
325
- availability:
326
- - SCSI
327
- - ATA
328
- unit: "celsius"
329
- chart_type: line
330
- dimensions:
331
- - name: a dimension per device
332
- - name: smartd_log.reallocated_sectors_count
333
- description: Reallocated Sectors Count
334
- availability:
335
- - ATA
336
- unit: "sectors"
337
- chart_type: line
338
- dimensions:
339
- - name: a dimension per device
340
- - name: smartd_log.reserved_block_count
341
- description: Reserved Block Count
342
- availability:
343
- - ATA
344
- unit: "percentage"
345
- chart_type: line
346
- dimensions:
347
- - name: a dimension per device
348
- - name: smartd_log.program_fail_count
349
- description: Program Fail Count
350
- availability:
351
- - ATA
352
- unit: "errors"
353
- chart_type: line
354
- dimensions:
355
- - name: a dimension per device
356
- - name: smartd_log.erase_fail_count
357
- description: Erase Fail Count
358
- availability:
359
- - ATA
360
- unit: "failures"
361
- chart_type: line
362
- dimensions:
363
- - name: a dimension per device
364
- - name: smartd_log.wear_leveller_worst_case_erase_count
365
- description: Wear Leveller Worst Case Erase Count
366
- availability:
367
- - ATA
368
- unit: "erases"
369
- chart_type: line
370
- dimensions:
371
- - name: a dimension per device
372
- - name: smartd_log.unused_reserved_nand_blocks
373
- description: Unused Reserved NAND Blocks
374
- availability:
375
- - ATA
376
- unit: "blocks"
377
- chart_type: line
378
- dimensions:
379
- - name: a dimension per device
380
- - name: smartd_log.reallocation_event_count
381
- description: Reallocation Event Count
382
- availability:
383
- - ATA
384
- unit: "events"
385
- chart_type: line
386
- dimensions:
387
- - name: a dimension per device
388
- - name: smartd_log.current_pending_sector_count
389
- description: Current Pending Sector Count
390
- availability:
391
- - ATA
392
- unit: "sectors"
393
- chart_type: line
394
- dimensions:
395
- - name: a dimension per device
396
- - name: smartd_log.offline_uncorrectable_sector_count
397
- description: Offline Uncorrectable Sector Count
398
- availability:
399
- - ATA
400
- unit: "sectors"
401
- chart_type: line
402
- dimensions:
403
- - name: a dimension per device
404
- - name: smartd_log.percent_lifetime_used
405
- description: Percent Lifetime Used
406
- availability:
407
- - ATA
408
- unit: "percentage"
409
- chart_type: line
410
- dimensions:
411
- - name: a dimension per device
412
- - name: smartd_log.media_wearout_indicator
413
- description: Media Wearout Indicator
414
- availability:
415
- - ATA
416
- unit: "percentage"
417
- chart_type: line
418
- dimensions:
419
- - name: a dimension per device
420
- - name: smartd_log.nand_writes_1gib
421
- description: NAND Writes
422
- availability:
423
- - ATA
424
- unit: "GiB"
425
- chart_type: line
426
- dimensions:
427
- - name: a dimension per device
83
+ title: "Config options"
84
+ enabled: true
85
+ list:
86
+ - name: log_path
87
+ description: path to smartd log files.
88
+ default_value: /var/log/smartd
89
+ required: true
90
+ - name: exclude_disks
91
+ description: Space-separated patterns. If the pattern is in the drive name, the module will not collect data for it.
92
+ default_value: ""
93
+ required: false
94
+ - name: age
95
+ description: Time in minutes since the last dump to file.
96
+ default_value: 30
97
+ required: false
98
+ - name: update_every
99
+ description: Sets the default data collection frequency.
100
+ default_value: 1
101
+ required: false
102
+ - name: priority
103
+ description: Controls the order of charts at the netdata dashboard.
104
+ default_value: 60000
105
+ required: false
106
+ - name: autodetection_retry
107
+ description: Sets the job re-check interval in seconds.
108
+ default_value: 0
109
+ required: false
110
+ - name: penalty
111
+ description: Indicates whether to apply penalty to update_every in case of failures.
112
+ default_value: yes
113
+ required: false
114
+ - name: name
115
+ description: >
116
+ Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
117
+ default_value: ""
118
+ required: false
119
+ examples:
120
+ folding:
121
+ enabled: true
122
+ title: "Config"
123
+ list:
124
+ - name: Basic
125
+ description: A basic configuration example.
126
+ folding:
127
+ enabled: false
128
+ config: |
129
+ custom:
130
+ name: smartd_log
131
+ log_path: '/var/log/smartd/'
132
+ troubleshooting:
133
+ problems:
134
+ list: []
135
+ alerts: []
136
+ metrics:
137
+ folding:
138
+ title: Metrics
139
+ enabled: false
140
+ description: "The metrics listed below are split in terms of availability on device type, SCSI or ATA."
141
+ availability:
142
+ - "SCSI"
143
+ - "ATA"
144
+ scopes:
145
+ - name: global
146
+ description: "These metrics refer to the entire monitored application."
147
+ labels: []
148
+ metrics:
149
+ - name: smartd_log.read_error_rate
150
+ description: Read Error Rate
151
+ availability:
152
+ - ATA
153
+ unit: "value"
154
+ chart_type: line
155
+ dimensions:
156
+ - name: a dimension per device
157
+ - name: smartd_log.seek_error_rate
158
+ description: Seek Error Rate
159
+ availability:
160
+ - ATA
161
+ unit: "value"
162
+ chart_type: line
163
+ dimensions:
164
+ - name: a dimension per device
165
+ - name: smartd_log.soft_read_error_rate
166
+ description: Soft Read Error Rate
167
+ availability:
168
+ - ATA
169
+ unit: "errors"
170
+ chart_type: line
171
+ dimensions:
172
+ - name: a dimension per device
173
+ - name: smartd_log.write_error_rate
174
+ description: Write Error Rate
175
+ availability:
176
+ - ATA
177
+ unit: "value"
178
+ chart_type: line
179
+ dimensions:
180
+ - name: a dimension per device
181
+ - name: smartd_log.read_total_err_corrected
182
+ description: Read Error Corrected
183
+ availability:
184
+ - SCSI
185
+ unit: "errors"
186
+ chart_type: line
187
+ dimensions:
188
+ - name: a dimension per device
189
+ - name: smartd_log.read_total_unc_errors
190
+ description: Read Error Uncorrected
191
+ availability:
192
+ - SCSI
193
+ unit: "errors"
194
+ chart_type: line
195
+ dimensions:
196
+ - name: a dimension per device
197
+ - name: smartd_log.write_total_err_corrected
198
+ description: Write Error Corrected
199
+ availability:
200
+ - SCSI
201
+ unit: "errors"
202
+ chart_type: line
203
+ dimensions:
204
+ - name: a dimension per device
205
+ - name: smartd_log.write_total_unc_errors
206
+ description: Write Error Uncorrected
207
+ availability:
208
+ - SCSI
209
+ unit: "errors"
210
+ chart_type: line
211
+ dimensions:
212
+ - name: a dimension per device
213
+ - name: smartd_log.verify_total_err_corrected
214
+ description: Verify Error Corrected
215
+ availability:
216
+ - SCSI
217
+ unit: "errors"
218
+ chart_type: line
219
+ dimensions:
220
+ - name: a dimension per device
221
+ - name: smartd_log.verify_total_unc_errors
222
+ description: Verify Error Uncorrected
223
+ availability:
224
+ - SCSI
225
+ unit: "errors"
226
+ chart_type: line
227
+ dimensions:
228
+ - name: a dimension per device
229
+ - name: smartd_log.sata_interface_downshift
230
+ description: SATA Interface Downshift
231
+ availability:
232
+ - ATA
233
+ unit: "events"
234
+ chart_type: line
235
+ dimensions:
236
+ - name: a dimension per device
237
+ - name: smartd_log.udma_crc_error_count
238
+ description: UDMA CRC Error Count
239
+ availability:
240
+ - ATA
241
+ unit: "errors"
242
+ chart_type: line
243
+ dimensions:
244
+ - name: a dimension per device
245
+ - name: smartd_log.throughput_performance
246
+ description: Throughput Performance
247
+ availability:
248
+ - ATA
249
+ unit: "value"
250
+ chart_type: line
251
+ dimensions:
252
+ - name: a dimension per device
253
+ - name: smartd_log.seek_time_performance
254
+ description: Seek Time Performance
255
+ availability:
256
+ - ATA
257
+ unit: "value"
258
+ chart_type: line
259
+ dimensions:
260
+ - name: a dimension per device
261
+ - name: smartd_log.start_stop_count
262
+ description: Start/Stop Count
263
+ availability:
264
+ - ATA
265
+ unit: "events"
266
+ chart_type: line
267
+ dimensions:
268
+ - name: a dimension per device
269
+ - name: smartd_log.power_on_hours_count
270
+ description: Power-On Hours Count
271
+ availability:
272
+ - ATA
273
+ unit: "hours"
274
+ chart_type: line
275
+ dimensions:
276
+ - name: a dimension per device
277
+ - name: smartd_log.power_cycle_count
278
+ description: Power Cycle Count
279
+ availability:
280
+ - ATA
281
+ unit: "events"
282
+ chart_type: line
283
+ dimensions:
284
+ - name: a dimension per device
285
+ - name: smartd_log.unexpected_power_loss
286
+ description: Unexpected Power Loss
287
+ availability:
288
+ - ATA
289
+ unit: "events"
290
+ chart_type: line
291
+ dimensions:
292
+ - name: a dimension per device
293
+ - name: smartd_log.spin_up_time
294
+ description: Spin-Up Time
295
+ availability:
296
+ - ATA
297
+ unit: "ms"
298
+ chart_type: line
299
+ dimensions:
300
+ - name: a dimension per device
301
+ - name: smartd_log.spin_up_retries
302
+ description: Spin-up Retries
303
+ availability:
304
+ - ATA
305
+ unit: "retries"
306
+ chart_type: line
307
+ dimensions:
308
+ - name: a dimension per device
309
+ - name: smartd_log.calibration_retries
310
+ description: Calibration Retries
311
+ availability:
312
+ - ATA
313
+ unit: "retries"
314
+ chart_type: line
315
+ dimensions:
316
+ - name: a dimension per device
317
+ - name: smartd_log.airflow_temperature_celsius
318
+ description: Airflow Temperature Celsius
319
+ availability:
320
+ - ATA
321
+ unit: "celsius"
322
+ chart_type: line
323
+ dimensions:
324
+ - name: a dimension per device
325
+ - name: smartd_log.temperature_celsius
326
+ description: Temperature
327
+ availability:
328
+ - SCSI
329
+ - ATA
330
+ unit: "celsius"
331
+ chart_type: line
332
+ dimensions:
333
+ - name: a dimension per device
334
+ - name: smartd_log.reallocated_sectors_count
335
+ description: Reallocated Sectors Count
336
+ availability:
337
+ - ATA
338
+ unit: "sectors"
339
+ chart_type: line
340
+ dimensions:
341
+ - name: a dimension per device
342
+ - name: smartd_log.reserved_block_count
343
+ description: Reserved Block Count
344
+ availability:
345
+ - ATA
346
+ unit: "percentage"
347
+ chart_type: line
348
+ dimensions:
349
+ - name: a dimension per device
350
+ - name: smartd_log.program_fail_count
351
+ description: Program Fail Count
352
+ availability:
353
+ - ATA
354
+ unit: "errors"
355
+ chart_type: line
356
+ dimensions:
357
+ - name: a dimension per device
358
+ - name: smartd_log.erase_fail_count
359
+ description: Erase Fail Count
360
+ availability:
361
+ - ATA
362
+ unit: "failures"
363
+ chart_type: line
364
+ dimensions:
365
+ - name: a dimension per device
366
+ - name: smartd_log.wear_leveller_worst_case_erase_count
367
+ description: Wear Leveller Worst Case Erase Count
368
+ availability:
369
+ - ATA
370
+ unit: "erases"
371
+ chart_type: line
372
+ dimensions:
373
+ - name: a dimension per device
374
+ - name: smartd_log.unused_reserved_nand_blocks
375
+ description: Unused Reserved NAND Blocks
376
+ availability:
377
+ - ATA
378
+ unit: "blocks"
379
+ chart_type: line
380
+ dimensions:
381
+ - name: a dimension per device
382
+ - name: smartd_log.reallocation_event_count
383
+ description: Reallocation Event Count
384
+ availability:
385
+ - ATA
386
+ unit: "events"
387
+ chart_type: line
388
+ dimensions:
389
+ - name: a dimension per device
390
+ - name: smartd_log.current_pending_sector_count
391
+ description: Current Pending Sector Count
392
+ availability:
393
+ - ATA
394
+ unit: "sectors"
395
+ chart_type: line
396
+ dimensions:
397
+ - name: a dimension per device
398
+ - name: smartd_log.offline_uncorrectable_sector_count
399
+ description: Offline Uncorrectable Sector Count
400
+ availability:
401
+ - ATA
402
+ unit: "sectors"
403
+ chart_type: line
404
+ dimensions:
405
+ - name: a dimension per device
406
+ - name: smartd_log.percent_lifetime_used
407
+ description: Percent Lifetime Used
408
+ availability:
409
+ - ATA
410
+ unit: "percentage"
411
+ chart_type: line
412
+ dimensions:
413
+ - name: a dimension per device
414
+ - name: smartd_log.media_wearout_indicator
415
+ description: Media Wearout Indicator
416
+ availability:
417
+ - ATA
418
+ unit: "percentage"
419
+ chart_type: line
420
+ dimensions:
421
+ - name: a dimension per device
422
+ - name: smartd_log.nand_writes_1gib
423
+ description: NAND Writes
424
+ availability:
425
+ - ATA
426
+ unit: "GiB"
427
+ chart_type: line
428
+ dimensions:
429
+ - name: a dimension per device
collectors/python.d.plugin/spigotmc/metadata.yaml
+175
-173
@@ -1,174 +1,176 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: spigotmc
4
- monitored_instance:
5
- name: SpigotMC
6
- link: ""
7
- categories:
8
- - data-collection.gaming
9
- icon_filename: "spigot.jfif"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - minecraft server
17
- - spigotmc server
18
- - spigot
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: |
23
- This collector monitors SpigotMC server performance, in the form of ticks per second average, memory utilization, and active users.
24
- method_description: |
25
- It sends the `tps`, `list` and `online` commands to the Server, and gathers the metrics from the responses.
26
- supported_platforms:
27
- include:
28
- - Linux
29
- exclude: []
30
- multi_instance: true
31
- additional_permissions:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: By default, this collector will attempt to connect to a Spigot server running on the local host on port `25575`.
36
- limits:
37
- description: ""
38
- performance_impact:
39
- description: ""
40
-setup:
41
- prerequisites:
42
- list:
43
- - title: Enable the Remote Console Protocol
44
- description: |
45
- Under your SpigotMC server's `server.properties` configuration file, you should set `enable-rcon` to `true`.
46
-
47
- This will allow the Server to listen and respond to queries over the rcon protocol.
48
- configuration:
49
- file:
50
- name: "python.d/spigotmc.conf"
51
- options:
52
- description: |
53
- There are 2 sections:
54
-
55
- * Global variables
56
- * One or more JOBS that can define multiple different instances to monitor.
57
-
58
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
59
-
60
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
61
-
62
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
63
- folding:
64
- title: "Config options"
65
- enabled: true
66
- list:
67
- - name: update_every
68
- description: Sets the default data collection frequency.
69
- default_value: 1
70
- required: false
71
- - name: priority
72
- description: Controls the order of charts at the netdata dashboard.
73
- default_value: 60000
74
- required: false
75
- - name: autodetection_retry
76
- description: Sets the job re-check interval in seconds.
77
- default_value: 0
78
- required: false
79
- - name: penalty
80
- description: Indicates whether to apply penalty to update_every in case of failures.
81
- default_value: yes
82
- required: false
83
- - name: name
84
- description: >
85
- Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed
86
- running at any time. This allows autodetection to try several alternatives and pick the one that works.
87
- default_value: ""
88
- required: false
89
- - name: host
90
- description: The host's IP to connect to.
91
- default_value: localhost
92
- required: true
93
- - name: port
94
- description: The port the remote console is listening on.
95
- default_value: 25575
96
- required: true
97
- - name: password
98
- description: Remote console password if any.
99
- default_value: ""
100
- required: false
101
- examples:
102
- folding:
103
- enabled: true
104
- title: "Config"
105
- list:
106
- - name: Basic
107
- description: A basic configuration example.
108
- folding:
109
- enabled: false
110
- config: |
111
- local:
112
- name: local_server
113
- url: 127.0.0.1
114
- port: 25575
115
- - name: Basic Authentication
116
- description: An example using basic password for authentication with the remote console.
117
- config: |
118
- local:
119
- name: local_server_pass
120
- url: 127.0.0.1
121
- port: 25575
122
- password: 'foobar'
123
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: spigotmc
6
+ monitored_instance:
7
+ name: SpigotMC
8
+ link: ""
9
+ categories:
10
+ - data-collection.gaming
11
+ icon_filename: "spigot.jfif"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - minecraft server
19
+ - spigotmc server
20
+ - spigot
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: |
25
+ This collector monitors SpigotMC server performance, in the form of ticks per second average, memory utilization, and active users.
26
+ method_description: |
27
+ It sends the `tps`, `list` and `online` commands to the Server, and gathers the metrics from the responses.
28
+ supported_platforms:
29
+ include:
30
+ - Linux
31
+ exclude: []
32
+ multi_instance: true
33
+ additional_permissions:
34
+ description: ""
35
+ default_behavior:
36
+ auto_detection:
37
+ description: By default, this collector will attempt to connect to a Spigot server running on the local host on port `25575`.
38
+ limits:
39
+ description: ""
40
+ performance_impact:
41
+ description: ""
42
+ setup:
43
+ prerequisites:
44
+ list:
45
+ - title: Enable the Remote Console Protocol
46
+ description: |
47
+ Under your SpigotMC server's `server.properties` configuration file, you should set `enable-rcon` to `true`.
48
+
49
+ This will allow the Server to listen and respond to queries over the rcon protocol.
50
+ configuration:
51
+ file:
52
+ name: "python.d/spigotmc.conf"
53
+ options:
54
description: |
125
- > **Note**: When you define multiple jobs, their names must be unique.
126
-
127
- Collecting metrics from local and remote instances.
128
- config: |
129
- local_server:
130
- name : my_local_server
131
- url : 127.0.0.1
132
- port: 25575
133
-
134
- remote_server:
135
- name : another_remote_server
136
- url : 192.0.2.1
137
- port: 25575
138
-troubleshooting:
139
- problems:
140
- list: []
141
-alerts: []
142
-metrics:
143
- folding:
144
- title: Metrics
145
- enabled: false
146
- description: ""
147
- availability: []
148
- scopes:
149
- - name: global
150
- description: "These metrics refer to the entire monitored application."
151
- labels: []
152
- metrics:
153
- - name: spigotmc.tps
154
- description: Spigot Ticks Per Second
155
- unit: "ticks"
156
- chart_type: line
157
- dimensions:
158
- - name: 1 Minute Average
159
- - name: 5 Minute Average
160
- - name: 15 Minute Average
161
- - name: spigotmc.users
162
- description: Minecraft Users
163
- unit: "users"
164
- chart_type: area
165
- dimensions:
166
- - name: Users
167
- - name: spigotmc.mem
168
- description: Minecraft Memory Usage
169
- unit: "MiB"
170
- chart_type: line
171
- dimensions:
172
- - name: used
173
- - name: allocated
174
- - name: max
55
+ There are 2 sections:
56
+
57
+ * Global variables
58
+ * One or more JOBS that can define multiple different instances to monitor.
59
+
60
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
61
+
62
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
63
+
64
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
65
+ folding:
66
+ title: "Config options"
67
+ enabled: true
68
+ list:
69
+ - name: update_every
70
+ description: Sets the default data collection frequency.
71
+ default_value: 1
72
+ required: false
73
+ - name: priority
74
+ description: Controls the order of charts at the netdata dashboard.
75
+ default_value: 60000
76
+ required: false
77
+ - name: autodetection_retry
78
+ description: Sets the job re-check interval in seconds.
79
+ default_value: 0
80
+ required: false
81
+ - name: penalty
82
+ description: Indicates whether to apply penalty to update_every in case of failures.
83
+ default_value: yes
84
+ required: false
85
+ - name: name
86
+ description: >
87
+ Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed
88
+ running at any time. This allows autodetection to try several alternatives and pick the one that works.
89
+ default_value: ""
90
+ required: false
91
+ - name: host
92
+ description: The host's IP to connect to.
93
+ default_value: localhost
94
+ required: true
95
+ - name: port
96
+ description: The port the remote console is listening on.
97
+ default_value: 25575
98
+ required: true
99
+ - name: password
100
+ description: Remote console password if any.
101
+ default_value: ""
102
+ required: false
103
+ examples:
104
+ folding:
105
+ enabled: true
106
+ title: "Config"
107
+ list:
108
+ - name: Basic
109
+ description: A basic configuration example.
110
+ folding:
111
+ enabled: false
112
+ config: |
113
+ local:
114
+ name: local_server
115
+ url: 127.0.0.1
116
+ port: 25575
117
+ - name: Basic Authentication
118
+ description: An example using basic password for authentication with the remote console.
119
+ config: |
120
+ local:
121
+ name: local_server_pass
122
+ url: 127.0.0.1
123
+ port: 25575
124
+ password: 'foobar'
125
+ - name: Multi-instance
126
+ description: |
127
+ > **Note**: When you define multiple jobs, their names must be unique.
128
+
129
+ Collecting metrics from local and remote instances.
130
+ config: |
131
+ local_server:
132
+ name : my_local_server
133
+ url : 127.0.0.1
134
+ port: 25575
135
+
136
+ remote_server:
137
+ name : another_remote_server
138
+ url : 192.0.2.1
139
+ port: 25575
140
+ troubleshooting:
141
+ problems:
142
+ list: []
143
+ alerts: []
144
+ metrics:
145
+ folding:
146
+ title: Metrics
147
+ enabled: false
148
+ description: ""
149
+ availability: []
150
+ scopes:
151
+ - name: global
152
+ description: "These metrics refer to the entire monitored application."
153
+ labels: []
154
+ metrics:
155
+ - name: spigotmc.tps
156
+ description: Spigot Ticks Per Second
157
+ unit: "ticks"
158
+ chart_type: line
159
+ dimensions:
160
+ - name: 1 Minute Average
161
+ - name: 5 Minute Average
162
+ - name: 15 Minute Average
163
+ - name: spigotmc.users
164
+ description: Minecraft Users
165
+ unit: "users"
166
+ chart_type: area
167
+ dimensions:
168
+ - name: Users
169
+ - name: spigotmc.mem
170
+ description: Minecraft Memory Usage
171
+ unit: "MiB"
172
+ chart_type: line
173
+ dimensions:
174
+ - name: used
175
+ - name: allocated
176
+ - name: max
collectors/python.d.plugin/squid/metadata.yaml
+173
-171
@@ -1,172 +1,174 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: squid
4
- monitored_instance:
5
- name: Squid
6
- link: "http://www.squid-cache.org/"
7
- categories:
8
- - data-collection.web-servers-and-web-proxies
9
- icon_filename: "squid.png"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - squid
17
- - web delivery
18
- - squid caching proxy
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: |
23
- This collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.
24
- method_description: "It collects metrics from the endpoint where Squid exposes its `counters` data."
25
- supported_platforms:
26
- include: []
27
- exclude: []
28
- multi_instance: true
29
- additional_permissions:
30
- description: ""
31
- default_behavior:
32
- auto_detection:
33
- description: "By default, this collector will try to autodetect where Squid presents its `counters` data, by trying various configurations."
34
- limits:
35
- description: ""
36
- performance_impact:
37
- description: ""
38
-setup:
39
- prerequisites:
40
- list:
41
- - title: Configure Squid's Cache Manager
42
- description: |
43
- Take a look at [Squid's official documentation](https://wiki.squid-cache.org/Features/CacheManager/Index#controlling-access-to-the-cache-manager) on how to configure access to the Cache Manager.
44
- configuration:
45
- file:
46
- name: "python.d/squid.conf"
47
- options:
48
- description: |
49
- There are 2 sections:
50
-
51
- * Global variables
52
- * One or more JOBS that can define multiple different instances to monitor.
53
-
54
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
55
-
56
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
-
58
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
- folding:
60
- title: "Config options"
61
- enabled: true
62
- list:
63
- - name: update_every
64
- description: Sets the default data collection frequency.
65
- default_value: 1
66
- required: false
67
- - name: priority
68
- description: Controls the order of charts at the netdata dashboard.
69
- default_value: 60000
70
- required: false
71
- - name: autodetection_retry
72
- description: Sets the job re-check interval in seconds.
73
- default_value: 0
74
- required: false
75
- - name: penalty
76
- description: Indicates whether to apply penalty to update_every in case of failures.
77
- default_value: yes
78
- required: false
79
- - name: name
80
- description: >
81
- Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
82
- default_value: "local"
83
- required: false
84
- - name: host
85
- description: The host to connect to.
86
- default_value: ""
87
- required: true
88
- - name: port
89
- description: The port to connect to.
90
- default_value: ""
91
- required: true
92
- - name: request
93
- description: The URL to request from Squid.
94
- default_value: ""
95
- required: true
96
- examples:
97
- folding:
98
- enabled: true
99
- title: "Config"
100
- list:
101
- - name: Basic
102
- description: A basic configuration example.
103
- folding:
104
- enabled: false
105
- config: |
106
- example_job_name:
107
- name: 'local'
108
- host: 'localhost'
109
- port: 3128
110
- request: 'cache_object://localhost:3128/counters'
111
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: squid
6
+ monitored_instance:
7
+ name: Squid
8
+ link: "http://www.squid-cache.org/"
9
+ categories:
10
+ - data-collection.web-servers-and-web-proxies
11
+ icon_filename: "squid.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - squid
19
+ - web delivery
20
+ - squid caching proxy
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: |
25
+ This collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.
26
+ method_description: "It collects metrics from the endpoint where Squid exposes its `counters` data."
27
+ supported_platforms:
28
+ include: []
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: "By default, this collector will try to autodetect where Squid presents its `counters` data, by trying various configurations."
36
+ limits:
37
+ description: ""
38
+ performance_impact:
39
+ description: ""
40
+ setup:
41
+ prerequisites:
42
+ list:
43
+ - title: Configure Squid's Cache Manager
44
+ description: |
45
+ Take a look at [Squid's official documentation](https://wiki.squid-cache.org/Features/CacheManager/Index#controlling-access-to-the-cache-manager) on how to configure access to the Cache Manager.
46
+ configuration:
47
+ file:
48
+ name: "python.d/squid.conf"
49
+ options:
50
description: |
113
- > **Note**: When you define multiple jobs, their names must be unique.
114
-
115
- Collecting metrics from local and remote instances.
116
- config: |
117
- local_job:
118
- name: 'local'
119
- host: '127.0.0.1'
120
- port: 3128
121
- request: 'cache_object://127.0.0.1:3128/counters'
122
-
123
- remote_job:
124
- name: 'remote'
125
- host: '192.0.2.1'
126
- port: 3128
127
- request: 'cache_object://192.0.2.1:3128/counters'
128
-troubleshooting:
129
- problems:
130
- list: []
131
-alerts: []
132
-metrics:
133
- folding:
134
- title: Metrics
135
- enabled: false
136
- description: ""
137
- availability: []
138
- scopes:
139
- - name: Squid instance
140
- description: "These metrics refer to each monitored Squid instance."
141
- labels: []
142
- metrics:
143
- - name: squid.clients_net
144
- description: Squid Client Bandwidth
145
- unit: "kilobits/s"
146
- chart_type: area
147
- dimensions:
148
- - name: in
149
- - name: out
150
- - name: hits
151
- - name: squid.clients_requests
152
- description: Squid Client Requests
153
- unit: "requests/s"
154
- chart_type: line
155
- dimensions:
156
- - name: requests
157
- - name: hits
158
- - name: errors
159
- - name: squid.servers_net
160
- description: Squid Server Bandwidth
161
- unit: "kilobits/s"
162
- chart_type: area
163
- dimensions:
164
- - name: in
165
- - name: out
166
- - name: squid.servers_requests
167
- description: Squid Server Requests
168
- unit: "requests/s"
169
- chart_type: line
170
- dimensions:
171
- - name: requests
172
- - name: errors
51
+ There are 2 sections:
52
+
53
+ * Global variables
54
+ * One or more JOBS that can define multiple different instances to monitor.
55
+
56
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
57
+
58
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
59
+
60
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
61
+ folding:
62
+ title: "Config options"
63
+ enabled: true
64
+ list:
65
+ - name: update_every
66
+ description: Sets the default data collection frequency.
67
+ default_value: 1
68
+ required: false
69
+ - name: priority
70
+ description: Controls the order of charts at the netdata dashboard.
71
+ default_value: 60000
72
+ required: false
73
+ - name: autodetection_retry
74
+ description: Sets the job re-check interval in seconds.
75
+ default_value: 0
76
+ required: false
77
+ - name: penalty
78
+ description: Indicates whether to apply penalty to update_every in case of failures.
79
+ default_value: yes
80
+ required: false
81
+ - name: name
82
+ description: >
83
+ Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
84
+ default_value: "local"
85
+ required: false
86
+ - name: host
87
+ description: The host to connect to.
88
+ default_value: ""
89
+ required: true
90
+ - name: port
91
+ description: The port to connect to.
92
+ default_value: ""
93
+ required: true
94
+ - name: request
95
+ description: The URL to request from Squid.
96
+ default_value: ""
97
+ required: true
98
+ examples:
99
+ folding:
100
+ enabled: true
101
+ title: "Config"
102
+ list:
103
+ - name: Basic
104
+ description: A basic configuration example.
105
+ folding:
106
+ enabled: false
107
+ config: |
108
+ example_job_name:
109
+ name: 'local'
110
+ host: 'localhost'
111
+ port: 3128
112
+ request: 'cache_object://localhost:3128/counters'
113
+ - name: Multi-instance
114
+ description: |
115
+ > **Note**: When you define multiple jobs, their names must be unique.
116
+
117
+ Collecting metrics from local and remote instances.
118
+ config: |
119
+ local_job:
120
+ name: 'local'
121
+ host: '127.0.0.1'
122
+ port: 3128
123
+ request: 'cache_object://127.0.0.1:3128/counters'
124
+
125
+ remote_job:
126
+ name: 'remote'
127
+ host: '192.0.2.1'
128
+ port: 3128
129
+ request: 'cache_object://192.0.2.1:3128/counters'
130
+ troubleshooting:
131
+ problems:
132
+ list: []
133
+ alerts: []
134
+ metrics:
135
+ folding:
136
+ title: Metrics
137
+ enabled: false
138
+ description: ""
139
+ availability: []
140
+ scopes:
141
+ - name: Squid instance
142
+ description: "These metrics refer to each monitored Squid instance."
143
+ labels: []
144
+ metrics:
145
+ - name: squid.clients_net
146
+ description: Squid Client Bandwidth
147
+ unit: "kilobits/s"
148
+ chart_type: area
149
+ dimensions:
150
+ - name: in
151
+ - name: out
152
+ - name: hits
153
+ - name: squid.clients_requests
154
+ description: Squid Client Requests
155
+ unit: "requests/s"
156
+ chart_type: line
157
+ dimensions:
158
+ - name: requests
159
+ - name: hits
160
+ - name: errors
161
+ - name: squid.servers_net
162
+ description: Squid Server Bandwidth
163
+ unit: "kilobits/s"
164
+ chart_type: area
165
+ dimensions:
166
+ - name: in
167
+ - name: out
168
+ - name: squid.servers_requests
169
+ description: Squid Server Requests
170
+ unit: "requests/s"
171
+ chart_type: line
172
+ dimensions:
173
+ - name: requests
174
+ - name: errors
collectors/python.d.plugin/tomcat/metadata.yaml
+199
-197
@@ -1,198 +1,200 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: tomcat
4
- monitored_instance:
5
- name: Tomcat
6
- link: "https://tomcat.apache.org/"
7
- categories:
8
- - data-collection.web-servers-and-web-proxies
9
- icon_filename: "tomcat.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - apache
17
- - tomcat
18
- - webserver
19
- - websocket
20
- - jakarta
21
- - javaEE
22
- most_popular: false
23
-overview:
24
- data_collection:
25
- metrics_description: |
26
- This collector monitors Tomcat metrics about bandwidth, processing time, threads and more.
27
- method_description: |
28
- It parses the information provided by the http endpoint of the `/manager/status` in XML format
29
- supported_platforms:
30
- include: []
31
- exclude: []
32
- multi_instance: true
33
- additional_permissions:
34
- description: "You need to provide the username and the password, to access the webserver's status page. Create a seperate user with read only rights for this particular endpoint"
35
- default_behavior:
36
- auto_detection:
37
- description: "If the Netdata Agent and the Tomcat webserver are in the same host, without configuration, module attempts to connect to http://localhost:8080/manager/status?XML=true, without any credentials. So it will probably fail."
38
- limits:
39
- description: "This module is not supporting SSL communication. If you want a Netdata Agent to monitor a Tomcat deployment, you shouldnt try to monitor it via public network (public internet). Credentials are passed by Netdata in an unsecure port"
40
- performance_impact:
41
- description: ""
42
-setup:
43
- prerequisites:
44
- list:
45
- - title: Create a read-only `netdata` user, to monitor the `/status` endpoint.
46
- description: You will need this configuring the collector
47
- configuration:
48
- file:
49
- name: "python.d/tomcat.conf"
50
- options:
51
- description: |
52
- There are 2 sections:
53
-
54
- * Global variables
55
- * One or more JOBS that can define multiple different instances to monitor.
56
-
57
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
-
59
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
- folding:
61
- title: "Config options per job"
62
- enabled: true
63
- list:
64
- - name: update_every
65
- description: Sets the default data collection frequency.
66
- default_value: 5
67
- required: false
68
- - name: priority
69
- description: Controls the order of charts at the netdata dashboard.
70
- default_value: 60000
71
- required: false
72
- - name: autodetection_retry
73
- description: Sets the job re-check interval in seconds.
74
- default_value: 0
75
- required: false
76
- - name: penalty
77
- description: Indicates whether to apply penalty to update_every in case of failures.
78
- default_value: yes
79
- required: false
80
- - name: url
81
- description: The URL of the Tomcat server's status endpoint. Always add the suffix ?XML=true.
82
- default_value: no
83
- required: true
84
- - name: user
85
- description: A valid user with read permission to access the /manager/status endpoint of the server. Required if the endpoint is password protected
86
- default_value: no
87
- required: false
88
- - name: pass
89
- description: A valid password for the user in question. Required if the endpoint is password protected
90
- default_value: no
91
- required: false
92
- - name: connector_name
93
- description: The connector component that communicates with a web connector via the AJP protocol, e.g ajp-bio-8009
94
- default_value: ""
95
- required: false
96
- examples:
97
- folding:
98
- enabled: true
99
- title: "Config"
100
- list:
101
- - name: Basic
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: tomcat
6
+ monitored_instance:
7
+ name: Tomcat
8
+ link: "https://tomcat.apache.org/"
9
+ categories:
10
+ - data-collection.web-servers-and-web-proxies
11
+ icon_filename: "tomcat.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - apache
19
+ - tomcat
20
+ - webserver
21
+ - websocket
22
+ - jakarta
23
+ - javaEE
24
+ most_popular: false
25
+ overview:
26
+ data_collection:
27
+ metrics_description: |
28
+ This collector monitors Tomcat metrics about bandwidth, processing time, threads and more.
29
+ method_description: |
30
+ It parses the information provided by the http endpoint of the `/manager/status` in XML format
31
+ supported_platforms:
32
+ include: []
33
+ exclude: []
34
+ multi_instance: true
35
+ additional_permissions:
36
+ description: "You need to provide the username and the password, to access the webserver's status page. Create a seperate user with read only rights for this particular endpoint"
37
+ default_behavior:
38
+ auto_detection:
39
+ description: "If the Netdata Agent and the Tomcat webserver are in the same host, without configuration, module attempts to connect to http://localhost:8080/manager/status?XML=true, without any credentials. So it will probably fail."
40
+ limits:
41
+ description: "This module is not supporting SSL communication. If you want a Netdata Agent to monitor a Tomcat deployment, you shouldnt try to monitor it via public network (public internet). Credentials are passed by Netdata in an unsecure port"
42
+ performance_impact:
43
+ description: ""
44
+ setup:
45
+ prerequisites:
46
+ list:
47
+ - title: Create a read-only `netdata` user, to monitor the `/status` endpoint.
48
+ description: You will need this configuring the collector
49
+ configuration:
50
+ file:
51
+ name: "python.d/tomcat.conf"
52
+ options:
53
+ description: |
54
+ There are 2 sections:
55
+
56
+ * Global variables
57
+ * One or more JOBS that can define multiple different instances to monitor.
58
+
59
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
60
+
61
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
62
folding:
103
- enabled: false
104
- description: A basic example configuration
105
- config: |
106
- localhost:
107
- name : 'local'
108
- url : 'http://localhost:8080/manager/status?XML=true'
109
- - name: Using an IPv4 endpoint
110
- description: A typical configuration using an IPv4 endpoint
111
- config: |
112
- local_ipv4:
113
- name : 'local'
114
- url : 'http://127.0.0.1:8080/manager/status?XML=true'
115
- - name: Using an IPv6 endpoint
116
- description: A typical configuration using an IPv6 endpoint
117
- config: |
118
- local_ipv6:
119
- name : 'local'
120
- url : 'http://[::1]:8080/manager/status?XML=true'
121
-troubleshooting:
122
- problems:
123
- list: []
124
-alerts: []
125
-metrics:
126
- folding:
127
- title: Metrics
128
- enabled: false
129
- description: ""
130
- availability: []
131
- scopes:
132
- - name: global
133
- description: "These metrics refer to the entire monitored application."
134
- labels: []
135
- metrics:
136
- - name: tomcat.accesses
137
- description: Requests
138
- unit: "requests/s"
139
- chart_type: area
140
- dimensions:
141
- - name: accesses
142
- - name: errors
143
- - name: tomcat.bandwidth
144
- description: Bandwidth
145
- unit: "KiB/s"
146
- chart_type: area
147
- dimensions:
148
- - name: sent
149
- - name: received
150
- - name: tomcat.processing_time
151
- description: processing time
152
- unit: "seconds"
153
- chart_type: area
154
- dimensions:
155
- - name: processing time
156
- - name: tomcat.threads
157
- description: Threads
158
- unit: "current threads"
159
- chart_type: area
160
- dimensions:
161
- - name: current
162
- - name: busy
163
- - name: tomcat.jvm
164
- description: JVM Memory Pool Usage
165
- unit: "MiB"
166
- chart_type: stacked
167
- dimensions:
168
- - name: free
169
- - name: eden
170
- - name: survivor
171
- - name: tenured
172
- - name: code cache
173
- - name: compressed
174
- - name: metaspace
175
- - name: tomcat.jvm_eden
176
- description: Eden Memory Usage
177
- unit: "MiB"
178
- chart_type: area
179
- dimensions:
180
- - name: used
181
- - name: committed
182
- - name: max
183
- - name: tomcat.jvm_survivor
184
- description: Survivor Memory Usage
185
- unit: "MiB"
186
- chart_type: area
187
- dimensions:
188
- - name: used
189
- - name: committed
190
- - name: max
191
- - name: tomcat.jvm_tenured
192
- description: Tenured Memory Usage
193
- unit: "MiB"
194
- chart_type: area
195
- dimensions:
196
- - name: used
197
- - name: committed
198
- - name: max
63
+ title: "Config options per job"
64
+ enabled: true
65
+ list:
66
+ - name: update_every
67
+ description: Sets the default data collection frequency.
68
+ default_value: 5
69
+ required: false
70
+ - name: priority
71
+ description: Controls the order of charts at the netdata dashboard.
72
+ default_value: 60000
73
+ required: false
74
+ - name: autodetection_retry
75
+ description: Sets the job re-check interval in seconds.
76
+ default_value: 0
77
+ required: false
78
+ - name: penalty
79
+ description: Indicates whether to apply penalty to update_every in case of failures.
80
+ default_value: yes
81
+ required: false
82
+ - name: url
83
+ description: The URL of the Tomcat server's status endpoint. Always add the suffix ?XML=true.
84
+ default_value: no
85
+ required: true
86
+ - name: user
87
+ description: A valid user with read permission to access the /manager/status endpoint of the server. Required if the endpoint is password protected
88
+ default_value: no
89
+ required: false
90
+ - name: pass
91
+ description: A valid password for the user in question. Required if the endpoint is password protected
92
+ default_value: no
93
+ required: false
94
+ - name: connector_name
95
+ description: The connector component that communicates with a web connector via the AJP protocol, e.g ajp-bio-8009
96
+ default_value: ""
97
+ required: false
98
+ examples:
99
+ folding:
100
+ enabled: true
101
+ title: "Config"
102
+ list:
103
+ - name: Basic
104
+ folding:
105
+ enabled: false
106
+ description: A basic example configuration
107
+ config: |
108
+ localhost:
109
+ name : 'local'
110
+ url : 'http://localhost:8080/manager/status?XML=true'
111
+ - name: Using an IPv4 endpoint
112
+ description: A typical configuration using an IPv4 endpoint
113
+ config: |
114
+ local_ipv4:
115
+ name : 'local'
116
+ url : 'http://127.0.0.1:8080/manager/status?XML=true'
117
+ - name: Using an IPv6 endpoint
118
+ description: A typical configuration using an IPv6 endpoint
119
+ config: |
120
+ local_ipv6:
121
+ name : 'local'
122
+ url : 'http://[::1]:8080/manager/status?XML=true'
123
+ troubleshooting:
124
+ problems:
125
+ list: []
126
+ alerts: []
127
+ metrics:
128
+ folding:
129
+ title: Metrics
130
+ enabled: false
131
+ description: ""
132
+ availability: []
133
+ scopes:
134
+ - name: global
135
+ description: "These metrics refer to the entire monitored application."
136
+ labels: []
137
+ metrics:
138
+ - name: tomcat.accesses
139
+ description: Requests
140
+ unit: "requests/s"
141
+ chart_type: area
142
+ dimensions:
143
+ - name: accesses
144
+ - name: errors
145
+ - name: tomcat.bandwidth
146
+ description: Bandwidth
147
+ unit: "KiB/s"
148
+ chart_type: area
149
+ dimensions:
150
+ - name: sent
151
+ - name: received
152
+ - name: tomcat.processing_time
153
+ description: processing time
154
+ unit: "seconds"
155
+ chart_type: area
156
+ dimensions:
157
+ - name: processing time
158
+ - name: tomcat.threads
159
+ description: Threads
160
+ unit: "current threads"
161
+ chart_type: area
162
+ dimensions:
163
+ - name: current
164
+ - name: busy
165
+ - name: tomcat.jvm
166
+ description: JVM Memory Pool Usage
167
+ unit: "MiB"
168
+ chart_type: stacked
169
+ dimensions:
170
+ - name: free
171
+ - name: eden
172
+ - name: survivor
173
+ - name: tenured
174
+ - name: code cache
175
+ - name: compressed
176
+ - name: metaspace
177
+ - name: tomcat.jvm_eden
178
+ description: Eden Memory Usage
179
+ unit: "MiB"
180
+ chart_type: area
181
+ dimensions:
182
+ - name: used
183
+ - name: committed
184
+ - name: max
185
+ - name: tomcat.jvm_survivor
186
+ description: Survivor Memory Usage
187
+ unit: "MiB"
188
+ chart_type: area
189
+ dimensions:
190
+ - name: used
191
+ - name: committed
192
+ - name: max
193
+ - name: tomcat.jvm_tenured
194
+ description: Tenured Memory Usage
195
+ unit: "MiB"
196
+ chart_type: area
197
+ dimensions:
198
+ - name: used
199
+ - name: committed
200
+ - name: max
collectors/python.d.plugin/tor/metadata.yaml
+139
-137
@@ -1,138 +1,140 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: tor
4
- monitored_instance:
5
- name: Tor
6
- link: 'https://www.torproject.org/'
7
- categories:
8
- - data-collection.vpns
9
- icon_filename: 'tor.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ''
15
- keywords:
16
- - tor
17
- - traffic
18
- - vpn
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: 'This collector monitors Tor bandwidth traffic .'
23
- method_description: 'It connects to the Tor control port to collect traffic statistics.'
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ''
30
- default_behavior:
31
- auto_detection:
32
- description: 'If no configuration is provided the collector will try to connect to 127.0.0.1:9051 to detect a running tor instance.'
33
- limits:
34
- description: ''
35
- performance_impact:
36
- description: ''
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: 'Required Tor configuration'
41
- description: |
42
- Add to /etc/tor/torrc:
43
-
44
- ControlPort 9051
45
-
46
- For more options please read the manual.
47
- configuration:
48
- file:
49
- name: python.d/tor.conf
50
- options:
51
- description: |
52
- There are 2 sections:
53
-
54
- * Global variables
55
- * One or more JOBS that can define multiple different instances to monitor.
56
-
57
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
58
-
59
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
60
-
61
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
62
- folding:
63
- title: "Config options"
64
- enabled: true
65
- list:
66
- - name: update_every
67
- description: Sets the default data collection frequency.
68
- default_value: 5
69
- required: false
70
- - name: priority
71
- description: Controls the order of charts at the netdata dashboard.
72
- default_value: 60000
73
- required: false
74
- - name: autodetection_retry
75
- description: Sets the job re-check interval in seconds.
76
- default_value: 0
77
- required: false
78
- - name: penalty
79
- description: Indicates whether to apply penalty to update_every in case of failures.
80
- default_value: yes
81
- required: false
82
- - name: name
83
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
84
- default_value: ''
85
- required: false
86
- - name: control_addr
87
- description: Tor control IP address
88
- default_value: 127.0.0.1
89
- required: false
90
- - name: control_port
91
- description: Tor control port. Can be either a tcp port, or a path to a socket file.
92
- default_value: 9051
93
- required: false
94
- - name: password
95
- description: Tor control password
96
- default_value: ''
97
- required: false
98
- examples:
99
- folding:
100
- enabled: true
101
- title: "Config"
102
- list:
103
- - name: Local TCP
104
- description: A basic TCP configuration. `local_addr` is ommited and will default to `127.0.0.1`
105
- config: |
106
- local_tcp:
107
- name: 'local'
108
- control_port: 9051
109
- password: <password> # if required
110
- - name: Local socket
111
- description: A basic local socket configuration
112
- config: |
113
- local_socket:
114
- name: 'local'
115
- control_port: '/var/run/tor/control'
116
- password: <password> # if required
117
-troubleshooting:
118
- problems:
119
- list: []
120
-alerts: []
121
-metrics:
122
- folding:
123
- title: Metrics
124
- enabled: false
125
- description: ""
126
- availability: []
127
- scopes:
128
- - name: global
129
- description: "These metrics refer to the entire monitored application."
130
- labels: []
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: tor
6
+ monitored_instance:
7
+ name: Tor
8
+ link: 'https://www.torproject.org/'
9
+ categories:
10
+ - data-collection.vpns
11
+ icon_filename: 'tor.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - tor
19
+ - traffic
20
+ - vpn
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: 'This collector monitors Tor bandwidth traffic .'
25
+ method_description: 'It connects to the Tor control port to collect traffic statistics.'
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: true
30
+ additional_permissions:
31
+ description: ''
32
+ default_behavior:
33
+ auto_detection:
34
+ description: 'If no configuration is provided the collector will try to connect to 127.0.0.1:9051 to detect a running tor instance.'
35
+ limits:
36
+ description: ''
37
+ performance_impact:
38
+ description: ''
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: 'Required Tor configuration'
43
+ description: |
44
+ Add to /etc/tor/torrc:
45
+
46
+ ControlPort 9051
47
+
48
+ For more options please read the manual.
49
+ configuration:
50
+ file:
51
+ name: python.d/tor.conf
52
+ options:
53
+ description: |
54
+ There are 2 sections:
55
+
56
+ * Global variables
57
+ * One or more JOBS that can define multiple different instances to monitor.
58
+
59
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
60
+
61
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
62
+
63
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
64
+ folding:
65
+ title: "Config options"
66
+ enabled: true
67
+ list:
68
+ - name: update_every
69
+ description: Sets the default data collection frequency.
70
+ default_value: 5
71
+ required: false
72
+ - name: priority
73
+ description: Controls the order of charts at the netdata dashboard.
74
+ default_value: 60000
75
+ required: false
76
+ - name: autodetection_retry
77
+ description: Sets the job re-check interval in seconds.
78
+ default_value: 0
79
+ required: false
80
+ - name: penalty
81
+ description: Indicates whether to apply penalty to update_every in case of failures.
82
+ default_value: yes
83
+ required: false
84
+ - name: name
85
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
86
+ default_value: ''
87
+ required: false
88
+ - name: control_addr
89
+ description: Tor control IP address
90
+ default_value: 127.0.0.1
91
+ required: false
92
+ - name: control_port
93
+ description: Tor control port. Can be either a tcp port, or a path to a socket file.
94
+ default_value: 9051
95
+ required: false
96
+ - name: password
97
+ description: Tor control password
98
+ default_value: ''
99
+ required: false
100
+ examples:
101
+ folding:
102
+ enabled: true
103
+ title: "Config"
104
+ list:
105
+ - name: Local TCP
106
+ description: A basic TCP configuration. `local_addr` is ommited and will default to `127.0.0.1`
107
+ config: |
108
+ local_tcp:
109
+ name: 'local'
110
+ control_port: 9051
111
+ password: <password> # if required
112
+ - name: Local socket
113
+ description: A basic local socket configuration
114
+ config: |
115
+ local_socket:
116
+ name: 'local'
117
+ control_port: '/var/run/tor/control'
118
+ password: <password> # if required
119
+ troubleshooting:
120
+ problems:
121
+ list: []
122
+ alerts: []
123
metrics:
132
- - name: tor.traffic
133
- description: Tor Traffic
134
- unit: "KiB/s"
135
- chart_type: area
136
- dimensions:
137
- - name: read
138
- - name: write
124
+ folding:
125
+ title: Metrics
126
+ enabled: false
127
+ description: ""
128
+ availability: []
129
+ scopes:
130
+ - name: global
131
+ description: "These metrics refer to the entire monitored application."
132
+ labels: []
133
+ metrics:
134
+ - name: tor.traffic
135
+ description: Tor Traffic
136
+ unit: "KiB/s"
137
+ chart_type: area
138
+ dimensions:
139
+ - name: read
140
+ - name: write
collectors/python.d.plugin/uwsgi/metadata.yaml
+200
-198
@@ -1,199 +1,201 @@
1
-meta:
2
- plugin_name: python.d.plugin
3
- module_name: uwsgi
4
- monitored_instance:
5
- name: uWSGI
6
- link: "https://github.com/unbit/uwsgi/tree/2.0.21"
7
- categories:
8
- - data-collection.web-servers-and-web-proxies
9
- icon_filename: "uwsgi.svg"
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - application server
17
- - python
18
- - web applications
19
- most_popular: false
20
-overview:
21
- data_collection:
22
- metrics_description: "This collector monitors uWSGI metrics about requests, workers, memory and more."
23
- method_description: "It collects every metric exposed from the stats server of uWSGI, either from the `stats.socket` or from the web server's TCP/IP socket."
24
- supported_platforms:
25
- include: []
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: ""
30
- default_behavior:
31
- auto_detection:
32
- description: "This collector will auto-detect uWSGI instances deployed on the local host, running on port 1717, or exposing stats on socket `tmp/stats.socket`."
33
- limits:
34
- description: ""
35
- performance_impact:
36
- description: ""
37
-setup:
38
- prerequisites:
39
- list:
40
- - title: Enable the uWSGI Stats server
41
- description: |
42
- Make sure that you uWSGI exposes it's metrics via a Stats server.
43
-
44
- Source: https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html
45
- configuration:
46
- file:
47
- name: "python.d/uwsgi.conf"
48
- options:
49
- description: |
50
- There are 2 sections:
51
-
52
- * Global variables
53
- * One or more JOBS that can define multiple different instances to monitor.
54
-
55
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
-
57
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
-
59
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
- folding:
61
- title: "Config options"
62
- enabled: true
63
- list:
64
- - name: update_every
65
- description: Sets the default data collection frequency.
66
- default_value: 5
67
- required: false
68
- - name: priority
69
- description: Controls the order of charts at the netdata dashboard.
70
- default_value: 60000
71
- required: false
72
- - name: autodetection_retry
73
- description: Sets the job re-check interval in seconds.
74
- default_value: 0
75
- required: false
76
- - name: penalty
77
- description: Indicates whether to apply penalty to update_every in case of failures.
78
- default_value: yes
79
- required: false
80
- - name: name
81
- description: The JOB's name as it will appear at the dashboard (by default is the job_name)
82
- default_value: job_name
83
- required: false
84
- - name: socket
85
- description: The 'path/to/uwsgistats.sock'
86
- default_value: no
87
- required: false
88
- - name: host
89
- description: The host to connect to
90
- default_value: no
91
- required: false
92
- - name: port
93
- description: The port to connect to
94
- default_value: no
95
- required: false
96
- examples:
97
- folding:
98
- enabled: true
99
- title: "Config"
100
- list:
101
- - name: Basic (default out-of-the-box)
102
- description: A basic example configuration, one job will run at a time. Autodetect mechanism uses it by default. As all JOBs have the same name, only one can run at a time.
103
- config: |
104
- socket:
105
- name : 'local'
106
- socket : '/tmp/stats.socket'
107
-
108
- localhost:
109
- name : 'local'
110
- host : 'localhost'
111
- port : 1717
112
-
113
- localipv4:
114
- name : 'local'
115
- host : '127.0.0.1'
116
- port : 1717
117
-
118
- localipv6:
119
- name : 'local'
120
- host : '::1'
121
- port : 1717
122
- - name: Multi-instance
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: uwsgi
6
+ monitored_instance:
7
+ name: uWSGI
8
+ link: "https://github.com/unbit/uwsgi/tree/2.0.21"
9
+ categories:
10
+ - data-collection.web-servers-and-web-proxies
11
+ icon_filename: "uwsgi.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - application server
19
+ - python
20
+ - web applications
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "This collector monitors uWSGI metrics about requests, workers, memory and more."
25
+ method_description: "It collects every metric exposed from the stats server of uWSGI, either from the `stats.socket` or from the web server's TCP/IP socket."
26
+ supported_platforms:
27
+ include: []
28
+ exclude: []
29
+ multi_instance: true
30
+ additional_permissions:
31
+ description: ""
32
+ default_behavior:
33
+ auto_detection:
34
+ description: "This collector will auto-detect uWSGI instances deployed on the local host, running on port 1717, or exposing stats on socket `tmp/stats.socket`."
35
+ limits:
36
+ description: ""
37
+ performance_impact:
38
+ description: ""
39
+ setup:
40
+ prerequisites:
41
+ list:
42
+ - title: Enable the uWSGI Stats server
43
+ description: |
44
+ Make sure that you uWSGI exposes it's metrics via a Stats server.
45
+
46
+ Source: https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html
47
+ configuration:
48
+ file:
49
+ name: "python.d/uwsgi.conf"
50
+ options:
51
description: |
124
- > **Note**: When you define multiple jobs, their names must be unique.
125
-
126
- Collecting metrics from local and remote instances.
127
- config: |
128
- local:
129
- name : 'local'
130
- host : 'localhost'
131
- port : 1717
132
-
133
- remote:
134
- name : 'remote'
135
- host : '192.0.2.1'
136
- port : 1717
137
-troubleshooting:
138
- problems:
139
- list: []
140
-alerts: []
141
-metrics:
142
- folding:
143
- title: Metrics
144
- enabled: false
145
- description: ""
146
- availability: []
147
- scopes:
148
- - name: global
149
- description: "These metrics refer to the entire monitored application."
150
- labels: []
151
- metrics:
152
- - name: uwsgi.requests
153
- description: Requests
154
- unit: "requests/s"
155
- chart_type: stacked
156
- dimensions:
157
- - name: a dimension per worker
158
- - name: uwsgi.tx
159
- description: Transmitted data
160
- unit: "KiB/s"
161
- chart_type: stacked
162
- dimensions:
163
- - name: a dimension per worker
164
- - name: uwsgi.avg_rt
165
- description: Average request time
166
- unit: "milliseconds"
167
- chart_type: line
168
- dimensions:
169
- - name: a dimension per worker
170
- - name: uwsgi.memory_rss
171
- description: RSS (Resident Set Size)
172
- unit: "MiB"
173
- chart_type: stacked
174
- dimensions:
175
- - name: a dimension per worker
176
- - name: uwsgi.memory_vsz
177
- description: VSZ (Virtual Memory Size)
178
- unit: "MiB"
179
- chart_type: stacked
180
- dimensions:
181
- - name: a dimension per worker
182
- - name: uwsgi.exceptions
183
- description: Exceptions
184
- unit: "exceptions"
185
- chart_type: line
186
- dimensions:
187
- - name: exceptions
188
- - name: uwsgi.harakiris
189
- description: Harakiris
190
- unit: "harakiris"
191
- chart_type: line
192
- dimensions:
193
- - name: harakiris
194
- - name: uwsgi.respawns
195
- description: Respawns
196
- unit: "respawns"
197
- chart_type: line
198
- dimensions:
199
- - name: respawns
52
+ There are 2 sections:
53
+
54
+ * Global variables
55
+ * One or more JOBS that can define multiple different instances to monitor.
56
+
57
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
58
+
59
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
60
+
61
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
62
+ folding:
63
+ title: "Config options"
64
+ enabled: true
65
+ list:
66
+ - name: update_every
67
+ description: Sets the default data collection frequency.
68
+ default_value: 5
69
+ required: false
70
+ - name: priority
71
+ description: Controls the order of charts at the netdata dashboard.
72
+ default_value: 60000
73
+ required: false
74
+ - name: autodetection_retry
75
+ description: Sets the job re-check interval in seconds.
76
+ default_value: 0
77
+ required: false
78
+ - name: penalty
79
+ description: Indicates whether to apply penalty to update_every in case of failures.
80
+ default_value: yes
81
+ required: false
82
+ - name: name
83
+ description: The JOB's name as it will appear at the dashboard (by default is the job_name)
84
+ default_value: job_name
85
+ required: false
86
+ - name: socket
87
+ description: The 'path/to/uwsgistats.sock'
88
+ default_value: no
89
+ required: false
90
+ - name: host
91
+ description: The host to connect to
92
+ default_value: no
93
+ required: false
94
+ - name: port
95
+ description: The port to connect to
96
+ default_value: no
97
+ required: false
98
+ examples:
99
+ folding:
100
+ enabled: true
101
+ title: "Config"
102
+ list:
103
+ - name: Basic (default out-of-the-box)
104
+ description: A basic example configuration, one job will run at a time. Autodetect mechanism uses it by default. As all JOBs have the same name, only one can run at a time.
105
+ config: |
106
+ socket:
107
+ name : 'local'
108
+ socket : '/tmp/stats.socket'
109
+
110
+ localhost:
111
+ name : 'local'
112
+ host : 'localhost'
113
+ port : 1717
114
+
115
+ localipv4:
116
+ name : 'local'
117
+ host : '127.0.0.1'
118
+ port : 1717
119
+
120
+ localipv6:
121
+ name : 'local'
122
+ host : '::1'
123
+ port : 1717
124
+ - name: Multi-instance
125
+ description: |
126
+ > **Note**: When you define multiple jobs, their names must be unique.
127
+
128
+ Collecting metrics from local and remote instances.
129
+ config: |
130
+ local:
131
+ name : 'local'
132
+ host : 'localhost'
133
+ port : 1717
134
+
135
+ remote:
136
+ name : 'remote'
137
+ host : '192.0.2.1'
138
+ port : 1717
139
+ troubleshooting:
140
+ problems:
141
+ list: []
142
+ alerts: []
143
+ metrics:
144
+ folding:
145
+ title: Metrics
146
+ enabled: false
147
+ description: ""
148
+ availability: []
149
+ scopes:
150
+ - name: global
151
+ description: "These metrics refer to the entire monitored application."
152
+ labels: []
153
+ metrics:
154
+ - name: uwsgi.requests
155
+ description: Requests
156
+ unit: "requests/s"
157
+ chart_type: stacked
158
+ dimensions:
159
+ - name: a dimension per worker
160
+ - name: uwsgi.tx
161
+ description: Transmitted data
162
+ unit: "KiB/s"
163
+ chart_type: stacked
164
+ dimensions:
165
+ - name: a dimension per worker
166
+ - name: uwsgi.avg_rt
167
+ description: Average request time
168
+ unit: "milliseconds"
169
+ chart_type: line
170
+ dimensions:
171
+ - name: a dimension per worker
172
+ - name: uwsgi.memory_rss
173
+ description: RSS (Resident Set Size)
174
+ unit: "MiB"
175
+ chart_type: stacked
176
+ dimensions:
177
+ - name: a dimension per worker
178
+ - name: uwsgi.memory_vsz
179
+ description: VSZ (Virtual Memory Size)
180
+ unit: "MiB"
181
+ chart_type: stacked
182
+ dimensions:
183
+ - name: a dimension per worker
184
+ - name: uwsgi.exceptions
185
+ description: Exceptions
186
+ unit: "exceptions"
187
+ chart_type: line
188
+ dimensions:
189
+ - name: exceptions
190
+ - name: uwsgi.harakiris
191
+ description: Harakiris
192
+ unit: "harakiris"
193
+ chart_type: line
194
+ dimensions:
195
+ - name: harakiris
196
+ - name: uwsgi.respawns
197
+ description: Respawns
198
+ unit: "respawns"
199
+ chart_type: line
200
+ dimensions:
201
+ - name: respawns
collectors/python.d.plugin/varnish/metadata.yaml
+250
-250
@@ -1,253 +1,253 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: varnish
6
- monitored_instance:
7
- name: Varnish
8
- link: https://varnish-cache.org/
9
- categories:
10
- - data-collection.web-servers-and-web-proxies
11
- icon_filename: 'varnish.svg'
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ''
17
- keywords:
18
- - varnish
19
- - varnishstat
20
- - varnishd
21
- - cache
22
- - web server
23
- - web cache
24
- most_popular: false
25
-overview:
26
- data_collection:
27
- metrics_description: |
28
- This collector monitors Varnish metrics about HTTP accelerator global, Backends (VBE) and Storages (SMF, SMA, MSE) statistics.
29
-
30
- Note that both, Varnish-Cache (free and open source) and Varnish-Plus (Commercial/Enterprise version), are supported.
31
- method_description: |
32
- It uses the `varnishstat` tool in order to collect the metrics.
33
- supported_platforms:
34
- include: []
35
- exclude: []
36
- multi_instance: false
37
- additional_permissions:
38
- description: |
39
- `netdata` user must be a member of the `varnish` group.
40
- default_behavior:
41
- auto_detection:
42
- description: By default, if the permissions are satisfied, the `varnishstat` tool will be executed on the host.
43
- limits:
44
- description: ''
45
- performance_impact:
46
- description: ''
47
-setup:
48
- prerequisites:
49
- list:
50
- - title: Provide the necessary permissions
51
- description: |
52
- In order for the collector to work, you need to add the `netdata` user to the `varnish` user group, so that it can execute the `varnishstat` tool:
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: varnish
6
+ monitored_instance:
7
+ name: Varnish
8
+ link: https://varnish-cache.org/
9
+ categories:
10
+ - data-collection.web-servers-and-web-proxies
11
+ icon_filename: 'varnish.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ''
17
+ keywords:
18
+ - varnish
19
+ - varnishstat
20
+ - varnishd
21
+ - cache
22
+ - web server
23
+ - web cache
24
+ most_popular: false
25
+ overview:
26
+ data_collection:
27
+ metrics_description: |
28
+ This collector monitors Varnish metrics about HTTP accelerator global, Backends (VBE) and Storages (SMF, SMA, MSE) statistics.
29
54
- ```
55
- usermod -aG varnish netdata
56
- ```
57
- configuration:
58
- file:
59
- name: python.d/varnish.conf
60
- description: ''
61
- options:
62
- description: |
63
- There are 2 sections:
64
-
65
- * Global variables
66
- * One or more JOBS that can define multiple different instances to monitor.
67
-
68
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
69
-
70
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
71
-
72
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
73
- folding:
74
- title: Config options
75
- enabled: true
76
- list:
77
- - name: instance_name
78
- description: the name of the varnishd instance to get logs from. If not specified, the host name is used.
79
- default_value: '<host name>'
80
- required: true
81
- - name: update_every
82
- description: Sets the default data collection frequency.
83
- default_value: 10
84
- required: false
85
- - name: priority
86
- description: Controls the order of charts at the netdata dashboard.
87
- default_value: 60000
88
- required: false
89
- - name: autodetection_retry
90
- description: Sets the job re-check interval in seconds.
91
- default_value: 0
92
- required: false
93
- - name: penalty
94
- description: Indicates whether to apply penalty to update_every in case of failures.
95
- default_value: yes
96
- required: false
97
- - name: name
98
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
99
- default_value: ''
100
- required: false
101
- examples:
102
- folding:
103
- enabled: true
104
- title: 'Config'
105
- list:
106
- - name: Basic
107
- description: An example configuration.
30
+ Note that both, Varnish-Cache (free and open source) and Varnish-Plus (Commercial/Enterprise version), are supported.
31
+ method_description: |
32
+ It uses the `varnishstat` tool in order to collect the metrics.
33
+ supported_platforms:
34
+ include: []
35
+ exclude: []
36
+ multi_instance: false
37
+ additional_permissions:
38
+ description: |
39
+ `netdata` user must be a member of the `varnish` group.
40
+ default_behavior:
41
+ auto_detection:
42
+ description: By default, if the permissions are satisfied, the `varnishstat` tool will be executed on the host.
43
+ limits:
44
+ description: ''
45
+ performance_impact:
46
+ description: ''
47
+ setup:
48
+ prerequisites:
49
+ list:
50
+ - title: Provide the necessary permissions
51
+ description: |
52
+ In order for the collector to work, you need to add the `netdata` user to the `varnish` user group, so that it can execute the `varnishstat` tool:
53
+
54
+ ```
55
+ usermod -aG varnish netdata
56
+ ```
57
+ configuration:
58
+ file:
59
+ name: python.d/varnish.conf
60
+ description: ''
61
+ options:
62
+ description: |
63
+ There are 2 sections:
64
+
65
+ * Global variables
66
+ * One or more JOBS that can define multiple different instances to monitor.
67
+
68
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
69
+
70
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
71
+
72
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
73
folding:
109
- enabled: false
110
- config: |
111
- job_name:
112
- instance_name: '<name-of-varnishd-instance>'
113
-troubleshooting:
114
- problems:
115
- list: []
116
-alerts: []
117
-metrics:
118
- folding:
119
- title: Metrics
120
- enabled: false
121
- description: ""
122
- availability: []
123
- scopes:
124
- - name: global
125
- description: "These metrics refer to the entire monitored application."
126
- labels: []
127
- metrics:
128
- - name: varnish.session_connection
129
- description: Connections Statistics
130
- unit: "connections/s"
131
- chart_type: line
132
- dimensions:
133
- - name: accepted
134
- - name: dropped
135
- - name: varnish.client_requests
136
- description: Client Requests
137
- unit: "requests/s"
138
- chart_type: line
139
- dimensions:
140
- - name: received
141
- - name: varnish.all_time_hit_rate
142
- description: All History Hit Rate Ratio
143
- unit: "percentage"
144
- chart_type: stacked
145
- dimensions:
146
- - name: hit
147
- - name: miss
148
- - name: hitpass
149
- - name: varnish.current_poll_hit_rate
150
- description: Current Poll Hit Rate Ratio
151
- unit: "percentage"
152
- chart_type: stacked
153
- dimensions:
154
- - name: hit
155
- - name: miss
156
- - name: hitpass
157
- - name: varnish.cached_objects_expired
158
- description: Expired Objects
159
- unit: "expired/s"
160
- chart_type: line
161
- dimensions:
162
- - name: objects
163
- - name: varnish.cached_objects_nuked
164
- description: Least Recently Used Nuked Objects
165
- unit: "nuked/s"
166
- chart_type: line
167
- dimensions:
168
- - name: objects
169
- - name: varnish.threads_total
170
- description: Number Of Threads In All Pools
171
- unit: "number"
172
- chart_type: line
173
- dimensions:
174
- - name: None
175
- - name: varnish.threads_statistics
176
- description: Threads Statistics
177
- unit: "threads/s"
178
- chart_type: line
179
- dimensions:
180
- - name: created
181
- - name: failed
182
- - name: limited
183
- - name: varnish.threads_queue_len
184
- description: Current Queue Length
185
- unit: "requests"
186
- chart_type: line
187
- dimensions:
188
- - name: in queue
189
- - name: varnish.backend_connections
190
- description: Backend Connections Statistics
191
- unit: "connections/s"
192
- chart_type: line
193
- dimensions:
194
- - name: successful
195
- - name: unhealthy
196
- - name: reused
197
- - name: closed
198
- - name: recycled
199
- - name: failed
200
- - name: varnish.backend_requests
201
- description: Requests To The Backend
202
- unit: "requests/s"
203
- chart_type: line
204
- dimensions:
205
- - name: sent
206
- - name: varnish.esi_statistics
207
- description: ESI Statistics
208
- unit: "problems/s"
209
- chart_type: line
210
- dimensions:
211
- - name: errors
212
- - name: warnings
213
- - name: varnish.memory_usage
214
- description: Memory Usage
215
- unit: "MiB"
216
- chart_type: stacked
217
- dimensions:
218
- - name: free
219
- - name: allocated
220
- - name: varnish.uptime
221
- description: Uptime
222
- unit: "seconds"
223
- chart_type: line
224
- dimensions:
225
- - name: uptime
226
- - name: Backend
227
- description: ""
228
- labels: []
229
- metrics:
230
- - name: varnish.backend
231
- description: Backend {backend_name}
232
- unit: "kilobits/s"
233
- chart_type: area
234
- dimensions:
235
- - name: header
236
- - name: body
237
- - name: Storage
238
- description: ""
239
- labels: []
74
+ title: Config options
75
+ enabled: true
76
+ list:
77
+ - name: instance_name
78
+ description: the name of the varnishd instance to get logs from. If not specified, the host name is used.
79
+ default_value: '<host name>'
80
+ required: true
81
+ - name: update_every
82
+ description: Sets the default data collection frequency.
83
+ default_value: 10
84
+ required: false
85
+ - name: priority
86
+ description: Controls the order of charts at the netdata dashboard.
87
+ default_value: 60000
88
+ required: false
89
+ - name: autodetection_retry
90
+ description: Sets the job re-check interval in seconds.
91
+ default_value: 0
92
+ required: false
93
+ - name: penalty
94
+ description: Indicates whether to apply penalty to update_every in case of failures.
95
+ default_value: yes
96
+ required: false
97
+ - name: name
98
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
99
+ default_value: ''
100
+ required: false
101
+ examples:
102
+ folding:
103
+ enabled: true
104
+ title: 'Config'
105
+ list:
106
+ - name: Basic
107
+ description: An example configuration.
108
+ folding:
109
+ enabled: false
110
+ config: |
111
+ job_name:
112
+ instance_name: '<name-of-varnishd-instance>'
113
+ troubleshooting:
114
+ problems:
115
+ list: []
116
+ alerts: []
117
metrics:
241
- - name: varnish.storage_usage
242
- description: Storage {storage_name} Usage
243
- unit: "KiB"
244
- chart_type: stacked
245
- dimensions:
246
- - name: free
247
- - name: allocated
248
- - name: varnish.storage_alloc_objs
249
- description: Storage {storage_name} Allocated Objects
250
- unit: "objects"
251
- chart_type: line
252
- dimensions:
253
- - name: allocated
118
+ folding:
119
+ title: Metrics
120
+ enabled: false
121
+ description: ""
122
+ availability: []
123
+ scopes:
124
+ - name: global
125
+ description: "These metrics refer to the entire monitored application."
126
+ labels: []
127
+ metrics:
128
+ - name: varnish.session_connection
129
+ description: Connections Statistics
130
+ unit: "connections/s"
131
+ chart_type: line
132
+ dimensions:
133
+ - name: accepted
134
+ - name: dropped
135
+ - name: varnish.client_requests
136
+ description: Client Requests
137
+ unit: "requests/s"
138
+ chart_type: line
139
+ dimensions:
140
+ - name: received
141
+ - name: varnish.all_time_hit_rate
142
+ description: All History Hit Rate Ratio
143
+ unit: "percentage"
144
+ chart_type: stacked
145
+ dimensions:
146
+ - name: hit
147
+ - name: miss
148
+ - name: hitpass
149
+ - name: varnish.current_poll_hit_rate
150
+ description: Current Poll Hit Rate Ratio
151
+ unit: "percentage"
152
+ chart_type: stacked
153
+ dimensions:
154
+ - name: hit
155
+ - name: miss
156
+ - name: hitpass
157
+ - name: varnish.cached_objects_expired
158
+ description: Expired Objects
159
+ unit: "expired/s"
160
+ chart_type: line
161
+ dimensions:
162
+ - name: objects
163
+ - name: varnish.cached_objects_nuked
164
+ description: Least Recently Used Nuked Objects
165
+ unit: "nuked/s"
166
+ chart_type: line
167
+ dimensions:
168
+ - name: objects
169
+ - name: varnish.threads_total
170
+ description: Number Of Threads In All Pools
171
+ unit: "number"
172
+ chart_type: line
173
+ dimensions:
174
+ - name: None
175
+ - name: varnish.threads_statistics
176
+ description: Threads Statistics
177
+ unit: "threads/s"
178
+ chart_type: line
179
+ dimensions:
180
+ - name: created
181
+ - name: failed
182
+ - name: limited
183
+ - name: varnish.threads_queue_len
184
+ description: Current Queue Length
185
+ unit: "requests"
186
+ chart_type: line
187
+ dimensions:
188
+ - name: in queue
189
+ - name: varnish.backend_connections
190
+ description: Backend Connections Statistics
191
+ unit: "connections/s"
192
+ chart_type: line
193
+ dimensions:
194
+ - name: successful
195
+ - name: unhealthy
196
+ - name: reused
197
+ - name: closed
198
+ - name: recycled
199
+ - name: failed
200
+ - name: varnish.backend_requests
201
+ description: Requests To The Backend
202
+ unit: "requests/s"
203
+ chart_type: line
204
+ dimensions:
205
+ - name: sent
206
+ - name: varnish.esi_statistics
207
+ description: ESI Statistics
208
+ unit: "problems/s"
209
+ chart_type: line
210
+ dimensions:
211
+ - name: errors
212
+ - name: warnings
213
+ - name: varnish.memory_usage
214
+ description: Memory Usage
215
+ unit: "MiB"
216
+ chart_type: stacked
217
+ dimensions:
218
+ - name: free
219
+ - name: allocated
220
+ - name: varnish.uptime
221
+ description: Uptime
222
+ unit: "seconds"
223
+ chart_type: line
224
+ dimensions:
225
+ - name: uptime
226
+ - name: Backend
227
+ description: ""
228
+ labels: []
229
+ metrics:
230
+ - name: varnish.backend
231
+ description: Backend {backend_name}
232
+ unit: "kilobits/s"
233
+ chart_type: area
234
+ dimensions:
235
+ - name: header
236
+ - name: body
237
+ - name: Storage
238
+ description: ""
239
+ labels: []
240
+ metrics:
241
+ - name: varnish.storage_usage
242
+ description: Storage {storage_name} Usage
243
+ unit: "KiB"
244
+ chart_type: stacked
245
+ dimensions:
246
+ - name: free
247
+ - name: allocated
248
+ - name: varnish.storage_alloc_objs
249
+ description: Storage {storage_name} Allocated Objects
250
+ unit: "objects"
251
+ chart_type: line
252
+ dimensions:
253
+ - name: allocated
collectors/python.d.plugin/w1sensor/metadata.yaml
+117
-116
@@ -1,118 +1,119 @@
1
-# yamllint disable rule:line-length
2
-meta:
3
- plugin_name: python.d.plugin
4
- module_name: w1sensor
5
- monitored_instance:
6
- name: 1-Wire Sensors
7
- link: "https://www.analog.com/en/product-category/1wire-temperature-sensors.html"
8
- categories:
9
- - data-collection.hardware-devices-and-sensors
10
- icon_filename: "1-wire.png"
11
- related_resources:
12
- integrations:
13
- list: []
14
- info_provided_to_referring_integrations:
15
- description: ""
16
- keywords:
17
- - temperature
18
- - sensor
19
- - 1-wire
20
- most_popular: false
21
-overview:
22
- data_collection:
23
- metrics_description: "Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts."
24
- method_description: "The collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected."
25
- supported_platforms:
26
- include:
27
- - Linux
28
- exclude: []
29
- multi_instance: true
30
- additional_permissions:
31
- description: ""
32
- default_behavior:
33
- auto_detection:
34
- description: "The collector will try to auto detect available 1-Wire devices."
35
- limits:
36
- description: ""
37
- performance_impact:
38
- description: ""
39
-setup:
40
- prerequisites:
41
- list:
42
- - title: "Required Linux kernel modules"
43
- description: "Make sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded."
44
- configuration:
45
- file:
46
- name: python.d/w1sensor.conf
47
- options:
48
- description: |
49
- There are 2 sections:
50
-
51
- * Global variables
52
- * One or more JOBS that can define multiple different instances to monitor.
53
-
54
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
55
-
56
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
-
58
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
- folding:
60
- title: "Config options"
61
- enabled: true
62
- list:
63
- - name: update_every
64
- description: Sets the default data collection frequency.
65
- default_value: 5
66
- required: false
67
- - name: priority
68
- description: Controls the order of charts at the netdata dashboard.
69
- default_value: 60000
70
- required: false
71
- - name: autodetection_retry
72
- description: Sets the job re-check interval in seconds.
73
- default_value: 0
74
- required: false
75
- - name: penalty
76
- description: Indicates whether to apply penalty to update_every in case of failures.
77
- default_value: yes
78
- required: false
79
- - name: name
80
- description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
- default_value: ""
82
- required: false
83
- - name: name_<1-Wire id>
84
- description: This allows associating a human readable name with a sensor's 1-Wire identifier.
85
- default_value: ""
86
- required: false
87
- examples:
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: w1sensor
6
+ monitored_instance:
7
+ name: 1-Wire Sensors
8
+ link: "https://www.analog.com/en/product-category/1wire-temperature-sensors.html"
9
+ categories:
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: "1-wire.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - temperature
19
+ - sensor
20
+ - 1-wire
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: "Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts."
25
+ method_description: "The collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected."
26
+ supported_platforms:
27
+ include:
28
+ - Linux
29
+ exclude: []
30
+ multi_instance: true
31
+ additional_permissions:
32
+ description: ""
33
+ default_behavior:
34
+ auto_detection:
35
+ description: "The collector will try to auto detect available 1-Wire devices."
36
+ limits:
37
+ description: ""
38
+ performance_impact:
39
+ description: ""
40
+ setup:
41
+ prerequisites:
42
+ list:
43
+ - title: "Required Linux kernel modules"
44
+ description: "Make sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded."
45
+ configuration:
46
+ file:
47
+ name: python.d/w1sensor.conf
48
+ options:
49
+ description: |
50
+ There are 2 sections:
51
+
52
+ * Global variables
53
+ * One or more JOBS that can define multiple different instances to monitor.
54
+
55
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
56
+
57
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
58
+
59
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
60
+ folding:
61
+ title: "Config options"
62
+ enabled: true
63
+ list:
64
+ - name: update_every
65
+ description: Sets the default data collection frequency.
66
+ default_value: 5
67
+ required: false
68
+ - name: priority
69
+ description: Controls the order of charts at the netdata dashboard.
70
+ default_value: 60000
71
+ required: false
72
+ - name: autodetection_retry
73
+ description: Sets the job re-check interval in seconds.
74
+ default_value: 0
75
+ required: false
76
+ - name: penalty
77
+ description: Indicates whether to apply penalty to update_every in case of failures.
78
+ default_value: yes
79
+ required: false
80
+ - name: name
81
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
82
+ default_value: ""
83
+ required: false
84
+ - name: name_<1-Wire id>
85
+ description: This allows associating a human readable name with a sensor's 1-Wire identifier.
86
+ default_value: ""
87
+ required: false
88
+ examples:
89
+ folding:
90
+ enabled: false
91
+ title: "Config"
92
+ list:
93
+ - name: Provide human readable names
94
+ description: Associate two 1-Wire identifiers with human readable names.
95
+ config: |
96
+ sensors:
97
+ name_00000022276e: 'Machine room'
98
+ name_00000022298f: 'Rack 12'
99
+ troubleshooting:
100
+ problems:
101
+ list: []
102
+ alerts: []
103
+ metrics:
104
folding:
105
+ title: Metrics
106
enabled: false
90
- title: "Config"
91
- list:
92
- - name: Provide human readable names
93
- description: Associate two 1-Wire identifiers with human readable names.
94
- config: |
95
- sensors:
96
- name_00000022276e: 'Machine room'
97
- name_00000022298f: 'Rack 12'
98
-troubleshooting:
99
- problems:
100
- list: []
101
-alerts: []
102
-metrics:
103
- folding:
104
- title: Metrics
105
- enabled: false
106
- description: ""
107
- availability: []
108
- scopes:
109
- - name: global
110
- description: "These metrics refer to the entire monitored application."
111
- labels: []
112
- metrics:
113
- - name: w1sensor.temp
114
- description: 1-Wire Temperature Sensor
115
- unit: "Celsius"
116
- chart_type: line
117
- dimensions:
118
- - name: a dimension per sensor
107
+ description: ""
108
+ availability: []
109
+ scopes:
110
+ - name: global
111
+ description: "These metrics refer to the entire monitored application."
112
+ labels: []
113
+ metrics:
114
+ - name: w1sensor.temp
115
+ description: 1-Wire Temperature Sensor
116
+ unit: "Celsius"
117
+ chart_type: line
118
+ dimensions:
119
+ - name: a dimension per sensor
collectors/python.d.plugin/zscores/metadata.yaml
+186
-186
@@ -1,187 +1,187 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: python.d.plugin
5
- module_name: zscores
6
- monitored_instance:
7
- name: python.d zscores
8
- link: https://en.wikipedia.org/wiki/Standard_score
9
- categories:
10
- - data-collection.other
11
- icon_filename: ""
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - zscore
19
- - z-score
20
- - standard score
21
- - standard deviation
22
- - anomaly detection
23
- - statistical anomaly detection
24
- most_popular: false
25
-overview:
26
- data_collection:
27
- metrics_description: |
28
- By using smoothed, rolling [Z-Scores](https://en.wikipedia.org/wiki/Standard_score) for selected metrics or charts you can narrow down your focus and shorten root cause analysis.
29
- method_description: |
30
- This collector uses the [Netdata rest api](https://github.com/netdata/netdata/blob/master/web/api/README.md) to get the `mean` and `stddev`
31
- for each dimension on specified charts over a time range (defined by `train_secs` and `offset_secs`).
32
-
33
- For each dimension it will calculate a Z-Score as `z = (x - mean) / stddev` (clipped at `z_clip`). Scores are then smoothed over
34
- time (`z_smooth_n`) and, if `mode: 'per_chart'`, aggregated across dimensions to a smoothed, rolling chart level Z-Score at each time step.
35
- supported_platforms:
36
- include: []
37
- exclude: []
38
- multi_instance: true
39
- additional_permissions:
40
- description: ""
41
- default_behavior:
42
- auto_detection:
43
- description: ""
44
- limits:
45
- description: ""
46
- performance_impact:
47
- description: ""
48
-setup:
49
- prerequisites:
50
- list:
51
- - title: Python Requirements
52
- description: |
53
- This collector will only work with Python 3 and requires the below packages be installed.
54
-
55
- ```bash
56
- # become netdata user
57
- sudo su -s /bin/bash netdata
58
- # install required packages
59
- pip3 install numpy pandas requests netdata-pandas==0.0.38
60
- ```
61
- configuration:
62
- file:
63
- name: python.d/zscores.conf
64
- description: ""
65
- options:
66
- description: |
67
- There are 2 sections:
68
-
69
- * Global variables
70
- * One or more JOBS that can define multiple different instances to monitor.
71
-
72
- The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
73
-
74
- Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
75
-
76
- Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
77
- folding:
78
- title: "Config options"
79
- enabled: true
80
- list:
81
- - name: charts_regex
82
- description: what charts to pull data for - A regex like `system\..*|` or `system\..*|apps.cpu|apps.mem` etc.
83
- default_value: "system\\..*"
84
- required: true
85
- - name: train_secs
86
- description: length of time (in seconds) to base calculations off for mean and stddev.
87
- default_value: 14400
88
- required: true
89
- - name: offset_secs
90
- description: offset (in seconds) preceding latest data to ignore when calculating mean and stddev.
91
- default_value: 300
92
- required: true
93
- - name: train_every_n
94
- description: recalculate the mean and stddev every n steps of the collector.
95
- default_value: 900
96
- required: true
97
- - name: z_smooth_n
98
- description: smooth the z score (to reduce sensitivity to spikes) by averaging it over last n values.
99
- default_value: 15
100
- required: true
101
- - name: z_clip
102
- description: cap absolute value of zscore (before smoothing) for better stability.
103
- default_value: 10
104
- required: true
105
- - name: z_abs
106
- description: "set z_abs: 'true' to make all zscores be absolute values only."
107
- default_value: "true"
108
- required: true
109
- - name: burn_in
110
- description: burn in period in which to initially calculate mean and stddev on every step.
111
- default_value: 2
112
- required: true
113
- - name: mode
114
- description: mode can be to get a zscore 'per_dim' or 'per_chart'.
115
- default_value: per_chart
116
- required: true
117
- - name: per_chart_agg
118
- description: per_chart_agg is how you aggregate from dimension to chart when mode='per_chart'.
119
- default_value: mean
120
- required: true
121
- - name: update_every
122
- description: Sets the default data collection frequency.
123
- default_value: 5
124
- required: false
125
- - name: priority
126
- description: Controls the order of charts at the netdata dashboard.
127
- default_value: 60000
128
- required: false
129
- - name: autodetection_retry
130
- description: Sets the job re-check interval in seconds.
131
- default_value: 0
132
- required: false
133
- - name: penalty
134
- description: Indicates whether to apply penalty to update_every in case of failures.
135
- default_value: yes
136
- required: false
137
- examples:
138
- folding:
139
- enabled: true
140
- title: "Config"
141
- list:
142
- - name: Default
143
- description: Default configuration.
1
+plugin_name: python.d.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: python.d.plugin
5
+ module_name: zscores
6
+ monitored_instance:
7
+ name: python.d zscores
8
+ link: https://en.wikipedia.org/wiki/Standard_score
9
+ categories:
10
+ - data-collection.other
11
+ icon_filename: ""
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - zscore
19
+ - z-score
20
+ - standard score
21
+ - standard deviation
22
+ - anomaly detection
23
+ - statistical anomaly detection
24
+ most_popular: false
25
+ overview:
26
+ data_collection:
27
+ metrics_description: |
28
+ By using smoothed, rolling [Z-Scores](https://en.wikipedia.org/wiki/Standard_score) for selected metrics or charts you can narrow down your focus and shorten root cause analysis.
29
+ method_description: |
30
+ This collector uses the [Netdata rest api](https://github.com/netdata/netdata/blob/master/web/api/README.md) to get the `mean` and `stddev`
31
+ for each dimension on specified charts over a time range (defined by `train_secs` and `offset_secs`).
32
+
33
+ For each dimension it will calculate a Z-Score as `z = (x - mean) / stddev` (clipped at `z_clip`). Scores are then smoothed over
34
+ time (`z_smooth_n`) and, if `mode: 'per_chart'`, aggregated across dimensions to a smoothed, rolling chart level Z-Score at each time step.
35
+ supported_platforms:
36
+ include: []
37
+ exclude: []
38
+ multi_instance: true
39
+ additional_permissions:
40
+ description: ""
41
+ default_behavior:
42
+ auto_detection:
43
+ description: ""
44
+ limits:
45
+ description: ""
46
+ performance_impact:
47
+ description: ""
48
+ setup:
49
+ prerequisites:
50
+ list:
51
+ - title: Python Requirements
52
+ description: |
53
+ This collector will only work with Python 3 and requires the below packages be installed.
54
+
55
+ ```bash
56
+ # become netdata user
57
+ sudo su -s /bin/bash netdata
58
+ # install required packages
59
+ pip3 install numpy pandas requests netdata-pandas==0.0.38
60
+ ```
61
+ configuration:
62
+ file:
63
+ name: python.d/zscores.conf
64
+ description: ""
65
+ options:
66
+ description: |
67
+ There are 2 sections:
68
+
69
+ * Global variables
70
+ * One or more JOBS that can define multiple different instances to monitor.
71
+
72
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
73
+
74
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
75
+
76
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
77
+ folding:
78
+ title: "Config options"
79
+ enabled: true
80
+ list:
81
+ - name: charts_regex
82
+ description: what charts to pull data for - A regex like `system\..*|` or `system\..*|apps.cpu|apps.mem` etc.
83
+ default_value: "system\\..*"
84
+ required: true
85
+ - name: train_secs
86
+ description: length of time (in seconds) to base calculations off for mean and stddev.
87
+ default_value: 14400
88
+ required: true
89
+ - name: offset_secs
90
+ description: offset (in seconds) preceding latest data to ignore when calculating mean and stddev.
91
+ default_value: 300
92
+ required: true
93
+ - name: train_every_n
94
+ description: recalculate the mean and stddev every n steps of the collector.
95
+ default_value: 900
96
+ required: true
97
+ - name: z_smooth_n
98
+ description: smooth the z score (to reduce sensitivity to spikes) by averaging it over last n values.
99
+ default_value: 15
100
+ required: true
101
+ - name: z_clip
102
+ description: cap absolute value of zscore (before smoothing) for better stability.
103
+ default_value: 10
104
+ required: true
105
+ - name: z_abs
106
+ description: "set z_abs: 'true' to make all zscores be absolute values only."
107
+ default_value: "true"
108
+ required: true
109
+ - name: burn_in
110
+ description: burn in period in which to initially calculate mean and stddev on every step.
111
+ default_value: 2
112
+ required: true
113
+ - name: mode
114
+ description: mode can be to get a zscore 'per_dim' or 'per_chart'.
115
+ default_value: per_chart
116
+ required: true
117
+ - name: per_chart_agg
118
+ description: per_chart_agg is how you aggregate from dimension to chart when mode='per_chart'.
119
+ default_value: mean
120
+ required: true
121
+ - name: update_every
122
+ description: Sets the default data collection frequency.
123
+ default_value: 5
124
+ required: false
125
+ - name: priority
126
+ description: Controls the order of charts at the netdata dashboard.
127
+ default_value: 60000
128
+ required: false
129
+ - name: autodetection_retry
130
+ description: Sets the job re-check interval in seconds.
131
+ default_value: 0
132
+ required: false
133
+ - name: penalty
134
+ description: Indicates whether to apply penalty to update_every in case of failures.
135
+ default_value: yes
136
+ required: false
137
+ examples:
138
folding:
145
- enabled: false
146
- config: |
147
- local:
148
- name: 'local'
149
- host: '127.0.0.1:19999'
150
- charts_regex: 'system\..*'
151
- charts_to_exclude: 'system.uptime'
152
- train_secs: 14400
153
- offset_secs: 300
154
- train_every_n: 900
155
- z_smooth_n: 15
156
- z_clip: 10
157
- z_abs: 'true'
158
- burn_in: 2
159
- mode: 'per_chart'
160
- per_chart_agg: 'mean'
161
-troubleshooting:
162
- problems:
163
- list: []
164
-alerts: []
165
-metrics:
166
- folding:
167
- title: Metrics
168
- enabled: false
169
- description: ""
170
- availability: []
171
- scopes:
172
- - name: global
173
- description: "These metrics refer to the entire monitored application."
174
- labels: []
175
- metrics:
176
- - name: zscores.z
177
- description: Z Score
178
- unit: "z"
179
- chart_type: line
180
- dimensions:
181
- - name: a dimension per chart or dimension
182
- - name: zscores.3stddev
183
- description: Z Score >3
184
- unit: "count"
185
- chart_type: stacked
186
- dimensions:
187
- - name: a dimension per chart or dimension
139
+ enabled: true
140
+ title: "Config"
141
+ list:
142
+ - name: Default
143
+ description: Default configuration.
144
+ folding:
145
+ enabled: false
146
+ config: |
147
+ local:
148
+ name: 'local'
149
+ host: '127.0.0.1:19999'
150
+ charts_regex: 'system\..*'
151
+ charts_to_exclude: 'system.uptime'
152
+ train_secs: 14400
153
+ offset_secs: 300
154
+ train_every_n: 900
155
+ z_smooth_n: 15
156
+ z_clip: 10
157
+ z_abs: 'true'
158
+ burn_in: 2
159
+ mode: 'per_chart'
160
+ per_chart_agg: 'mean'
161
+ troubleshooting:
162
+ problems:
163
+ list: []
164
+ alerts: []
165
+ metrics:
166
+ folding:
167
+ title: Metrics
168
+ enabled: false
169
+ description: ""
170
+ availability: []
171
+ scopes:
172
+ - name: global
173
+ description: "These metrics refer to the entire monitored application."
174
+ labels: []
175
+ metrics:
176
+ - name: zscores.z
177
+ description: Z Score
178
+ unit: "z"
179
+ chart_type: line
180
+ dimensions:
181
+ - name: a dimension per chart or dimension
182
+ - name: zscores.3stddev
183
+ description: Z Score >3
184
+ unit: "count"
185
+ chart_type: stacked
186
+ dimensions:
187
+ - name: a dimension per chart or dimension
collectors/slabinfo.plugin/metadata.yaml
+105
-103
@@ -1,104 +1,106 @@
1
-meta:
2
- plugin_name: slabinfo.plugin
3
- module_name: slabinfo.plugin
4
- monitored_instance:
5
- name: Linux kernel SLAB allocator statistics
6
- link: "https://kernel.org/"
7
- categories:
8
- - data-collection.linux-systems.kernel-metrics
9
- icon_filename: 'linuxserver.svg'
10
- related_resources:
11
- integrations:
12
- list: []
13
- info_provided_to_referring_integrations:
14
- description: ""
15
- keywords:
16
- - linux kernel
17
- - slab
18
- - slub
19
- - slob
20
- - slabinfo
21
- most_popular: false
22
-overview:
23
- data_collection:
24
- metrics_description: >
25
- Collects metrics on kernel SLAB cache utilization to monitor the low-level performance impact of workloads
26
- in the kernel.
27
- method_description: "The plugin parses `/proc/slabinfo`"
28
- supported_platforms:
29
- include:
30
- - Linux
31
- exclude: []
32
- multi_instance: false
33
- additional_permissions:
34
- description: >
35
- This integration requires read access to `/proc/slabinfo`, which is accessible only to the root user by
36
- default. Netdata uses Linux Capabilities to give the plugin access to this file. `CAP_DAC_READ_SEARCH`
37
- is added automatically during installation. This capability allows bypassing file read permission checks
38
- and directory read and execute permission checks. If file capabilities are not usable, then the plugin is
39
- instead installed with the SUID bit set in permissions sVko that it runs as root.
40
- default_behavior:
41
- auto_detection:
42
- description: >
43
- Due to the large number of metrics generated by this integration, it is disabled by default and must be
44
- manually enabled inside `/etc/netdata/netdata.conf`
45
- limits:
46
- description: ""
47
- performance_impact:
48
- description: ""
49
-setup:
50
- prerequisites:
51
- list: []
52
- configuration:
53
- file:
54
- name: "netdata.conf"
55
- section_name: "[plugins]"
56
- description: "The main configuration file."
57
- options:
58
- description: ""
1
+plugin_name: slabinfo.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: slabinfo.plugin
5
+ module_name: slabinfo.plugin
6
+ monitored_instance:
7
+ name: Linux kernel SLAB allocator statistics
8
+ link: "https://kernel.org/"
9
+ categories:
10
+ - data-collection.linux-systems.kernel-metrics
11
+ icon_filename: 'linuxserver.svg'
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - linux kernel
19
+ - slab
20
+ - slub
21
+ - slob
22
+ - slabinfo
23
+ most_popular: false
24
+ overview:
25
+ data_collection:
26
+ metrics_description: >
27
+ Collects metrics on kernel SLAB cache utilization to monitor the low-level performance impact of workloads
28
+ in the kernel.
29
+ method_description: "The plugin parses `/proc/slabinfo`"
30
+ supported_platforms:
31
+ include:
32
+ - Linux
33
+ exclude: []
34
+ multi_instance: false
35
+ additional_permissions:
36
+ description: >
37
+ This integration requires read access to `/proc/slabinfo`, which is accessible only to the root user by
38
+ default. Netdata uses Linux Capabilities to give the plugin access to this file. `CAP_DAC_READ_SEARCH`
39
+ is added automatically during installation. This capability allows bypassing file read permission checks
40
+ and directory read and execute permission checks. If file capabilities are not usable, then the plugin is
41
+ instead installed with the SUID bit set in permissions sVko that it runs as root.
42
+ default_behavior:
43
+ auto_detection:
44
+ description: >
45
+ Due to the large number of metrics generated by this integration, it is disabled by default and must be
46
+ manually enabled inside `/etc/netdata/netdata.conf`
47
+ limits:
48
+ description: ""
49
+ performance_impact:
50
+ description: ""
51
+ setup:
52
+ prerequisites:
53
+ list: []
54
+ configuration:
55
+ file:
56
+ name: "netdata.conf"
57
+ section_name: "[plugins]"
58
+ description: "The main configuration file."
59
+ options:
60
+ description: ""
61
+ folding:
62
+ title: "The main configuration file."
63
+ enabled: true
64
+ list:
65
+ - name: Enable plugin
66
+ description: As described above plugin is disabled by default, this option is used to enable plugin.
67
+ default_value: no
68
+ required: true
69
+ examples:
70
+ folding:
71
+ enabled: true
72
+ title: ""
73
+ list: []
74
+ troubleshooting:
75
+ problems:
76
+ list: []
77
+ alerts: []
78
+ metrics:
79
folding:
60
- title: "The main configuration file."
61
- enabled: true
62
- list:
63
- - name: Enable plugin
64
- description: As described above plugin is disabled by default, this option is used to enable plugin.
65
- default_value: no
66
- required: true
67
- examples:
68
- folding:
69
- enabled: true
70
- title: ""
71
- list: []
72
-troubleshooting:
73
- problems:
74
- list: []
75
-alerts: []
76
-metrics:
77
- folding:
78
- title: Metrics
79
- enabled: false
80
- description: "SLAB cache utilization metrics for the whole system."
81
- availability: []
82
- scopes:
83
- - name: global
84
- description: ""
85
- labels: []
86
- metrics:
87
- - name: mem.slabmemory
88
- description: Memory Usage
89
- unit: "B"
90
- chart_type: line
91
- dimensions:
92
- - name: a dimension per cache
93
- - name: mem.slabfilling
94
- description: Object Filling
95
- unit: "%"
96
- chart_type: line
97
- dimensions:
98
- - name: a dimension per cache
99
- - name: mem.slabwaste
100
- description: Memory waste
101
- unit: "B"
102
- chart_type: line
103
- dimensions:
104
- - name: a dimension per cache
80
+ title: Metrics
81
+ enabled: false
82
+ description: "SLAB cache utilization metrics for the whole system."
83
+ availability: []
84
+ scopes:
85
+ - name: global
86
+ description: ""
87
+ labels: []
88
+ metrics:
89
+ - name: mem.slabmemory
90
+ description: Memory Usage
91
+ unit: "B"
92
+ chart_type: line
93
+ dimensions:
94
+ - name: a dimension per cache
95
+ - name: mem.slabfilling
96
+ description: Object Filling
97
+ unit: "%"
98
+ chart_type: line
99
+ dimensions:
100
+ - name: a dimension per cache
101
+ - name: mem.slabwaste
102
+ description: Memory waste
103
+ unit: "B"
104
+ chart_type: line
105
+ dimensions:
106
+ - name: a dimension per cache
collectors/tc.plugin/metadata.yaml
+113
-113
@@ -1,115 +1,115 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: tc.plugin
5
- module_name: tc.plugin
6
- monitored_instance:
7
- name: tc QoS classes
8
- link: "https://wiki.linuxfoundation.org/networking/iproute2"
9
- categories:
10
- - data-collection.networking-stack-and-network-interfaces
11
- icon_filename: "netdata.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords: []
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: "Examine tc metrics to gain insights into Linux traffic control operations. Study packet flow rates, queue lengths, and drop rates to optimize network traffic flow."
22
- method_description: "The plugin uses `tc` command to collect information about Traffic control."
23
- supported_platforms:
24
- include:
25
- - Linux
26
- exclude: []
27
- multi_instance: true
28
- additional_permissions:
29
- description: "The plugin needs to access command `tc` to get the necessary metrics. To achieve this netdata modifies permission of file `/usr/libexec/netdata/plugins.d/tc-qos-helper.sh`."
30
- default_behavior:
31
- auto_detection:
32
- description: ""
33
- limits:
34
- description: ""
35
- performance_impact:
36
- description: ""
37
-setup:
38
- prerequisites:
39
- list: []
40
- configuration:
41
- file:
42
- name: "netdata.conf"
43
- section_name: "[plugin:tc]"
44
- description: "The main configuration file."
45
- options:
46
- description: ""
47
- folding:
48
- title: "Config option"
49
- enabled: true
50
- list:
51
- - name: script to run to get tc values
52
- description: Path to script `tc-qos-helper.sh`
53
- default_value: "usr/libexec/netdata/plugins.d/tc-qos-helper.s"
54
- required: false
55
- examples:
1
+plugin_name: tc.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: tc.plugin
5
+ module_name: tc.plugin
6
+ monitored_instance:
7
+ name: tc QoS classes
8
+ link: "https://wiki.linuxfoundation.org/networking/iproute2"
9
+ categories:
10
+ - data-collection.networking-stack-and-network-interfaces
11
+ icon_filename: "netdata.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords: []
18
+ most_popular: false
19
+ overview:
20
+ data_collection:
21
+ metrics_description: "Examine tc metrics to gain insights into Linux traffic control operations. Study packet flow rates, queue lengths, and drop rates to optimize network traffic flow."
22
+ method_description: "The plugin uses `tc` command to collect information about Traffic control."
23
+ supported_platforms:
24
+ include:
25
+ - Linux
26
+ exclude: []
27
+ multi_instance: true
28
+ additional_permissions:
29
+ description: "The plugin needs to access command `tc` to get the necessary metrics. To achieve this netdata modifies permission of file `/usr/libexec/netdata/plugins.d/tc-qos-helper.sh`."
30
+ default_behavior:
31
+ auto_detection:
32
+ description: ""
33
+ limits:
34
+ description: ""
35
+ performance_impact:
36
+ description: ""
37
+ setup:
38
+ prerequisites:
39
+ list: []
40
+ configuration:
41
+ file:
42
+ name: "netdata.conf"
43
+ section_name: "[plugin:tc]"
44
+ description: "The main configuration file."
45
+ options:
46
+ description: ""
47
+ folding:
48
+ title: "Config option"
49
+ enabled: true
50
+ list:
51
+ - name: script to run to get tc values
52
+ description: Path to script `tc-qos-helper.sh`
53
+ default_value: "usr/libexec/netdata/plugins.d/tc-qos-helper.s"
54
+ required: false
55
+ examples:
56
+ folding:
57
+ enabled: false
58
+ title: "Config"
59
+ list:
60
+ - name: Basic
61
+ description: A basic example configuration.
62
+ config: |
63
+ [plugin:tc]
64
+ script to run to get tc values = /usr/libexec/netdata/plugins.d/tc-qos-helper.sh
65
+ troubleshooting:
66
+ problems:
67
+ list: []
68
+ alerts: []
69
+ metrics:
70
folding:
71
+ title: Metrics
72
enabled: false
58
- title: "Config"
59
- list:
60
- - name: Basic
61
- description: A basic example configuration.
62
- config: |
63
- [plugin:tc]
64
- script to run to get tc values = /usr/libexec/netdata/plugins.d/tc-qos-helper.sh
65
-troubleshooting:
66
- problems:
67
- list: []
68
-alerts: []
69
-metrics:
70
- folding:
71
- title: Metrics
72
- enabled: false
73
- description: ""
74
- availability: []
75
- scopes:
76
- - name: network device direction
77
- description: "Metrics related to QoS network device directions. Each direction (in/out) produces its own set of the following metrics."
78
- labels:
79
- - name: device
80
- description: The network interface.
81
- - name: device_name
82
- description: The network interface name
83
- - name: group
84
- description: The device family
85
- metrics:
86
- - name: tc.qos
87
- description: Class Usage
88
- unit: "kilobits/s"
89
- chart_type: stacked
90
- dimensions:
91
- - name: a dimension per class
92
- - name: tc.qos_packets
93
- description: Class Packets
94
- unit: "packets/s"
95
- chart_type: stacked
96
- dimensions:
97
- - name: a dimension per class
98
- - name: tc.qos_dropped
99
- description: Class Dropped Packets
100
- unit: "packets/s"
101
- chart_type: stacked
102
- dimensions:
103
- - name: a dimension per class
104
- - name: tc.qos_tokens
105
- description: Class Tokens
106
- unit: "tokens"
107
- chart_type: line
108
- dimensions:
109
- - name: a dimension per class
110
- - name: tc.qos_ctokens
111
- description: Class cTokens
112
- unit: "ctokens"
113
- chart_type: line
114
- dimensions:
115
- - name: a dimension per class
73
+ description: ""
74
+ availability: []
75
+ scopes:
76
+ - name: network device direction
77
+ description: "Metrics related to QoS network device directions. Each direction (in/out) produces its own set of the following metrics."
78
+ labels:
79
+ - name: device
80
+ description: The network interface.
81
+ - name: device_name
82
+ description: The network interface name
83
+ - name: group
84
+ description: The device family
85
+ metrics:
86
+ - name: tc.qos
87
+ description: Class Usage
88
+ unit: "kilobits/s"
89
+ chart_type: stacked
90
+ dimensions:
91
+ - name: a dimension per class
92
+ - name: tc.qos_packets
93
+ description: Class Packets
94
+ unit: "packets/s"
95
+ chart_type: stacked
96
+ dimensions:
97
+ - name: a dimension per class
98
+ - name: tc.qos_dropped
99
+ description: Class Dropped Packets
100
+ unit: "packets/s"
101
+ chart_type: stacked
102
+ dimensions:
103
+ - name: a dimension per class
104
+ - name: tc.qos_tokens
105
+ description: Class Tokens
106
+ unit: "tokens"
107
+ chart_type: line
108
+ dimensions:
109
+ - name: a dimension per class
110
+ - name: tc.qos_ctokens
111
+ description: Class cTokens
112
+ unit: "ctokens"
113
+ chart_type: line
114
+ dimensions:
115
+ - name: a dimension per class
collectors/timex.plugin/metadata.yaml
+111
-111
@@ -1,112 +1,112 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: timex.plugin
5
- module_name: timex.plugin
6
- monitored_instance:
7
- name: Timex
8
- link: ""
9
- categories:
10
- - data-collection.system-clock-and-ntp
11
- icon_filename: "syslog.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords: []
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: "Examine Timex metrics to gain insights into system clock operations. Study time sync status, clock drift, and adjustments to ensure accurate system timekeeping."
22
- method_description: "It uses system call adjtimex on Linux and ntp_adjtime on FreeBSD or Mac to monitor the system kernel clock synchronization state."
23
- supported_platforms:
24
- include: []
25
- exclude: []
26
- multi_instance: true
27
- additional_permissions:
28
- description: ""
29
- default_behavior:
30
- auto_detection:
31
- description: ""
32
- limits:
33
- description: ""
34
- performance_impact:
35
- description: ""
36
-setup:
37
- prerequisites:
38
- list: []
39
- configuration:
40
- file:
41
- name: "netdata.conf"
42
- section_name: "[plugin:timex]"
43
- description: "The netdata main configuration file."
44
- options:
45
- description: "At least one option ('clock synchronization state', 'time offset') needs to be enabled for this collector to run."
1
+plugin_name: timex.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: timex.plugin
5
+ module_name: timex.plugin
6
+ monitored_instance:
7
+ name: Timex
8
+ link: ""
9
+ categories:
10
+ - data-collection.system-clock-and-ntp
11
+ icon_filename: "syslog.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords: []
18
+ most_popular: false
19
+ overview:
20
+ data_collection:
21
+ metrics_description: "Examine Timex metrics to gain insights into system clock operations. Study time sync status, clock drift, and adjustments to ensure accurate system timekeeping."
22
+ method_description: "It uses system call adjtimex on Linux and ntp_adjtime on FreeBSD or Mac to monitor the system kernel clock synchronization state."
23
+ supported_platforms:
24
+ include: []
25
+ exclude: []
26
+ multi_instance: true
27
+ additional_permissions:
28
+ description: ""
29
+ default_behavior:
30
+ auto_detection:
31
+ description: ""
32
+ limits:
33
+ description: ""
34
+ performance_impact:
35
+ description: ""
36
+ setup:
37
+ prerequisites:
38
+ list: []
39
+ configuration:
40
+ file:
41
+ name: "netdata.conf"
42
+ section_name: "[plugin:timex]"
43
+ description: "The netdata main configuration file."
44
+ options:
45
+ description: "At least one option ('clock synchronization state', 'time offset') needs to be enabled for this collector to run."
46
+ folding:
47
+ title: "Config options"
48
+ enabled: true
49
+ list:
50
+ - name: update every
51
+ description: Data collection frequency.
52
+ default_value: 1
53
+ required: false
54
+ - name: clock synchronization state
55
+ description: Make chart showing system clock synchronization state.
56
+ default_value: yes
57
+ required: true
58
+ - name: time offset
59
+ description: Make chart showing computed time offset between local system and reference clock
60
+ default_value: yes
61
+ required: true
62
+ examples:
63
+ folding:
64
+ enabled: true
65
+ title: "Config"
66
+ list:
67
+ - name: Basic
68
+ description: A basic configuration example.
69
+ config: |
70
+ [plugin:timex]
71
+ update every = 1
72
+ clock synchronization state = yes
73
+ time offset = yes
74
+ troubleshooting:
75
+ problems:
76
+ list: []
77
+ alerts:
78
+ - name: system_clock_sync_state
79
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/timex.conf
80
+ metric: system.clock_sync_state
81
+ info: when set to 0, the system kernel believes the system clock is not properly synchronized to a reliable server
82
+ os: "linux"
83
+ metrics:
84
folding:
47
- title: "Config options"
48
- enabled: true
49
- list:
50
- - name: update every
51
- description: Data collection frequency.
52
- default_value: 1
53
- required: false
54
- - name: clock synchronization state
55
- description: Make chart showing system clock synchronization state.
56
- default_value: yes
57
- required: true
58
- - name: time offset
59
- description: Make chart showing computed time offset between local system and reference clock
60
- default_value: yes
61
- required: true
62
- examples:
63
- folding:
64
- enabled: true
65
- title: "Config"
66
- list:
67
- - name: Basic
68
- description: A basic configuration example.
69
- config: |
70
- [plugin:timex]
71
- update every = 1
72
- clock synchronization state = yes
73
- time offset = yes
74
-troubleshooting:
75
- problems:
76
- list: []
77
-alerts:
78
- - name: system_clock_sync_state
79
- link: https://github.com/netdata/netdata/blob/master/health/health.d/timex.conf
80
- metric: system.clock_sync_state
81
- info: when set to 0, the system kernel believes the system clock is not properly synchronized to a reliable server
82
- os: "linux"
83
-metrics:
84
- folding:
85
- title: Metrics
86
- enabled: false
87
- description: ""
88
- availability: []
89
- scopes:
90
- - name: global
91
- description: "These metrics refer to the entire monitored application."
92
- labels: []
93
- metrics:
94
- - name: system.clock_sync_state
95
- description: System Clock Synchronization State
96
- unit: "state"
97
- chart_type: line
98
- dimensions:
99
- - name: state
100
- - name: system.clock_status
101
- description: System Clock Status
102
- unit: "status"
103
- chart_type: line
104
- dimensions:
105
- - name: unsync
106
- - name: clockerr
107
- - name: system.clock_sync_offset
108
- description: Computed Time Offset Between Local System and Reference Clock
109
- unit: "milliseconds"
110
- chart_type: line
111
- dimensions:
112
- - name: offset
85
+ title: Metrics
86
+ enabled: false
87
+ description: ""
88
+ availability: []
89
+ scopes:
90
+ - name: global
91
+ description: "These metrics refer to the entire monitored application."
92
+ labels: []
93
+ metrics:
94
+ - name: system.clock_sync_state
95
+ description: System Clock Synchronization State
96
+ unit: "state"
97
+ chart_type: line
98
+ dimensions:
99
+ - name: state
100
+ - name: system.clock_status
101
+ description: System Clock Status
102
+ unit: "status"
103
+ chart_type: line
104
+ dimensions:
105
+ - name: unsync
106
+ - name: clockerr
107
+ - name: system.clock_sync_offset
108
+ description: Computed Time Offset Between Local System and Reference Clock
109
+ unit: "milliseconds"
110
+ chart_type: line
111
+ dimensions:
112
+ - name: offset
collectors/xenstat.plugin/metadata.yaml
+194
-194
@@ -1,195 +1,195 @@
1
-# yamllint disable rule:line-length
2
----
3
-meta:
4
- plugin_name: xenstat.plugin
5
- module_name: xenstat.plugin
6
- monitored_instance:
7
- name: Xen/XCP-ng
8
- link: "https://xenproject.org/"
9
- categories:
10
- - data-collection.containers-and-vms
11
- icon_filename: "xen.png"
12
- related_resources:
13
- integrations:
14
- list: []
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords: []
18
- most_popular: false
19
-overview:
20
- data_collection:
21
- metrics_description: "This collector monitors XenServer and XCP-ng host and domains statistics."
22
- method_description: ""
23
- supported_platforms:
24
- include: []
25
- exclude: []
26
- multi_instance: true
27
- additional_permissions:
28
- description: "The plugin needs setuid."
29
- default_behavior:
30
- auto_detection:
31
- description: "This plugin requires the `xen-dom0-libs-devel` and `yajl-devel` libraries to be installed."
32
- limits:
33
- description: ""
34
- performance_impact:
35
- description: ""
36
-setup:
37
- prerequisites:
38
- list:
39
- - title: Libraries
40
- description: |
41
- 1. Install `xen-dom0-libs-devel` and `yajl-devel` using the package manager of your system.
42
-
43
- Note: On Cent-OS systems you will need `centos-release-xen` repository and the required package for xen is `xen-devel`
44
-
45
- 2. Re-install Netdata from source. The installer will detect that the required libraries are now available and will also build xenstat.plugin.
46
- configuration:
47
- file:
48
- name: "netdata.conf"
49
- section_name: "[plugin:xenstat]"
50
- description: "The netdata main configuration file."
51
- options:
52
- description: ""
1
+plugin_name: xenstat.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: xenstat.plugin
5
+ module_name: xenstat.plugin
6
+ monitored_instance:
7
+ name: Xen/XCP-ng
8
+ link: "https://xenproject.org/"
9
+ categories:
10
+ - data-collection.containers-and-vms
11
+ icon_filename: "xen.png"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords: []
18
+ most_popular: false
19
+ overview:
20
+ data_collection:
21
+ metrics_description: "This collector monitors XenServer and XCP-ng host and domains statistics."
22
+ method_description: ""
23
+ supported_platforms:
24
+ include: []
25
+ exclude: []
26
+ multi_instance: true
27
+ additional_permissions:
28
+ description: "The plugin needs setuid."
29
+ default_behavior:
30
+ auto_detection:
31
+ description: "This plugin requires the `xen-dom0-libs-devel` and `yajl-devel` libraries to be installed."
32
+ limits:
33
+ description: ""
34
+ performance_impact:
35
+ description: ""
36
+ setup:
37
+ prerequisites:
38
+ list:
39
+ - title: Libraries
40
+ description: |
41
+ 1. Install `xen-dom0-libs-devel` and `yajl-devel` using the package manager of your system.
42
+
43
+ Note: On Cent-OS systems you will need `centos-release-xen` repository and the required package for xen is `xen-devel`
44
+
45
+ 2. Re-install Netdata from source. The installer will detect that the required libraries are now available and will also build xenstat.plugin.
46
+ configuration:
47
+ file:
48
+ name: "netdata.conf"
49
+ section_name: "[plugin:xenstat]"
50
+ description: "The netdata main configuration file."
51
+ options:
52
+ description: ""
53
+ folding:
54
+ title: "Config options"
55
+ enabled: true
56
+ list:
57
+ - name: update every
58
+ description: Data collection frequency.
59
+ default_value: 1
60
+ required: false
61
+ examples:
62
+ folding:
63
+ enabled: true
64
+ title: ""
65
+ list: []
66
+ troubleshooting:
67
+ problems:
68
+ list: []
69
+ alerts: []
70
+ metrics:
71
folding:
54
- title: "Config options"
55
- enabled: true
56
- list:
57
- - name: update every
58
- description: Data collection frequency.
59
- default_value: 1
60
- required: false
61
- examples:
62
- folding:
63
- enabled: true
64
- title: ""
65
- list: []
66
-troubleshooting:
67
- problems:
68
- list: []
69
-alerts: []
70
-metrics:
71
- folding:
72
- title: Metrics
73
- enabled: false
74
- description: ""
75
- availability: []
76
- scopes:
77
- - name: global
78
- description: "These metrics refer to the entire monitored application."
79
- labels: []
80
- metrics:
81
- - name: xenstat.mem
82
- description: Memory Usage
83
- unit: "MiB"
84
- chart_type: stacked
85
- dimensions:
86
- - name: free
87
- - name: used
88
- - name: xenstat.domains
89
- description: Number of Domains
90
- unit: "domains"
91
- chart_type: line
92
- dimensions:
93
- - name: domains
94
- - name: xenstat.cpus
95
- description: Number of CPUs
96
- unit: "cpus"
97
- chart_type: line
98
- dimensions:
99
- - name: cpus
100
- - name: xenstat.cpu_freq
101
- description: CPU Frequency
102
- unit: "MHz"
103
- chart_type: line
104
- dimensions:
105
- - name: frequency
106
- - name: xendomain
107
- description: "Metrics related to Xen domains. Each domain provides its own set of the following metrics."
108
- labels: []
109
- metrics:
110
- - name: xendomain.states
111
- description: Domain States
112
- unit: "boolean"
113
- chart_type: line
114
- dimensions:
115
- - name: running
116
- - name: blocked
117
- - name: paused
118
- - name: shutdown
119
- - name: crashed
120
- - name: dying
121
- - name: xendomain.cpu
122
- description: CPU Usage (100% = 1 core)
123
- unit: "percentage"
124
- chart_type: line
125
- dimensions:
126
- - name: used
127
- - name: xendomain.mem
128
- description: Memory Reservation
129
- unit: "MiB"
130
- chart_type: line
131
- dimensions:
132
- - name: maximum
133
- - name: current
134
- - name: xendomain.vcpu
135
- description: CPU Usage per VCPU
136
- unit: "percentage"
137
- chart_type: line
138
- dimensions:
139
- - name: a dimension per vcpu
140
- - name: xendomain vbd
141
- description: "Metrics related to Xen domain Virtual Block Device. Each VBD provides its own set of the following metrics."
142
- labels: []
143
- metrics:
144
- - name: xendomain.oo_req_vbd
145
- description: VBD{%u} Out Of Requests
146
- unit: "requests/s"
147
- chart_type: line
148
- dimensions:
149
- - name: requests
150
- - name: xendomain.requests_vbd
151
- description: VBD{%u} Requests
152
- unit: "requests/s"
153
- chart_type: line
154
- dimensions:
155
- - name: read
156
- - name: write
157
- - name: xendomain.sectors_vbd
158
- description: VBD{%u} Read/Written Sectors
159
- unit: "sectors/s"
160
- chart_type: line
161
- dimensions:
162
- - name: read
163
- - name: write
164
- - name: xendomain network
165
- description: "Metrics related to Xen domain network interfaces. Each network interface provides its own set of the following metrics."
166
- labels: []
167
- metrics:
168
- - name: xendomain.bytes_network
169
- description: Network{%u} Received/Sent Bytes
170
- unit: "kilobits/s"
171
- chart_type: line
172
- dimensions:
173
- - name: received
174
- - name: sent
175
- - name: xendomain.packets_network
176
- description: Network{%u} Received/Sent Packets
177
- unit: "packets/s"
178
- chart_type: line
179
- dimensions:
180
- - name: received
181
- - name: sent
182
- - name: xendomain.errors_network
183
- description: Network{%u} Receive/Transmit Errors
184
- unit: "errors/s"
185
- chart_type: line
186
- dimensions:
187
- - name: received
188
- - name: sent
189
- - name: xendomain.drops_network
190
- description: Network{%u} Receive/Transmit Drops
191
- unit: "drops/s"
192
- chart_type: line
193
- dimensions:
194
- - name: received
195
- - name: sent
72
+ title: Metrics
73
+ enabled: false
74
+ description: ""
75
+ availability: []
76
+ scopes:
77
+ - name: global
78
+ description: "These metrics refer to the entire monitored application."
79
+ labels: []
80
+ metrics:
81
+ - name: xenstat.mem
82
+ description: Memory Usage
83
+ unit: "MiB"
84
+ chart_type: stacked
85
+ dimensions:
86
+ - name: free
87
+ - name: used
88
+ - name: xenstat.domains
89
+ description: Number of Domains
90
+ unit: "domains"
91
+ chart_type: line
92
+ dimensions:
93
+ - name: domains
94
+ - name: xenstat.cpus
95
+ description: Number of CPUs
96
+ unit: "cpus"
97
+ chart_type: line
98
+ dimensions:
99
+ - name: cpus
100
+ - name: xenstat.cpu_freq
101
+ description: CPU Frequency
102
+ unit: "MHz"
103
+ chart_type: line
104
+ dimensions:
105
+ - name: frequency
106
+ - name: xendomain
107
+ description: "Metrics related to Xen domains. Each domain provides its own set of the following metrics."
108
+ labels: []
109
+ metrics:
110
+ - name: xendomain.states
111
+ description: Domain States
112
+ unit: "boolean"
113
+ chart_type: line
114
+ dimensions:
115
+ - name: running
116
+ - name: blocked
117
+ - name: paused
118
+ - name: shutdown
119
+ - name: crashed
120
+ - name: dying
121
+ - name: xendomain.cpu
122
+ description: CPU Usage (100% = 1 core)
123
+ unit: "percentage"
124
+ chart_type: line
125
+ dimensions:
126
+ - name: used
127
+ - name: xendomain.mem
128
+ description: Memory Reservation
129
+ unit: "MiB"
130
+ chart_type: line
131
+ dimensions:
132
+ - name: maximum
133
+ - name: current
134
+ - name: xendomain.vcpu
135
+ description: CPU Usage per VCPU
136
+ unit: "percentage"
137
+ chart_type: line
138
+ dimensions:
139
+ - name: a dimension per vcpu
140
+ - name: xendomain vbd
141
+ description: "Metrics related to Xen domain Virtual Block Device. Each VBD provides its own set of the following metrics."
142
+ labels: []
143
+ metrics:
144
+ - name: xendomain.oo_req_vbd
145
+ description: VBD{%u} Out Of Requests
146
+ unit: "requests/s"
147
+ chart_type: line
148
+ dimensions:
149
+ - name: requests
150
+ - name: xendomain.requests_vbd
151
+ description: VBD{%u} Requests
152
+ unit: "requests/s"
153
+ chart_type: line
154
+ dimensions:
155
+ - name: read
156
+ - name: write
157
+ - name: xendomain.sectors_vbd
158
+ description: VBD{%u} Read/Written Sectors
159
+ unit: "sectors/s"
160
+ chart_type: line
161
+ dimensions:
162
+ - name: read
163
+ - name: write
164
+ - name: xendomain network
165
+ description: "Metrics related to Xen domain network interfaces. Each network interface provides its own set of the following metrics."
166
+ labels: []
167
+ metrics:
168
+ - name: xendomain.bytes_network
169
+ description: Network{%u} Received/Sent Bytes
170
+ unit: "kilobits/s"
171
+ chart_type: line
172
+ dimensions:
173
+ - name: received
174
+ - name: sent
175
+ - name: xendomain.packets_network
176
+ description: Network{%u} Received/Sent Packets
177
+ unit: "packets/s"
178
+ chart_type: line
179
+ dimensions:
180
+ - name: received
181
+ - name: sent
182
+ - name: xendomain.errors_network
183
+ description: Network{%u} Receive/Transmit Errors
184
+ unit: "errors/s"
185
+ chart_type: line
186
+ dimensions:
187
+ - name: received
188
+ - name: sent
189
+ - name: xendomain.drops_network
190
+ description: Network{%u} Receive/Transmit Drops
191
+ unit: "drops/s"
192
+ chart_type: line
193
+ dimensions:
194
+ - name: received
195
+ - name: sent
integrations/schemas/collection-multi-module.json
deleted
-20
@@ -1,20 +0,0 @@
1
-{
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "type": "object",
4
- "properties": {
5
- "plugin_name": {
6
- "type": "string"
7
- },
8
- "modules": {
9
- "type": "array",
10
- "description": "A list of single module templates",
11
- "items": {
12
- "$ref": "./collection-single-module.json"
13
- }
14
- }
15
- },
16
- "required": [
17
- "plugin_name",
18
- "modules"
19
- ]
20
-}
integrations/schemas/collection-single-module.json
deleted
-432
@@ -1,432 +0,0 @@
1
-{
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "type": "object",
4
- "title": "Netdata collector single module meta",
5
- "properties": {
6
- "meta": {
7
- "type": "object",
8
- "properties": {
9
- "plugin_name": {
10
- "type": "string",
11
- "description": "Plugin name (e.g. apps.plugin, proc.plugin, go.d.plugin). It must match the name of the executable file in the plugins.d directory."
12
- },
13
- "module_name": {
14
- "type": "string",
15
- "description": "Module name (e.g. apache, /proc/stat, httpcheck). It usually has the same name as the module configuration file (external plugin) or the section name in netdata.conf (internal plugin)."
16
- },
17
- "monitored_instance": {
18
- "$ref": "./shared.json#/$defs/instance"
19
- },
20
- "keywords": {
21
- "$ref": "./shared.json#/$defs/keywords"
22
- },
23
- "related_resources": {
24
- "type": "object",
25
- "description": "Available related resources for the monitored instance.",
26
- "properties": {
27
- "integrations": {
28
- "type": "object",
29
- "description": "All collectors that provide additional metrics for the monitored instance. This may include generic collectors, e.g. 'httpcheck' for web servers to monitor specific endpoints.",
30
- "properties": {
31
- "list": {
32
- "type": "array",
33
- "description": "List of related integrations.",
34
- "items": {
35
- "type": "object",
36
- "properties": {
37
- "plugin_name": {
38
- "type": "string",
39
- "description": "Related integration plugin name."
40
- },
41
- "module_name": {
42
- "type": "string",
43
- "description": "Related integration module name."
44
- }
45
- },
46
- "required": [
47
- "plugin_name",
48
- "module_name"
49
- ]
50
- }
51
- }
52
- },
53
- "required": [
54
- "list"
55
- ]
56
- }
57
- },
58
- "required": [
59
- "integrations"
60
- ]
61
- },
62
- "info_provided_to_referring_integrations": {
63
- "type": "object",
64
- "description": "Information that this collector can provide about itself when other integrations mention it. This text will not be appear on this collector's page.",
65
- "properties": {
66
- "description": {
67
- "type": "string",
68
- "description": "TODO"
69
- }
70
- },
71
- "required": [
72
- "description"
73
- ]
74
- },
75
- "most_popular": {
76
- "type": "boolean",
77
- "description": "Whether or not the integration is to be flagged as most-popular, meaning it will show up at the top of the menu."
78
- },
79
- "community": {
80
- "type": "boolean",
81
- "description": "Whether or not the integration should be flagged as community."
82
- }
83
- },
84
- "required": [
85
- "plugin_name",
86
- "module_name",
87
- "monitored_instance",
88
- "keywords",
89
- "related_resources",
90
- "info_provided_to_referring_integrations",
91
- "most_popular"
92
- ]
93
- },
94
- "overview": {
95
- "type": "object",
96
- "properties": {
97
- "data_collection": {
98
- "type": "object",
99
- "description": "An overview of the collected metrics and a detailed description of the data collection method.",
100
- "properties": {
101
- "metrics_description": {
102
- "type": "string",
103
- "description": "Brief description of what metrics are collected. A suggested approach here is to talk about the areas covered (e.g. health, performance, errors) and the metric scopes."
104
- },
105
- "method_description": {
106
- "type": "string",
107
- "description": "Description of how metrics are collected (e.g. HTTP requests, establish a TCP connection and send a command, a specific binary execution). A suggested approach here is to provide a detailed description of how the collector gathers metrics: how many connections are established, exact requests/commands executed, exact endpoints used."
108
- }
109
- },
110
- "required": [
111
- "metrics_description",
112
- "method_description"
113
- ]
114
- },
115
- "supported_platforms": {
116
- "type": "object",
117
- "description": "Supported OS/platforms. By default, all platforms supported by Netdata are considered supported. See https://learn.netdata.cloud/docs/installing/platform-support-policy#currently-supported-platforms.",
118
- "properties": {
119
- "include": {
120
- "type": "array",
121
- "description": "Only supported OS/platforms. Platforms supported by Netdata will be ignored, only those listed are considered supported.",
122
- "items": {
123
- "type": "string",
124
- "minLength": 2
125
- }
126
- },
127
- "exclude": {
128
- "type": "array",
129
- "description": "Unsupported OS/platforms. The result set is all platforms supported by Netdata except for those excluded.",
130
- "items": {
131
- "type": "string",
132
- "minLength": 2
133
- }
134
- }
135
- },
136
- "required": [
137
- "include",
138
- "exclude"
139
- ]
140
- },
141
- "multi_instance": {
142
- "type": "boolean",
143
- "description": "Whether this collector supports collecting metrics from multiple (for example, local and remote) instances."
144
- },
145
- "additional_permissions": {
146
- "type": "object",
147
- "description": "Information about additional permissions other than those required by the Netdata process (e.g. setuid, specific Linux capabilities).",
148
- "properties": {
149
- "description": {
150
- "type": "string"
151
- }
152
- },
153
- "required": [
154
- "description"
155
- ]
156
- },
157
- "default_behavior": {
158
- "type": "object",
159
- "description": "Descriptions of how the data collector works with the default configuration.",
160
- "properties": {
161
- "auto_detection": {
162
- "type": "object",
163
- "description": "Information about detecting (discovering) monitored instances with default configuration. Example: tries to connect to Apache running on localhost on ports 80, 443 and 8080.",
164
- "properties": {
165
- "description": {
166
- "type": "string"
167
- }
168
- },
169
- "required": [
170
- "description"
171
- ]
172
- },
173
- "limits": {
174
- "type": "object",
175
- "description": "Information about limiting data collection, taking into account the default values of any configuration settings that restrict data collection (including filtering metrics).",
176
- "properties": {
177
- "description": {
178
- "type": "string"
179
- }
180
- },
181
- "required": [
182
- "description"
183
- ]
184
- },
185
- "performance_impact": {
186
- "type": "object",
187
- "description": "Information about the known impact on the performance of the monitored application or system.",
188
- "properties": {
189
- "description": {
190
- "type": "string"
191
- }
192
- },
193
- "required": [
194
- "description"
195
- ]
196
- }
197
- },
198
- "required": [
199
- "auto_detection",
200
- "limits",
201
- "performance_impact"
202
- ]
203
- }
204
- },
205
- "required": [
206
- "data_collection",
207
- "supported_platforms",
208
- "multi_instance",
209
- "additional_permissions",
210
- "default_behavior"
211
- ]
212
- },
213
- "setup": {
214
- "$ref": "./shared.json#/$defs/full_setup"
215
- },
216
- "troubleshooting": {
217
- "type": "object",
218
- "description": "Information needed to troubleshoot issues with this collector.",
219
- "properties": {
220
- "problems": {
221
- "type": "object",
222
- "description": "Common problems that users face again and again... and their solutions.",
223
- "properties": {
224
- "list": {
225
- "type": "array",
226
- "description": "List of common problems.",
227
- "items": {
228
- "type": "object",
229
- "properties": {
230
- "name": {
231
- "type": "string",
232
- "description": "Problem name."
233
- },
234
- "description": {
235
- "type": "string",
236
- "description": "Explanation of the problem and its solution."
237
- }
238
- }
239
- },
240
- "required": [
241
- "name",
242
- "description"
243
- ]
244
- }
245
- },
246
- "required": [
247
- "list"
248
- ]
249
- }
250
- },
251
- "required": [
252
- "problems"
253
- ]
254
- },
255
- "alerts": {
256
- "type": "array",
257
- "description": "The list of configured alerts shipped with Netdata for this collector.",
258
- "items": {
259
- "type": "object",
260
- "description": "Information about the configured alert.",
261
- "properties": {
262
- "name": {
263
- "type": "string",
264
- "description": "Alert's 'alarm' or 'template' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-alarm-or-template)."
265
- },
266
- "link": {
267
- "type": "string",
268
- "description": "Link to github .conf file that this alert originates from"
269
- },
270
- "metric": {
271
- "type": "string",
272
- "description": "Alert's 'on' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-on)."
273
- },
274
- "info": {
275
- "type": "string",
276
- "description": "Alert's 'info' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-info)."
277
- },
278
- "os": {
279
- "type": "string",
280
- "description": "Alert's 'os' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-os)."
281
- }
282
- },
283
- "required": [
284
- "name",
285
- "link",
286
- "metric",
287
- "info"
288
- ]
289
- }
290
- },
291
- "metrics": {
292
- "type": "object",
293
- "description": "Collected metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.",
294
- "properties": {
295
- "folding": {
296
- "$ref": "./shared.json#/$defs/_folding"
297
- },
298
- "description": {
299
- "type": "string",
300
- "description": "General description of collected metrics/scopes."
301
- },
302
- "availability": {
303
- "type": "array",
304
- "description": "Metrics collection availability conditions. Some metrics are only available when certain conditions are met. For example, Apache exposes additional metrics when Extended status is configured, Consul exposes different set of metrics depends on its mode. This field should list the available conditions that will later be matched for each of the metrics.",
305
- "items": {
306
- "type": "string",
307
- "description": "Availability condition name."
308
- }
309
- },
310
- "scopes": {
311
- "type": "array",
312
- "description": "List of scopes and their metrics.",
313
- "items": {
314
- "type": "object",
315
- "properties": {
316
- "name": {
317
- "type": "string",
318
- "description": "Scope name."
319
- },
320
- "description": {
321
- "type": "string",
322
- "description": "Scope description."
323
- },
324
- "labels": {
325
- "type": "array",
326
- "description": "Label set of the scope.",
327
- "items": {
328
- "type": "object",
329
- "properties": {
330
- "name": {
331
- "type": "string",
332
- "description": "Label name."
333
- },
334
- "description": {
335
- "type": "string",
336
- "description": "Label description."
337
- }
338
- },
339
- "required": [
340
- "name",
341
- "description"
342
- ]
343
- }
344
- },
345
- "metrics": {
346
- "type": "array",
347
- "description": "List of collected metrics (chart contexts) in the scope.",
348
- "items": {
349
- "type": "object",
350
- "properties": {
351
- "name": {
352
- "type": "string",
353
- "description": "Metric name (chart context)."
354
- },
355
- "availability": {
356
- "type": "array",
357
- "description": "Metric collection availability conditions. An empty list means that it is available for all conditions defined in 'metrics.availability'.",
358
- "items": {
359
- "type": "string",
360
- "description": "Availability condition name."
361
- }
362
- },
363
- "description": {
364
- "type": "string",
365
- "description": "Metric description (chart title)."
366
- },
367
- "unit": {
368
- "type": "string",
369
- "description": "Metric description (chart unit)."
370
- },
371
- "chart_type": {
372
- "type": "string",
373
- "description": "Metric description (chart type).",
374
- "enum": [
375
- "line",
376
- "area",
377
- "stacked"
378
- ]
379
- },
380
- "dimensions": {
381
- "type": "array",
382
- "description": "",
383
- "items": {
384
- "type": "object",
385
- "properties": {
386
- "name": {
387
- "type": "string",
388
- "description": "Dimension name."
389
- }
390
- },
391
- "required": [
392
- "name"
393
- ]
394
- }
395
- }
396
- },
397
- "required": [
398
- "name",
399
- "description",
400
- "unit",
401
- "chart_type",
402
- "dimensions"
403
- ]
404
- }
405
- }
406
- },
407
- "required": [
408
- "name",
409
- "description",
410
- "labels",
411
- "metrics"
412
- ]
413
- }
414
- }
415
- },
416
- "required": [
417
- "folding",
418
- "description",
419
- "availability",
420
- "scopes"
421
- ]
422
- }
423
- },
424
- "required": [
425
- "meta",
426
- "overview",
427
- "setup",
428
- "troubleshooting",
429
- "alerts",
430
- "metrics"
431
- ]
432
-}
integrations/schemas/collector.json
new
+447
@@ -0,0 +1,447 @@
1
+{
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "plugin_name": {
6
+ "type": "string"
7
+ },
8
+ "modules": {
9
+ "description": "A list of module templates",
10
+ "items": {
11
+ "type": "object",
12
+ "properties": {
13
+ "meta": {
14
+ "type": "object",
15
+ "properties": {
16
+ "plugin_name": {
17
+ "type": "string",
18
+ "description": "Plugin name (e.g. apps.plugin, proc.plugin, go.d.plugin). It must match the name of the executable file in the plugins.d directory."
19
+ },
20
+ "module_name": {
21
+ "type": "string",
22
+ "description": "Module name (e.g. apache, /proc/stat, httpcheck). It usually has the same name as the module configuration file (external plugin) or the section name in netdata.conf (internal plugin)."
23
+ },
24
+ "monitored_instance": {
25
+ "$ref": "./shared.json#/$defs/instance"
26
+ },
27
+ "keywords": {
28
+ "$ref": "./shared.json#/$defs/keywords"
29
+ },
30
+ "related_resources": {
31
+ "type": "object",
32
+ "description": "Available related resources for the monitored instance.",
33
+ "properties": {
34
+ "integrations": {
35
+ "type": "object",
36
+ "description": "All collectors that provide additional metrics for the monitored instance. This may include generic collectors, e.g. 'httpcheck' for web servers to monitor specific endpoints.",
37
+ "properties": {
38
+ "list": {
39
+ "type": "array",
40
+ "description": "List of related integrations.",
41
+ "items": {
42
+ "type": "object",
43
+ "properties": {
44
+ "plugin_name": {
45
+ "type": "string",
46
+ "description": "Related integration plugin name."
47
+ },
48
+ "module_name": {
49
+ "type": "string",
50
+ "description": "Related integration module name."
51
+ }
52
+ },
53
+ "required": [
54
+ "plugin_name",
55
+ "module_name"
56
+ ]
57
+ }
58
+ }
59
+ },
60
+ "required": [
61
+ "list"
62
+ ]
63
+ }
64
+ },
65
+ "required": [
66
+ "integrations"
67
+ ]
68
+ },
69
+ "info_provided_to_referring_integrations": {
70
+ "type": "object",
71
+ "description": "Information that this collector can provide about itself when other integrations mention it. This text will not be appear on this collector's page.",
72
+ "properties": {
73
+ "description": {
74
+ "type": "string",
75
+ "description": "TODO"
76
+ }
77
+ },
78
+ "required": [
79
+ "description"
80
+ ]
81
+ },
82
+ "most_popular": {
83
+ "type": "boolean",
84
+ "description": "Whether or not the integration is to be flagged as most-popular, meaning it will show up at the top of the menu."
85
+ },
86
+ "community": {
87
+ "type": "boolean",
88
+ "description": "Whether or not the integration should be flagged as community."
89
+ }
90
+ },
91
+ "required": [
92
+ "plugin_name",
93
+ "module_name",
94
+ "monitored_instance",
95
+ "keywords",
96
+ "related_resources",
97
+ "info_provided_to_referring_integrations",
98
+ "most_popular"
99
+ ]
100
+ },
101
+ "overview": {
102
+ "type": "object",
103
+ "properties": {
104
+ "data_collection": {
105
+ "type": "object",
106
+ "description": "An overview of the collected metrics and a detailed description of the data collection method.",
107
+ "properties": {
108
+ "metrics_description": {
109
+ "type": "string",
110
+ "description": "Brief description of what metrics are collected. A suggested approach here is to talk about the areas covered (e.g. health, performance, errors) and the metric scopes."
111
+ },
112
+ "method_description": {
113
+ "type": "string",
114
+ "description": "Description of how metrics are collected (e.g. HTTP requests, establish a TCP connection and send a command, a specific binary execution). A suggested approach here is to provide a detailed description of how the collector gathers metrics: how many connections are established, exact requests/commands executed, exact endpoints used."
115
+ }
116
+ },
117
+ "required": [
118
+ "metrics_description",
119
+ "method_description"
120
+ ]
121
+ },
122
+ "supported_platforms": {
123
+ "type": "object",
124
+ "description": "Supported OS/platforms. By default, all platforms supported by Netdata are considered supported. See https://learn.netdata.cloud/docs/installing/platform-support-policy#currently-supported-platforms.",
125
+ "properties": {
126
+ "include": {
127
+ "type": "array",
128
+ "description": "Only supported OS/platforms. Platforms supported by Netdata will be ignored, only those listed are considered supported.",
129
+ "items": {
130
+ "type": "string",
131
+ "minLength": 2
132
+ }
133
+ },
134
+ "exclude": {
135
+ "type": "array",
136
+ "description": "Unsupported OS/platforms. The result set is all platforms supported by Netdata except for those excluded.",
137
+ "items": {
138
+ "type": "string",
139
+ "minLength": 2
140
+ }
141
+ }
142
+ },
143
+ "required": [
144
+ "include",
145
+ "exclude"
146
+ ]
147
+ },
148
+ "multi_instance": {
149
+ "type": "boolean",
150
+ "description": "Whether this collector supports collecting metrics from multiple (for example, local and remote) instances."
151
+ },
152
+ "additional_permissions": {
153
+ "type": "object",
154
+ "description": "Information about additional permissions other than those required by the Netdata process (e.g. setuid, specific Linux capabilities).",
155
+ "properties": {
156
+ "description": {
157
+ "type": "string"
158
+ }
159
+ },
160
+ "required": [
161
+ "description"
162
+ ]
163
+ },
164
+ "default_behavior": {
165
+ "type": "object",
166
+ "description": "Descriptions of how the data collector works with the default configuration.",
167
+ "properties": {
168
+ "auto_detection": {
169
+ "type": "object",
170
+ "description": "Information about detecting (discovering) monitored instances with default configuration. Example: tries to connect to Apache running on localhost on ports 80, 443 and 8080.",
171
+ "properties": {
172
+ "description": {
173
+ "type": "string"
174
+ }
175
+ },
176
+ "required": [
177
+ "description"
178
+ ]
179
+ },
180
+ "limits": {
181
+ "type": "object",
182
+ "description": "Information about limiting data collection, taking into account the default values of any configuration settings that restrict data collection (including filtering metrics).",
183
+ "properties": {
184
+ "description": {
185
+ "type": "string"
186
+ }
187
+ },
188
+ "required": [
189
+ "description"
190
+ ]
191
+ },
192
+ "performance_impact": {
193
+ "type": "object",
194
+ "description": "Information about the known impact on the performance of the monitored application or system.",
195
+ "properties": {
196
+ "description": {
197
+ "type": "string"
198
+ }
199
+ },
200
+ "required": [
201
+ "description"
202
+ ]
203
+ }
204
+ },
205
+ "required": [
206
+ "auto_detection",
207
+ "limits",
208
+ "performance_impact"
209
+ ]
210
+ }
211
+ },
212
+ "required": [
213
+ "data_collection",
214
+ "supported_platforms",
215
+ "multi_instance",
216
+ "additional_permissions",
217
+ "default_behavior"
218
+ ]
219
+ },
220
+ "setup": {
221
+ "$ref": "./shared.json#/$defs/full_setup"
222
+ },
223
+ "troubleshooting": {
224
+ "type": "object",
225
+ "description": "Information needed to troubleshoot issues with this collector.",
226
+ "properties": {
227
+ "problems": {
228
+ "type": "object",
229
+ "description": "Common problems that users face again and again... and their solutions.",
230
+ "properties": {
231
+ "list": {
232
+ "type": "array",
233
+ "description": "List of common problems.",
234
+ "items": {
235
+ "type": "object",
236
+ "properties": {
237
+ "name": {
238
+ "type": "string",
239
+ "description": "Problem name."
240
+ },
241
+ "description": {
242
+ "type": "string",
243
+ "description": "Explanation of the problem and its solution."
244
+ }
245
+ }
246
+ },
247
+ "required": [
248
+ "name",
249
+ "description"
250
+ ]
251
+ }
252
+ },
253
+ "required": [
254
+ "list"
255
+ ]
256
+ }
257
+ },
258
+ "required": [
259
+ "problems"
260
+ ]
261
+ },
262
+ "alerts": {
263
+ "type": "array",
264
+ "description": "The list of configured alerts shipped with Netdata for this collector.",
265
+ "items": {
266
+ "type": "object",
267
+ "description": "Information about the configured alert.",
268
+ "properties": {
269
+ "name": {
270
+ "type": "string",
271
+ "description": "Alert's 'alarm' or 'template' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-alarm-or-template)."
272
+ },
273
+ "link": {
274
+ "type": "string",
275
+ "description": "Link to github .conf file that this alert originates from"
276
+ },
277
+ "metric": {
278
+ "type": "string",
279
+ "description": "Alert's 'on' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-on)."
280
+ },
281
+ "info": {
282
+ "type": "string",
283
+ "description": "Alert's 'info' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-info)."
284
+ },
285
+ "os": {
286
+ "type": "string",
287
+ "description": "Alert's 'os' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-os)."
288
+ }
289
+ },
290
+ "required": [
291
+ "name",
292
+ "link",
293
+ "metric",
294
+ "info"
295
+ ]
296
+ }
297
+ },
298
+ "metrics": {
299
+ "type": "object",
300
+ "description": "Collected metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.",
301
+ "properties": {
302
+ "folding": {
303
+ "$ref": "./shared.json#/$defs/_folding"
304
+ },
305
+ "description": {
306
+ "type": "string",
307
+ "description": "General description of collected metrics/scopes."
308
+ },
309
+ "availability": {
310
+ "type": "array",
311
+ "description": "Metrics collection availability conditions. Some metrics are only available when certain conditions are met. For example, Apache exposes additional metrics when Extended status is configured, Consul exposes different set of metrics depends on its mode. This field should list the available conditions that will later be matched for each of the metrics.",
312
+ "items": {
313
+ "type": "string",
314
+ "description": "Availability condition name."
315
+ }
316
+ },
317
+ "scopes": {
318
+ "type": "array",
319
+ "description": "List of scopes and their metrics.",
320
+ "items": {
321
+ "type": "object",
322
+ "properties": {
323
+ "name": {
324
+ "type": "string",
325
+ "description": "Scope name."
326
+ },
327
+ "description": {
328
+ "type": "string",
329
+ "description": "Scope description."
330
+ },
331
+ "labels": {
332
+ "type": "array",
333
+ "description": "Label set of the scope.",
334
+ "items": {
335
+ "type": "object",
336
+ "properties": {
337
+ "name": {
338
+ "type": "string",
339
+ "description": "Label name."
340
+ },
341
+ "description": {
342
+ "type": "string",
343
+ "description": "Label description."
344
+ }
345
+ },
346
+ "required": [
347
+ "name",
348
+ "description"
349
+ ]
350
+ }
351
+ },
352
+ "metrics": {
353
+ "type": "array",
354
+ "description": "List of collected metrics (chart contexts) in the scope.",
355
+ "items": {
356
+ "type": "object",
357
+ "properties": {
358
+ "name": {
359
+ "type": "string",
360
+ "description": "Metric name (chart context)."
361
+ },
362
+ "availability": {
363
+ "type": "array",
364
+ "description": "Metric collection availability conditions. An empty list means that it is available for all conditions defined in 'metrics.availability'.",
365
+ "items": {
366
+ "type": "string",
367
+ "description": "Availability condition name."
368
+ }
369
+ },
370
+ "description": {
371
+ "type": "string",
372
+ "description": "Metric description (chart title)."
373
+ },
374
+ "unit": {
375
+ "type": "string",
376
+ "description": "Metric description (chart unit)."
377
+ },
378
+ "chart_type": {
379
+ "type": "string",
380
+ "description": "Metric description (chart type).",
381
+ "enum": [
382
+ "line",
383
+ "area",
384
+ "stacked"
385
+ ]
386
+ },
387
+ "dimensions": {
388
+ "type": "array",
389
+ "description": "",
390
+ "items": {
391
+ "type": "object",
392
+ "properties": {
393
+ "name": {
394
+ "type": "string",
395
+ "description": "Dimension name."
396
+ }
397
+ },
398
+ "required": [
399
+ "name"
400
+ ]
401
+ }
402
+ }
403
+ },
404
+ "required": [
405
+ "name",
406
+ "description",
407
+ "unit",
408
+ "chart_type",
409
+ "dimensions"
410
+ ]
411
+ }
412
+ }
413
+ },
414
+ "required": [
415
+ "name",
416
+ "description",
417
+ "labels",
418
+ "metrics"
419
+ ]
420
+ }
421
+ }
422
+ },
423
+ "required": [
424
+ "folding",
425
+ "description",
426
+ "availability",
427
+ "scopes"
428
+ ]
429
+ }
430
+ },
431
+ "required": [
432
+ "meta",
433
+ "overview",
434
+ "setup",
435
+ "troubleshooting",
436
+ "alerts",
437
+ "metrics"
438
+ ]
439
+ }
440
+ }
441
+ },
442
+ "required": [
443
+ "plugin_name",
444
+ "modules"
445
+ ]
446
+}
447
+