github.com/netdata/go.d.plugin@v0.58.1/modules/couchbase/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-couchbase 5 plugin_name: go.d.plugin 6 module_name: couchbase 7 monitored_instance: 8 name: Couchbase 9 link: https://www.couchbase.com/ 10 icon_filename: couchbase.svg 11 categories: 12 - data-collection.database-servers 13 keywords: 14 - couchbase 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 Couchbase 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/couchbase.conf 46 options: 47 description: | 48 The following options can be defined globally: update_every, autodetection_retry. 49 folding: 50 title: All options 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:8091 64 required: true 65 - name: username 66 description: Username for basic HTTP authentication. 67 default_value: "" 68 required: false 69 - name: password 70 description: Password for basic HTTP authentication. 71 default_value: "" 72 required: false 73 - name: proxy_url 74 description: Proxy URL. 75 default_value: "" 76 required: false 77 - name: proxy_username 78 description: Username for proxy basic HTTP authentication. 79 default_value: "" 80 required: false 81 - name: proxy_password 82 description: Password for proxy basic HTTP authentication. 83 default_value: "" 84 required: false 85 - name: timeout 86 description: HTTP request timeout. 87 default_value: 2 88 required: false 89 - name: method 90 description: HTTP request method. 91 default_value: GET 92 required: false 93 - name: body 94 description: HTTP request body. 95 default_value: "" 96 required: false 97 - name: headers 98 description: HTTP request headers. 99 default_value: "" 100 required: false 101 - name: not_follow_redirects 102 description: Redirect handling policy. Controls whether the client follows redirects. 103 default_value: false 104 required: false 105 - name: tls_skip_verify 106 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 107 default_value: false 108 required: false 109 - name: tls_ca 110 description: Certification authority that the client uses when verifying the server's certificates. 111 default_value: "" 112 required: false 113 - name: tls_cert 114 description: Client tls certificate. 115 default_value: "" 116 required: false 117 - name: tls_key 118 description: Client tls key. 119 default_value: "" 120 required: false 121 examples: 122 folding: 123 title: Config 124 enabled: true 125 list: 126 - name: Basic 127 description: An example configuration. 128 config: | 129 jobs: 130 - name: local 131 url: http://127.0.0.1:8091 132 - name: Basic HTTP auth 133 description: Local server with basic HTTP authentication. 134 config: | 135 jobs: 136 - name: local 137 url: http://127.0.0.1:8091 138 username: foo 139 password: bar 140 - name: Multi-instance 141 description: | 142 > **Note**: When you define multiple jobs, their names must be unique. 143 144 Collecting metrics from local and remote instances. 145 config: | 146 jobs: 147 - name: local 148 url: http://127.0.0.1:8091 149 150 - name: remote 151 url: http://203.0.113.0:8091 152 troubleshooting: 153 problems: 154 list: [] 155 alerts: [] 156 metrics: 157 folding: 158 title: Metrics 159 enabled: false 160 description: "" 161 availability: [] 162 scopes: 163 - name: global 164 description: These metrics refer to the entire monitored application. 165 labels: [] 166 metrics: 167 - name: couchbase.bucket_quota_percent_used 168 description: Quota Percent Used Per Bucket 169 unit: percentage 170 chart_type: line 171 dimensions: 172 - name: a dimension per bucket 173 - name: couchbase.bucket_ops_per_sec 174 description: Operations Per Second Per Bucket 175 unit: ops/s 176 chart_type: stacked 177 dimensions: 178 - name: a dimension per bucket 179 - name: couchbase.bucket_disk_fetches 180 description: Disk Fetches Per Bucket 181 unit: fetches 182 chart_type: stacked 183 dimensions: 184 - name: a dimension per bucket 185 - name: couchbase.bucket_item_count 186 description: Item Count Per Bucket 187 unit: items 188 chart_type: stacked 189 dimensions: 190 - name: a dimension per bucket 191 - name: couchbase.bucket_disk_used_stats 192 description: Disk Used Per Bucket 193 unit: bytes 194 chart_type: stacked 195 dimensions: 196 - name: a dimension per bucket 197 - name: couchbase.bucket_data_used 198 description: Data Used Per Bucket 199 unit: bytes 200 chart_type: stacked 201 dimensions: 202 - name: a dimension per bucket 203 - name: couchbase.bucket_mem_used 204 description: Memory Used Per Bucket 205 unit: bytes 206 chart_type: stacked 207 dimensions: 208 - name: a dimension per bucket 209 - name: couchbase.bucket_vb_active_num_non_resident 210 description: Number Of Non-Resident Items Per Bucket 211 unit: items 212 chart_type: stacked 213 dimensions: 214 - name: a dimension per bucket