[Rule-based Auto Tagging] Add rule schema for auto tagging by ruai0511 · Pull Request #17238 · opensearch-project/OpenSearch

ruai0511 · 2025-02-03T22:47:57Z

Description

This PR introduces the schema for Rule object used in the auto tagging feature. A single rule will only have one feature but could have multiple attributes.
For the example below, the feature is query_group, and corresponds to the tag dev_query_group_id

{
    "_id": "fwhbuib397u4o03==",
    "description": "description",
    "attribute_1": ["logs123"],
    "attribute_2": ["xxxx", "yyyy"],
    "query_group": "dev_query_group_id",
    "updated_at": "01-10-2025T21:23:456Z"
}

Related issues:
RFC: #16797
#16813

Check List

Functionality includes testing.
API changes companion pull request created, if applicable.
Public documentation issue/PR created, if applicable.

github-actions · 2025-02-04T00:02:16Z

✅ Gradle check result for f6a4a28: SUCCESS

codecov · 2025-02-04T00:03:13Z

Codecov Report

Attention: Patch coverage is 79.32692% with 43 lines in your changes missing coverage. Please review.

Project coverage is 72.36%. Comparing base (47d3655) to head (8f106ae).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
...src/main/java/org/opensearch/autotagging/Rule.java	81.63%	6 Missing and 12 partials ⚠️
...java/org/opensearch/autotagging/RuleValidator.java	81.08%	4 Missing and 10 partials ⚠️
...ain/java/org/opensearch/autotagging/Attribute.java	45.45%	5 Missing and 1 partial ⚠️
...rg/opensearch/autotagging/AutoTaggingRegistry.java	83.33%	1 Missing and 2 partials ⚠️
...n/java/org/opensearch/autotagging/FeatureType.java	71.42%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #17238      +/-   ##
============================================
- Coverage     72.53%   72.36%   -0.18%     
+ Complexity    65826    65741      -85     
============================================
  Files          5311     5316       +5     
  Lines        305073   305281     +208     
  Branches      44243    44287      +44     
============================================
- Hits         221293   220912     -381     
- Misses        65688    66197     +509     
- Partials      18092    18172      +80

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

CHANGELOG.md

server/src/main/java/org/opensearch/wlm/Rule.java

github-actions · 2025-03-20T01:59:44Z

❕ Gradle check result for 108ae79: UNSTABLE

TEST FAILURES:

      1 org.opensearch.snapshots.DedicatedClusterSnapshotRestoreIT.testSnapshotWithStuckNode
      1 org.opensearch.repositories.azure.AzureBlobStoreRepositoryTests.testIndicesDeletedFromRepository

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

github-actions · 2025-03-20T21:01:41Z

❕ Gradle check result for 8f106ae: UNSTABLE

TEST FAILURES:

      2 org.opensearch.cluster.MinimumClusterManagerNodesIT.testThreeNodesNoClusterManagerBlock
      1 org.opensearch.snapshots.DedicatedClusterSnapshotRestoreIT.testSnapshotWithStuckNode

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

sgup432

LGTM! Thanks for making the change

opensearch-trigger-bot · 2025-03-21T04:26:32Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-17238-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 b24c72b06bfd76d7d1d134a9ec9804965ad74352
# Push it to GitHub
git push --set-upstream origin backport/backport-17238-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-17238-to-2.x.

…h-project#17238) Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * add rule schema for workload management Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * modify rule structure based on comment Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * update based on comments Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * add javadoc for autotagging directory Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * change field name from 'name' to 'description' Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * update the rule schema Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * simplify autotagging registry Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * remove generic type parameter from Rule class Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * modify based on comments Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> (cherry picked from commit b24c72b)

…17653) Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * add rule schema for workload management Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * modify rule structure based on comment Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * update based on comments Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * add javadoc for autotagging directory Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * change field name from 'name' to 'description' Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * update the rule schema Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * simplify autotagging registry Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * remove generic type parameter from Rule class Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * modify based on comments Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> (cherry picked from commit b24c72b) Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

