Skip to content

docs(tracing): document migration to OtelTracingMiddleware - #2706

Open
RICARDO51167 wants to merge 1 commit into
agentscope-ai:mainfrom
RICARDO51167:codex/issue-1934-otel-tracing-migration
Open

docs(tracing): document migration to OtelTracingMiddleware#2706
RICARDO51167 wants to merge 1 commit into
agentscope-ai:mainfrom
RICARDO51167:codex/issue-1934-otel-tracing-migration

Conversation

@RICARDO51167

Copy link
Copy Markdown

AgentScope-Java Version

2.0.3-SNAPSHOT

Description

TracerRegistry and its Tracer abstraction are deprecated, but users upgrading from the legacy TelemetryTracer setup did not have an end-to-end migration path.

This PR:

  • clarifies the current Studio extension location of TelemetryTracer
  • documents migration to a process-wide OpenTelemetry SDK plus OtelTracingMiddleware
  • adds OTLP exporter, custom authorization header, and shutdown examples
  • keeps English and Chinese v2 docs aligned
  • updates TracerRegistry Javadoc without changing runtime behavior

Fixes #1934

Validation

  • mvn spotless:check
  • mvn -pl agentscope-core -am -DskipTests compile
  • mvn -pl agentscope-core -am -DskipTests javadoc:javadoc
  • cd docs && jupyter-book clean --all . && jupyter-book build .
  • mvn -DargLine=-Djava.awt.headless=true test (JDK 17)
  • mvn -DargLine=-Djava.awt.headless=true verify (JDK 17)

Checklist

  • Code has been formatted with mvn spotless:apply
  • All tests are passing (mvn test)
  • Javadoc comments are complete and follow project conventions
  • Related documentation has been updated
  • Code is ready for review

@codecov

codecov Bot commented Aug 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AgentScopeJavaBot AgentScopeJavaBot added area/docs Documentation area/core Core library: agentscope-core (general) labels Aug 14, 2026

@AgentScopeJavaBot AgentScopeJavaBot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 AI Review

Pure documentation PR adding migration guide from deprecated TracerRegistry/TelemetryTracer to OtelTracingMiddleware. High quality — OTel API usage correct, version numbers match BOM, EN/ZH docs aligned, cross-document links valid. Recommendation: APPROVE.

@AgentScopeJavaBot AgentScopeJavaBot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 AI Review

Pure documentation PR adding migration guide from deprecated TracerRegistry/TelemetryTracer to OtelTracingMiddleware. High quality — OTel API usage correct, version numbers match BOM, EN/ZH docs aligned, cross-document links valid. Recommendation: APPROVE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Core library: agentscope-core (general) area/docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: TelemetryTracer removed in 2.0.0-RC4 breaks TracerRegistry.register() — no migration path documented

2 participants