Skip to content

Commit 37eac94

Browse files
committed
address mroe comments
Signed-off-by: chrislai <[email protected]>
1 parent cc41762 commit 37eac94

File tree

5 files changed

+19
-5
lines changed

5 files changed

+19
-5
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
# Sample Data Prepper configuration for agent tracing
2+
# This is an example configuration for development purposes
13
ssl: false

docs/tutorials/agent_tracing/docker-compose.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Sample Docker Compose configuration for agent tracing setup
2+
# This is an example configuration for development purposes
13
version: '3'
24
services:
35
opensearch-node1:
@@ -33,7 +35,8 @@ services:
3335
bash -c "
3436
bin/opensearch-plugin remove opensearch-skills;
3537
bin/opensearch-plugin remove opensearch-ml;
36-
bin/opensearch-plugin install --batch telemetry-otel --batch file:///usr/share/opensearch/<YOUR_NAME>/opensearch-ml-3.1.0.0-SNAPSHOT.zip;
38+
bin/opensearch-plugin install --batch telemetry-otel;
39+
bin/opensearch-plugin install --batch file:///usr/share/opensearch/<YOUR_NAME>/opensearch-ml-3.1.0.0-SNAPSHOT.zip;
3740
OPENSEARCH_LOG4J_CONFIG_FILE=/usr/share/opensearch/config/telemetry-log4j2.xml ./opensearch-docker-entrypoint.sh opensearch"
3841
ports:
3942
- 9200:9200

docs/tutorials/agent_tracing/otel-collector-config.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Sample OpenTelemetry Collector configuration for agent tracing
2+
# This is an example configuration for development purposes
13
receivers:
24
otlp:
35
protocols:

docs/tutorials/agent_tracing/pipelines.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Sample Data Prepper pipelines configuration for agent tracing
2+
# This is an example configuration for development purposes
13
entry-pipeline:
24
workers: 8
35
source:

docs/tutorials/agent_tracing/setup_agent_tracing_and_visualization.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,8 @@ You may see error logs like this in Data Prepper:
126126
[raw-trace-pipeline-processor-worker-3-thread-1] ERROR org.opensearch.dataprepper.plugins.processor.oteltracegroup.OTelTraceGroupProcessor - Search request for traceGroup failed for traceIds: [] due to OpenSearch exception [type=index_not_found_exception, reason=no such index [otel-v1-apm-span]]
127127
```
128128

129-
These errors are expected and can be safely ignored. They occur because we're using custom static mappings instead of the default Data Prepper index mappings. The system will work correctly despite these warnings.
129+
These errors are expected and can be safely ignored. They occur because we're using custom static mappings instead of the default Data Prepper index mappings. The system will work correctly despite these warnings. There is no current robust solution to correct these errors, but remember these error messages are harmless and don't affect functionality.
130+
130131

131132
Verify services are running:
132133
```bash
@@ -153,14 +154,18 @@ Note: The `plugins.ml_commons.agent_tracing_enabled` setting only takes effect i
153154
Use this API to turn agent tracing on or off without restarting your cluster, as long as tracing is enabled globally.
154155

155156

156-
## 8. View Traces
157+
## 8. Run an Agent to Generate Traces
158+
159+
When you build and run agents normally, they automatically create traces as long as the tracing settings are enabled. For example, when you create a plan-execute-reflect agent following the [tutorial](https://docs.opensearch.org/latest/tutorials/gen-ai/agents/build-plan-execute-reflect-agent/) or run it as shown in the [intelligent troubleshooting blog post](https://opensearch.org/blog/intelligent-troubleshooting-using-opensearch-3-0s-plan-execute-reflect-agent/), the agent will generate comprehensive traces that capture every step of its execution. After execution, traces should appear in OpenSearch Dashboards within 3-5 minutes.
160+
161+
## 9. View Traces
157162

158163
- Open OpenSearch Dashboards at [http://localhost:5601](http://localhost:5601)
159164
- Navigate to **Observability → Traces**
160165
- You should see agent traces around ~3-5 minutes after agent execution
161166

162167

163-
## 9. Understanding the Visualizations
168+
## 10. Understanding the Visualizations
164169

165170
The traces visualization provides several main views to help you analyze and understand your trace data:
166171

@@ -195,7 +200,7 @@ The [`trace-graph-vega.json`](trace-graph-vega.json) file contains a Vega specif
195200
*Vega Graph View: This custom graph visualization shows the relationships between services and spans in your trace data, helping you understand dependencies and flow at a glance.*
196201

197202

198-
## 10. Setup Notes for Non-Docker Environments
203+
## 11. Setup Notes for Non-Docker Environments
199204

200205
If you're setting up agent tracing in a production environment without Docker Compose, consider these important notes:
201206

0 commit comments

Comments
 (0)