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

[DOC] Update search profile API documentation with concurrency related changes #4281

Closed
1 of 4 tasks
ticheng-aws opened this issue Jun 7, 2023 · 9 comments · Fixed by #5999
Closed
1 of 4 tasks

[DOC] Update search profile API documentation with concurrency related changes #4281

ticheng-aws opened this issue Jun 7, 2023 · 9 comments · Fixed by #5999
Assignees
Labels
3 - Done Issue is done/complete search-and-query Issue: Issues related to search and query features v2.12.0
Milestone

Comments

@ticheng-aws
Copy link
Contributor

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
As a part of introducing concurrent segment search we have also updated the search profile API to return more detailed summary stats in cases with concurrency.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
opensearch-project/OpenSearch#7355
opensearch-project/OpenSearch#7898

@ticheng-aws
Copy link
Contributor Author

Hi @hdhalter, we are targeting this for 2.9 as well.

@hdhalter hdhalter added this to the v2.9 milestone Jun 7, 2023
@hdhalter hdhalter added 1 - Backlog Issue: The issue is unassigned or assigned but not started v2.9.0 search-and-query Issue: Issues related to search and query features and removed untriaged labels Jun 7, 2023
@ticheng-aws
Copy link
Contributor Author

Hi @hdhalter and @kolchfa-aws, apologies for the confusion. The documentation change will be required for concurrent search GA (targeted v2.10) instead of v2.9.

@kolchfa-aws
Copy link
Collaborator

Thanks for the clarification, @ticheng-aws!

@sohami
Copy link
Contributor

sohami commented Aug 1, 2023

Another PR which will require profile related doc update: (opensearch-project/OpenSearch#8331)

@kolchfa-aws
Copy link
Collaborator

2.10 changes tracked in #4989

@hdhalter hdhalter modified the milestones: v2.10, v2.11 Sep 21, 2023
@kolchfa-aws
Copy link
Collaborator

@sohami Is there any documentation needed for the 2.11 version for this issue?

@kolchfa-aws
Copy link
Collaborator

Per offline sync with @sohami, there's no work to be done for 2.11 for this issue

@kolchfa-aws kolchfa-aws modified the milestones: v2.11, v2.12 Oct 3, 2023
@sohami
Copy link
Contributor

sohami commented Oct 3, 2023

Confirming we don't need any change in 2.11 for this API doc

@ticheng-aws
Copy link
Contributor Author

ticheng-aws commented Oct 27, 2023

We need to update the document for the query profile part here in the next release. We will have some new fields similar to the aggregation profile like max/min/avg_slice_time_in_nanos and time/count stats for the query breakdowns except create_weight type. More details can be found #9248.

@ticheng-aws ticheng-aws moved this from Todo to In Progress in Concurrent Search Dec 26, 2023
@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Dec 26, 2023
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Jan 16, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Concurrent Search Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete search-and-query Issue: Issues related to search and query features v2.12.0
Projects
Status: Done
4 participants