provide a response description for supervisor status api #15031

sergioferragut · 2023-09-22T21:36:55Z

Description

Provides a description for the response to the supervisor status API.

This PR has:

[ X ] been self-reviewed.
- using the concurrency checklist (Remove this item if the PR doesn't have any relation to concurrency.)
[ X ] added documentation for new or modified features or behaviors.
a release note entry in the PR description.
added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
added or updated version, license, or notice information in licenses.yaml
added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
added unit tests or modified existing tests to cover new code paths, ensuring the threshold for code coverage is met.
added integration tests.
been tested in a test Druid cluster.

ektravel · 2023-11-01T21:08:39Z

docs/api-reference/supervisor-api.md

@@ -1311,6 +1311,29 @@ Host: http://ROUTER_IP:ROUTER_PORT
  ```
 </details>

+#### Response Description 
+The response `payload` contains the following structure:


Suggested change

The response `payload` contains the following structure:

The response `payload` contains the following properties:

ektravel · 2023-11-01T21:09:17Z

docs/api-reference/supervisor-api.md

+|Property|Type|Description|
+|---|---|---|
+|`dataSource`|String|The target datasource.|
+|`stream`|String|Name of the topic or stream that the ingestion is reading from.|


ektravel · 2023-11-01T21:09:31Z

docs/api-reference/supervisor-api.md

+|---|---|---|
+|`dataSource`|String|The target datasource.|
+|`stream`|String|Name of the topic or stream that the ingestion is reading from.|
+|`partitions`|Integer|Number of partitions in the source stream.|


ektravel · 2023-11-01T21:12:47Z

docs/api-reference/supervisor-api.md

+|`dataSource`|String|The target datasource.|
+|`stream`|String|Name of the topic or stream that the ingestion is reading from.|
+|`partitions`|Integer|Number of partitions in the source stream.|
+|`replicas`|Integer|Number of replicas being used per task for high availability where 1 means no redundancy.|


ektravel · 2023-11-01T21:13:18Z

docs/api-reference/supervisor-api.md

+|`stream`|String|Name of the topic or stream that the ingestion is reading from.|
+|`partitions`|Integer|Number of partitions in the source stream.|
+|`replicas`|Integer|Number of replicas being used per task for high availability where 1 means no redundancy.|
+|`durationSeconds`|Integer|Seconds that each task spends reading before moving to a publishing state.|


ektravel · 2023-11-01T21:18:00Z

docs/api-reference/supervisor-api.md

+|`replicas`|Integer|Number of replicas being used per task for high availability where 1 means no redundancy.|
+|`durationSeconds`|Integer|Seconds that each task spends reading before moving to a publishing state.|
+|`activeTasks`|Array of Object|Lists the tasks that are reading from the stream, each with: <table><tbody><tr><td>`startTime`</td><td>String</td><td>Task start time.</td></tr><tr><td>`remainingTime`</td><td>Integer</td><td>The time remaining in the reading state</td><tr><tr><td>`currentOffsets`</td><td>Map < String , Integer ></td><td>The list of partitions that the task is reading from with the latest offset consumed from each.</td></tr><tr><td>`lag`</td><td>Map < String , Integer ></td><td>The number of messages pending to read from each partition.</td></tr></tbody></table> | 
+|`publishingTasks`|Array of Object|Lists the tasks that are publishing segments to Deep Storage and awaiting handoff confirmation. For detailed structure see `activeTasks` above.|


Suggested change

|`publishingTasks`|Array of Object|Lists the tasks that are publishing segments to Deep Storage and awaiting handoff confirmation. For detailed structure see `activeTasks` above.|

|`publishingTasks`|Array of objects|Lists the tasks that are publishing segments to Deep Storage and awaiting handoff confirmation. For detailed structure see `activeTasks` above.|

ektravel · 2023-11-01T21:20:16Z

docs/api-reference/supervisor-api.md

+|`activeTasks`|Array of Object|Lists the tasks that are reading from the stream, each with: <table><tbody><tr><td>`startTime`</td><td>String</td><td>Task start time.</td></tr><tr><td>`remainingTime`</td><td>Integer</td><td>The time remaining in the reading state</td><tr><tr><td>`currentOffsets`</td><td>Map < String , Integer ></td><td>The list of partitions that the task is reading from with the latest offset consumed from each.</td></tr><tr><td>`lag`</td><td>Map < String , Integer ></td><td>The number of messages pending to read from each partition.</td></tr></tbody></table> | 
+|`publishingTasks`|Array of Object|Lists the tasks that are publishing segments to Deep Storage and awaiting handoff confirmation. For detailed structure see `activeTasks` above.|
+|`latestOffsets`|Map < String, Integer >|The lastest offset consumed from the stream by partition.|
+|`minimumLag`|Map < String, Integer >|The number of messages pending to read from stream by partition.|


ektravel · 2023-11-01T21:25:05Z

docs/api-reference/supervisor-api.md

+|`latestOffsets`|Map < String, Integer >|The lastest offset consumed from the stream by partition.|
+|`minimumLag`|Map < String, Integer >|The number of messages pending to read from stream by partition.|
+|`aggregateLag`|Integer|The sum of minimum lags (see above) across all partitions.|
+|`offsetLastUpdated`|String|Contains the timestamp of when the stream offsets were last inspected.|


ektravel · 2023-11-01T21:26:02Z

docs/api-reference/supervisor-api.md

+|`minimumLag`|Map < String, Integer >|The number of messages pending to read from stream by partition.|
+|`aggregateLag`|Integer|The sum of minimum lags (see above) across all partitions.|
+|`offsetLastUpdated`|String|Contains the timestamp of when the stream offsets were last inspected.|
+|`suspended`|Boolean|True if the supervisor is in a SUSPENDED state.|


ektravel · 2023-11-01T21:26:45Z

docs/api-reference/supervisor-api.md

+|`suspended`|Boolean|True if the supervisor is in a SUSPENDED state.|
+|`healthy`|Boolean|True if the supervisor and its tasks are currently healthy.|
+|`state`|String|Overall state of the supervisor. |
+|`detailedState`|String|Current stage of processing for the supervisor.|


ektravel · 2023-11-01T21:30:32Z

docs/api-reference/supervisor-api.md

+|`healthy`|Boolean|True if the supervisor and its tasks are currently healthy.|
+|`state`|String|Overall state of the supervisor. |
+|`detailedState`|String|Current stage of processing for the supervisor.|
+|`recentErrors`|Array of String|Errors reported recently by supervisor managed tasks.|


ektravel · 2023-11-01T21:36:37Z

docs/api-reference/supervisor-api.md

+|`partitions`|Integer|Number of partitions in the source stream.|
+|`replicas`|Integer|Number of replicas being used per task for high availability where 1 means no redundancy.|
+|`durationSeconds`|Integer|Seconds that each task spends reading before moving to a publishing state.|
+|`activeTasks`|Array of Object|Lists the tasks that are reading from the stream, each with: <table><tbody><tr><td>`startTime`</td><td>String</td><td>Task start time.</td></tr><tr><td>`remainingTime`</td><td>Integer</td><td>The time remaining in the reading state</td><tr><tr><td>`currentOffsets`</td><td>Map < String , Integer ></td><td>The list of partitions that the task is reading from with the latest offset consumed from each.</td></tr><tr><td>`lag`</td><td>Map < String , Integer ></td><td>The number of messages pending to read from each partition.</td></tr></tbody></table> | 


Instead of a nested table, consider creating a separate table for activeTasks properties.

Also, the Map interface should probably be in code font.

ektravel

Left some suggestions. Also, I think "array of objects" reads better than "array of object". Unless "array of object" is the correct way of referring to array values.

github-actions · 2024-03-05T00:16:24Z

This pull request has been marked as stale due to 60 days of inactivity.
It will be closed in 4 weeks if no further activity occurs. If you think
that's incorrect or this pull request should instead be reviewed, please simply
write any comment. Even if closed, you can still revive the PR at any time or
discuss it on the dev@druid.apache.org list.
Thank you for your contributions.

github-actions · 2024-04-03T00:16:09Z

This pull request/issue has been closed due to lack of activity. If you think that
is incorrect, or the pull request requires review, you can revive the PR at any time.

sergioferragut added 2 commits September 22, 2023 14:27

provide a response description for supervisor status api

a4f9ee3

fixed description for state

ba95920

github-actions bot added the Area - Documentation label Sep 22, 2023

sergioferragut marked this pull request as ready for review September 22, 2023 21:37

ektravel reviewed Nov 1, 2023

View reviewed changes

github-actions bot added the stale label Mar 5, 2024

github-actions bot closed this Apr 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

provide a response description for supervisor status api #15031

provide a response description for supervisor status api #15031

sergioferragut commented Sep 22, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023 •

edited

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023

ektravel Nov 1, 2023 •

edited

ektravel left a comment

github-actions bot commented Mar 5, 2024

github-actions bot commented Apr 3, 2024

	The response `payload` contains the following structure:

	The response `payload` contains the following properties:

	\|`stream`\|String\|Name of the topic or stream that the ingestion is reading from.\|
	\|`stream`\|String\|The name of the topic or stream that the ingestion is reading from.\|

	\|`partitions`\|Integer\|Number of partitions in the source stream.\|
	\|`partitions`\|Integer\|The number of partitions in the source stream.\|

	\|`replicas`\|Integer\|Number of replicas being used per task for high availability where 1 means no redundancy.\|
	\|`replicas`\|Integer\|The number of replicas being used per task for high availability where 1 means no redundancy.\|

	\|`durationSeconds`\|Integer\|Seconds that each task spends reading before moving to a publishing state.\|
	\|`durationSeconds`\|Integer\|The number of seconds that each task spends reading before moving to a publishing state.\|

	\|`publishingTasks`\|Array of Object\|Lists the tasks that are publishing segments to Deep Storage and awaiting handoff confirmation. For detailed structure see `activeTasks` above.\|
	\|`publishingTasks`\|Array of objects\|Lists the tasks that are publishing segments to Deep Storage and awaiting handoff confirmation. For detailed structure see `activeTasks` above.\|

	\|`minimumLag`\|Map < String, Integer >\|The number of messages pending to read from stream by partition.\|
	\|`minimumLag`\|`Map < String, Integer >`\|The number of messages pending to read from the stream by partition.\|

	\|`offsetLastUpdated`\|String\|Contains the timestamp of when the stream offsets were last inspected.\|
	\|`offsetLastUpdated`\|String\|The timestamp of when the stream offsets were last inspected.\|

	\|`suspended`\|Boolean\|True if the supervisor is in a SUSPENDED state.\|
	\|`suspended`\|Boolean\|True if the supervisor is in a `SUSPENDED` state.\|

	\|`detailedState`\|String\|Current stage of processing for the supervisor.\|
	\|`detailedState`\|String\|Current stage of processing for the supervisor.\|

	\|`recentErrors`\|Array of String\|Errors reported recently by supervisor managed tasks.\|
	\|`recentErrors`\|Array of strings\|Errors reported recently by supervisor managed tasks.\|

provide a response description for supervisor status api #15031

provide a response description for supervisor status api #15031

Conversation

sergioferragut commented Sep 22, 2023

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ektravel Nov 1, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ektravel Nov 1, 2023 • edited

Choose a reason for hiding this comment

ektravel left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 5, 2024

github-actions bot commented Apr 3, 2024

ektravel Nov 1, 2023 •

edited

ektravel Nov 1, 2023 •

edited