Skip to main content


Plugin: python.d.plugin Module: openldap


This collector monitors OpenLDAP metrics about connections, operations, referrals and more.

Statistics are taken from the monitoring interface of a openLDAP (slapd) server

This collector is supported on all platforms.

This collector only supports collecting metrics from a single instance of this integration.

Default Behavior


This collector doesn't work until all the prerequisites are checked.


The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.


Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per OpenLDAP instance

These metrics refer to the entire monitored application.

This scope has no labels.


openldap.operations_statuscompleted, initiatedops/s
openldap.ldap_operationsbind, search, unbind, add, delete, modify, compareops/s
openldap.waiterswrite, readwaiters/s


There are no alerts configured by default for this integration.



Configure the openLDAP server to expose metrics to monitor it.

Follow instructions from to activate monitoring interface.

Install python-ldap module

Install python ldap module

  1. From pip package manager
pip install ldap
  1. With apt package manager (in most deb based distros)
apt-get install python-ldap
  1. With yum package manager (in most rpm based distros)
yum install python-ldap

Insert credentials for Netdata to access openLDAP server

Use the ldappasswd utility to set a password for the username you will use.



The configuration file name for this integration is python.d/openldap.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config python.d/openldap.conf


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.

Config options
update_everySets the default data collection frequency.5no
priorityControls the order of charts at the netdata dashboard.60000no
autodetection_retrySets the job re-check interval in seconds.0no
penaltyIndicates whether to apply penalty to update_every in case of failures.yesno
nameJob 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
usernameThe bind user with right to access monitor statisticsyes
passwordThe password for the binded useryes
serverThe listening address of the LDAP server. In case of TLS, use the hostname which the certificate is published for.yes
portThe listening port of the LDAP server. Change to 636 port in case of TLS connection.389yes
use_tlsMake True if a TLS connection is used over ldaps://nono
use_start_tlsMake True if a TLS connection is used over ldap://nono
cert_checkFalse if you want to ignore certificate checkTrueyes
timeoutSeconds to timeout if no connection existyes



A basic example configuration.

username: "cn=admin"
password: "pass"
server: "localhost"
port: "389"
check_cert: True
timeout: 1


Debug Mode

To troubleshoot issues with the openldap collector, run the python.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the python.d.plugin to debug the collector:

    ./python.d.plugin openldap debug trace

Getting Logs

If you're encountering problems with the openldap collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep openldap

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep openldap /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep openldap

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.