Skip to content

Commit 6342ede

Browse files
committed
Doc UI and update terminology for transcripts
1 parent 2ed4e2f commit 6342ede

2 files changed

Lines changed: 251 additions & 31 deletions

File tree

modules/ai-agents/pages/observability/concepts.adoc

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
= Transcripts and AI Observability
2-
:description: Understand how Redpanda captures execution traces for agents and MCP servers using OpenTelemetry.
2+
:description: Understand how Redpanda captures execution transcripts for agents and MCP servers using OpenTelemetry.
33
:page-topic-type: concepts
44
:personas: agent_developer, platform_admin, data_engineer
5-
:learning-objective-1: Explain how traces and spans capture execution flow
6-
:learning-objective-2: Interpret trace structure for debugging and monitoring
7-
:learning-objective-3: Distinguish between observability traces and audit logs
5+
:learning-objective-1: Explain how transcripts and spans capture execution flow
6+
:learning-objective-2: Interpret transcript structure for debugging and monitoring
7+
:learning-objective-3: Distinguish between transcripts and audit logs
88

9-
Redpanda automatically captures execution traces for both AI agents and MCP servers, providing complete observability into how your agentic systems operate.
9+
Redpanda automatically captures execution transcripts for both AI agents and MCP servers, providing complete observability into how your agentic systems operate.
1010

1111
After reading this page, you will be able to:
1212

@@ -27,7 +27,7 @@ Transcripts capture:
2727
* Error conditions
2828
* Performance metrics
2929

30-
With 100% sampling, every operation is captured, creating complete transcripts that you can use for debugging, monitoring, and performance analysis.
30+
With 100% sampling, every operation is captured, enabling comprehensive debugging, monitoring, and performance analysis.
3131

3232
== Traces and spans
3333

@@ -37,13 +37,13 @@ OpenTelemetry traces provide a complete picture of how a request flows through y
3737
* A _span_ represents a single unit of work within that trace (such as a data processing operation or an external API call).
3838
* A trace contains one or more spans organized hierarchically, showing how operations relate to each other.
3939

40-
== Agent trace hierarchy
40+
== Agent transcript hierarchy
4141

4242
Agent executions create a hierarchy of spans that reflect how agents process requests. Understanding this hierarchy helps you interpret agent behavior and identify where issues occur.
4343

4444
=== Agent span types
4545

46-
Agent traces contain these span types:
46+
Agent transcripts contain these span types:
4747

4848
[cols="2,3,3", options="header"]
4949
|===
@@ -90,13 +90,13 @@ This shows:
9090

9191
Examine span durations to identify where time is spent and optimize accordingly.
9292

93-
== MCP server trace hierarchy
93+
== MCP server transcript hierarchy
9494

95-
MCP server executions create a different hierarchy that reflects tool invocations and internal processing. Understanding this hierarchy helps you debug tool execution and identify performance bottlenecks.
95+
MCP server tool invocations produce a different span hierarchy focused on tool execution and internal processing. This structure reveals performance bottlenecks and helps debug tool-specific issues.
9696

9797
=== MCP server span types
9898

99-
MCP server traces contain these span types:
99+
MCP server transcripts contain these span types:
100100

101101
[cols="2,3,3", options="header"]
102102
|===
@@ -143,13 +143,13 @@ This shows:
143143

144144
The majority of time (4+ seconds) is spent in tool execution, while internal processing (mapping) takes only microseconds. This indicates the tool itself (likely making external API calls or database queries) is the bottleneck, not Redpanda Connect's internal processing.
145145

146-
== Trace layers and scope
146+
== Transcript layers and scope
147147

148-
Traces contain multiple layers of instrumentation, from HTTP transport through application logic to external service calls. The `scope.name` field in each span identifies which layer of instrumentation created that span.
148+
Transcripts contain multiple layers of instrumentation, from HTTP transport through application logic to external service calls. The `scope.name` field in each span identifies which instrumentation layer created that span.
149149

150150
=== Instrumentation layers
151151

152-
A complete agent trace includes these layers:
152+
A complete agent transcript includes these layers:
153153

154154
[cols="2,2,4", options="header"]
155155
|===
@@ -178,7 +178,7 @@ A complete agent trace includes these layers:
178178

179179
=== How layers connect
180180

181-
Layers connect through parent-child relationships in a single trace:
181+
Layers connect through parent-child relationships in a single transcript:
182182

183183
----
184184
ai-agent-http-server (HTTP Server layer)
@@ -191,7 +191,7 @@ ai-agent-http-server (HTTP Server layer)
191191
└── chat gpt-5-nano (AI SDK layer, LLM call 2)
192192
----
193193

194-
This shows:
194+
The request flow demonstrates:
195195

196196
1. HTTP request arrives at agent
197197
2. Agent invokes sub-agent
@@ -201,9 +201,9 @@ This shows:
201201
6. Agent makes second LLM call with tool results
202202
7. Response returns through HTTP layer
203203