…h-project#17238) * add rule schema for workload management Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * modify rule structure based on comment Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * update based on comments Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * add javadoc for autotagging directory Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * change field name from 'name' to 'description' Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * update the rule schema Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * simplify autotagging registry Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * remove generic type parameter from Rule class Signed-off-by: Ruirui Zhang <mariazrr@amazon.com> * modify based on comments Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

ruai0511 force-pushed the rule-schema-PR branch 2 times, most recently from bc12186 to f6a4a28 Compare February 3, 2025 23:01

kaushalmahi12 reviewed Feb 4, 2025

View reviewed changes

ruai0511 added the backport 2.x Backport to 2.x branch label Feb 7, 2025

ruai0511 force-pushed the rule-schema-PR branch from 094c95d to bb8d06c Compare February 7, 2025 05:41

opensearch-ci-bot mentioned this pull request Mar 20, 2025

[AUTOCUT] Gradle Check Flaky Test Report for AzureBlobStoreRepositoryTests #14291

Open

ruai0511 added 9 commits March 20, 2025 12:55

add rule schema for workload management

8a2d686

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

modify rule structure based on comment

efc73ed

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

update based on comments

62965d4

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

add javadoc for autotagging directory

c58c8c4

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

change field name from 'name' to 'description'

4a849b1

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

update the rule schema

ad1a2ee

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

simplify autotagging registry

58e034a

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

remove generic type parameter from Rule class

c45f25f

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

modify based on comments

8f106ae

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

ruai0511 force-pushed the rule-schema-PR branch from 108ae79 to 8f106ae Compare March 20, 2025 19:56

sgup432 approved these changes Mar 20, 2025

View reviewed changes

jainankitk approved these changes Mar 21, 2025

View reviewed changes

jainankitk merged commit b24c72b into opensearch-project:main Mar 21, 2025
31 of 32 checks passed

opensearch-trigger-bot bot added the backport-failed label Mar 21, 2025

opensearch-ci-bot mentioned this pull request Mar 21, 2025

[AUTOCUT] Gradle Check Flaky Test Report for SearchRestCancellationIT #14311

Open

ruai0511 mentioned this pull request Mar 21, 2025

[Backport 2.x] [Rule-based Auto Tagging] Add rule schema for auto tagging #17653

Merged

opensearch-ci-bot mentioned this pull request Mar 26, 2025

[AUTOCUT] Gradle Check Flaky Test Report for HaHdfsFailoverTestSuiteIT #17692

Closed

This was referenced Apr 3, 2025

[rule based autotagging] Add Create Rule API Logic #17792

Merged

[rule based autotagging] Add Update Rule API Logic #17797

Merged

BrewTestBot mentioned this pull request May 6, 2025

opensearch 3.0.0 Homebrew/homebrew-core#222665

Merged

ruai0511 deleted the rule-schema-PR branch July 9, 2025 23:29

This was referenced Jan 11, 2026

docs: add Rule-Based Auto-Tagging report for v3.0.0 tkykenmt/opensearch-feature-explorer#1903

Merged

[v3.0.0] Rule-Based Auto-Tagging tkykenmt/opensearch-feature-explorer#234

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Rule-based Auto Tagging] Add rule schema for auto tagging#17238

[Rule-based Auto Tagging] Add rule schema for auto tagging#17238
jainankitk merged 9 commits intoopensearch-project:mainfrom
ruai0511:rule-schema-PR

ruai0511 commented Feb 3, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Feb 4, 2025

Uh oh!

codecov bot commented Feb 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

sgup432 left a comment

Uh oh!

Uh oh!

opensearch-trigger-bot bot commented Mar 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

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

Uh oh!

Description

Check List

Uh oh!

github-actions bot commented Feb 4, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

github-actions bot commented Mar 20, 2025

Uh oh!

sgup432 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

opensearch-trigger-bot bot commented Mar 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ruai0511 commented Feb 3, 2025 •

edited

Loading

codecov bot commented Feb 4, 2025 •

edited

Loading