techdocsmith commented on code in PR #15591: URL: https://github.com/apache/druid/pull/15591#discussion_r1480788198
########## docs/api-reference/supervisor-api.md: ########## @@ -1309,13 +1307,184 @@ Host: http://ROUTER_IP:ROUTER_PORT ``` </details> +### Get supervisor health + +Retrieves the current health report for a single supervisor. The health of a supervisor is determined by the supervisor's `state` (as returned by the `/status` endpoint) and the `druid.supervisor.*` Overlord configuration thresholds. + +#### URL + +<code class="getAPI">GET</code> <code>/druid/indexer/v1/supervisor/:supervisorId/health</code> + +#### Responses + +<Tabs> + +<TabItem value="18" label="200 SUCCESS"> + +*Supervisor is healthy* + +</TabItem> + +<TabItem value="19" label="404 NOT FOUND"> + +*Invalid supervisor ID* + +</TabItem> + +<TabItem value="20" label="503 SERVICE UNAVAILABLE"> + +*Supervisor is unhealthy* + +</TabItem> + +</Tabs> + +--- + +#### Sample request + +The following example shows how to retrieve the health report for a supervisor with the name `social_media`. + +<Tabs> + +<TabItem value="21" label="cURL"> + +```shell +curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/health"; +``` +</TabItem> + +<TabItem value="22" label="HTTP"> + +```HTTP +GET /druid/indexer/v1/supervisor/social_media/health HTTP/1.1 +Host: http://ROUTER_IP:ROUTER_PORT +``` +</TabItem> + +</Tabs> + +#### Sample response + +<details> + <summary>Click to show sample response</summary> + + ```json + { + "healthy": false + } + ``` +</details> + +### Get supervisor ingestion stats + +Returns a snapshot of the current ingestion row counters for each task being managed by the supervisor, along with moving averages for the row counters. See [Row stats](../ingestion/tasks.md#row-stats) for more information. + +#### URL + +<code class="getAPI">GET</code> <code>/druid/indexer/v1/supervisor/:supervisorId/stats</code> Review Comment: ```suggestion <code class="getAPI">GET</code> <code>/druid/indexer/v1/supervisor/SUPERVISOR_ID/stats</code> ``` where did the `:supervisorId` syntax come from? am I missing something? ########## docs/api-reference/supervisor-api.md: ########## @@ -1309,13 +1307,184 @@ Host: http://ROUTER_IP:ROUTER_PORT ``` </details> +### Get supervisor health + +Retrieves the current health report for a single supervisor. The health of a supervisor is determined by the supervisor's `state` (as returned by the `/status` endpoint) and the `druid.supervisor.*` Overlord configuration thresholds. + +#### URL + +<code class="getAPI">GET</code> <code>/druid/indexer/v1/supervisor/:supervisorId/health</code> Review Comment: can you check this even for rows you did not change? ########## docs/api-reference/supervisor-api.md: ########## @@ -1309,13 +1307,184 @@ Host: http://ROUTER_IP:ROUTER_PORT ``` </details> +### Get supervisor health + +Retrieves the current health report for a single supervisor. The health of a supervisor is determined by the supervisor's `state` (as returned by the `/status` endpoint) and the `druid.supervisor.*` Overlord configuration thresholds. + +#### URL + +<code class="getAPI">GET</code> <code>/druid/indexer/v1/supervisor/:supervisorId/health</code> Review Comment: ```suggestion <code class="getAPI">GET</code> <code>/druid/indexer/v1/supervisor/SUPERVISOR_ID/health</code> ``` colon is a bug, supervisor_id should be the style I think for a variable -- 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]