204-
=== Cross-service traces
204+
=== Cross-service transcripts
205205

206-
When agents call MCP tools, the trace spans multiple services. Each service has a different `service.name` in the resource attributes:
206+
When agents call MCP tools, the transcript spans multiple services. Each service has a different `service.name` in the resource attributes:
207207

208208
* Agent spans: `"service.name": "ai-agent"`
209209
* MCP server spans: `"service.name": "mcp-{server-id}"`
@@ -240,9 +240,9 @@ Redpanda Connect layer:
240240

241241
- Component-specific attributes from your tool configuration
242242

243-
Use `scope.name` to filter spans by layer when analyzing traces.
243+
Use `scope.name` to filter spans by layer when analyzing transcripts.
244244

245-
== Understand the trace structure
245+
== Understand the transcript structure
246246

247247
Each span captures a unit of work. Here's what a typical MCP tool invocation looks like:
248248

@@ -273,7 +273,7 @@ Key elements to understand:
273273

274274
=== Parent-child relationships
275275

276-
Traces show how operations relate. A tool invocation (parent) may trigger internal operations (children):
276+
Transcripts show how operations relate. A tool invocation (parent) may trigger internal operations (children):
277277

278278
[,json]
279279
----
@@ -289,9 +289,9 @@ Traces show how operations relate. A tool invocation (parent) may trigger intern
289289

290290
The `parentSpanId` links this child span to the parent tool invocation. Both share the same `traceId` so you can reconstruct the complete operation.
291291

292-
== Error events in traces
292+
== Error events in transcripts
293293

294-
When something goes wrong, traces capture error details:
294+
When something goes wrong, transcripts capture error details:
295295

296296
[,json]
297297
----
@@ -314,32 +314,32 @@ When something goes wrong, traces capture error details:
314314
The `events` array captures what happened and when. Use `timeUnixNano` to see exactly when the error occurred within the operation.
315315

316316
[[opentelemetry-traces-topic]]
317-
== How Redpanda stores traces
317+
== How Redpanda stores trace data
318318

319-
The `redpanda.otel_traces` topic stores OpenTelemetry spans in JSON format, following the https://opentelemetry.io/docs/specs/otel/protocol/[OpenTelemetry Protocol (OTLP)^] specification. A Protobuf schema named `redpanda.otel_traces-value` is also automatically registered with the topic, enabling clients to deserialize trace data correctly.
319+
The `redpanda.otel_traces` topic stores OpenTelemetry spans using Redpanda's Schema Registry wire format with a custom Protobuf schema that closely follows the https://opentelemetry.io/docs/specs/otel/protocol/[OpenTelemetry Protocol (OTLP)^] specification. A schema named `redpanda.otel_traces-value` is automatically registered in the Schema Registry with the topic, enabling clients to deserialize trace data correctly.
320320

321-
The `redpanda.otel_traces` topic and its schema are managed automatically by Redpanda. If you delete either the topic or the schema, they are recreated automatically. However, deleting the topic permanently deletes all trace data, and the topic comes back empty. Do not produce your own data to this topic. It is reserved for OpenTelemetry traces.
321+
Redpanda manages both the topic and its schema automatically. If you delete either the topic or the schema, they are recreated automatically. However, deleting the topic permanently deletes all trace data, and the topic comes back empty. Do not produce your own data to this topic. It is reserved for OpenTelemetry traces.
322322

323323
=== Topic configuration and lifecycle
324324

325325
The `redpanda.otel_traces` topic has a predefined retention policy. Configuration changes to this topic are not supported. If you modify settings, Redpanda reverts them to the default values.
326326

327327
The topic persists in your cluster even after all agents and MCP servers are deleted, allowing you to retain historical trace data for analysis.
328328

329-
Trace data may contain sensitive information from your tool inputs and outputs. Consider implementing appropriate glossterm:ACL[access control lists (ACLs)] for the `redpanda.otel_traces` topic, and review the data in traces before sharing or exporting to external systems.
329+
Transcripts may contain sensitive information from your tool inputs and outputs. Consider implementing appropriate glossterm:ACL[access control lists (ACLs)] for the `redpanda.otel_traces` topic, and review the data in transcripts before sharing or exporting to external systems.
330330

331-
== Traces compared to audit logs
331+
== Transcripts compared to audit logs
332332

333-
OpenTelemetry traces are designed for observability and debugging, not audit logging or compliance.
333+
Transcripts are designed for observability and debugging, not audit logging or compliance.
334334

335-
Traces provide:
335+
Transcripts provide:
336336

337337
* Hierarchical view of request flow through your system (parent-child span relationships)
338338
* Detailed timing information for performance analysis
339339
* Ability to reconstruct execution paths and identify bottlenecks
340340
* Insights into how operations flow through distributed systems
341341

342-
Traces are not:
342+
Transcripts are not:
343343

344344
* Immutable audit records for compliance purposes
345345
* Designed for "who did what" accountability tracking

0 commit comments

Comments
 (0)