| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: go.d.plugin |
| 5 | module_name: openldap |
| 6 | monitored_instance: |
| 7 | name: OpenLDAP |
| 8 | link: https://www.openldap.org/ |
| 9 | categories: |
| 10 | - data-collection.applications |
| 11 | icon_filename: openldap.svg |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: |
| 18 | - openldap |
| 19 | - RBAC |
| 20 | - Directory access |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors OpenLDAP metrics about connections, operations, referrals and more. |
| 25 | method_description: | |
| 26 | It gathers the metrics using the [go-ldap](https://github.com/go-ldap/ldap) module and the [Monitor backend](https://www.openldap.org/doc/admin24/monitoringslapd.html) of OpenLDAP. |
| 27 | supported_platforms: |
| 28 | include: ["Linux"] |
| 29 | exclude: [] |
| 30 | multi_instance: true |
| 31 | additional_permissions: |
| 32 | description: "" |
| 33 | default_behavior: |
| 34 | auto_detection: |
| 35 | description: "The collector cannot auto-detect OpenLDAP instances, because credential configuration is required." |
| 36 | limits: |
| 37 | description: "" |
| 38 | performance_impact: |
| 39 | description: "" |
| 40 | setup: |
| 41 | prerequisites: |
| 42 | list: |
| 43 | - title: Enable the openLDAP Monitor Backend. |
| 44 | description: | |
| 45 | Follow instructions from https://www.openldap.org/doc/admin24/monitoringslapd.html to activate monitoring interface. |
| 46 | configuration: |
| 47 | file: |
| 48 | name: go.d/openldap.conf |
| 49 | options: |
| 50 | description: | |
| 51 | The following options can be defined globally: update_every. |
| 52 | folding: |
| 53 | title: Config options |
| 54 | enabled: true |
| 55 | list: |
| 56 | - name: update_every |
| 57 | description: Data collection interval (seconds). |
| 58 | default_value: 1 |
| 59 | required: false |
| 60 | group: Collection |
| 61 | - name: autodetection_retry |
| 62 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 63 | default_value: 0 |
| 64 | required: false |
| 65 | group: Collection |
| 66 | |
| 67 | - name: url |
| 68 | description: LDAP server URL. |
| 69 | default_value: ldap://127.0.0.1:389 |
| 70 | required: true |
| 71 | group: Target |
| 72 | - name: timeout |
| 73 | description: Connection and communication timeout (seconds). |
| 74 | default_value: 2 |
| 75 | required: false |
| 76 | group: Target |
| 77 | |
| 78 | - name: username |
| 79 | description: Distinguished Name (DN) of the user authorized to query the monitor database. |
| 80 | default_value: "" |
| 81 | required: true |
| 82 | group: Auth |
| 83 | - name: password |
| 84 | description: Password for the DN user. |
| 85 | default_value: "" |
| 86 | required: true |
| 87 | group: Auth |
| 88 | |
| 89 | - name: tls_skip_verify |
| 90 | description: Skip TLS certificate and hostname verification (insecure). |
| 91 | default_value: no |
| 92 | required: false |
| 93 | group: TLS |
| 94 | - name: tls_ca |
| 95 | description: Path to CA bundle used to validate the server certificate. |
| 96 | default_value: "" |
| 97 | required: false |
| 98 | group: TLS |
| 99 | - name: tls_cert |
| 100 | description: Path to client TLS certificate (for mTLS). |
| 101 | default_value: "" |
| 102 | required: false |
| 103 | group: TLS |
| 104 | - name: tls_key |
| 105 | description: Path to client TLS private key (for mTLS). |
| 106 | default_value: "" |
| 107 | required: false |
| 108 | group: TLS |
| 109 | |
| 110 | - name: vnode |
| 111 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 112 | default_value: "" |
| 113 | required: false |
| 114 | group: Virtual Node |
| 115 | examples: |
| 116 | folding: |
| 117 | title: "" |
| 118 | enabled: false |
| 119 | list: |
| 120 | - name: Basic |
| 121 | description: A basic example configuration. |
| 122 | config: | |
| 123 | jobs: |
| 124 | - name: local |
| 125 | url: ldap://localhost:389 |
| 126 | username: cn=netdata,dc=example,dc=com |
| 127 | password: secret |
| 128 | - name: Multi-instance |
| 129 | description: | |
| 130 | > **Note**: When you define multiple jobs, their names must be unique. |
| 131 | |
| 132 | Collecting metrics from local and remote instances. |
| 133 | config: | |
| 134 | jobs: |
| 135 | - name: local |
| 136 | url: ldap://localhost:389 |
| 137 | username: cn=netdata,dc=example,dc=com |
| 138 | password: secret |
| 139 | |
| 140 | - name: remote |
| 141 | url: ldap://192.0.2.1:389 |
| 142 | username: cn=netdata,dc=example,dc=com |
| 143 | password: secret |
| 144 | troubleshooting: |
| 145 | problems: |
| 146 | list: [] |
| 147 | alerts: [] |
| 148 | metrics: |
| 149 | folding: |
| 150 | title: Metrics |
| 151 | enabled: false |
| 152 | description: "" |
| 153 | availability: [] |
| 154 | scopes: |
| 155 | - name: global |
| 156 | description: "These metrics refer to the entire monitored application." |
| 157 | labels: [] |
| 158 | metrics: |
| 159 | - name: openldap.current_connections |
| 160 | description: Current Connections |
| 161 | unit: "connections" |
| 162 | chart_type: line |
| 163 | dimensions: |
| 164 | - name: active |
| 165 | - name: openldap.connections |
| 166 | description: Connections |
| 167 | unit: "connections/s" |
| 168 | chart_type: line |
| 169 | dimensions: |
| 170 | - name: connections |
| 171 | - name: openldap.traffic |
| 172 | description: Traffic |
| 173 | unit: "bytes/s" |
| 174 | chart_type: area |
| 175 | dimensions: |
| 176 | - name: sent |
| 177 | - name: openldap.entries |
| 178 | description: Entries |
| 179 | unit: "entries/s" |
| 180 | chart_type: line |
| 181 | dimensions: |
| 182 | - name: sent |
| 183 | - name: openldap.referrals |
| 184 | description: Referrals |
| 185 | unit: "referrals/s" |
| 186 | chart_type: line |
| 187 | dimensions: |
| 188 | - name: sent |
| 189 | - name: openldap.operations |
| 190 | description: Operations |
| 191 | unit: "operations/s" |
| 192 | chart_type: line |
| 193 | dimensions: |
| 194 | - name: completed |
| 195 | - name: initiated |
| 196 | - name: openldap.operations_by_type |
| 197 | description: Operations by Typ |
| 198 | unit: "operations/s" |
| 199 | chart_type: stacked |
| 200 | dimensions: |
| 201 | - name: bind |
| 202 | - name: search |
| 203 | - name: unbind |
| 204 | - name: add |
| 205 | - name: delete |
| 206 | - name: modify |
| 207 | - name: compare |
| 208 | - name: openldap.waiters |
| 209 | description: Waiters |
| 210 | unit: "waiters/s" |
| 211 | chart_type: line |
| 212 | dimensions: |
| 213 | - name: write |
| 214 | - name: read |