Update metadata for multiple python collectors. (#15543)
- Adaptec Raid controller - Apache Tomcat - OpenLDAP - megacli - oracledb - riakkv - uwsgi - ipfs Signed-off-by: Tasos Katsoulas <tasos@netdata.cloud> Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Tasos Katsoulas committed
Jul 27, 2023 at 18:25 UTC
39e87ef05d5cac2b323d6477d7409bf1275f3922
8 files changed
+1471
-849
collectors/python.d.plugin/adaptec_raid/metadata.yaml
+123
-56
@@ -3,64 +3,131 @@ meta:
3
module_name: adaptec_raid
4
monitored_instance:
5
name: AdaptecRAID
6
- link: ''
6
+ link: "https://www.microchip.com/en-us/products/storage"
7
categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: 'adaptec.png'
8
+ - data-collection.storage-mount-points-and-filesystems
9
+ icon_filename: "adaptec.png"
10
related_resources:
11
integrations:
12
list: []
13
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
14
+ description: ""
15
+ keywords:
16
+ - storage
17
+ - raid-controller
18
+ - manage-disks
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Assess Adaptec RAID hardware storage controllers with Netdata for RAID controller performance and operational metrics. Improve your RAID controller performance with comprehensive dashboards and anomaly detection.'
20
- method_description: ''
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: []
24
- multi_instance: true
33
+ multi_instance: false
34
additional_permissions:
26
- description: ''
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:
29
- description: ''
38
+ description: "After all the permissions are satisfied, netdata should be to execute commands via the arcconf command line utility"
39
limits:
31
- description: ''
40
+ description: ""
41
performance_impact:
33
- description: ''
42
+ description: ""
43
setup:
44
prerequisites:
36
- list: []
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:
39
- name: ''
40
- description: ''
70
+ name: "python.d/adaptec_raid.conf"
71
options:
42
- description: ''
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:
44
- title: ''
84
+ title: "Config options"
85
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
106
+ title: "Config"
107
+ list:
108
+ - name: Basic
109
+ 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:
56
-- name: adaptec_raid_ld_status
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
58
- metric: adaptec_raid.ld_status
59
- info: logical device status is failed or degraded
60
-- name: adaptec_raid_pd_state
61
- link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
62
- metric: adaptec_raid.pd_state
63
- info: physical device state is not online
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
@@ -68,31 +135,31 @@ metrics:
135
description: ""
136
availability: []
137
scopes:
71
- - name: global
72
- description: ""
73
- labels: []
74
- metrics:
75
- - name: adaptec_raid.ld_status
76
- description: 'Status of logical devices (1: Failed or Degraded)'
77
- unit: "bool"
78
- chart_type: line
79
- dimensions:
80
- - name: a dimension per logical device
81
- - name: adaptec_raid.pd_state
82
- description: 'State of physical devices (1: not Online)'
83
- unit: "bool"
84
- chart_type: line
85
- dimensions:
86
- - name: a dimension per physical device
87
- - name: adaptec_raid.smart_warnings
88
- description: S.M.A.R.T warnings
89
- unit: "count"
90
- chart_type: line
91
- dimensions:
92
- - name: a dimension per physical device
93
- - name: adaptec_raid.temperature
94
- description: Temperature
95
- unit: "celsius"
96
- chart_type: line
97
- dimensions:
98
- - name: a dimension per physical device
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
collectors/python.d.plugin/ipfs/metadata.yaml
+125
-53
@@ -3,60 +3,132 @@ meta:
3
module_name: ipfs
4
monitored_instance:
5
name: IPFS
6
- link: ''
6
+ link: "https://ipfs.tech/"
7
categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: 'ipfs.png'
8
+ - data-collection.storage-mount-points-and-filesystems
9
+ icon_filename: "ipfs.png"
10
related_resources:
11
integrations:
12
list: []
13
info_provided_to_referring_integrations:
14
- description: ''
14
+ description: ""
15
keywords: []
16
most_popular: false
17
overview:
18
data_collection:
19
- metrics_description: 'Examine IPFS metrics for insights into distributed file system operations. Analyze node connectivity, data replication, and retrieval times for efficient distributed file handling.'
20
- method_description: ''
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: ''
26
+ description: ""
27
default_behavior:
28
auto_detection:
29
- description: ''
29
+ description: "If the endpoint is accessible by the Agent, netdata will autodetect it"
30
limits:
31
- description: ''
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:
33
- description: ''
37
+ description: ""
38
setup:
39
prerequisites:
40
list: []
41
configuration:
42
file:
39
- name: ''
40
- description: ''
43
+ name: "python.d/ipfs.conf"
44
options:
42
- description: ''
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:
44
- title: ''
57
+ title: ""
58
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
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
108
+ 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:
56
-- name: ipfs_datastore_usage
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/ipfs.conf
58
- metric: ipfs.repo_size
59
- info: IPFS datastore utilization
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
@@ -64,35 +136,35 @@ metrics:
136
description: ""
137
availability: []
138
scopes:
67
- - name: global
68
- description: ""
69
- labels: []
70
- metrics:
71
- - name: ipfs.bandwidth
72
- description: IPFS Bandwidth
73
- unit: "kilobits/s"
74
- chart_type: line
75
- dimensions:
76
- - name: in
77
- - name: out
78
- - name: ipfs.peers
79
- description: IPFS Peers
80
- unit: "peers"
81
- chart_type: line
82
- dimensions:
83
- - name: peers
84
- - name: ipfs.repo_size
85
- description: IPFS Repo Size
86
- unit: "GiB"
87
- chart_type: area
88
- dimensions:
89
- - name: avail
90
- - name: size
91
- - name: ipfs.repo_objects
92
- description: IPFS Repo Objects
93
- unit: "objects"
94
- chart_type: line
95
- dimensions:
96
- - name: objects
97
- - name: pinned
98
- - name: recursive_pins
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
collectors/python.d.plugin/megacli/metadata.yaml
+150
-78
@@ -1,78 +1,150 @@
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
6
- link: ''
7
+ link: "https://wikitech.wikimedia.org/wiki/MegaCli"
8
categories:
8
- - data-collection.storage-mount-points-and-filesystems
9
- icon_filename: 'hard-drive.svg'
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:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - storage
18
+ - raid-controller
19
+ - manage-disks
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Examine MegaCLI metrics with Netdata for insights into RAID controller performance. Improve your RAID controller efficiency with real-time MegaCLI metrics.'
20
- method_description: ''
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: []
24
- multi_instance: true
34
+ multi_instance: false
35
additional_permissions:
26
- description: ''
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:
29
- description: ''
39
+ description: "After all the permissions are satisfied, netdata should be to execute commands via the megacli command line utility"
40
limits:
31
- description: ''
41
+ description: ""
42
performance_impact:
33
- description: ''
43
+ description: ""
44
setup:
45
prerequisites:
36
- list: []
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:
39
- name: ''
40
- description: ''
71
+ name: "python.d/megacli.conf"
72
options:
42
- description: ''
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:
44
- title: ''
85
+ title: "Config options"
86
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
111
+ title: "Config"
112
+ list:
113
+ - name: Basic
114
+ 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:
56
-- name: megacli_adapter_state
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
58
- metric: megacli.adapter_degraded
59
- info: 'adapter is in the degraded state (0: false, 1: true)'
60
-- name: megacli_pd_media_errors
61
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
62
- metric: megacli.pd_media_error
63
- info: number of physical drive media errors
64
-- name: megacli_pd_predictive_failures
65
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
66
- metric: megacli.pd_predictive_failure
67
- info: number of physical drive predictive failures
68
-- name: megacli_bbu_relative_charge
69
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
70
- metric: megacli.bbu_relative_charge
71
- info: average battery backup unit (BBU) relative state of charge over the last 10 seconds
72
-- name: megacli_bbu_cycle_count
73
- link: https://github.com/netdata/netdata/blob/master/health/health.d/megacli.conf
74
- metric: megacli.bbu_cycle_count
75
- info: average battery backup unit (BBU) charge cycles count over the last 10 seconds
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
@@ -80,41 +152,41 @@ metrics:
152
description: ""
153
availability: []
154
scopes:
83
- - name: global
84
- description: ""
85
- labels: []
86
- metrics:
87
- - name: megacli.adapter_degraded
88
- description: Adapter State
89
- unit: "is degraded"
90
- chart_type: line
91
- dimensions:
92
- - name: a dimension per adapter
93
- - name: megacli.pd_media_error
94
- description: Physical Drives Media Errors
95
- unit: "errors/s"
96
- chart_type: line
97
- dimensions:
98
- - name: a dimension per physical drive
99
- - name: megacli.pd_predictive_failure
100
- description: Physical Drives Predictive Failures
101
- unit: "failures/s"
102
- chart_type: line
103
- dimensions:
104
- - name: a dimension per physical drive
105
- - name: battery
106
- description: ""
107
- labels: []
108
- metrics:
109
- - name: megacli.bbu_relative_charge
110
- description: Relative State of Charge
111
- unit: "percentage"
112
- chart_type: line
113
- dimensions:
114
- - name: adapter {battery id}
115
- - name: megacli.bbu_cycle_count
116
- description: Cycle Count
117
- unit: "cycle count"
118
- chart_type: line
119
- dimensions:
120
- - name: adapter {battery id}
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}
collectors/python.d.plugin/openldap/metadata.yaml
+182
-74
@@ -1,54 +1,162 @@
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
6
- link: ''
7
+ link: "https://www.openldap.org/"
8
categories:
8
- - data-collection.authentication-and-authorization
9
- icon_filename: 'statsd.png'
9
+ - data-collection.authentication-and-authorization
10
+ icon_filename: "statsd.png"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - openldap
18
+ - RBAC
19
+ - Directory access
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Examine OpenLDAP metrics for insights into directory service operations. Analyze query rates, response times, and error rates for efficient directory services.'
20
- method_description: ''
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: []
24
- multi_instance: true
29
+ multi_instance: false
30
additional_permissions:
26
- description: ''
31
+ description: ""
32
default_behavior:
33
auto_detection:
29
- description: ''
34
+ description: |
35
+ This collector doesn't work until all the prerequisites are checked.
36
limits:
31
- description: ''
37
+ description: ""
38
performance_impact:
33
- description: ''
39
+ description: ""
40
setup:
41
prerequisites:
36
- list: []
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:
39
- name: ''
40
- description: ''
75
+ name: "python.d/openldap.conf"
76
options:
42
- description: ''
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:
44
- title: ''
89
+ title: "Config options"
90
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
147
+ title: "Config"
148
+ list:
149
+ - name: Basic
150
+ description: A basic example configuration.
151
+ 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: []
@@ -60,57 +168,57 @@ metrics:
168
description: ""
169
availability: []
170
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: openldap.total_connections
68
- description: Total Connections
69
- unit: "connections/s"
70
- chart_type: line
71
- dimensions:
72
- - name: connections
73
- - name: openldap.traffic_stats
74
- description: Traffic
75
- unit: "KiB/s"
76
- chart_type: line
77
- dimensions:
78
- - name: sent
79
- - name: openldap.operations_status
80
- description: Operations Status
81
- unit: "ops/s"
82
- chart_type: line
83
- dimensions:
84
- - name: completed
85
- - name: initiated
86
- - name: openldap.referrals
87
- description: Referrals
88
- unit: "referrals/s"
89
- chart_type: line
90
- dimensions:
91
- - name: sent
92
- - name: openldap.entries
93
- description: Entries
94
- unit: "entries/s"
95
- chart_type: line
96
- dimensions:
97
- - name: sent
98
- - name: openldap.ldap_operations
99
- description: Operations
100
- unit: "ops/s"
101
- chart_type: line
102
- dimensions:
103
- - name: bind
104
- - name: search
105
- - name: unbind
106
- - name: add
107
- - name: delete
108
- - name: modify
109
- - name: compare
110
- - name: openldap.waiters
111
- description: Waiters
112
- unit: "waiters/s"
113
- chart_type: line
114
- dimensions:
115
- - name: write
116
- - name: read
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
collectors/python.d.plugin/oracledb/metadata.yaml
+266
-174
@@ -1,54 +1,146 @@
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: OracleDB
6
- link: ''
7
+ link: "https://docs.oracle.com/en/database/oracle/oracle-database/"
8
categories:
8
- - data-collection.database-servers
9
- icon_filename: 'oracle.jpeg'
9
+ - data-collection.database-servers
10
+ icon_filename: "oracle.jpeg"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - database
18
+ - oracle
19
+ - data warehouse
20
+ - SQL
21
most_popular: false
22
overview:
23
data_collection:
19
- metrics_description: 'Monitor OracleDB performance for efficient database operations and resource management. Netdata provides real-time insights and alerts for optimal database management.'
20
- method_description: ''
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:
26
- description: ''
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:
29
- description: ''
35
+ description: "When the requirements are met, databases on the local host on port 1521 will be auto-detected"
36
limits:
31
- description: ''
37
+ description: ""
38
performance_impact:
33
- description: ''
39
+ description: ""
40
setup:
41
prerequisites:
36
- list: []
42
+ list:
43
+ - title: Install the python-oracledb package
44
+ 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:
39
- name: ''
40
- description: ''
68
+ name: "python.d/oracledb.conf"
69
options:
42
- description: ''
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:
44
- title: ''
82
+ title: "Config options"
83
enabled: true
46
- list: []
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
50
- title: ''
51
- list: []
124
+ title: "Config"
125
+ list:
126
+ - name: Basic
127
+ 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: []
@@ -57,160 +149,160 @@ metrics:
149
folding:
150
title: Metrics
151
enabled: false
60
- description: ""
152
+ description: "These metrics refer to the entire monitored application."
153
availability: []
154
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: oracledb.session_count
68
- description: Session Count
69
- unit: "sessions"
70
- chart_type: line
71
- dimensions:
72
- - name: total
73
- - name: active
74
- - name: oracledb.session_limit_usage
75
- description: Session Limit Usage
76
- unit: "%"
77
- chart_type: area
78
- dimensions:
79
- - name: usage
80
- - name: oracledb.logons
81
- description: Logons
82
- unit: "events/s"
83
- chart_type: area
84
- dimensions:
85
- - name: logons
86
- - name: oracledb.physical_disk_read_writes
87
- description: Physical Disk Reads/Writes
88
- unit: "events/s"
89
- chart_type: area
90
- dimensions:
91
- - name: reads
92
- - name: writes
93
- - name: oracledb.sorts_on_disks
94
- description: Sorts On Disk
95
- unit: "events/s"
96
- chart_type: line
97
- dimensions:
98
- - name: sorts
99
- - name: oracledb.full_table_scans
100
- description: Full Table Scans
101
- unit: "events/s"
102
- chart_type: line
103
- dimensions:
104
- - name: full table scans
105
- - name: oracledb.database_wait_time_ratio
106
- description: Database Wait Time Ratio
107
- unit: "%"
108
- chart_type: line
109
- dimensions:
110
- - name: wait time ratio
111
- - name: oracledb.shared_pool_free_memory
112
- description: Shared Pool Free Memory
113
- unit: "%"
114
- chart_type: line
115
- dimensions:
116
- - name: free memory
117
- - name: oracledb.in_memory_sorts_ratio
118
- description: In-Memory Sorts Ratio
119
- unit: "%"
120
- chart_type: line
121
- dimensions:
122
- - name: in-memory sorts
123
- - name: oracledb.sql_service_response_time
124
- description: SQL Service Response Time
125
- unit: "seconds"
126
- chart_type: line
127
- dimensions:
128
- - name: time
129
- - name: oracledb.user_rollbacks
130
- description: User Rollbacks
131
- unit: "events/s"
132
- chart_type: line
133
- dimensions:
134
- - name: rollbacks
135
- - name: oracledb.enqueue_timeouts
136
- description: Enqueue Timeouts
137
- unit: "events/s"
138
- chart_type: line
139
- dimensions:
140
- - name: enqueue timeouts
141
- - name: oracledb.cache_hit_ration
142
- description: Cache Hit Ratio
143
- unit: "%"
144
- chart_type: stacked
145
- dimensions:
146
- - name: buffer
147
- - name: cursor
148
- - name: library
149
- - name: row
150
- - name: oracledb.global_cache_blocks
151
- description: Global Cache Blocks Events
152
- unit: "events/s"
153
- chart_type: area
154
- dimensions:
155
- - name: corrupted
156
- - name: lost
157
- - name: oracledb.activity
158
- description: Activities
159
- unit: "events/s"
160
- chart_type: stacked
161
- dimensions:
162
- - name: parse count
163
- - name: execute count
164
- - name: user commits
165
- - name: user rollbacks
166
- - name: oracledb.wait_time
167
- description: Wait Time
168
- unit: "ms"
169
- chart_type: stacked
170
- dimensions:
171
- - name: application
172
- - name: configuration
173
- - name: administrative
174
- - name: concurrency
175
- - name: commit
176
- - name: network
177
- - name: user I/O
178
- - name: system I/O
179
- - name: scheduler
180
- - name: other
181
- - name: oracledb.tablespace_size
182
- description: Size
183
- unit: "KiB"
184
- chart_type: line
185
- dimensions:
186
- - name: a dimension per active tablespace
187
- - name: oracledb.tablespace_usage
188
- description: Usage
189
- unit: "KiB"
190
- chart_type: line
191
- dimensions:
192
- - name: a dimension per active tablespace
193
- - name: oracledb.tablespace_usage_in_percent
194
- description: Usage
195
- unit: "%"
196
- chart_type: line
197
- dimensions:
198
- - name: a dimension per active tablespace
199
- - name: oracledb.allocated_size
200
- description: Size
201
- unit: "B"
202
- chart_type: line
203
- dimensions:
204
- - name: a dimension per active tablespace
205
- - name: oracledb.allocated_usage
206
- description: Usage
207
- unit: "B"
208
- chart_type: line
209
- dimensions:
210
- - name: a dimension per active tablespace
211
- - name: oracledb.allocated_usage_in_percent
212
- description: Usage
213
- unit: "%"
214
- chart_type: line
215
- dimensions:
216
- - name: a dimension per active tablespace
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
collectors/python.d.plugin/riakkv/metadata.yaml
+314
-257
@@ -1,82 +1,139 @@
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
6
- link: ''
7
+ link: "https://riak.com/products/riak-kv/index.html"
8
categories:
8
- - data-collection.database-servers
9
- icon_filename: 'riak.svg'
9
+ - data-collection.database-servers
10
+ icon_filename: "riak.svg"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - database
18
+ - nosql
19
+ - big data
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Examine RiakKV metrics for optimal key-value database performance. Netdata provides comprehensive dashboards and anomaly detection for efficient database operations.'
20
- method_description: ''
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:
26
- description: ''
31
+ description: ""
32
default_behavior:
33
auto_detection:
29
- description: ''
34
+ description: "If the /stats endpoint is accessible, RiakKV instances on the local host running on port 8098 will be autodetected."
35
limits:
31
- description: ''
36
+ description: ""
37
performance_impact:
33
- description: ''
38
+ description: ""
39
setup:
40
prerequisites:
36
- list: []
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:
39
- name: ''
40
- description: ''
49
+ name: "python.d/riakkv.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: url
83
+ description: The url of the server
84
+ default_value: no
85
+ required: true
86
examples:
87
folding:
88
enabled: true
50
- title: ''
51
- list: []
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
99
+ 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:
56
-- name: riakkv_1h_kv_get_mean_latency
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
58
- metric: riak.kv.latency.get
59
- info: average time between reception of client GET request and subsequent response to client over the last hour
60
-- name: riakkv_kv_get_slow
61
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
62
- metric: riak.kv.latency.get
63
- 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
64
-- name: riakkv_1h_kv_put_mean_latency
65
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
66
- metric: riak.kv.latency.put
67
- info: average time between reception of client PUT request and subsequent response to the client over the last hour
68
-- name: riakkv_kv_put_slow
69
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
70
- metric: riak.kv.latency.put
71
- 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
72
-- name: riakkv_vm_high_process_count
73
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
74
- metric: riak.vm
75
- info: number of processes running in the Erlang VM
76
-- name: riakkv_list_keys_active
77
- link: https://github.com/netdata/netdata/blob/master/health/health.d/riakkv.conf
78
- metric: riak.core.fsm_active
79
- info: number of currently running list keys finite state machines
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
@@ -84,217 +141,217 @@ metrics:
141
description: ""
142
availability: []
143
scopes:
87
- - name: global
88
- description: ""
89
- labels: []
90
- metrics:
91
- - name: riak.kv.throughput
92
- description: Reads & writes coordinated by this node
93
- unit: "operations/s"
94
- chart_type: line
95
- dimensions:
96
- - name: gets
97
- - name: puts
98
- - name: riak.dt.vnode_updates
99
- description: Update operations coordinated by local vnodes by data type
100
- unit: "operations/s"
101
- chart_type: line
102
- dimensions:
103
- - name: counters
104
- - name: sets
105
- - name: maps
106
- - name: riak.search
107
- description: Search queries on the node
108
- unit: "queries/s"
109
- chart_type: line
110
- dimensions:
111
- - name: queries
112
- - name: riak.search.documents
113
- description: Documents indexed by search
114
- unit: "documents/s"
115
- chart_type: line
116
- dimensions:
117
- - name: indexed
118
- - name: riak.consistent.operations
119
- description: Consistent node operations
120
- unit: "operations/s"
121
- chart_type: line
122
- dimensions:
123
- - name: gets
124
- - name: puts
125
- - name: riak.kv.latency.get
126
- description: Time between reception of a client GET request and subsequent response to client
127
- unit: "ms"
128
- chart_type: line
129
- dimensions:
130
- - name: mean
131
- - name: median
132
- - name: '95'
133
- - name: '99'
134
- - name: '100'
135
- - name: riak.kv.latency.put
136
- description: Time between reception of a client PUT request and subsequent response to client
137
- unit: "ms"
138
- chart_type: line
139
- dimensions:
140
- - name: mean
141
- - name: median
142
- - name: '95'
143
- - name: '99'
144
- - name: '100'
145
- - name: riak.dt.latency.counter_merge
146
- description: Time it takes to perform an Update Counter operation
147
- unit: "ms"
148
- chart_type: line
149
- dimensions:
150
- - name: mean
151
- - name: median
152
- - name: '95'
153
- - name: '99'
154
- - name: '100'
155
- - name: riak.dt.latency.set_merge
156
- description: Time it takes to perform an Update Set operation
157
- unit: "ms"
158
- chart_type: line
159
- dimensions:
160
- - name: mean
161
- - name: median
162
- - name: '95'
163
- - name: '99'
164
- - name: '100'
165
- - name: riak.dt.latency.map_merge
166
- description: Time it takes to perform an Update Map operation
167
- unit: "ms"
168
- chart_type: line
169
- dimensions:
170
- - name: mean
171
- - name: median
172
- - name: '95'
173
- - name: '99'
174
- - name: '100'
175
- - name: riak.search.latency.query
176
- description: Search query latency
177
- unit: "ms"
178
- chart_type: line
179
- dimensions:
180
- - name: median
181
- - name: min
182
- - name: '95'
183
- - name: '99'
184
- - name: '999'
185
- - name: max
186
- - name: riak.search.latency.index
187
- description: Time it takes Search to index a new document
188
- unit: "ms"
189
- chart_type: line
190
- dimensions:
191
- - name: median
192
- - name: min
193
- - name: '95'
194
- - name: '99'
195
- - name: '999'
196
- - name: max
197
- - name: riak.consistent.latency.get
198
- description: Strongly consistent read latency
199
- unit: "ms"
200
- chart_type: line
201
- dimensions:
202
- - name: mean
203
- - name: median
204
- - name: '95'
205
- - name: '99'
206
- - name: '100'
207
- - name: riak.consistent.latency.put
208
- description: Strongly consistent write latency
209
- unit: "ms"
210
- chart_type: line
211
- dimensions:
212
- - name: mean
213
- - name: median
214
- - name: '95'
215
- - name: '99'
216
- - name: '100'
217
- - name: riak.vm
218
- description: Total processes running in the Erlang VM
219
- unit: "total"
220
- chart_type: line
221
- dimensions:
222
- - name: processes
223
- - name: riak.vm.memory.processes
224
- description: Memory allocated & used by Erlang processes
225
- unit: "MB"
226
- chart_type: line
227
- dimensions:
228
- - name: allocated
229
- - name: used
230
- - name: riak.kv.siblings_encountered.get
231
- description: Number of siblings encountered during GET operations by this node during the past minute
232
- unit: "siblings"
233
- chart_type: line
234
- dimensions:
235
- - name: mean
236
- - name: median
237
- - name: '95'
238
- - name: '99'
239
- - name: '100'
240
- - name: riak.kv.objsize.get
241
- description: Object size encountered by this node during the past minute
242
- unit: "KB"
243
- chart_type: line
244
- dimensions:
245
- - name: mean
246
- - name: median
247
- - name: '95'
248
- - name: '99'
249
- - name: '100'
250
- - name: riak.search.vnodeq_size
251
- description: Number of unprocessed messages in the vnode message queues of Search on this node in the past minute
252
- unit: "messages"
253
- chart_type: line
254
- dimensions:
255
- - name: mean
256
- - name: median
257
- - name: '95'
258
- - name: '99'
259
- - name: '100'
260
- - name: riak.search.index
261
- description: Number of document index errors encountered by Search
262
- unit: "errors"
263
- chart_type: line
264
- dimensions:
265
- - name: errors
266
- - name: riak.core.protobuf_connections
267
- description: Protocol buffer connections by status
268
- unit: "connections"
269
- chart_type: line
270
- dimensions:
271
- - name: active
272
- - name: riak.core.repairs
273
- description: Number of repair operations this node has coordinated
274
- unit: "repairs"
275
- chart_type: line
276
- dimensions:
277
- - name: read
278
- - name: riak.core.fsm_active
279
- description: Active finite state machines by kind
280
- unit: "fsms"
281
- chart_type: line
282
- dimensions:
283
- - name: get
284
- - name: put
285
- - name: secondary index
286
- - name: list keys
287
- - name: riak.core.fsm_rejected
288
- description: Finite state machines being rejected by Sidejobs overload protection
289
- unit: "fsms"
290
- chart_type: line
291
- dimensions:
292
- - name: get
293
- - name: put
294
- - name: riak.search.index
295
- description: Number of writes to Search failed due to bad data format by reason
296
- unit: "writes"
297
- chart_type: line
298
- dimensions:
299
- - name: bad_entry
300
- - name: extract_fail
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
collectors/python.d.plugin/tomcat/metadata.yaml
+155
-86
@@ -3,52 +3,121 @@ meta:
3
module_name: tomcat
4
monitored_instance:
5
name: Tomcat
6
- link: ''
6
+ link: "https://tomcat.apache.org/"
7
categories:
8
- - data-collection.web-servers-and-web-proxies
9
- icon_filename: 'tomcat.png'
8
+ - data-collection.web-servers-and-web-proxies
9
+ icon_filename: "tomcat.png"
10
related_resources:
11
integrations:
12
list: []
13
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
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:
19
- metrics_description: 'Monitor Tomcat performance with Netdata for optimal Java servlet container operations. Improve your web application performance with real-time Tomcat metrics.'
20
- method_description: ''
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:
26
- description: ''
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:
29
- description: ''
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:
31
- description: ''
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:
33
- description: ''
41
+ description: ""
42
setup:
43
prerequisites:
36
- list: []
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:
39
- name: ''
40
- description: ''
49
+ name: "python.d/tomcat.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.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 per job"
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: 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: no
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: no
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: null
95
+ required: false
96
examples:
97
folding:
98
enabled: true
50
- title: ''
51
- list: []
99
+ title: "Config"
100
+ list:
101
+ - name: Basic
102
+ 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: []
@@ -60,70 +129,70 @@ metrics:
129
description: ""
130
availability: []
131
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: tomcat.accesses
68
- description: Requests
69
- unit: "requests/s"
70
- chart_type: area
71
- dimensions:
72
- - name: accesses
73
- - name: errors
74
- - name: tomcat.bandwidth
75
- description: Bandwidth
76
- unit: "KiB/s"
77
- chart_type: area
78
- dimensions:
79
- - name: sent
80
- - name: received
81
- - name: tomcat.processing_time
82
- description: processing time
83
- unit: "seconds"
84
- chart_type: area
85
- dimensions:
86
- - name: processing time
87
- - name: tomcat.threads
88
- description: Threads
89
- unit: "current threads"
90
- chart_type: area
91
- dimensions:
92
- - name: current
93
- - name: busy
94
- - name: tomcat.jvm
95
- description: JVM Memory Pool Usage
96
- unit: "MiB"
97
- chart_type: stacked
98
- dimensions:
99
- - name: free
100
- - name: eden
101
- - name: survivor
102
- - name: tenured
103
- - name: code cache
104
- - name: compressed
105
- - name: metaspace
106
- - name: tomcat.jvm_eden
107
- description: Eden Memory Usage
108
- unit: "MiB"
109
- chart_type: area
110
- dimensions:
111
- - name: used
112
- - name: committed
113
- - name: max
114
- - name: tomcat.jvm_survivor
115
- description: Survivor Memory Usage
116
- unit: "MiB"
117
- chart_type: area
118
- dimensions:
119
- - name: used
120
- - name: committed
121
- - name: max
122
- - name: tomcat.jvm_tenured
123
- description: Tenured Memory Usage
124
- unit: "MiB"
125
- chart_type: area
126
- dimensions:
127
- - name: used
128
- - name: committed
129
- - name: max
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
collectors/python.d.plugin/uwsgi/metadata.yaml
+156
-71
@@ -3,52 +3,137 @@ meta:
3
module_name: uwsgi
4
monitored_instance:
5
name: uWSGI
6
- link: ''
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.png'
8
+ - data-collection.web-servers-and-web-proxies
9
+ icon_filename: "uwsgi.png"
10
related_resources:
11
integrations:
12
list: []
13
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
14
+ description: ""
15
+ keywords:
16
+ - application server
17
+ - python
18
+ - web applications
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Monitor uWSGI performance for optimal application server operations. Monitor request rates, worker statuses, and error rates to ensure efficient application delivery.'
20
- method_description: ''
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:
26
- description: ''
29
+ description: ""
30
default_behavior:
31
auto_detection:
29
- description: ''
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:
31
- description: ''
34
+ description: ""
35
performance_impact:
33
- description: ''
36
+ description: ""
37
setup:
38
prerequisites:
36
- list: []
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:
39
- name: ''
40
- description: ''
47
+ name: "python.d/uwsgi.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: 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
50
- title: ''
51
- list: []
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
123
+ 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: []
@@ -60,55 +145,55 @@ metrics:
145
description: ""
146
availability: []
147
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: uwsgi.requests
68
- description: Requests
69
- unit: "requests/s"
70
- chart_type: stacked
71
- dimensions:
72
- - name: a dimension per worker
73
- - name: uwsgi.tx
74
- description: Transmitted data
75
- unit: "KiB/s"
76
- chart_type: stacked
77
- dimensions:
78
- - name: a dimension per worker
79
- - name: uwsgi.avg_rt
80
- description: Average request time
81
- unit: "milliseconds"
82
- chart_type: line
83
- dimensions:
84
- - name: a dimension per worker
85
- - name: uwsgi.memory_rss
86
- description: RSS (Resident Set Size)
87
- unit: "MiB"
88
- chart_type: stacked
89
- dimensions:
90
- - name: a dimension per worker
91
- - name: uwsgi.memory_vsz
92
- description: VSZ (Virtual Memory Size)
93
- unit: "MiB"
94
- chart_type: stacked
95
- dimensions:
96
- - name: a dimension per worker
97
- - name: uwsgi.exceptions
98
- description: Exceptions
99
- unit: "exceptions"
100
- chart_type: line
101
- dimensions:
102
- - name: exceptions
103
- - name: uwsgi.harakiris
104
- description: Harakiris
105
- unit: "harakiris"
106
- chart_type: line
107
- dimensions:
108
- - name: harakiris
109
- - name: uwsgi.respawns
110
- description: Respawns
111
- unit: "respawns"
112
- chart_type: line
113
- dimensions:
114
- - name: respawns
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