Skip to content

Commit 721e322

Browse files
authored
Update monitor-activity.adoc
1 parent a9ec8ce commit 721e322

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

modules/ai-agents/pages/mcp/remote/monitor-activity.adoc

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,27 @@ Every MCP server automatically emits OpenTelemetry traces to a topic called `red
77

88
You must have an existing MCP server. If you do not have one, see xref:ai-agents:mcp/remote/quickstart.adoc[].
99

10-
== OpenTelemetry traces topic
10+
== Execution log
1111

12-
When you create an MCP server, Redpanda automatically creates the `redpanda.otel_traces` topic in your cluster. This topic stores OpenTelemetry span data in JSON format with 100% sampling rate (also known as an execution log), following the https://opentelemetry.io/docs/specs/otel/protocol/[OpenTelemetry Protocol (OTLP)^] specification.
12+
When you create an MCP server, Redpanda captures a complete execution log by recording all operations as OpenTelemetry traces with 100% sampling. This execution log is stored in the `redpanda.otel_traces` topic.
1313

14-
A Protobuf schema named `redpanda.otel_traces-value` is also automatically registered with the topic, enabling clients to deserialize trace data correctly.
14+
=== Traces and spans
15+
16+
OpenTelemetry traces provide a complete picture of how a request flows through your system:
17+
18+
* A *trace* represents the entire lifecycle of a request (for example, a tool invocation from start to finish).
19+
* A *span* represents a single unit of work within that trace (such as a data processing operation or an external API call).
20+
* A trace contains one or more spans organized hierarchically, showing how operations relate to each other.
21+
22+
With 100% sampling, every operation is captured, creating a complete execution log that you can use for debugging, monitoring, and performance analysis.
23+
24+
=== How Redpanda stores traces
25+
26+
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.
1527

1628
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.
1729

18-
Each span represents a unit of work performed by your MCP server, such as:
30+
Each span in the execution log represents a specific operation performed by your MCP server, such as:
1931

2032
* Tool invocation requests
2133
* Data processing operations
@@ -25,11 +37,11 @@ Each span represents a unit of work performed by your MCP server, such as:
2537

2638
=== Topic configuration and lifecycle
2739

28-
The `redpanda.otel_traces` topic is managed automatically by Redpanda and follows a predefined retention policy. Configuration changes to this topic are not supported. If you modify settings, Redpanda reverts them to the default values.
40+
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.
2941

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

32-
You can create xref:security:authorization/acl.adoc[ACLs] to control access to the `redpanda.otel_traces` topic using standard Redpanda ACL operations.
44+
You can create glossterm:ACL[,access control lists (ACLs)] to control access to the `redpanda.otel_traces` topic using standard Redpanda ACL operations.
3345

3446
Trace data may contain sensitive information from your tool inputs and outputs. Consider implementing appropriate access controls and review the data in traces before sharing or exporting to external systems.
3547

@@ -49,7 +61,7 @@ Traces are not:
4961
* Immutable audit records for compliance purposes
5062
* Designed for "who did what" accountability tracking
5163

52-
== Consume trace data
64+
== Consume traces from the execution log
5365

5466
You can consume traces from the `redpanda.otel_traces` topic using any Kafka-compatible client or the Redpanda Console.
5567

0 commit comments

Comments
 (0)