MLAgentTracer Class #3946

chriswlai · 2025-06-26T21:18:34Z

Description

Adds new MLAgentTracer class to capture traces within ML-commons and settings to disable or enable tracing.

Related Issues

Resolves #3971

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

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.

brianf-aws

Left a few comments, I'm seeing the commit history is a criss crossed with some commits can we rebase with the opensearch-project:feature/agent-tracing branch to see if it fixes it?

Also lets make sure to sign off our commits using -s as in git commit -s -m "<your Message>" you can see this is why DCO is complaining

brianf-aws · 2025-06-26T21:33:42Z

...lgorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/tracing/MLAgentTracer.java

+        return tracer;
+    }
+
+    static void resetForTest() {


Should we use a @ VisibleForTesting annotation also what else do we need to reset?

brianf-aws · 2025-06-26T21:33:54Z

...lgorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/tracing/MLAgentTracer.java

+
+    public static synchronized MLAgentTracer getInstance() {
+        if (instance == null) {
+            throw new IllegalStateException("MLAgentTracer is not initialized. Call initialize() first or check feature flag.");


Lets be specific which feature flag needs to be flipped
plugins.ml_commons.agent_tracing_feature_enabled or
plugins.ml_commons.agent_tracing_enabled?

As a side note how can I tell what setting I need to switch on?

Signed-off-by: chrislai <[email protected]>

pyek-bot · 2025-07-14T18:45:24Z

...rithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/tracing/AbstractMLTracer.java

+     *         The returned span should be passed to {@link #endSpan(Span)} when the
+     *         operation completes.
+     */
+    public abstract Span startSpan(String name, Map<String, String> attributes, Span parentSpan);


what do you think of creating an overloaded method for spans without parents:
startSpan(String name, Map<String, String> attributes);

This internally can call the startSpan method with null parent

pyek-bot · 2025-07-14T18:48:23Z

...lgorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/tracing/MLAgentTracer.java

+        }
+        SpanCreationContext context = SpanCreationContext.server().name(name).attributes(attrBuilder);
+        Span newSpan;
+        if (name != null && name.startsWith(AGENT_TASK_SPAN) && !(tracer instanceof NoopTracer)) {


any reason for checking if (!tracer instance of NoopTracer)

i would assume since they are both tracer objects, you could simply use the methods but just that internally NoopTracer wouldn't do anything

We check for NoopTracer since although it gracefully handles public methods of Tracer, we use reflection to access internals (for custom span creation and injection/extraction) and NoopTracer doesn't have these so it will give a NoSuchFieldException.

The agent execution will still run as normal, but I'm just checking to avoid the exception.

pyek-bot · 2025-07-14T18:51:25Z

...lgorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/tracing/MLAgentTracer.java

+     * @param carrier The map to inject context into. The span context will be added
+     *               as key-value pairs to this map. Must not be null.
+     */
+    public void injectSpanContext(Span span, Map<String, String> carrier) {


when will these method be used?

injectSpanContext

extractSpanContext

These are used in Plan-Execute-Reflect and Conversational agents to connect the conversational agent span with the p-e-r agent span

Signed-off-by: chrislai <[email protected]>

* adding agent tracing to mlplugin Signed-off-by: chrislai <[email protected]> * add settings and clean code Signed-off-by: chrislai <[email protected]> * add tests Signed-off-by: chrislai <[email protected]> * cr fixes Signed-off-by: chrislai <[email protected]> * tests message fix and spotlessApply Signed-off-by: chrislai <[email protected]> * spotlessApply Signed-off-by: chrislai <[email protected]> * add tests Signed-off-by: chrislai <[email protected]> * fix comments Signed-off-by: chrislai <[email protected]> * add visiblefortesting Signed-off-by: chrislai <[email protected]> * address comments Signed-off-by: chrislai <[email protected]> * javadoc Signed-off-by: chrislai <[email protected]> * more tests Signed-off-by: chrislai <[email protected]> * more class fixes Signed-off-by: chrislai <[email protected]> * overloaded method Signed-off-by: chrislai <[email protected]> --------- Signed-off-by: chrislai <[email protected]>

chriswlai requested review from b4sjoo, dhrubo-os, mingshl, jngz-es, model-collapse, rbhavna, ylwu-amzn, zane-neo, Zhangxunmt, austintlee, HenryL27 and xinyual as code owners June 26, 2025 21:18

chriswlai changed the title ~~Feature/mlagenttracer~~ MLAgentTracer Class Jun 26, 2025

chriswlai had a problem deploying to ml-commons-cicd-env-require-approval June 26, 2025 21:20 — with GitHub Actions Failure

brianf-aws reviewed Jun 26, 2025

View reviewed changes

chriswlai force-pushed the feature/mlagenttracer branch 2 times, most recently from d4cca33 to 6eb634d Compare June 26, 2025 22:15

chriswlai added 5 commits June 26, 2025 15:20

adding agent tracing to mlplugin

5949a90

Signed-off-by: chrislai <[email protected]>

add settings and clean code

1b78311

Signed-off-by: chrislai <[email protected]>

add tests

ac3dac6

Signed-off-by: chrislai <[email protected]>

cr fixes

093c0e9

Signed-off-by: chrislai <[email protected]>

tests message fix and spotlessApply

c712e12

Signed-off-by: chrislai <[email protected]>

chriswlai force-pushed the feature/mlagenttracer branch from 6eb634d to c712e12 Compare June 26, 2025 22:21

spotlessApply

b9821af

Signed-off-by: chrislai <[email protected]>

chriswlai temporarily deployed to ml-commons-cicd-env-require-approval June 26, 2025 22:27 — with GitHub Actions Inactive

chriswlai had a problem deploying to ml-commons-cicd-env-require-approval June 26, 2025 22:27 — with GitHub Actions Failure

chriswlai had a problem deploying to ml-commons-cicd-env-require-approval June 26, 2025 22:27 — with GitHub Actions Error

javadoc

5703c4f

Signed-off-by: chrislai <[email protected]>

chriswlai had a problem deploying to ml-commons-cicd-env-require-approval July 10, 2025 22:59 — with GitHub Actions Failure

more tests

1494166

Signed-off-by: chrislai <[email protected]>

chriswlai had a problem deploying to ml-commons-cicd-env-require-approval July 10, 2025 23:14 — with GitHub Actions Failure

more class fixes

9fc8b05

Signed-off-by: chrislai <[email protected]>

chriswlai had a problem deploying to ml-commons-cicd-env-require-approval July 12, 2025 00:20 — with GitHub Actions Failure

pyek-bot reviewed Jul 14, 2025

View reviewed changes

overloaded method

8c10cf6

Signed-off-by: chrislai <[email protected]>

chriswlai temporarily deployed to ml-commons-cicd-env-require-approval July 14, 2025 19:46 — with GitHub Actions Inactive

chriswlai had a problem deploying to ml-commons-cicd-env-require-approval July 14, 2025 20:50 — with GitHub Actions Failure

mingshl approved these changes Jul 15, 2025

View reviewed changes

pyek-bot approved these changes Jul 15, 2025

View reviewed changes

mingshl merged commit 1abc5fb into opensearch-project:feature/agent-tracing Jul 15, 2025
11 of 13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

MLAgentTracer Class #3946

MLAgentTracer Class #3946

Uh oh!

chriswlai commented Jun 26, 2025 •

edited

Loading

Uh oh!

brianf-aws left a comment

Uh oh!

brianf-aws Jun 26, 2025

Uh oh!

brianf-aws Jun 26, 2025

Uh oh!

pyek-bot Jul 14, 2025

Uh oh!

pyek-bot Jul 14, 2025

Uh oh!

chriswlai Jul 14, 2025

Uh oh!

pyek-bot Jul 14, 2025

Uh oh!

chriswlai Jul 14, 2025

Uh oh!

Uh oh!

Uh oh!

MLAgentTracer Class #3946

MLAgentTracer Class #3946

Uh oh!

Conversation

chriswlai commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

brianf-aws left a comment

Choose a reason for hiding this comment

Uh oh!

brianf-aws Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

brianf-aws Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

pyek-bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

pyek-bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

chriswlai Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

pyek-bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

chriswlai Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chriswlai commented Jun 26, 2025 •

edited

Loading