Update metadata.yaml for some python collectors (#15513)
* add more info to metadata.yaml for ceph, haproxy and tor * changes * add dovecot metdata * add metdata for hpssa * add icecast metadata * add rethinkdbs metadata * add am2320 metadata * address review comments * Update collectors/python.d.plugin/ceph/metadata.yaml * Update collectors/python.d.plugin/am2320/metadata.yaml * Apply suggestions from code review * Update collectors/python.d.plugin/ceph/metadata.yaml --------- Co-authored-by: Andrew Maguire <andrewm4894@gmail.com> Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Emmanuel Vasilakis committed
Jul 26, 2023 at 10:33 UTC
e7d9d14c16bac4820f32fe4657650ace4054a498
8 files changed
+608
-116
collectors/python.d.plugin/am2320/metadata.yaml
+71
-16
@@ -3,7 +3,7 @@ meta:
3
module_name: am2320
4
monitored_instance:
5
name: AM2320
6
- link: ''
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'
@@ -12,43 +12,98 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - temperature
17
+ - am2320
18
+ - sensor
19
+ - humidity
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Monitor AM2320 metrics with Netdata for optimal temperature and humidity sensor performance. Improve your sensor performance with comprehensive dashboards and anomaly detection.'
20
- method_description: ''
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: []
24
- multi_instance: true
28
+ multi_instance: false
29
additional_permissions:
30
description: ''
31
default_behavior:
32
auto_detection:
29
- description: ''
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:
36
- list: []
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:
39
- name: ''
40
- description: ''
60
+ name: python.d/am2320.conf
61
options:
42
- description: ''
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:
44
- title: ''
74
+ title: "Config options"
75
enabled: true
46
- list: []
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:
98
folding:
49
- enabled: true
50
- title: ''
51
- list: []
99
+ 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: []
@@ -61,7 +116,7 @@ metrics:
116
availability: []
117
scopes:
118
- name: global
64
- description: ""
119
+ description: "These metrics refer to the entire monitored application."
120
labels: []
121
metrics:
122
- name: am2320.temperature
collectors/python.d.plugin/ceph/metadata.yaml
+70
-13
@@ -3,7 +3,7 @@ meta:
3
module_name: ceph
4
monitored_instance:
5
name: Ceph
6
- link: ''
6
+ link: 'https://ceph.io/'
7
categories:
8
- data-collection.storage-mount-points-and-filesystems
9
icon_filename: 'ceph.png'
@@ -12,12 +12,14 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - ceph
17
+ - storage
18
most_popular: false
19
overview:
20
data_collection:
19
- metrics_description: 'Monitor Ceph metrics for efficient distributed storage system performance. Keep tabs on cluster health, data redundancy, and latency to ensure reliable storage operations.'
20
- method_description: ''
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: []
@@ -33,22 +35,77 @@ overview:
35
description: ''
36
setup:
37
prerequisites:
36
- list: []
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:
39
- name: ''
40
- description: ''
47
+ name: python.d/ceph.conf
48
options:
42
- description: ''
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:
44
- title: ''
61
+ title: "Config options"
62
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
99
+ title: "Config"
100
+ list:
101
+ - name: Basic local Ceph cluster
102
+ description: A basic configuration to connect to a local Ceph cluster.
103
+ 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: []
@@ -65,7 +122,7 @@ metrics:
122
availability: []
123
scopes:
124
- name: global
68
- description: ""
125
+ description: "These metrics refer to the entire monitored application."
126
labels: []
127
metrics:
128
- name: ceph.general_usage
collectors/python.d.plugin/dovecot/metadata.yaml
+73
-14
@@ -3,7 +3,7 @@ meta:
3
module_name: dovecot
4
monitored_instance:
5
name: Dovecot
6
- link: ''
6
+ link: 'https://www.dovecot.org/'
7
categories:
8
- data-collection.mail-servers
9
icon_filename: 'dovecot.png'
@@ -12,12 +12,15 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - dovecot
17
+ - imap
18
+ - mail
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Examine Dovecot metrics for insights into IMAP and POP3 server operations. Analyze connection statuses, mailbox operations, and error rates for efficient mail server operations.'
20
- method_description: ''
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: []
@@ -26,29 +29,85 @@ overview:
29
description: ''
30
default_behavior:
31
auto_detection:
29
- description: ''
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:
36
- list: []
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:
39
- name: ''
40
- description: ''
44
+ name: python.d/dovecot.conf
45
options:
42
- description: ''
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:
44
- title: ''
58
+ title: "Config options"
59
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
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: []
@@ -61,7 +120,7 @@ metrics:
120
availability: []
121
scopes:
122
- name: global
64
- description: ""
123
+ description: "These metrics refer to the entire monitored application."
124
labels: []
125
metrics:
126
- name: dovecot.sessions
collectors/python.d.plugin/haproxy/metadata.yaml
+77
-13
@@ -3,7 +3,7 @@ meta:
3
module_name: haproxy
4
monitored_instance:
5
name: HAProxy
6
- link: ''
6
+ link: 'https://www.haproxy.org/'
7
categories:
8
- data-collection.web-servers-and-web-proxies
9
icon_filename: 'haproxy.png'
@@ -12,12 +12,15 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - haproxy
17
+ - tcp
18
+ - balancer
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Monitor HAProxy performance for ideal load balancing operations. Monitor session rates, queue lengths, and error rates to maintain balanced network traffic.'
20
- method_description: ''
22
+ metrics_description: 'This collector monitors HAProxy metrics about frontend servers, backend servers, responses and more.'
23
+ method_description: 'It connects to the HAProxy instance via URL or UNIX socket.'
24
supported_platforms:
25
include: []
26
exclude: []
@@ -33,22 +36,83 @@ overview:
36
description: ''
37
setup:
38
prerequisites:
36
- list: []
39
+ list:
40
+ - title: 'HAProxy setup for socket'
41
+ description: 'Socket must be readable and writable by the netdata user.'
42
+ - title: 'HAProxy setup for URL'
43
+ description: 'URL must have `stats uri <path>` present in the haproxy config, otherwise you will get HTTP 503 in the haproxy logs.'
44
configuration:
45
file:
39
- name: ''
40
- description: ''
46
+ name: python.d/haproxy.conf
47
options:
42
- description: ''
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:
44
- title: ''
60
+ title: "Config options"
61
enabled: true
46
- list: []
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: user
84
+ description: Username if stats auth is used.
85
+ default_value: ''
86
+ required: false
87
+ - name: pass
88
+ description: Password if stats auth is used.
89
+ default_value: ''
90
+ required: false
91
+ - name: url
92
+ description: URL to the haproxy_stats endpoint. Also make sure the parameters `csv` and `norefresh` are provided.
93
+ default_value: ''
94
+ required: false
95
+ - name: socket
96
+ description: Unix socket path to the haproxy sock file.
97
+ default_value: ''
98
+ required: false
99
examples:
100
folding:
101
enabled: true
50
- title: ''
51
- list: []
102
+ title: "Config"
103
+ list:
104
+ - name: URL method
105
+ description: Use a URL to specify the endpoint to check for haproxy statistics.
106
+ config: |
107
+ via_url:
108
+ user: 'username' # ONLY IF stats auth is used
109
+ pass: 'password' # # ONLY IF stats auth is used
110
+ url: 'http://ip.address:port/url;csv;norefresh'
111
+ - name: Local socket
112
+ description: Use a local socket to check for haproxy statistics.
113
+ config: |
114
+ via_socket:
115
+ socket: 'path/to/haproxy/sock'
116
troubleshooting:
117
problems:
118
list: []
@@ -69,7 +133,7 @@ metrics:
133
availability: []
134
scopes:
135
- name: global
72
- description: ""
136
+ description: 'These metrics refer to the entire monitored application.'
137
labels: []
138
metrics:
139
- name: haproxy_f.bin
collectors/python.d.plugin/hpssa/metadata.yaml
+90
-16
@@ -3,7 +3,7 @@ meta:
3
module_name: hpssa
4
monitored_instance:
5
name: HP Smart Storage Arrays
6
- link: ''
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.jpeg'
@@ -12,43 +12,117 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - storage
17
+ - hp
18
+ - hpssa
19
+ - array
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Examine HP Smart Storage Arrays metrics with Netdata for efficient storage management. Improve your storage efficiency with real-time performance insights.'
20
- method_description: ''
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: []
24
- multi_instance: true
28
+ multi_instance: false
29
additional_permissions:
30
description: ''
31
default_behavior:
32
auto_detection:
29
- description: ''
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:
36
- list: []
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:
39
- name: ''
40
- description: ''
69
+ name: python.d/hpssa.conf
70
options:
42
- description: ''
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:
44
- title: ''
83
+ title: "Config options"
84
enabled: true
46
- list: []
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:
49
- enabled: true
50
- title: ''
51
- list: []
116
+ enabled: false
117
+ title: "Config"
118
+ list:
119
+ - name: Local simple config
120
+ description: A basic configuration, specyfing the path to `ssacli`
121
+ folding:
122
+ enabled: false
123
+ config: |
124
+ local:
125
+ ssacli_path: /usr/sbin/ssacli
126
troubleshooting:
127
problems:
128
list: []
@@ -61,7 +135,7 @@ metrics:
135
availability: []
136
scopes:
137
- name: global
64
- description: ""
138
+ description: "These metrics refer to the entire monitored application."
139
labels: []
140
metrics:
141
- name: hpssa.ctrl_status
collectors/python.d.plugin/icecast/metadata.yaml
+68
-15
@@ -3,7 +3,7 @@ meta:
3
module_name: icecast
4
monitored_instance:
5
name: Icecast
6
- link: ''
6
+ link: 'https://icecast.org/'
7
categories:
8
- data-collection.media-streaming-servers
9
icon_filename: 'icecast.png'
@@ -12,12 +12,15 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - icecast
17
+ - streaming
18
+ - media
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Examine Icecast metrics for insights into media streaming server operations. Study listener counts, bitrate, and connection statuses for smooth streaming services.'
20
- method_description: ''
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: []
@@ -26,29 +29,79 @@ overview:
29
description: ''
30
default_behavior:
31
auto_detection:
29
- description: ''
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:
36
- list: []
39
+ list:
40
+ - title: 'Icecast minimum version'
41
+ description: 'Needs at least icecast version >= 2.4.0'
42
configuration:
43
file:
39
- name: ''
40
- description: ''
44
+ name: python.d/icecast.conf
45
options:
42
- description: ''
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:
44
- title: ''
58
+ title: "Config options"
59
enabled: true
46
- list: []
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:
49
- enabled: true
50
- title: ''
51
- list: []
95
+ enabled: false
96
+ title: "Config"
97
+ list:
98
+ - name: Remote Icecast server
99
+ description: Configure a remote icecast server
100
+ folding:
101
+ enabled: false
102
+ config: |
103
+ remote:
104
+ url: 'http://1.2.3.4:8443/status-json.xsl'
105
troubleshooting:
106
problems:
107
list: []
@@ -61,7 +114,7 @@ metrics:
114
availability: []
115
scopes:
116
- name: global
64
- description: ""
117
+ description: "These metrics refer to the entire monitored application."
118
labels: []
119
metrics:
120
- name: icecast.listeners
collectors/python.d.plugin/rethinkdbs/metadata.yaml
+80
-15
@@ -3,7 +3,7 @@ meta:
3
module_name: rethinkdbs
4
monitored_instance:
5
name: RethinkDB
6
- link: ''
6
+ link: 'https://rethinkdb.com/'
7
categories:
8
- data-collection.database-servers
9
icon_filename: 'rethinkdb.png'
@@ -12,12 +12,15 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - rethinkdb
17
+ - database
18
+ - db
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Monitor RethinkDB performance for real-time database operations and performance. Improve your database operations with Netdata''s real-time metrics and built-in alerts.'
20
- method_description: ''
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: []
@@ -26,29 +29,91 @@ overview:
29
description: ''
30
default_behavior:
31
auto_detection:
29
- description: ''
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:
36
- list: []
39
+ list:
40
+ - title: 'Required python module'
41
+ description: 'The collector requires the `rethinkdb` python module to be installed.'
42
configuration:
43
file:
39
- name: ''
40
- description: ''
44
+ name: python.d/rethinkdbs.conf
45
options:
42
- description: ''
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:
44
- title: ''
58
+ title: "Config options"
59
enabled: true
46
- list: []
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:
49
- enabled: true
50
- title: ''
51
- list: []
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
108
+ folding:
109
+ 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: []
@@ -61,7 +126,7 @@ metrics:
126
availability: []
127
scopes:
128
- name: global
64
- description: ""
129
+ description: "These metrics refer to the entire monitored application."
130
labels: []
131
metrics:
132
- name: rethinkdb.cluster_connected_servers
collectors/python.d.plugin/tor/metadata.yaml
+79
-14
@@ -3,7 +3,7 @@ meta:
3
module_name: tor
4
monitored_instance:
5
name: Tor
6
- link: ''
6
+ link: 'https://www.torproject.org/'
7
categories:
8
- data-collection.vpns
9
icon_filename: 'tor.png'
@@ -12,12 +12,15 @@ meta:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - tor
17
+ - traffic
18
+ - vpn
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Monitor Tor metrics with Netdata for efficient anonymous communication operations. Enhance your anonymous communication with real-time insights and alerts.'
20
- method_description: ''
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: []
@@ -26,29 +29,91 @@ overview:
29
description: ''
30
default_behavior:
31
auto_detection:
29
- description: ''
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:
36
- list: []
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:
39
- name: ''
40
- description: ''
49
+ name: python.d/tor.conf
50
options:
42
- description: ''
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:
44
- title: ''
63
+ title: "Config options"
64
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
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: []
@@ -61,7 +126,7 @@ metrics:
126
availability: []
127
scopes:
128
- name: global
64
- description: ""
129
+ description: "These metrics refer to the entire monitored application."
130
labels: []
131
metrics:
132
- name: tor.traffic