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

Star Tree Search changes related to new Aggregations supported #9163

Merged
merged 22 commits into from
Feb 11, 2025

Conversation

sandeshkr419
Copy link
Contributor

@sandeshkr419 sandeshkr419 commented Feb 6, 2025

Adding example for star-tree supported date histogram as it is supported in OpenSearch 2.19

Description

Adds details about following features added in 2.19
PRs with feature inclusions:
opensearch-project/OpenSearch#17137
opensearch-project/OpenSearch#16674

Project Meta: opensearch-project/OpenSearch#15257

Issues Resolved

Closes #[delete this text, including the brackets, and replace with the issue number]

Version

OpenSearch 2.19 and above

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

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.

Adding example for star-tree supported date histogram as it is supported in OpenSearch 2.19

Signed-off-by: Sandesh Kumar <[email protected]>
Copy link

github-actions bot commented Feb 6, 2025

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Add queries included in 2.19

Signed-off-by: Sandesh Kumar <[email protected]>
@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes v2.19.0 labels Feb 6, 2025
@sandeshkr419 sandeshkr419 changed the title Update star-tree-index.md Star Tree Search changes related to new Aggregations supported Feb 6, 2025
Signed-off-by: Sandesh Kumar <[email protected]>
{
"query": {
"term": {
"status": "500"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we use range query or keyword term query since term is already used in the above example ? Maybe keyword term query will be a good example.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@bharath-techie: I'll update the example to use a range query.

@Naarcha-AWS Naarcha-AWS added the 3 - Tech review PR: Tech review in progress label Feb 7, 2025
bharath-techie and others added 2 commits February 7, 2025 23:02
Signed-off-by: bharath-techie <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Feb 10, 2025
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

Before we can pass this to editorial review, there's one review comment from @expani that still needs to be address and a follow-up question from me.

Signed-off-by: Sandesh Kumar <[email protected]>
Signed-off-by: Sandesh Kumar <[email protected]>
@sandeshkr419
Copy link
Contributor Author

Thanks @Naarcha-AWS for the comments, addressed them all now. Let me know if there are further actions.

- `keyword`
- `object`
- `date` which can use up to three of following calendar intervals:
- `year` (of era)
Copy link
Collaborator

Choose a reason for hiding this comment

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

What do we mean by "of blank"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The fields names are what defined inside "". Extra clarification is just for information. Usually month, year etc are understood easily, but certain fields like week` needed extra clarification like (week of week based year)

Signed-off-by: Sandesh Kumar <[email protected]>
Signed-off-by: Sandesh Kumar <[email protected]>
```json
POST /logs/_search
{
"query": {
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this a valid query ? @sandeshkr419 just double checking. I don't see term/terms etc

Copy link
Collaborator

Choose a reason for hiding this comment

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

@bharath-techie: I updated the query to add terms while keeping the method.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is still not a valid query , we don't support range on timestamp. Lets reword this @Naarcha-AWS

Copy link
Collaborator

Choose a reason for hiding this comment

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

@bharath-techie: Can you suggest a valid query?

@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Feb 11, 2025
@Naarcha-AWS
Copy link
Collaborator

@natebower: This is ready for editorial review.

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.

@Naarcha-AWS Please see my comments and changes and reply to my tags when addressed and ready for approval. Thanks!

_field-types/supported-field-types/star-tree.md Outdated Show resolved Hide resolved
_field-types/supported-field-types/star-tree.md Outdated Show resolved Hide resolved
_field-types/supported-field-types/star-tree.md Outdated Show resolved Hide resolved
_search-plugins/star-tree-index.md Outdated Show resolved Hide resolved
_search-plugins/star-tree-index.md Outdated Show resolved Hide resolved
_search-plugins/star-tree-index.md Outdated Show resolved Hide resolved
_search-plugins/star-tree-index.md Show resolved Hide resolved
_search-plugins/star-tree-index.md Outdated Show resolved Hide resolved
_search-plugins/star-tree-index.md Show resolved Hide resolved
_search-plugins/star-tree-index.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits February 11, 2025 08:58
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
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.

@Naarcha-AWS Naarcha-AWS merged commit c4dc728 into opensearch-project:main Feb 11, 2025
6 checks passed
@sandeshkr419 sandeshkr419 deleted the patch-1 branch February 11, 2025 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes v2.19.0
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants