blakelead/couchbase-exporter

By blakelead

•Updated over 6 years ago

Prometheus exporter for Couchbase Server.

Image

1M+

Overview Tags

blakelead/couchbase-exporter repository overview

⁠Couchbase Exporter

Expose metrics from Couchbase server for consumption by Prometheus.

Go to Github⁠ page for more informations.

⁠Getting Started

$ docker run --name cbexporter -p 9191:9191 blakelead/couchbase-exporter:latest

⁠Environment variables

name	description	default
CB_EXPORTER_LISTEN_ADDR	Address to listen on for HTTP requests	127.0.0.1:9191
CB_EXPORTER_TELEMETRY_PATH	Path under which to expose metrics	/metrics
CB_EXPORTER_SERVER_TIMEOUT	Server read timeout in seconds	10s
CB_EXPORTER_DB_URI	Address of Couchbase cluster	http://127.0.0.1:8091⁠
CB_EXPORTER_DB_TIMEOUT	Couchbase client timeout in seconds	10s
CB_EXPORTER_DB_USER	Administrator username	admin
CB_EXPORTER_DB_PASSWORD	Administrator password	password
CB_EXPORTER_LOG_LEVEL	Log level: info,debug,warn,error,fatal	info
CB_EXPORTER_LOG_FORMAT	Log format: text, json	text
CB_EXPORTER_SCRAPE_CLUSTER	If false, wont scrape cluster metrics	true
CB_EXPORTER_SCRAPE_NODE	If false, wont scrape node metrics	true
CB_EXPORTER_SCRAPE_BUCKET	If false, wont scrape bucket metrics	true
CB_EXPORTER_SCRAPE_XDCR	If false, wont scrape XDCR metrics	true

Full example:

## run docker container
$ docker run --name cbexporter \
                     --publish 9191:9191 \
                     --env CB_EXPORTER_LISTEN_ADDR=:9191 \
                     --env CB_EXPORTER_TELEMETRY_PATH=/metrics \
                     --env CB_EXPORTER_SERVER_TIMEOUT=10s \
                     --env CB_EXPORTER_LOG_LEVEL=debug \
                     --env CB_EXPORTER_LOG_FORMAT=json \
                     --env CB_EXPORTER_DB_URI=http://cb.local:8091 \
                     --env CB_EXPORTER_DB_TIMEOUT=10s \
                     --env CB_EXPORTER_DB_USER=admin \
                     --env CB_EXPORTER_DB_PASSWORD=password \
                     --env CB_EXPORTER_SCRAPE_CLUSTER=true \
                     --env CB_EXPORTER_SCRAPE_NODE=true \
                     --env CB_EXPORTER_SCRAPE_BUCKET=false \
                     --env CB_EXPORTER_SCRAPE_XDCR=false \
                     blakelead/couchbase-exporter:latest

## get metrics
$ curl http://localhost:9191/metrics
# HELP cb_cluster_balanced Status of cluster balance
# TYPE cb_cluster_balanced gauge
cb_cluster_balanced 1
# HELP cb_cluster_data_ram_quota_bytes Memory quota allocated to Data buckets
# TYPE cb_cluster_data_ram_quota_bytes gauge
cb_cluster_data_ram_quota_bytes 2.147483648e+09
# HELP cb_cluster_disk_free_bytes Free disk space in the cluster
# TYPE cb_cluster_disk_free_bytes gauge
cb_cluster_disk_free_bytes 5.7707573904e+10
# HELP cb_cluster_disk_quota_total_bytes Disk space quota for the cluster
# TYPE cb_cluster_disk_quota_total_bytes gauge
cb_cluster_disk_quota_total_bytes 6.2725623808e+10
...
...

⁠Metrics

For a complete list of metrics, please go to the Github page⁠.

Tag summary

Recent tags

Content type

Image

Digest

Size

8.7 MB

Last updated

over 6 years ago

docker pull blakelead/couchbase-exporter