{"id":19188566,"url":"https://github.com/blakelead/couchbase_exporter","last_synced_at":"2025-04-20T06:32:55.088Z","repository":{"id":56579037,"uuid":"143576861","full_name":"blakelead/couchbase_exporter","owner":"blakelead","description":"Export metrics from Couchbase Server for Prometheus consumption","archived":false,"fork":false,"pushed_at":"2020-02-24T11:39:47.000Z","size":484,"stargazers_count":35,"open_issues_count":6,"forks_count":18,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-06-20T17:38:57.131Z","etag":null,"topics":["couchbase","exporter","metrics","prometheus"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blakelead.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-05T02:16:48.000Z","updated_at":"2024-05-04T09:10:47.000Z","dependencies_parsed_at":"2022-08-15T21:20:33.494Z","dependency_job_id":null,"html_url":"https://github.com/blakelead/couchbase_exporter","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blakelead%2Fcouchbase_exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blakelead%2Fcouchbase_exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blakelead%2Fcouchbase_exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blakelead%2Fcouchbase_exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blakelead","download_url":"https://codeload.github.com/blakelead/couchbase_exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223820310,"owners_count":17208421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["couchbase","exporter","metrics","prometheus"],"created_at":"2024-11-09T11:25:19.296Z","updated_at":"2024-11-09T11:25:19.922Z","avatar_url":"https://github.com/blakelead.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Couchbase Exporter\n\n[![Build Status](https://travis-ci.com/blakelead/couchbase_exporter.svg?branch=master)](https://travis-ci.org/blakelead/couchbase_exporter)\n[![Coverage Status](https://coveralls.io/repos/github/blakelead/couchbase_exporter/badge.svg?branch=master)](https://coveralls.io/github/blakelead/couchbase_exporter?branch=master)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](/LICENSE.txt)\n\nExpose metrics from Couchbase cluster for consumption by Prometheus.\n\n## News\n\nCouchbase has released an official exporter: [couchbase-exporter](https://github.com/couchbase/couchbase-exporter).\n\n## Getting Started\n\nRun from command-line:\n\n```bash\n./couchbase_exporter [flags]\n```\n\nThe exporter supports various configuration ways: command-line arguments takes precedence over environment variables that take precedence over configuration file.\n\nConfiguration file can be provided on the command line. It must be written in json or yaml. If none is provided using the command line `--config.file` option, it will look for a file named `config.json` or `config.yml` in the same directory that the exporter binary. You can find complete examples of configuation files in the sources (directory `examples`).\n\nAs for available flags and equivalent environment variables, here is a list:\n\n|     environment variable      |      argument       |                    description                     |        default        |\n| ----------------------------- | ------------------- | -------------------------------------------------- | --------------------- |\n|                               | -config.file        | Configuration file to load data from               |                       |\n| CB_EXPORTER_LISTEN_ADDR       | -web.listen-address | Address to listen on for HTTP requests             | :9191                 |\n| CB_EXPORTER_TELEMETRY_PATH    | -web.telemetry-path | Path under which to expose metrics                 | /metrics              |\n| CB_EXPORTER_SERVER_TIMEOUT    | -web.timeout        | Server read timeout in seconds                     | 10s                   |\n| CB_EXPORTER_DB_URI            | -db.uri             | Address of Couchbase cluster                       | http://127.0.0.1:8091 |\n| CB_EXPORTER_DB_TIMEOUT        | -db.timeout         | Couchbase client timeout in seconds                | 10s                   |\n| CB_EXPORTER_TLS_ENABLED       | -tls.enabled        | If true, enable TLS communication with the cluster | false                 |\n| CB_EXPORTER_TLS_SKIP_INSECURE | -tls.skip-insecure  | If true, certificate won't be verified             | false                 |\n| CB_EXPORTER_TLS_CA_CERT       | -tls.ca-cert        | Root certificate of the cluster                    |                       |\n| CB_EXPORTER_TLS_CLIENT_CERT   | -tls.client-cert    | Client certificate                                 |                       |\n| CB_EXPORTER_TLS_CLIENT_KEY    | -tls.client-key     | Client private key                                 |                       |\n| CB_EXPORTER_DB_USER           | *not allowed*       | Administrator username                             |                       |\n| CB_EXPORTER_DB_PASSWORD       | *not allowed*       | Administrator password                             |                       |\n| CB_EXPORTER_LOG_LEVEL         | -log.level          | Log level: info,debug,warn,error,fatal             | error                 |\n| CB_EXPORTER_LOG_FORMAT        | -log.format         | Log format: text, json                             | text                  |\n| CB_EXPORTER_SCRAPE_CLUSTER    | -scrape.cluster     | If false, wont scrape cluster metrics              | true                  |\n| CB_EXPORTER_SCRAPE_NODE       | -scrape.node        | If false, wont scrape node metrics                 | true                  |\n| CB_EXPORTER_SCRAPE_BUCKET     | -scrape.bucket      | If false, wont scrape bucket metrics               | true                  |\n| CB_EXPORTER_SCRAPE_XDCR       | -scrape.xdcr        | If false, wont scrape xdcr metrics                 | false                 |\n|                               | -help               | Command line help                                  |                       |\n\n\u003e Important: for security reasons credentials cannot be set with command line arguments.\n\n## Metrics\n\nAll metrics are listed in [resources/metrics.md](resources/metrics.md).\n\n## Docker\n\nUse it like this:\n\n```bash\ndocker run --name cbexporter -p 9191:9191 -e CB_EXPORTER_DB_USER=admin -e CB_EXPORTER_DB_PASSWORD=complicatedpassword blakelead/couchbase-exporter:latest\n```\n\n## Examples\n\nYou can find example files in `resources` directory.\n\n### Prometheus\n\nSome simple alerting rules: [resources/prometheus-alerts.yaml](resources/prometheus-alerts.yaml).\n\n### Grafana\n\nMinimal dashboard ([resources/grafana-dashboard.json](resources/grafana-dashboard.json)):\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"resources/grafana.png\" width=\"1000\"\u003e\u003c/p\u003e\n\n### Systemd\n\nYou can adapt and use the provided service template to run the exporter with systemd ([resources/couchbase-exporter.service](resources/couchbase-exporter.service)):\n\n```bash\nsudo mv couchbase-exporter.service /etc/systemd/system/couchbase-exporter.service\nsudo systemctl enable couchbase-exporter.service\nsudo systemctl start couchbase-exporter.service\n```\n\n## Contributors\n\nSpecial thanks to:\n\n- @Berchiche\n- @bitdba88\n- @CharlesRaymond1\n- @pandrieux\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblakelead%2Fcouchbase_exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblakelead%2Fcouchbase_exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblakelead%2Fcouchbase_exporter/lists"}