Adding create and start to AD node client by amitgalitz · Pull Request #1611 · opensearch-project/anomaly-detection

amitgalitz · 2025-11-11T11:17:26Z

Description

Adding create and start to AD node client.

Involves creating new constructor for a few request types were we pass AD cluster settings from rest layer and utilizing cluster setting fetching in transport layer instead for plugin to plugin communication.

Check List

Commits are signed per the DCO using --signoff.

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

codecov · 2025-11-12T23:27:07Z

Codecov Report

❌ Patch coverage is 86.23188% with 19 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.33%. Comparing base (4b21947) to head (6538cf5).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...transport/IndexAnomalyDetectorTransportAction.java	74.07%	3 Missing and 4 partials ⚠️
...arch/ad/transport/IndexAnomalyDetectorRequest.java	77.27%	5 Missing ⚠️
...rch/ad/transport/IndexAnomalyDetectorResponse.java	77.77%	2 Missing ⚠️
...rg/opensearch/timeseries/transport/JobRequest.java	81.81%	2 Missing ⚠️
...g/opensearch/timeseries/transport/JobResponse.java	77.77%	2 Missing ⚠️
...s/transport/BaseValidateConfigTransportAction.java	95.83%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1611      +/-   ##
============================================
- Coverage     81.47%   81.33%   -0.15%     
  Complexity     6170     6170              
============================================
  Files           542      542              
  Lines         24994    25101     +107     
  Branches       2543     2551       +8     
============================================
+ Hits          20363    20415      +52     
- Misses         3367     3409      +42     
- Partials       1264     1277      +13

