blob: 3826b22c72c7cbad8129b23aadaa5012ff3f65a4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
plugin_name: python.d.plugin
modules:
- meta:
plugin_name: python.d.plugin
module_name: openldap
monitored_instance:
name: OpenLDAP
link: "https://www.openldap.org/"
categories:
- data-collection.authentication-and-authorization
icon_filename: "statsd.png"
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
keywords:
- openldap
- RBAC
- Directory access
most_popular: false
overview:
data_collection:
metrics_description: "This collector monitors OpenLDAP metrics about connections, operations, referrals and more."
method_description: |
Statistics are taken from the monitoring interface of a openLDAP (slapd) server
supported_platforms:
include: []
exclude: []
multi_instance: false
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: |
This collector doesn't work until all the prerequisites are checked.
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list:
- title: Configure the openLDAP server to expose metrics to monitor it.
description: |
Follow instructions from https://www.openldap.org/doc/admin24/monitoringslapd.html to activate monitoring interface.
- title: Install python-ldap module
description: |
Install python ldap module
1. From pip package manager
```bash
pip install ldap
```
2. With apt package manager (in most deb based distros)
```bash
apt-get install python-ldap
```
3. With yum package manager (in most rpm based distros)
```bash
yum install python-ldap
```
- title: Insert credentials for Netdata to access openLDAP server
description: |
Use the `ldappasswd` utility to set a password for the username you will use.
configuration:
file:
name: "python.d/openldap.conf"
options:
description: |
There are 2 sections:
* Global variables
* One or more JOBS that can define multiple different instances to monitor.
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.
Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
folding:
title: "Config options"
enabled: true
list:
- name: update_every
description: Sets the default data collection frequency.
default_value: 5
required: false
- name: priority
description: Controls the order of charts at the netdata dashboard.
default_value: 60000
required: false
- name: autodetection_retry
description: Sets the job re-check interval in seconds.
default_value: 0
required: false
- name: penalty
description: Indicates whether to apply penalty to update_every in case of failures.
default_value: yes
required: false
- name: name
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.
default_value: ""
required: false
- name: username
description: The bind user with right to access monitor statistics
default_value: ""
required: true
- name: password
description: The password for the binded user
default_value: ""
required: true
- name: server
description: The listening address of the LDAP server. In case of TLS, use the hostname which the certificate is published for.
default_value: ""
required: true
- name: port
description: The listening port of the LDAP server. Change to 636 port in case of TLS connection.
default_value: "389"
required: true
- name: use_tls
description: Make True if a TLS connection is used over ldaps://
default_value: False
required: false
- name: use_start_tls
description: Make True if a TLS connection is used over ldap://
default_value: False
required: false
- name: cert_check
description: False if you want to ignore certificate check
default_value: "True"
required: true
- name: timeout
description: Seconds to timeout if no connection exist
default_value: ""
required: true
examples:
folding:
enabled: true
title: "Config"
list:
- name: Basic
description: A basic example configuration.
folding:
enabled: false
config: |
username: "cn=admin"
password: "pass"
server: "localhost"
port: "389"
check_cert: True
timeout: 1
troubleshooting:
problems:
list: []
alerts: []
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: "These metrics refer to the entire monitored application."
labels: []
metrics:
- name: openldap.total_connections
description: Total Connections
unit: "connections/s"
chart_type: line
dimensions:
- name: connections
- name: openldap.traffic_stats
description: Traffic
unit: "KiB/s"
chart_type: line
dimensions:
- name: sent
- name: openldap.operations_status
description: Operations Status
unit: "ops/s"
chart_type: line
dimensions:
- name: completed
- name: initiated
- name: openldap.referrals
description: Referrals
unit: "referrals/s"
chart_type: line
dimensions:
- name: sent
- name: openldap.entries
description: Entries
unit: "entries/s"
chart_type: line
dimensions:
- name: sent
- name: openldap.ldap_operations
description: Operations
unit: "ops/s"
chart_type: line
dimensions:
- name: bind
- name: search
- name: unbind
- name: add
- name: delete
- name: modify
- name: compare
- name: openldap.waiters
description: Waiters
unit: "waiters/s"
chart_type: line
dimensions:
- name: write
- name: read
|
