aruraghuwanshi opened a new pull request, #19090:
URL: https://github.com/apache/druid/pull/19090
### Description
The Supervisor Stats API (`GET
/druid/indexer/v1/supervisor/{supervisorId}/stats`) returns task group IDs as
outer map keys and task IDs as inner map keys, but this structure was not
documented. This led automation clients (e.g., operators, tooling) to
re-implement fragile client-side task group ID computation from partition data,
which breaks with multi-topic Kafka supervisors where Druid uses a different
assignment scheme.
This PR documents the response schema and recommends using the API keys
directly.
#### Changes
- **docs/api-reference/supervisor-api.md**: Added explicit response schema
(`Map<taskGroupId, Map<taskId, RowStatsPayload>>`) under "Get supervisor
ingestion stats", plain-language notes for keys, an annotated sample response,
and guidance for automation clients to use `/stats` keys instead of re-deriving
group IDs.
- **docs/ingestion/tasks.md**: Added a paragraph in the Row stats section
describing the nested map structure and cross-referencing the Supervisor API
for full schema and automation guidance.
No code or behavior changes; documentation only.
#### Release note
Documented the Supervisor Stats API response structure so automation clients
can reliably obtain task group IDs from the API keys instead of re-deriving
them, which avoids fragility with multi-topic Kafka supervisors.
<hr>
##### Key changed/added classes in this PR
* `docs/api-reference/supervisor-api.md`
* `docs/ingestion/tasks.md`
<hr>
This PR has:
- [x] been self-reviewed.
- [x] added documentation for new or modified features or behaviors.
- [x] a release note entry in the PR description.
- [ ] added Javadocs for most classes and all non-trivial methods. Linked
related entities via Javadoc links. *(N/A - docs only)*
- [ ] added or updated version, license, or notice information in
[licenses.yaml](https://github.com/apache/druid/blob/master/dev/license.md)
*(N/A)*
- [ ] added comments explaining the "why" and the intent of the code
wherever would not be obvious for an unfamiliar reader. *(N/A - docs only)*
- [ ] added unit tests or modified existing tests to cover new code paths,
ensuring the threshold for [code
coverage](https://github.com/apache/druid/blob/master/dev/code-review/code-coverage.md)
is met. *(N/A - docs only)*
- [ ] added integration tests. *(N/A)*
- [ ] been tested in a test Druid cluster. *(N/A)*
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
