ldap_exporter

README

LDAP Prometheus Exporter

A Prometheus metrics exporter for LDAP.

This exporter allows for configurable tree attributes to be exposed as prometheus metrics, and bundles a set of useful metrics for LDAP backends it knows of (currently this is just 389 Directory Server).

Build status

Usage

Usage of ./ldap_exporter:
  -ldap.bind string
    	Ldap DN to bind to
  -ldap.password string
    	LDAP bind DN password.  Can be configured via the environment variable LDAP_PASSWORD
  -ldap.tls.ca-file string
    	If TLS is used, the path for to CA to use
  -ldap.tls.cert-file string
    	If the server requires a client cert, the path to that TLS cert.  If this is passed, -ldap.tls.key-file must also be passed
  -ldap.tls.key-file string
    	If the server requires a client key, the path to that TLS key.  If this is passed, -ldap.tls.cert-file must also be passed
  -ldap.tls.server-name string
    	If specified, expect this name for TLS handshakes rather than using the hostname parsed from -ldap.uri
  -ldap.tls.skip-verify
    	If given, do not do any verification of the server's cert.  Insecure and allows for MITM
  -ldap.uri string
    	Openldap compatible URI to connect to.  Can use ldap://, ldaps://, ldapi://
  -metrics.config string
    	YAML file holding ldap -> metrics queries.  Note if the LDAP vendor cannot be identified, this must be set
  -metrics.disable-vendor-metrics
    	By default, try to identify the LDAP vendor and load metrics for thhat vendor.  If the vendor cannot be identified or if this is enabled,, -metrics.config must be set.
  -web.listen-address string
    	The host:port to listen on for HTTP requests (default ":9095")
  -web.telemetry-path string
    	Path under which to expose metrics (default "/metrics")

Developing

This codebase uses vfsgen to manage the bundled queries to run for a given LDAP backend; that content is in assets/definitions/*.yaml.

If you're making changes to those files then you must remember to refresh assets_vfsdata.go via a go generate invocation.

If you wish to be able to make changes to the bundled definitions without rebuilding, just use the -metrics.config option to pass in the bundled metrics you're testing, and pass -metrics.disable-vendor-metrics to disable the bundled definitions.