From eac98d8eae392ac41e77c33b20a758abcad79386 Mon Sep 17 00:00:00 2001 From: Julien Lafont Date: Thu, 31 Mar 2022 11:42:51 +0200 Subject: [PATCH] Documentation of the "sinks" config required to activate reporters Hello, I noticed that the readme was missing instructions to activate other reporters than Prometheus. The "sinks" configuration should indeed list all active reporters. I have described this mechanism in the readme. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 03450493..ddc01422 100644 --- a/README.md +++ b/README.md @@ -245,6 +245,8 @@ It is possible to report (either one, multiple or all): - to graphite via the config `kafka-lag-exporter.reporters.graphite` - as prometheus via the config `kafka-lag-exporter.reporters.prometheus` +You must also specify the active reporters in the `kafka-lag-exporter.sinks` config. + See section below for more information. ### Configuration @@ -262,7 +264,8 @@ General Configuration (`kafka-lag-exporter{}`) | `reporters.influxdb.database` | `kafka_lag_exporter` | The influxdb database to send metrics to | | `reporters.influxdb.username` | None | The influxdb username to connect (if not set, username will be empty) | | `reporters.influxdb.password` | None | The influxdb password to connect (if not set, password will be empty) | -| `reporters.influxdb.async` | `true` | Flag to enable influxdb async **non-blocking** write mode to send metrics | +| `reporters.influxdb.async` | `true` | Flag to enable influxdb async **non-blocking** write mode to send metrics +| `sinks` | `["PrometheusEndpointSink"]` | Specify which reporters must be used to send metrics. Possible values are: `PrometheusEndpointSink`, `InfluxDBPusherSink`, `GraphiteEndpointSink`. (if not set, only Prometheus is activated) | `poll-interval` | `30 seconds` | How often to poll Kafka for latest and group offsets | | `lookup-table-size` | `60` | The maximum window size of the look up table **per partition** | | `client-group-id` | `kafkalagexporter` | Consumer group id of kafka-lag-exporter's client connections |