Flag	Coverage Δ
plugin	`81.33% <86.23%> (-0.15%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...g/opensearch/ad/client/AnomalyDetectionClient.java	`100.00% <100.00%> (ø)`
...ensearch/ad/client/AnomalyDetectionNodeClient.java	`100.00% <100.00%> (ø)`
...d/transport/AnomalyDetectorJobTransportAction.java	`100.00% <ø> (ø)`
...nsport/ValidateAnomalyDetectorTransportAction.java	`100.00% <ø> (ø)`
...recast/transport/ForecasterJobTransportAction.java	`100.00% <ø> (ø)`
...t/transport/ValidateForecasterTransportAction.java	`100.00% <ø> (ø)`
...h/timeseries/transport/BaseJobTransportAction.java	`88.63% <100.00%> (+0.54%)`	⬆️
...ch/timeseries/transport/ValidateConfigRequest.java	`84.90% <100.00%> (+0.59%)`	⬆️
...s/transport/BaseValidateConfigTransportAction.java	`77.39% <95.83%> (+4.56%)`	⬆️
...rch/ad/transport/IndexAnomalyDetectorResponse.java	`95.12% <77.77%> (-4.88%)`	⬇️
... and 4 more

... and 13 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kaituo · 2025-11-25T01:08:36Z

src/main/java/org/opensearch/ad/client/AnomalyDetectionClient.java

    void suggestAnomalyDetector(SuggestConfigParamRequest suggestRequest, ActionListener<SuggestConfigParamResponse> listener);
+
+    /**
+     * Create anomaly detector - refer to https://opensearch.org/docs/latest/observing-your-data/ad/api/#create-detector


The link should be https://docs.opensearch.org/latest/observing-your-data/ad/api/#create-anomaly-detector

kaituo · 2025-11-25T01:09:25Z

src/main/java/org/opensearch/ad/client/AnomalyDetectionClient.java

+    }
+
+    /**
+     * Create anomaly detector - refer to https://opensearch.org/docs/latest/observing-your-data/ad/api/#create-detector


kaituo · 2025-11-25T01:09:44Z

src/main/java/org/opensearch/ad/client/AnomalyDetectionClient.java

+    void createAnomalyDetector(IndexAnomalyDetectorRequest createRequest, ActionListener<IndexAnomalyDetectorResponse> listener);
+
+    /**
+     * Start anomaly detector - refer to https://opensearch.org/docs/latest/observing-your-data/ad/api/#start-detector


Should be https://opensearch.org/docs/latest/observing-your-data/ad/api/#start-detector-job

kaituo · 2025-11-25T01:11:48Z

build.gradle


    testImplementation "org.opensearch.test:framework:${opensearch_version}"
+
+    zipArchive("org.opensearch.plugin:opensearch-ml-plugin:${opensearch_build}")


why do you need ml-plugin?

removing this, left from testing

kaituo · 2025-11-26T22:57:12Z

src/main/java/org/opensearch/ad/transport/IndexAnomalyDetectorRequest.java

        this.maxCategoricalFields = maxCategoricalFields;
    }

+    public IndexAnomalyDetectorRequest(String detectorID, AnomalyDetector detector, RestRequest.Method method) {


Where do you call this constructor?

from skills repo on creating an anomaly detector from create ad tool, will have PR for that by tomorrow

kaituo · 2025-11-26T22:58:46Z

src/main/java/org/opensearch/ad/transport/IndexAnomalyDetectorTransportAction.java

+
+        // Initialize cluster settings for node client requests
+        this.maxSingleEntityAnomalyDetectors = AnomalyDetectorSettings.AD_MAX_SINGLE_ENTITY_ANOMALY_DETECTORS.get(settings);
+        this.maxMultiEntityAnomalyDetectors = AnomalyDetectorSettings.AD_MAX_HC_ANOMALY_DETECTORS.get(settings);
+        this.maxAnomalyFeatures = AnomalyDetectorSettings.MAX_ANOMALY_FEATURES.get(settings);
+        this.maxCategoricalFields = ADNumericSetting.maxCategoricalFields();
+


Why do we need these changes?

so we can access settings on a transport request call that doesn't go through rest layer at first

kaituo · 2025-11-26T23:00:19Z

src/main/java/org/opensearch/timeseries/transport/BaseValidateConfigTransportAction.java

+        this.maxSingleEntityAnomalyDetectors = AnomalyDetectorSettings.AD_MAX_SINGLE_ENTITY_ANOMALY_DETECTORS.get(settings);
+        this.maxMultiEntityAnomalyDetectors = AnomalyDetectorSettings.AD_MAX_HC_ANOMALY_DETECTORS.get(settings);
+        this.maxAnomalyFeatures = AnomalyDetectorSettings.MAX_ANOMALY_FEATURES.get(settings);
+        this.maxCategoricalFields = ADNumericSetting.maxCategoricalFields();
+


time series package should try to avoid cross-module dependency. These setting are not useful to forecast subclass.

will change so we have ad with ad settings and forecaster with forecaster. We have some of those checks on Config level but i see we have different settings for some of them to supply that value. will fix

kaituo

partial review

kaituo · 2025-11-27T00:37:10Z

src/main/java/org/opensearch/ad/transport/IndexAnomalyDetectorRequest.java

        detector = new AnomalyDetector(in);
        method = in.readEnum(RestRequest.Method.class);
        requestTimeout = in.readTimeValue();
-        maxSingleEntityAnomalyDetectors = in.readInt();


This may cause bwc issue as if the caller sends request between new and old nodes.

will make this optional

kaituo · 2025-11-27T00:38:36Z

src/main/java/org/opensearch/ad/transport/IndexAnomalyDetectorResponse.java

+                return new IndexAnomalyDetectorResponse(namedWriteableAwareInput);
+            }
+        } catch (IOException e) {
+            throw new UncheckedIOException("failed to parse ActionResponse into IndexAnomalyDetectorResponse", e);


be consistent: IndexAnomalyDetectorRequest.fromActionRequest(...) throws IllegalArgumentException wrapping the IOException, while we throw UncheckedIOException here.

kaituo · 2025-11-28T21:26:32Z

src/main/java/org/opensearch/ad/transport/IndexAnomalyDetectorResponse.java

+                return new IndexAnomalyDetectorResponse(namedWriteableAwareInput);
+            }
+        } catch (IOException e) {
+            throw new UncheckedIOException("failed to parse ActionResponse into IndexAnomalyDetectorResponse", e);


Also consider including the source class in the error message, e.g.:

"failed to parse " + actionRequest.getClass().getName() + " into IndexAnomalyDetectorRequest"

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>

amitgalitz requested review from VijayanB, dbwiddis, jackiehanyang, jmazanec15, jngz-es, joshpalis, kaituo, ohltyler, owaiskazi19, saratvemulapalli, sean-zheng-amazon, vamshin and ylwu-amzn as code owners November 11, 2025 11:17

opensearch-trigger-bot bot added infra Changes to infrastructure, testing, CI/CD, pipelines, etc. backport 2.x labels Nov 11, 2025

amitgalitz force-pushed the create-client branch from e88bc67 to a6d8027 Compare November 11, 2025 20:10

amitgalitz removed the backport 2.x label Nov 11, 2025

kaituo reviewed Nov 26, 2025

View reviewed changes

kaituo reviewed Nov 27, 2025

View reviewed changes

kaituo reviewed Nov 29, 2025

View reviewed changes

amitgalitz added 2 commits December 1, 2025 14:25

initial create and start client

dedfd63

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>

add CHANGELOG.md

6538cf5

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>

amitgalitz force-pushed the create-client branch from abd0c6f to 6538cf5 Compare December 1, 2025 23:21


		testImplementation "org.opensearch.test:framework:${opensearch_version}"

		zipArchive("org.opensearch.plugin:opensearch-ml-plugin:${opensearch_build}")

Conversation

amitgalitz commented Nov 11, 2025

Description

Check List

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amitgalitz Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amitgalitz Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaituo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Nov 12, 2025 •

edited

Loading

amitgalitz Nov 29, 2025 •

edited

Loading

amitgalitz Dec 1, 2025 •

edited

Loading