Execution hint documentation added to cardinality agg by asimmahmood1 · Pull Request #9224 · opensearch-project/documentation-website

asimmahmood1 · 2025-02-17T19:14:23Z

Description

This PR adds documentation for execution_hint field that is being added for cardinality aggregator introduced in opensearch-project/OpenSearch#17312. Waiting for main repo PR to be merged.

This PR updates #8265

Issues Resolved

Closes #8264

Version

3.0

Frontend features

n/a

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.

Signed-off-by: Siddharth Rayabharam <maitreya2954@gmail.com>

Signed-off-by: Asim Mahmood <asim.seng@gmail.com>

github-actions · 2025-02-17T19:14:34Z

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.

kolchfa-aws · 2025-02-17T21:41:07Z

@asimmahmood1 FYI: There is another PR on this topic here #8265.

asimmahmood1 · 2025-02-17T21:48:01Z

@asimmahmood1 FYI: There is another PR on this topic here #8265.

Yes, I've kept that original commit and add mine on top. I wanted to make sure to provide the warning.

kolchfa-aws · 2025-02-18T14:32:17Z

Thanks! So should we close the original PR because this one contains the original commit?

asimmahmood1 · 2025-02-18T22:31:56Z

Thanks! So should we close the original PR because this one contains the original commit?

Yes, we can close the original PR. Note: I don't have permission to.

kolchfa-aws · 2025-02-20T16:57:09Z

@asimmahmood1 Is this PR ready for doc review?

asimmahmood1 · 2025-02-20T17:46:06Z

Code PR opensearch-project/OpenSearch#17312 has been merged, so this is ready for ~~merge~~ review.

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

kolchfa-aws · 2025-02-24T21:47:36Z

@asimmahmood1 Doc review complete. Moving this PR to editorial review. Is this still slated for 3.0, or is this going into 2.19.1?

asimmahmood1 · 2025-02-24T22:00:42Z

Thank you @kolchfa-aws . Its been merged into 2.19.1 as well, and 2.x PR is also open.

natebower

@kolchfa-aws @asimmahmood1 Just one minor change. Thanks!

_aggregations/metric/cardinality.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Asim M <asim.seng@gmail.com>

kolchfa-aws

LGTM

asimmahmood1 · 2025-02-26T19:24:14Z

Just to confirm, this should goto 2.19.1, 2.x branch and main/3.0 branch.

* Execution hint documentation added to cardinality agg Signed-off-by: Siddharth Rayabharam <maitreya2954@gmail.com> * Add expert level warning to cardinality execution_hint paramter Signed-off-by: Asim Mahmood <asim.seng@gmail.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _aggregations/metric/cardinality.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Asim M <asim.seng@gmail.com> --------- Signed-off-by: Siddharth Rayabharam <maitreya2954@gmail.com> Signed-off-by: Asim Mahmood <asim.seng@gmail.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Asim M <asim.seng@gmail.com> Co-authored-by: Siddharth Rayabharam <maitreya2954@gmail.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> (cherry picked from commit 2d39e1c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ject#9224) * Execution hint documentation added to cardinality agg Signed-off-by: Siddharth Rayabharam <maitreya2954@gmail.com> * Add expert level warning to cardinality execution_hint paramter Signed-off-by: Asim Mahmood <asim.seng@gmail.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _aggregations/metric/cardinality.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Asim M <asim.seng@gmail.com> --------- Signed-off-by: Siddharth Rayabharam <maitreya2954@gmail.com> Signed-off-by: Asim Mahmood <asim.seng@gmail.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Asim M <asim.seng@gmail.com> Co-authored-by: Siddharth Rayabharam <maitreya2954@gmail.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> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>

maitreya2954 and others added 2 commits February 17, 2025 18:44

Execution hint documentation added to cardinality agg

776c355

Signed-off-by: Siddharth Rayabharam <maitreya2954@gmail.com>

Add expert level warning to cardinality execution_hint paramter

59f966b

Signed-off-by: Asim Mahmood <asim.seng@gmail.com>

asimmahmood1 requested review from AMoo-Miki, Naarcha-AWS, dlvenable, epugh, kolchfa-aws and natebower as code owners February 17, 2025 19:14

github-actions bot assigned kolchfa-aws Feb 17, 2025

asimmahmood1 mentioned this pull request Feb 17, 2025

Introduce execution_hint for Cardinality aggregation opensearch-project/OpenSearch#17312

Merged

3 tasks

kolchfa-aws added the v3.0.0 label Feb 17, 2025

kolchfa-aws mentioned this pull request Feb 18, 2025

Execution hint documentation added to cardinality agg #8265

Closed

1 task

Merge branch 'main' into execution_hint

a29031d

This was referenced Feb 21, 2025

Introduce execution_hint for Cardinality aggregation (#17312) - backport to 2.x opensearch-project/OpenSearch#17419

Merged

Introduce execution_hint for Cardinality aggregation (#17312) - backport to 2.19 opensearch-project/OpenSearch#17420

Merged

Doc review

18665c8

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

Merge branch 'main' into execution_hint

9cf1947

natebower reviewed Feb 25, 2025

View reviewed changes

_aggregations/metric/cardinality.md Outdated Show resolved Hide resolved

Update _aggregations/metric/cardinality.md

81cb367

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Asim M <asim.seng@gmail.com>

kolchfa-aws approved these changes Feb 26, 2025

View reviewed changes

kolchfa-aws removed the v3.0.0 label Feb 26, 2025

kolchfa-aws added v2.19.1 Done but waiting to merge PR: The work is done and ready to merge backport 2.19 labels Feb 26, 2025

kolchfa-aws merged commit 2d39e1c into opensearch-project:main Feb 27, 2025
9 checks passed

opensearch-trigger-bot bot mentioned this pull request Feb 27, 2025

[Backport 2.19] Execution hint documentation added to cardinality agg #9316

Merged

github-actions bot pushed a commit that referenced this pull request Feb 27, 2025

Execution hint documentation added to cardinality agg (#9224) (#9316)

dd273b0

Conversation

asimmahmood1 commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Version

Frontend features

Checklist

Uh oh!

github-actions bot commented Feb 17, 2025

Uh oh!

kolchfa-aws commented Feb 17, 2025

Uh oh!

asimmahmood1 commented Feb 17, 2025

Uh oh!

kolchfa-aws commented Feb 18, 2025

Uh oh!

asimmahmood1 commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kolchfa-aws commented Feb 20, 2025

Uh oh!

asimmahmood1 commented Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kolchfa-aws commented Feb 24, 2025

Uh oh!

asimmahmood1 commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

natebower left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kolchfa-aws left a comment

Choose a reason for hiding this comment

Uh oh!

asimmahmood1 commented Feb 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

asimmahmood1 commented Feb 17, 2025 •

edited

Loading

asimmahmood1 commented Feb 18, 2025 •

edited

Loading

asimmahmood1 commented Feb 20, 2025 •

edited

Loading

asimmahmood1 commented Feb 24, 2025 •

edited

Loading