Date: 06-05-2022

The OpenLDAP Project developed and maintained a Python3 script to monitor replication. It is available from the Project's Repository.

This module provides tools to monitor multiprovider OpenLDAP environments in real time. Hooks are available for each change as announced by the provider, when a provider has caught up with the rest of its environment and when it is not catching up fast enough and has fallen behind. The package also provides two executables:

• a command line tool to check that servers catch up in a configured amount of time and measuring how long it took
• a rudimentary terminal application (syncmonitor) for manual monitoring

Installation and Setup

To install the syncmonitor tool, clone the OpenLDAP Project's Repository and install the required Python dependencies. The following steps outline the process:

Clone the Repository:

git clone https://github.com/openldap/syncmonitor.git
cd syncmonitor

Install Dependencies: Ensure you have Python3 installed and then run the following command to install necessary dependencies:

pip install -r requirements.txt

Configuration: Modify the configuration file (syncmonitor.conf) to specify details about your OpenLDAP environment, including provider URLs, credentials, and other parameters like polling intervals.

Usage

There are two primary ways to use syncmonitor:

Command Line Monitoring: You can use the command line tool (check.py) to ensure that all servers are catching up in the configured amount of time. This tool provides a quick check to verify the health of replication across the environment.

Example usage:

python syncmonitor/check.py --check-delay 60

This command checks whether the servers have caught up within 60 seconds and prints out the results.

Interactive Terminal Monitoring: The rudimentary terminal application (ui.py) allows for manual, real-time monitoring of replication status across all configured providers.

Example usage:

python syncmonitor/ui.py --interactive

This will open an interactive terminal interface, displaying the status of replication across your environment in real time.

Key Features

Change Hooks: The syncrepl_observer.py module provides hooks for each replication change, enabling integration with other tools or alerts. You can utilize these hooks to create notifications when certain conditions are met, such as when a server falls behind.

Catching Up Notifications: Syncmonitor notifies when a provider successfully catches up with the rest of the environment, which can help validate system stability.

Delay Alerts: Alerts are generated when replication delay exceeds the configured limit, allowing system administrators to take proactive measures.

Example Configuration

Below is an example of how to set up the syncmonitor.conf configuration file:

[default]
providers = ldap://provider1.example.com ldap://provider2.example.com
binddn = cn=admin,dc=example,dc=com
bindpw = secret
interval = 30  # Polling interval in seconds
timeout = 60   # Alert if delay exceeds this value

providers: List of provider URLs to monitor.

binddn: The distinguished name used to bind to the LDAP server.

bindpw: The password associated with the binddn.

interval: How frequently the syncmonitor tool should poll the providers for replication status.

timeout: Time (in seconds) allowed for the providers to catch up before triggering an alert.

Troubleshooting

Connection Errors: Ensure that the bind credentials are correct and that the OpenLDAP servers are reachable over the network. Check firewall settings if needed.

Replication Delays: If replication delays are consistent, consider adjusting server performance parameters, increasing resources, or checking network latency between servers.

Dependencies: Verify that all Python dependencies are installed correctly. If you run into issues, use a virtual environment to isolate dependencies:

python -m venv syncmonitor-env
source syncmonitor-env/bin/activate
pip install -r requirements.txt

Conclusion

The syncmonitor tool is a useful utility for maintaining healthy replication across multiprovider OpenLDAP environments. By providing real-time monitoring and alerts, it helps system administrators ensure that their LDAP infrastructure remains consistent and up-to-date. It is recommended to integrate syncmonitor into your monitoring workflows to proactively manage replication health and minimize service disruptions.