Sign inSign up

elfido/n1qlexporter

By elfido

•Updated about 8 years ago

Prometheus exporter for N1QL statistics

Image
0

355

elfido/n1qlexporter repository overview

⁠Prometheus N1QL Exporter

Exposes Prometheus statistics from Couchbase's N1QL monitoring APIs. Enter as many servers as you want as shown in the example:

To start a container:

docker run --rm --name test -p 8380:8380 -e CLUSTERS="{\"myserver\":\"my_ip\"}" -e HTTPUSER=couchbase_user -e="HTTPPASSWORD=couchbase_password" n1qlexporter:1.0.0

The configuration is done via environment variable or by mapping a JSON file to /app/settings.json in the following format:

{
	"httpuser": "",
	"httppassword": "",
	"usehttps": "false",
	"clusters": {
		"myClusterName": "localhost"
	}
}

You just need to provide a single host name and the exporter will discover all query nodes.

The following metrics are exposed:

Metric nameMetric typeDescription
n1ql_active_time_executionHistogramActive queries current time execution per cluster/node/query type
n1ql_active_accumulated_queriesHistogramActive queries running per node/cluster
n1ql_active_time_waitingHistogramActive queries waiting time for execution per node/cluster/query type
n1ql_active_consistencyCounterActive queries count per cluster/scan consistency
n1ql_completed_result_countHistogramCompleted (usually slow) queries count per cluster/query type
n1ql_completed_result_sizeHistogramCompleted (usually slow) queries results size (in bytes) per cluster/query type
n1ql_completed_time_executionHistogramCompleted (usually slow) queries response time per cluster/node/query type
n1ql_completed_time_waitingHistogramCompleted (usually slow) queries waiting time for execution per cluster/node/query type
n1ql_completed_primaryindexCounterCompleted (usually slow) queries using primary index scan per cluster/query type
n1ql_vitals_completed_queriesGaugeExecuted queries by cluster/node
n1ql_vitals_cpu_usageGaugecurrent CPU required by cluster/node/space (space: system or user)

Tag summary

Content type

Image

Digest

Size

5.6 MB

Last updated

about 8 years ago

docker pull elfido/n1qlexporter:1.0.1