github.com/netdata/go.d.plugin@v0.58.1/modules/couchdb/metadata.yaml (about) 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.database-servers 13 keywords: 14 - couchdb 15 - databases 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: false 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors CouchDB servers. 26 method_description: "" 27 supported_platforms: 28 include: [] 29 exclude: [] 30 multi_instance: true 31 additional_permissions: 32 description: "" 33 default_behavior: 34 auto_detection: 35 description: "" 36 limits: 37 description: "" 38 performance_impact: 39 description: "" 40 setup: 41 prerequisites: 42 list: [] 43 configuration: 44 file: 45 name: go.d/couchdb.conf 46 options: 47 description: | 48 The following options can be defined globally: update_every, autodetection_retry. 49 folding: 50 title: Config 51 enabled: true 52 list: 53 - name: update_every 54 description: Data collection frequency. 55 default_value: 1 56 required: false 57 - name: autodetection_retry 58 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 59 default_value: 0 60 required: false 61 - name: url 62 description: Server URL. 63 default_value: http://127.0.0.1:5984 64 required: true 65 - name: node 66 description: CouchDB node name. Same as -name vm.args argument. 67 default_value: "_local" 68 required: false 69 - name: databases 70 description: List of database names for which db-specific stats should be displayed, space separated. 71 default_value: "" 72 required: false 73 - name: username 74 description: Username for basic HTTP authentication. 75 default_value: "" 76 required: false 77 - name: password 78 description: Password for basic HTTP authentication. 79 default_value: "" 80 required: false 81 - name: proxy_url 82 description: Proxy URL. 83 default_value: "" 84 required: false 85 - name: proxy_username 86 description: Username for proxy basic HTTP authentication. 87 default_value: "" 88 required: false 89 - name: proxy_password 90 description: Password for proxy basic HTTP authentication. 91 default_value: "" 92 required: false 93 - name: timeout 94 description: HTTP request timeout. 95 default_value: 2 96 required: false 97 - name: method 98 description: HTTP request method. 99 default_value: GET 100 required: false 101 - name: body 102 description: HTTP request body. 103 default_value: "" 104 required: false 105 - name: headers 106 description: HTTP request headers. 107 default_value: "" 108 required: false 109 - name: not_follow_redirects 110 description: Redirect handling policy. Controls whether the client follows redirects. 111 default_value: false 112 required: false 113 - name: tls_skip_verify 114 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 115 default_value: false 116 required: false 117 - name: tls_ca 118 description: Certification authority that the client uses when verifying the server's certificates. 119 default_value: "" 120 required: false 121 - name: tls_cert 122 description: Client tls certificate. 123 default_value: "" 124 required: false 125 - name: tls_key 126 description: Client tls key. 127 default_value: "" 128 required: false 129 examples: 130 folding: 131 title: Config 132 enabled: true 133 list: 134 - name: Basic 135 description: An example configuration. 136 folding: 137 title: Example 138 enabled: true 139 config: | 140 jobs: 141 - name: local 142 url: http://127.0.0.1:5984 143 - name: Basic HTTP auth 144 description: > 145 Local server with basic HTTP authentication, node name and multiple databases defined. 146 Make sure to match the node name with the `NODENAME` value in your CouchDB's `etc/vm.args` file. 147 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. 148 config: | 149 jobs: 150 - name: local 151 url: http://127.0.0.1:5984 152 node: couchdb@127.0.0.1 153 databases: my-db other-db 154 username: foo 155 password: bar 156 - name: Multi-instance 157 description: | 158 > **Note**: When you define multiple jobs, their names must be unique. 159 160 Collecting metrics from local and remote instances. 161 config: | 162 jobs: 163 - name: local 164 url: http://127.0.0.1:5984 165 166 - name: remote 167 url: http://203.0.113.0:5984 168 troubleshooting: 169 problems: 170 list: [] 171 alerts: [] 172 metrics: 173 folding: 174 title: Metrics 175 enabled: false 176 description: "" 177 availability: [] 178 scopes: 179 - name: global 180 description: These metrics refer to the entire monitored application. 181 labels: [] 182 metrics: 183 - name: couchdb.activity 184 description: Overall Activity 185 unit: requests/s 186 chart_type: stacked 187 dimensions: 188 - name: db_reads 189 - name: db_writes 190 - name: view_reads 191 - name: couchdb.request_methods 192 description: HTTP request methods 193 unit: requests/s 194 chart_type: stacked 195 dimensions: 196 - name: copy 197 - name: delete 198 - name: get 199 - name: head 200 - name: options 201 - name: post 202 - name: put 203 - name: couchdb.response_codes 204 description: HTTP response status codes 205 unit: responses/s 206 chart_type: stacked 207 dimensions: 208 - name: "200" 209 - name: "201" 210 - name: "202" 211 - name: "204" 212 - name: "206" 213 - name: "301" 214 - name: "302" 215 - name: "304" 216 - name: "400" 217 - name: "401" 218 - name: "403" 219 - name: "404" 220 - name: "406" 221 - name: "409" 222 - name: "412" 223 - name: "413" 224 - name: "414" 225 - name: "415" 226 - name: "416" 227 - name: "417" 228 - name: "500" 229 - name: "501" 230 - name: "503" 231 - name: couchdb.response_code_classes 232 description: HTTP response status code classes 233 unit: responses/s 234 chart_type: stacked 235 dimensions: 236 - name: 2xx 237 - name: 3xx 238 - name: 4xx 239 - name: 5xx 240 - name: couchdb.active_tasks 241 description: Active task breakdown 242 unit: tasks 243 chart_type: stacked 244 dimensions: 245 - name: indexer 246 - name: db_compaction 247 - name: replication 248 - name: view_compaction 249 - name: couchdb.replicator_jobs 250 description: Replicator job breakdown 251 unit: jobs 252 chart_type: stacked 253 dimensions: 254 - name: running 255 - name: pending 256 - name: crashed 257 - name: internal_replication_jobs 258 - name: couchdb.open_files 259 description: Open files 260 unit: files 261 chart_type: line 262 dimensions: 263 - name: files 264 - name: couchdb.erlang_vm_memory 265 description: Erlang VM memory usage 266 unit: B 267 chart_type: stacked 268 dimensions: 269 - name: atom 270 - name: binaries 271 - name: code 272 - name: ets 273 - name: procs 274 - name: other 275 - name: couchdb.proccounts 276 description: Process counts 277 unit: processes 278 chart_type: line 279 dimensions: 280 - name: os_procs 281 - name: erl_procs 282 - name: couchdb.peakmsgqueue 283 description: Peak message queue size 284 unit: messages 285 chart_type: line 286 dimensions: 287 - name: peak_size 288 - name: couchdb.reductions 289 description: Erlang reductions 290 unit: reductions 291 chart_type: line 292 dimensions: 293 - name: reductions 294 - name: couchdb.db_sizes_file 295 description: Database sizes (file) 296 unit: KiB 297 chart_type: line 298 dimensions: 299 - name: a dimension per database 300 - name: couchdb.db_sizes_external 301 description: Database sizes (external) 302 unit: KiB 303 chart_type: line 304 dimensions: 305 - name: a dimension per database 306 - name: couchdb.db_sizes_active 307 description: Database sizes (active) 308 unit: KiB 309 chart_type: line 310 dimensions: 311 - name: a dimension per database 312 - name: couchdb.db_doc_count 313 description: 'Database # of docs' 314 unit: docs 315 chart_type: line 316 dimensions: 317 - name: a dimension per database 318 - name: couchdb.db_doc_del_count 319 description: 'Database # of deleted docs' 320 unit: docs 321 chart_type: line 322 dimensions: 323 - name: a dimension per database