Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

provide a response description for supervisor status api #15031

Closed
wants to merge 2 commits into from
Closed

provide a response description for supervisor status api #15031

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4f9ee3
provide a response description for supervisor status api
sergioferragut Sep 22, 2023
ba95920
fixed description for state
sergioferragut Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/api-reference/supervisor-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1311,6 +1311,29 @@ Host: http://ROUTER_IP:ROUTER_PORT
```
</details>

#### Response Description
The response `payload` contains the following structure:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The response `payload` contains the following structure:
The response `payload` contains the following properties:


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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`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.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`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.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`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.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`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.|

|`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> |
Copy link
Contributor

@ektravel ektravel Nov 1, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.|

|`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.|
Copy link
Contributor

@ektravel ektravel Nov 1, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`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.|

Should the Map interface be in code font?

|`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.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`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.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`suspended`|Boolean|True if the supervisor is in a SUSPENDED state.|
|`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.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Should this say "state" instead of "stage"?

|`recentErrors`|Array of String|Errors reported recently by supervisor managed tasks.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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



## Audit history

An audit history provides a comprehensive log of events, including supervisor configuration, creation, suspension, and modification history.
Expand Down