| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-couchdb |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: couchdb |
| 7 | monitored_instance: |
| 8 | name: CouchDB |
| 9 | link: https://couchdb.apache.org/ |
| 10 | icon_filename: couchdb.svg |
| 11 | categories: |
| 12 | - data-collection.databases |
| 13 | keywords: |
| 14 | - couchdb |
| 15 | - databases |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: [] |
| 19 | info_provided_to_referring_integrations: |
| 20 | description: "" |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors CouchDB servers. |
| 25 | method_description: "" |
| 26 | supported_platforms: |
| 27 | include: [] |
| 28 | exclude: [] |
| 29 | multi_instance: true |
| 30 | additional_permissions: |
| 31 | description: "" |
| 32 | default_behavior: |
| 33 | auto_detection: |
| 34 | description: "" |
| 35 | limits: |
| 36 | description: "" |
| 37 | performance_impact: |
| 38 | description: "" |
| 39 | setup: |
| 40 | prerequisites: |
| 41 | list: [] |
| 42 | configuration: |
| 43 | file: |
| 44 | name: go.d/couchdb.conf |
| 45 | options: |
| 46 | description: | |
| 47 | The following options can be defined globally: update_every, autodetection_retry. |
| 48 | folding: |
| 49 | title: Config |
| 50 | enabled: true |
| 51 | list: |
| 52 | - name: update_every |
| 53 | description: Data collection interval (seconds). |
| 54 | default_value: 10 |
| 55 | required: false |
| 56 | group: Collection |
| 57 | - name: autodetection_retry |
| 58 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 59 | default_value: 0 |
| 60 | required: false |
| 61 | group: Collection |
| 62 | |
| 63 | - name: url |
| 64 | description: Target endpoint URL. |
| 65 | default_value: http://127.0.0.1:5984 |
| 66 | required: true |
| 67 | group: Target |
| 68 | - name: node |
| 69 | description: CouchDB node name (same as the `-name` argument in `vm.args`). |
| 70 | default_value: "_local" |
| 71 | required: true |
| 72 | group: Target |
| 73 | - name: timeout |
| 74 | description: HTTP request timeout (seconds). |
| 75 | default_value: 2 |
| 76 | required: false |
| 77 | group: Target |
| 78 | |
| 79 | - name: databases |
| 80 | description: Space-separated list of databases to collect stats for. |
| 81 | default_value: "" |
| 82 | required: false |
| 83 | group: Filters |
| 84 | |
| 85 | - name: username |
| 86 | description: Username for Basic HTTP authentication. |
| 87 | default_value: "" |
| 88 | required: false |
| 89 | group: HTTP Auth |
| 90 | - name: password |
| 91 | description: Password for Basic HTTP authentication. |
| 92 | default_value: "" |
| 93 | required: false |
| 94 | group: HTTP Auth |
| 95 | - name: bearer_token_file |
| 96 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 97 | default_value: "" |
| 98 | required: false |
| 99 | group: HTTP Auth |
| 100 | |
| 101 | - name: tls_skip_verify |
| 102 | description: Skip TLS certificate and hostname verification (insecure). |
| 103 | default_value: no |
| 104 | required: false |
| 105 | group: TLS |
| 106 | - name: tls_ca |
| 107 | description: Path to CA bundle used to validate the server certificate. |
| 108 | default_value: "" |
| 109 | required: false |
| 110 | group: TLS |
| 111 | - name: tls_cert |
| 112 | description: Path to client TLS certificate (for mTLS). |
| 113 | default_value: "" |
| 114 | required: false |
| 115 | group: TLS |
| 116 | - name: tls_key |
| 117 | description: Path to client TLS private key (for mTLS). |
| 118 | default_value: "" |
| 119 | required: false |
| 120 | group: TLS |
| 121 | |
| 122 | - name: proxy_url |
| 123 | description: HTTP proxy URL. |
| 124 | default_value: "" |
| 125 | required: false |
| 126 | group: Proxy |
| 127 | - name: proxy_username |
| 128 | description: Username for proxy Basic HTTP authentication. |
| 129 | default_value: "" |
| 130 | required: false |
| 131 | group: Proxy |
| 132 | - name: proxy_password |
| 133 | description: Password for proxy Basic HTTP authentication. |
| 134 | default_value: "" |
| 135 | required: false |
| 136 | group: Proxy |
| 137 | |
| 138 | - name: method |
| 139 | description: HTTP method to use. |
| 140 | default_value: "GET" |
| 141 | required: false |
| 142 | group: Request |
| 143 | - name: body |
| 144 | description: Request body (e.g., for POST/PUT). |
| 145 | default_value: "" |
| 146 | required: false |
| 147 | group: Request |
| 148 | - name: headers |
| 149 | description: "Additional HTTP headers (one per line as key: value)." |
| 150 | default_value: "" |
| 151 | required: false |
| 152 | group: Request |
| 153 | - name: not_follow_redirects |
| 154 | description: Do not follow HTTP redirects. |
| 155 | default_value: no |
| 156 | required: false |
| 157 | group: Request |
| 158 | - name: force_http2 |
| 159 | description: Force HTTP/2 (including h2c over TCP). |
| 160 | default_value: no |
| 161 | required: false |
| 162 | group: Request |
| 163 | |
| 164 | - name: vnode |
| 165 | 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). |
| 166 | default_value: "" |
| 167 | required: false |
| 168 | group: Virtual Node |
| 169 | examples: |
| 170 | folding: |
| 171 | title: Config |
| 172 | enabled: true |
| 173 | list: |
| 174 | - name: Basic |
| 175 | description: An example configuration. |
| 176 | folding: |
| 177 | title: Example |
| 178 | enabled: true |
| 179 | config: | |
| 180 | jobs: |
| 181 | - name: local |
| 182 | url: http://127.0.0.1:5984 |
| 183 | - name: Basic HTTP auth |
| 184 | description: > |
| 185 | Local server with basic HTTP authentication, node name and multiple databases defined. |
| 186 | Make sure to match the node name with the `NODENAME` value in your CouchDB's `etc/vm.args` file. |
| 187 | Typically, this is of the form `couchdb@fully.qualified.domain.name` in a cluster, or `couchdb@127.0.0.1` for a single-node server. |
| 188 | config: | |
| 189 | jobs: |
| 190 | - name: local |
| 191 | url: http://127.0.0.1:5984 |
| 192 | node: couchdb@127.0.0.1 |
| 193 | databases: my-db other-db |
| 194 | username: foo |
| 195 | password: bar |
| 196 | - name: Multi-instance |
| 197 | description: | |
| 198 | > **Note**: When you define multiple jobs, their names must be unique. |
| 199 | |
| 200 | Collecting metrics from local and remote instances. |
| 201 | config: | |
| 202 | jobs: |
| 203 | - name: local |
| 204 | url: http://127.0.0.1:5984 |
| 205 | |
| 206 | - name: remote |
| 207 | url: http://203.0.113.0:5984 |
| 208 | troubleshooting: |
| 209 | problems: |
| 210 | list: [] |
| 211 | alerts: [] |
| 212 | metrics: |
| 213 | folding: |
| 214 | title: Metrics |
| 215 | enabled: false |
| 216 | description: "" |
| 217 | availability: [] |
| 218 | scopes: |
| 219 | - name: global |
| 220 | description: These metrics refer to the entire monitored application. |
| 221 | labels: [] |
| 222 | metrics: |
| 223 | - name: couchdb.activity |
| 224 | description: Overall Activity |
| 225 | unit: requests/s |
| 226 | chart_type: stacked |
| 227 | dimensions: |
| 228 | - name: db_reads |
| 229 | - name: db_writes |
| 230 | - name: view_reads |
| 231 | - name: couchdb.request_methods |
| 232 | description: HTTP request methods |
| 233 | unit: requests/s |
| 234 | chart_type: stacked |
| 235 | dimensions: |
| 236 | - name: copy |
| 237 | - name: delete |
| 238 | - name: get |
| 239 | - name: head |
| 240 | - name: options |
| 241 | - name: post |
| 242 | - name: put |
| 243 | - name: couchdb.response_codes |
| 244 | description: HTTP response status codes |
| 245 | unit: responses/s |
| 246 | chart_type: stacked |
| 247 | dimensions: |
| 248 | - name: "200" |
| 249 | - name: "201" |
| 250 | - name: "202" |
| 251 | - name: "204" |
| 252 | - name: "206" |
| 253 | - name: "301" |
| 254 | - name: "302" |
| 255 | - name: "304" |
| 256 | - name: "400" |
| 257 | - name: "401" |
| 258 | - name: "403" |
| 259 | - name: "404" |
| 260 | - name: "406" |
| 261 | - name: "409" |
| 262 | - name: "412" |
| 263 | - name: "413" |
| 264 | - name: "414" |
| 265 | - name: "415" |
| 266 | - name: "416" |
| 267 | - name: "417" |
| 268 | - name: "500" |
| 269 | - name: "501" |
| 270 | - name: "503" |
| 271 | - name: couchdb.response_code_classes |
| 272 | description: HTTP response status code classes |
| 273 | unit: responses/s |
| 274 | chart_type: stacked |
| 275 | dimensions: |
| 276 | - name: 2xx |
| 277 | - name: 3xx |
| 278 | - name: 4xx |
| 279 | - name: 5xx |
| 280 | - name: couchdb.active_tasks |
| 281 | description: Active task breakdown |
| 282 | unit: tasks |
| 283 | chart_type: stacked |
| 284 | dimensions: |
| 285 | - name: indexer |
| 286 | - name: db_compaction |
| 287 | - name: replication |
| 288 | - name: view_compaction |
| 289 | - name: couchdb.replicator_jobs |
| 290 | description: Replicator job breakdown |
| 291 | unit: jobs |
| 292 | chart_type: stacked |
| 293 | dimensions: |
| 294 | - name: running |
| 295 | - name: pending |
| 296 | - name: crashed |
| 297 | - name: internal_replication_jobs |
| 298 | - name: couchdb.open_files |
| 299 | description: Open files |
| 300 | unit: files |
| 301 | chart_type: line |
| 302 | dimensions: |
| 303 | - name: files |
| 304 | - name: couchdb.erlang_vm_memory |
| 305 | description: Erlang VM memory usage |
| 306 | unit: B |
| 307 | chart_type: stacked |
| 308 | dimensions: |
| 309 | - name: atom |
| 310 | - name: binaries |
| 311 | - name: code |
| 312 | - name: ets |
| 313 | - name: procs |
| 314 | - name: other |
| 315 | - name: couchdb.proccounts |
| 316 | description: Process counts |
| 317 | unit: processes |
| 318 | chart_type: line |
| 319 | dimensions: |
| 320 | - name: os_procs |
| 321 | - name: erl_procs |
| 322 | - name: couchdb.peakmsgqueue |
| 323 | description: Peak message queue size |
| 324 | unit: messages |
| 325 | chart_type: line |
| 326 | dimensions: |
| 327 | - name: peak_size |
| 328 | - name: couchdb.reductions |
| 329 | description: Erlang reductions |
| 330 | unit: reductions |
| 331 | chart_type: line |
| 332 | dimensions: |
| 333 | - name: reductions |
| 334 | - name: couchdb.db_sizes_file |
| 335 | description: Database sizes (file) |
| 336 | unit: KiB |
| 337 | chart_type: line |
| 338 | dimensions: |
| 339 | - name: a dimension per database |
| 340 | - name: couchdb.db_sizes_external |
| 341 | description: Database sizes (external) |
| 342 | unit: KiB |
| 343 | chart_type: line |
| 344 | dimensions: |
| 345 | - name: a dimension per database |
| 346 | - name: couchdb.db_sizes_active |
| 347 | description: Database sizes (active) |
| 348 | unit: KiB |
| 349 | chart_type: line |
| 350 | dimensions: |
| 351 | - name: a dimension per database |
| 352 | - name: couchdb.db_doc_count |
| 353 | description: 'Database # of docs' |
| 354 | unit: docs |
| 355 | chart_type: line |
| 356 | dimensions: |
| 357 | - name: a dimension per database |
| 358 | - name: couchdb.db_doc_del_count |
| 359 | description: 'Database # of deleted docs' |
| 360 | unit: docs |
| 361 | chart_type: line |
| 362 | dimensions: |
| 363 | - name: a dimension per database |