github.com/mackerelio/mackerel-agent-plugins@v0.89.3/mackerel-plugin-openldap/README.md (about)

     1  mackerel-plugin-openldap
     2  ====
     3  
     4  OpenLDAP custom metrics plugin for mackerel.io agent.
     5  
     6  ## Usege
     7  
     8  
     9  ### Set up your OpenLDAP server
    10  
    11  To use this plugin, you need to enable the monitoring interface of slapd.
    12  
    13  Details of setting are on this page. -> https://www.openldap.org/doc/admin24/monitoringslapd.html
    14  
    15  ## Synopsis
    16  
    17  ```shell
    18  mackerel-plugin-openldap <-bind=<bind dn>> <-pw=<password>> [-host=<hostname>] [-port=<port number>] [-tls]...
    19  
    20  options:
    21    -bind string
    22      	bind dn ("cn=config" read user dn)
    23    -host string
    24      	Hostname (default "localhost")
    25    -insecureSkipVerify
    26      	TLS accepts any certificate.
    27    -metric-key-prefix string
    28      	Metric key prefix (default "openldap")
    29    -port string
    30      	Port (default "389")
    31    -pw string
    32      	bind password
    33    -replBase string
    34      	replication base dn
    35    -replLocalBind string
    36      	replicationlocalmaster bind dn
    37    -replLocalPW string
    38      	replication local bind password
    39    -replMasterBind string
    40      	replication master bind dn
    41    -replMasterHost string
    42      	replication master hostname
    43    -replMasterPW string
    44      	replication master bind password
    45    -replMasterPort string
    46      	replication master port (default "389")
    47    -replMasterTLS
    48      	replication master TLS(ldaps)
    49    -tempfile string
    50      	Temp file name
    51    -tls
    52      	TLS(ldaps)
    53  ```
    54  ## Example of mackerel-agent.conf
    55  
    56  ```
    57  [plugin.metrics.openldap]
    58  command = '''
    59  	/path/to/mackerel-plugin-openldap 
    60  		-host localhost \
    61  		-port 636 \
    62  		-tls -insecureSkipVerify \
    63  		-bind "cn=Manager,dc=example,dc=net" \
    64  		-pw "password" \
    65  		-replBase "dc=example,dc=net" \
    66  		-replMasterBind "uid=master_user,ou=system,dc=example,dc=net" \
    67  		-replMasterPW "password" \
    68  		-replMasterHost master-server-hostname \
    69  		-replMasterPort 636 \
    70  		-replMasterTLS \
    71  		-replLocalBind "uid=local_user,ou=system,dc=example,dc=net" \
    72  		-replLocalPW "password"
    73  '''
    74  ```
    75  
    76