Plugin: go.d.plugin Module: couchbase
This collector monitors Couchbase servers.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
This integration doesn’t support auto-detection.
The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
No action required.
The configuration file name for this integration is go.d/couchbase.conf
.
You can edit the configuration file using the edit-config
script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/couchbase.conf
The following options can be defined globally: update_every, autodetection_retry.
Name | Description | Default | Required |
---|---|---|---|
update_every | Data collection frequency. | 1 | False |
autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | False |
url | Server URL. | http://127.0.0.1:8091 | True |
username | Username for basic HTTP authentication. | False | |
password | Password for basic HTTP authentication. | False | |
proxy_url | Proxy URL. | False | |
proxy_username | Username for proxy basic HTTP authentication. | False | |
proxy_password | Password for proxy basic HTTP authentication. | False | |
timeout | HTTP request timeout. | 2 | False |
method | HTTP request method. | GET | False |
body | HTTP request body. | False | |
headers | HTTP request headers. | False | |
not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | False | False |
tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | False | False |
tls_ca | Certification authority that the client uses when verifying the server’s certificates. | False | |
tls_cert | Client tls certificate. | False | |
tls_key | Client tls key. | False |
An example configuration.
jobs:
- name: local
url: http://127.0.0.1:8091
Local server with basic HTTP authentication.
jobs:
- name: local
url: http://127.0.0.1:8091
username: foo
password: bar
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
jobs:
- name: local
url: http://127.0.0.1:8091
- name: remote
url: http://203.0.113.0:8091
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
Metric | Dimensions | Unit |
---|---|---|
couchbase.bucket_quota_percent_used | a dimension per bucket | percentage |
couchbase.bucket_ops_per_sec | a dimension per bucket | ops/s |
couchbase.bucket_disk_fetches | a dimension per bucket | fetches |
couchbase.bucket_item_count | a dimension per bucket | items |
couchbase.bucket_disk_used_stats | a dimension per bucket | bytes |
couchbase.bucket_data_used | a dimension per bucket | bytes |
couchbase.bucket_mem_used | a dimension per bucket | bytes |
couchbase.bucket_vb_active_num_non_resident | a dimension per bucket | items |
There are no alerts configured by default for this integration.
To troubleshoot issues with the couchbase
collector, run the go.d.plugin
with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
Navigate to the plugins.d
directory, usually at /usr/libexec/netdata/plugins.d/
. If that’s not the case on
your system, open netdata.conf
and look for the plugins
setting under [directories]
.
cd /usr/libexec/netdata/plugins.d/
Switch to the netdata
user.
sudo -u netdata -s
Run the go.d.plugin
to debug the collector:
./go.d.plugin -d -m couchbase