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.

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

Add thread level details to _tasks API #4542

Merged
merged 4 commits into from
Jul 14, 2023

Conversation

jed326
Copy link
Contributor

@jed326 jed326 commented Jul 11, 2023

Description

Updates the sample response for _tasks API with detailed flag to include the new thread level response.

Issues Resolved

Resolves #4206

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@jed326
Copy link
Contributor Author

jed326 commented Jul 11, 2023

@sohami Could you double check this PR for me? Thanks!

Signed-off-by: Jay Deng <jayd0104@gmail.com>
@jed326
Copy link
Contributor Author

jed326 commented Jul 11, 2023

@hdhalter @kolchfa-aws could you take a look at this PR now and let me know if the formatting / wording looks good? Thanks!

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
@kolchfa-aws
Copy link
Collaborator

@jed326 Thanks so much for contributing this documentation! I've made some tweaks so it adheres to our style guide. If you have no other changes, we can push this documentation forward.

@kolchfa-aws kolchfa-aws self-assigned this Jul 11, 2023
@jed326
Copy link
Contributor Author

jed326 commented Jul 11, 2023

@kolchfa-aws Looks good to me, thanks for the edits!

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Great, thanks @jed326!

@kolchfa-aws kolchfa-aws added v2.9.0 release-notes PR: Include this PR in the automated release notes 5 - Final Editorial Review PR: Editorial Review in progress labels Jul 11, 2023
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@kolchfa-aws Just a few changes. Thanks!

_api-reference/tasks.md Outdated Show resolved Hide resolved
`total` | The sum of resource usages across all scheduled thread executions. |
`min` | The minimum resource usage across all scheduled thread executions. |
`max` | The maximum resource usage across all scheduled thread executions. |
`thread_info` | Thread count-related stats.|
Copy link
Collaborator

Choose a reason for hiding this comment

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

If this means "count-related stats for the thread", then the hyphenation is correct, but confirm that it shouldn't be "thread-count-related stats".

Copy link
Collaborator

Choose a reason for hiding this comment

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

It is "thread-count-related". I'll change.

kolchfa-aws and others added 2 commits July 12, 2023 11:33
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws kolchfa-aws added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Final Editorial Review PR: Editorial Review in progress labels Jul 12, 2023
@kolchfa-aws kolchfa-aws merged commit a7da897 into opensearch-project:main Jul 14, 2023
4 checks passed
@kolchfa-aws kolchfa-aws changed the title Add thread level details to _tasks API Add thread level details to _tasks API Jul 24, 2023
@kolchfa-aws kolchfa-aws changed the title Add thread level details to _tasks API Add thread level details to _tasks API Jul 24, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
* Add thread level details to _tasks API

Signed-off-by: Jay Deng <jayd0104@gmail.com>

* Rewording according to style guide and formatting changes

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _api-reference/tasks.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update tasks.md

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Jay Deng <jayd0104@gmail.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
* Add thread level details to _tasks API

Signed-off-by: Jay Deng <jayd0104@gmail.com>

* Rewording according to style guide and formatting changes

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _api-reference/tasks.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update tasks.md

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Jay Deng <jayd0104@gmail.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6 - Done but waiting to merge PR: The work is done and ready to merge release-notes PR: Include this PR in the automated release notes v2.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update _tasks API documentation with concurrency related changes
4 participants