couchbase

README

Couchbase monitoring with Netdata

Couchbase is an open source, distributed, JSON document database. It exposes a scale-out, key-value store with managed cache for sub-millisecond data operations, purpose-built indexers for efficient queries and a powerful query engine for executing SQL-like queries.

Metrics

All metrics have "couchbase." prefix.

Metric	Scope	Dimensions	Units
bucket_quota_percent_used	global	a dimension per bucket	percentage
bucket_ops_per_sec	global	a dimension per bucket	ops/s
bucket_disk_fetches	global	a dimension per bucket	fetches
bucket_item_count	global	a dimension per bucket	items
bucket_disk_used_stats	global	a dimension per bucket	bytes
bucket_data_used	global	a dimension per bucket	bytes
bucket_mem_used	global	a dimension per bucket	bytes
bucket_vb_active_num_non_resident	global	a dimension per bucket	items

Charts

In this module 8 charts are supported because we collect basic stats from couchbase.

Buckets Basic Stats

Collected from /pools/default/buckets endpoint.

• Quota Percent Used Per Bucket in %
• Operations Per Second Per Bucket in ops/s
• Disk Fetches Per Bucket in fetches
• Item Count Per Bucket in items
• Disk Used Per Bucket in bytes
• Data Used Per Bucket in bytes
• Memory Used Per Bucket in bytes
• Number Of Non-Resident Items Per Bucket in items

Configuration

Edit the go.d/couchbase.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/couchbase.conf

To add a new endpoint to collect metrics from, or change the URL that Netdata looks for, add or configure the name and url values. Endpoints can be both local or remote as long as they expose their metrics on the provided URL.

Here is an example with two endpoints:

jobs:
  - name: local
    url: http://127.0.0.1:8091
    username: admin
    password: admin-password

  - name: remote
    url: http://203.0.113.0:8091
    username: admin
    password: admin-passwor

For all available options, see the Couchbase collector's configuration file.

Troubleshooting

To troubleshoot issues with the couchbase, 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
  

Documentation

Index

• type Chart
• type Charts
• type Config
• type Couchbase
  • func New() *Couchbase
  • func (cb *Couchbase) Charts() *Charts
  • func (cb *Couchbase) Check() bool
  • func (cb *Couchbase) Cleanup()
  • func (cb *Couchbase) Collect() map[string]int64
  • func (cb *Couchbase) Init() bool
• type Dim

Types

type Chart

type Chart = module.Chart

type Charts

type Charts = module.Charts

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

type Couchbase

type Couchbase struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *Couchbase

func (*Couchbase) Charts

func (cb *Couchbase) Charts() *Charts

func (*Couchbase) Check

func (cb *Couchbase) Check() bool

func (*Couchbase) Cleanup

func (cb *Couchbase) Cleanup()

func (*Couchbase) Collect

func (cb *Couchbase) Collect() map[string]int64

func (*Couchbase) Init

func (cb *Couchbase) Init() bool

type Dim

type Dim = module.Dim