chore(doc): rename Studio doc to Observability & Studio with OpenTelemetry tracing guide#1186
Open
LearningGp wants to merge 1 commit intoagentscope-ai:mainfrom
Open
chore(doc): rename Studio doc to Observability & Studio with OpenTelemetry tracing guide#1186LearningGp wants to merge 1 commit intoagentscope-ai:mainfrom
LearningGp wants to merge 1 commit intoagentscope-ai:mainfrom
Conversation
…metry tracing guide Replace studio.md with observability.md covering both Studio visual debugging (unchanged) and new OpenTelemetry tracing configuration guide for Langfuse and other OTLP backends. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Renames and expands the Studio documentation into a consolidated “Observability & Studio” guide, adding OpenTelemetry (OTLP) tracing setup alongside the existing Studio visual debugging content.
Changes:
- Updated EN/ZH observability docs to include a combined Studio + OpenTelemetry tracing guide.
- Added TelemetryTracer + TracerRegistry usage examples, including Langfuse OTLP configuration.
- Updated the docs TOC to point from
task/studiototask/observabilityin both EN and ZH.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/zh/task/observability.md | Adds OpenTelemetry tracing section and restructures Studio content under a unified observability page (ZH). |
| docs/en/task/observability.md | Adds OpenTelemetry tracing section and restructures Studio content under a unified observability page (EN). |
| docs/_toc.yml | Replaces Studio TOC entries with Observability & Studio entries for EN/ZH navigation. |
Comments suppressed due to low confidence (4)
docs/en/task/observability.md:321
- The Jaeger example uses
http://localhost:4317, butTelemetryTraceris implemented withOtlpHttpSpanExporter(OTLP/HTTP), which expects an HTTP endpoint (commonlyhttp://localhost:4318/v1/traces). As written, this endpoint is likely to fail or confuse users; please update the example (and wording) to match OTLP/HTTP expectations.
docs/zh/task/observability.md:319 - 这里描述为“支持 OTLP 协议的平台都可以使用”，但
TelemetryTracer实际是基于OtlpHttpSpanExporter（OTLP/HTTP）。建议在文档中明确需要 OTLP/HTTP 端点（通常形如http://host:4318/v1/traces），避免用户按 gRPC(4317) 配置导致无法上报。
docs/en/task/observability.md:246 - This section says traces can be exported to “any platform that supports the OTLP protocol”, but
TelemetryTracerusesOtlpHttpSpanExporter(OTLP/HTTP). Please clarify that an OTLP/HTTP endpoint (typically including/v1/traces) is required, so readers don’t try OTLP/gRPC-only endpoints.
docs/zh/task/observability.md:244 - 此处说明可导出到“任何支持 OTLP 协议的平台”，但
TelemetryTracer使用的是 OTLP/HTTP 导出器。建议明确需要 OTLP/HTTP 的 endpoint（通常包含/v1/traces），以免读者误配到仅支持 OTLP/gRPC 的地址。
Comment on lines
56
to
60
| title: Structured Output | ||
| - file: en/task/studio | ||
| title: Studio | ||
| - file: en/task/observability | ||
| title: Observability & Studio | ||
| - file: en/task/agui | ||
| title: AG-UI Protocol |
There was a problem hiding this comment.
The TOC now points to en/task/observability, but there are still docs linking to the removed task/studio.md (e.g., docs/en/intro.md). Please update those links so users don’t hit a 404.
Comment on lines
131
to
136
| title: 结构化输出 | ||
| - file: zh/task/studio | ||
| title: Studio | ||
| - file: zh/task/observability | ||
| title: 可观测与调试 | ||
| - file: zh/task/agui | ||
| title: AG-UI 协议 | ||
| - file: zh/task/a2a |
There was a problem hiding this comment.
目录已从 zh/task/studio 改为 zh/task/observability，但仍有文档链接指向已移除的 task/studio.md（如 docs/zh/intro.md）。请同步更新这些链接，避免导航到不存在的页面。
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AgentScope-Java Version
1.0.11
Description
Replace studio.md with observability.md covering both Studio visual debugging (unchanged) and new OpenTelemetry tracing configuration guide for Langfuse and other OTLP backends.
Checklist
Please check the following items before code is ready to be reviewed.
mvn spotless:applymvn test)