{"id":18418571,"url":"https://github.com/bsm/rumour","last_synced_at":"2025-04-13T05:54:48.308Z","repository":{"id":44666950,"uuid":"160495579","full_name":"bsm/rumour","owner":"bsm","description":" Kafka Consumer Monitoring and Reporting","archived":false,"fork":false,"pushed_at":"2022-02-01T08:51:03.000Z","size":41,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T05:54:45.110Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bsm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-05T09:44:15.000Z","updated_at":"2022-01-31T16:13:12.000Z","dependencies_parsed_at":"2022-09-25T00:00:50.154Z","dependency_job_id":null,"html_url":"https://github.com/bsm/rumour","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsm%2Frumour","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsm%2Frumour/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsm%2Frumour/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsm%2Frumour/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bsm","download_url":"https://codeload.github.com/bsm/rumour/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670502,"owners_count":21142901,"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":[],"created_at":"2024-11-06T04:14:01.744Z","updated_at":"2025-04-13T05:54:48.275Z","avatar_url":"https://github.com/bsm.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rumour\n\n[![GoDoc](https://godoc.org/github.com/bsm/rumour?status.svg)](https://godoc.org/github.com/bsm/rumour)\n[![Build Status](https://travis-ci.org/bsm/rumour.svg?branch=master)](https://travis-ci.org/bsm/rumour)\n[![Go Report Card](https://goreportcard.com/badge/github.com/bsm/rumour)](https://goreportcard.com/report/github.com/bsm/rumour)\n\nRumour is a leaner, meaner and more easily configurable version of LinkedIn's [Burrow](https://github.com/linkedin/Burrow). It is a small binary which can perform continuous monitoring tasks of [Apache Kafka](https://kafka.apache.org/) consumer states, offsets and lags.\n\n## Setup\n\nDownload the latest release from [GitHub](https://github.com/bsm/rumour/releases) or run it directly via Docker:\n\n```shell\ndocker run --rm \\\n  -e RUMOUR_CLUSTERS=default \\\n  -e RUMOUR_DEFAULT_BROKERS=kafka:9092 \\\n  blacksquaremedia/rumour:latest\n```\n\n## Configuration\n\nAll configuration is done via ENV variables. The main configuration parameters are:\n\n- `RUMOUR_CLUSTERS` - a comma-separated list of cluster names to monitor. Default: `default`\n- `RUMOUR_HTTP_ADDR` - the address to listen on. Default: `:8080`.\n- `RUMOUR_LOG_LEVEL` - the log level. Default: `info`.\n- `RUMOUR_LOG_JSON` - use JSON format. Default: `false`.\n- `RUMOUR_LOG_TAGS` - additional logging tags as comma-separated map\n  `key1:value,key1:value`. Default: _none_.\n\nAdditonal configuration can be specified for each of the named clusters using the `RUMOUR_{cluster}_` prefix.\n\n- `RUMOUR_{cluster}_BROKERS` - a comma-separated list of broker addresses.\n- `RUMOUR_{cluster}_META_REFRESH` - metadata refresh interval. Default: 180s.\n- `RUMOUR_{cluster}_OFFSET_REFRESH` - offset refresh interval. Default: 30s.\n\nExample:\n\n```shell\nRUMOUR_CLUSTERS=main,prio \\\nRUMOUR_MAIN_BROKERS=10.0.0.1:9092,10.0.0.2:9092,10.0.0.3:9092 \\\nRUMOUR_PRIO_BROKERS=10.0.0.1:9192,10.0.0.2:9192,10.0.0.3:9192 \\\nRUMOUR_PRIO_META_REFRESH=120s \\\n./rumour\n```\n\n## Integrations\n\n- [datadog](./integrations/datadog/) - a Datadog check to pull metrics out of Rumour and push them to [Datadog](https://www.datadoghq.com/).\n\n## API\n\nRumour exposes metrics via a HTTP API for data collectors. It is loosely based on [Burrow's](https://github.com/linkedin/Burrow/wiki/HTTP-Endpoint) HTTP endpoints.\n\n### Error Responses\n\nFor bad requests, the API will return an appropriate HTTP status code and a JSON body containing:\n\n```json\n{\n  \"error\": true,\n  \"message\": \"Full error message\"\n}\n```\n\n### Endpoints\n\n#### Health check:\n\n```\nGET /healthz\n```\n\n#### List clusters:\n\n```\nGET /v1/clusters\n```\n\n```json\n{\n  \"clusters\": [\"main\", \"prio\"]\n}\n```\n\n#### Show cluster details:\n\n```\nGET /v1/clusters/NAME\n```\n\n```json\n{\n  \"cluster\": \"main\",\n  \"brokers\": [\"10.0.0.1:9092\", \"10.0.0.2:9092\", \"10.0.0.3:9092\"],\n  \"topics\": [\"my-topic\"],\n  \"consumers\": [\"consumer-x\", \"consumer-y\"]\n}\n```\n\n#### Show cluster topics:\n\n```\nGET /v1/clusters/NAME/topics\n```\n\n```json\n{\n  \"cluster\": \"main\",\n  \"topics\": [\"my-topic\"]\n}\n```\n\n#### Show cluster consumers:\n\n```\nGET /v1/clusters/NAME/consumers\n```\n\n```json\n{\n  \"cluster\": \"main\",\n  \"consumers\": [\"consumer-x\", \"consumer-y\"]\n}\n```\n\n#### Show topic:\n\n```\nGET /v1/clusters/NAME/topics/TOPIC\n```\n\n```json\n{\n  \"cluster\": \"main\",\n  \"topic\": \"my-topic\",\n  \"offsets\": [1041, 1042, 1043, 1044]\n}\n```\n\n#### Show consumer:\n\n```\nGET /v1/clusters/NAME/consumers/GROUP\n```\n\n```json\n{\n  \"cluster\": \"main\",\n  \"consumer\": \"consumer-x\",\n  \"topics\": [\n    {\n      \"topic\": \"my-topic\",\n      \"timestamp\": 1515151515,\n      \"offsets\": [\n        { \"offset\": 1037, \"lag\": 4 },\n        { \"offset\": 1041, \"lag\": 1 },\n        { \"offset\": 1029, \"lag\": 14 },\n        { \"offset\": 1044, \"lag\": 0 }\n      ]\n    }\n  ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbsm%2Frumour","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbsm%2Frumour","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbsm%2Frumour/lists"}