| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-zookeeper |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: zookeeper |
| 7 | monitored_instance: |
| 8 | name: ZooKeeper |
| 9 | link: https://zookeeper.apache.org/ |
| 10 | categories: |
| 11 | - data-collection.applications |
| 12 | icon_filename: zookeeper.svg |
| 13 | keywords: |
| 14 | - zookeeper |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: |
| 20 | - plugin_name: apps.plugin |
| 21 | module_name: apps |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: "" |
| 25 | method_description: | |
| 26 | It connects to the Zookeeper instance via a TCP and executes the following commands: |
| 27 | |
| 28 | - [mntr](https://zookeeper.apache.org/doc/r3.4.8/zookeeperAdmin.html#sc_zkCommands). |
| 29 | default_behavior: |
| 30 | auto_detection: |
| 31 | description: | |
| 32 | By default, it detects instances running on localhost by attempting to connect using known ZooKeeper TCP sockets: |
| 33 | |
| 34 | - 127.0.0.1:2181 |
| 35 | - 127.0.0.1:2182 |
| 36 | limits: |
| 37 | description: "" |
| 38 | performance_impact: |
| 39 | description: "" |
| 40 | additional_permissions: |
| 41 | description: "" |
| 42 | multi_instance: true |
| 43 | supported_platforms: |
| 44 | include: [] |
| 45 | exclude: [] |
| 46 | setup: |
| 47 | prerequisites: |
| 48 | list: |
| 49 | - title: Whitelist `mntr` command |
| 50 | description: | |
| 51 | Add `mntr` to Zookeeper's [4lw.commands.whitelist](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_4lw). |
| 52 | configuration: |
| 53 | file: |
| 54 | name: "go.d/zookeeper.conf" |
| 55 | options: |
| 56 | description: | |
| 57 | The following options can be defined globally: update_every, autodetection_retry. |
| 58 | folding: |
| 59 | title: Config options |
| 60 | enabled: true |
| 61 | list: |
| 62 | - name: update_every |
| 63 | description: Data collection interval (seconds). |
| 64 | default_value: 1 |
| 65 | required: false |
| 66 | group: Collection |
| 67 | - name: autodetection_retry |
| 68 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 69 | default_value: 0 |
| 70 | required: false |
| 71 | group: Collection |
| 72 | |
| 73 | - name: address |
| 74 | description: Zookeeper server address (`IP:PORT`). |
| 75 | default_value: 127.0.0.1:2181 |
| 76 | required: true |
| 77 | group: Target |
| 78 | - name: timeout |
| 79 | description: Connection, read, write, and TLS handshake timeout (seconds). |
| 80 | default_value: 1 |
| 81 | required: false |
| 82 | group: Target |
| 83 | |
| 84 | - name: use_tls |
| 85 | description: Enable TLS for the connection. |
| 86 | default_value: no |
| 87 | required: false |
| 88 | group: TLS |
| 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: Config |
| 118 | enabled: true |
| 119 | list: |
| 120 | - name: Basic |
| 121 | description: Local server. |
| 122 | config: | |
| 123 | jobs: |
| 124 | - name: local |
| 125 | address: 127.0.0.1:2181 |
| 126 | - name: TLS with self-signed certificate |
| 127 | description: Zookeeper with TLS and self-signed certificate. |
| 128 | config: | |
| 129 | jobs: |
| 130 | - name: local |
| 131 | address: 127.0.0.1:2181 |
| 132 | use_tls: yes |
| 133 | tls_skip_verify: yes |
| 134 | - name: Multi-instance |
| 135 | description: | |
| 136 | > **Note**: When you define multiple jobs, their names must be unique. |
| 137 | |
| 138 | Collecting metrics from local and remote instances. |
| 139 | config: | |
| 140 | jobs: |
| 141 | - name: local |
| 142 | address: 127.0.0.1:2181 |
| 143 | |
| 144 | - name: remote |
| 145 | address: 192.0.2.1:2181 |
| 146 | troubleshooting: |
| 147 | problems: |
| 148 | list: [] |
| 149 | alerts: [] |
| 150 | metrics: |
| 151 | folding: |
| 152 | title: Metrics |
| 153 | enabled: false |
| 154 | description: "" |
| 155 | availability: [] |
| 156 | scopes: |
| 157 | - name: ZooKeeper server |
| 158 | description: These metrics refer to ZooKeeper servers. |
| 159 | labels: [] |
| 160 | metrics: |
| 161 | - name: zookeeper.requests |
| 162 | description: Outstanding Requests |
| 163 | unit: requests |
| 164 | chart_type: line |
| 165 | dimensions: |
| 166 | - name: outstanding |
| 167 | - name: zookeeper.requests_latency |
| 168 | description: Requests Latency |
| 169 | unit: ms |
| 170 | chart_type: line |
| 171 | dimensions: |
| 172 | - name: min |
| 173 | - name: avg |
| 174 | - name: max |
| 175 | - name: zookeeper.stale_requests |
| 176 | description: Stale Requests |
| 177 | unit: requests/s |
| 178 | chart_type: line |
| 179 | dimensions: |
| 180 | - name: stale |
| 181 | - name: zookeeper.stale_requests_dropped |
| 182 | description: Stale Requests Dropped |
| 183 | unit: requests/s |
| 184 | chart_type: line |
| 185 | dimensions: |
| 186 | - name: dropped |
| 187 | - name: zookeeper.connections |
| 188 | description: Alive Connections |
| 189 | unit: connections |
| 190 | chart_type: line |
| 191 | dimensions: |
| 192 | - name: alive |
| 193 | - name: zookeeper.connections_dropped |
| 194 | description: Dropped Connections |
| 195 | unit: connections/s |
| 196 | chart_type: line |
| 197 | dimensions: |
| 198 | - name: dropped |
| 199 | - name: zookeeper.connections_rejected |
| 200 | description: Rejected Connections |
| 201 | unit: connections/s |
| 202 | chart_type: line |
| 203 | dimensions: |
| 204 | - name: rejected |
| 205 | - name: zookeeper.auth_fails |
| 206 | description: Auth Fails |
| 207 | unit: fails/s |
| 208 | chart_type: line |
| 209 | dimensions: |
| 210 | - name: auth |
| 211 | - name: zookeeper.global_sessions |
| 212 | description: Global Sessions |
| 213 | unit: sessions |
| 214 | chart_type: line |
| 215 | dimensions: |
| 216 | - name: global |
| 217 | - name: zookeeper.server_state |
| 218 | description: Server State |
| 219 | unit: state |
| 220 | chart_type: line |
| 221 | dimensions: |
| 222 | - name: leader |
| 223 | - name: follower |
| 224 | - name: observer |
| 225 | - name: standalone |
| 226 | - name: zookeeper.throttled_ops |
| 227 | description: Throttled Operations |
| 228 | unit: ops/s |
| 229 | chart_type: line |
| 230 | dimensions: |
| 231 | - name: throttled |
| 232 | - name: zookeeper.packets |
| 233 | description: Packets |
| 234 | unit: pps |
| 235 | chart_type: line |
| 236 | dimensions: |
| 237 | - name: received |
| 238 | - name: sent |
| 239 | - name: zookeeper.file_descriptor |
| 240 | description: Open File Descriptors |
| 241 | unit: file descriptors |
| 242 | chart_type: line |
| 243 | dimensions: |
| 244 | - name: open |
| 245 | - name: zookeeper.nodes |
| 246 | description: Number of Nodes |
| 247 | unit: nodes |
| 248 | chart_type: line |
| 249 | dimensions: |
| 250 | - name: znode |
| 251 | - name: ephemerals |
| 252 | - name: zookeeper.watches |
| 253 | description: Number of Watches |
| 254 | unit: watches |
| 255 | chart_type: line |
| 256 | dimensions: |
| 257 | - name: watches |
| 258 | - name: zookeeper.approximate_data_size |
| 259 | description: Approximate Data Tree Size |
| 260 | unit: KiB |
| 261 | chart_type: line |
| 262 | dimensions: |
| 263 | - name: size |
| 264 | - name: zookeeper.uptime |
| 265 | description: Uptime |
| 266 | unit: seconds |
| 267 | chart_type: line |
| 268 | dimensions: |
| 269 | - name: uptime |