consumer_lag
Measure Kafka consumer backlog for up to 100 topics in one call, showing production/consumption rates, whether lag is growing or draining, and an ETA when it is shrinking.
Instructions
Measure consumer lag for 1 to 100 topics in one call through items: production and consumption rates, and whether each topic's backlog is caught up, draining, growing, stalled or has no active consumers. Returns an ETA only when lag is shrinking.
Results follow items order, each carrying index with result or error. Measuring one topic is an items array of length one.
Consumption rate is sampled for sample_seconds, so the call waits that long. Windows run concurrently, so several measurements do not add their waits together. Set skip_consume_rate for an immediate result without an ETA.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | The measurements to take, 1 to 100 of them. Measuring one topic is an array of length one. Sampling windows run concurrently, so several measurements do not add their wait times together. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| atomic | Yes | ||
| failed | Yes | ||
| applied | Yes | ||
| results | Yes | ||
| succeeded | Yes |