surekhasaharan commented on a change in pull request #8547: Add `sys.supervisors` table to system tables URL: https://github.com/apache/incubator-druid/pull/8547#discussion_r336321281
########## File path: docs/operations/api-reference.md ########## @@ -519,9 +519,25 @@ Returns a list of objects of the currently active supervisors and their current |Field|Type|Description| |---|---|---| |`id`|String|supervisor unique identifier| -|`state`|String|basic state of the supervisor. Available states:`UNHEALTHY_SUPERVISOR`, `UNHEALTHY_TASKS`, `PENDING`, `RUNNING`, `SUSPENDED`, `STOPPING`| -|`detailedState`|String|supervisor specific state. (See documentation of specific supervisor for details)| +|`state`|String|basic state of the supervisor. Available states: `UNHEALTHY_SUPERVISOR`, `UNHEALTHY_TASKS`, `PENDING`, `RUNNING`, `SUSPENDED`, `STOPPING`. Check [Kafka Docs](../development/extensions-core/kafka-ingestion.html#operations) for details.| +|`detailedState`|String|supervisor specific state. (See documentation of the specific supervisor for details, e.g. [Kafka](../development/extensions-core/kafka-ingestion.html) or [Kinesis](../development/extensions-core/kinesis-ingestion.html))| +|`healthy`|Boolean|true or false indicator of overall supervisor health| +|`suspended`|Boolean|true or false indicator of whether the supervisor is in suspended state| + +* `/druid/indexer/v1/supervisor?fullStatus` Review comment: Since `fullStatus` is used internally for sys tables, i'm now thinking should we document it, as I think for users, the `full` query param might suffice. Not sure what is generally our stance on these kind of internal options. I think, the only reason, one would use `fullStatus` , is if they care to get `type` or `source` without digging into the `spec` object. I can either remove the `fullStatus` or add that explanation. Thoughts ? ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
