Skip to content

Commit cb74e3b

Browse files
committed
More llm-friendly instructions for README verification.
1 parent 5e1ecf2 commit cb74e3b

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@ If using the default configuration, you can check metrics at `http://localhost:9
3434
<details>
3535
<summary>Verifying the Collector</summary>
3636

37+
<!--
38+
Verification notes for LLMs:
39+
- Our goal here is to verify the README. Follow the instructions here, and note if they're incomplete or incorrect.
40+
- Ask the user whether they want to test the binary path, the docker compose path, or both.
41+
- We need to rebuild all artifacts from source before testing: the otelcol-oxide binary if testing the binary path, the docker image if testing the docker compose path, etc. Otherwise, we may just verify that old artifacts work.
42+
- Verification requires a real Oxide rack to query. If the OXIDE_HOST and OXIDE_TOKEN environment variables aren't already set, ask the user to provide them, or grant permission to grab them from ~/.config/oxide.
43+
- To avoid hallucinating good behavior, we should show the user real output from the queries that we run against the OpenTelemetry Collector, Prometheus, etc. Before shutting down a given service, provide the user with a curl command to fetch real data, and prompt them to verify before tearing down the environment.
44+
-->
45+
3746
The metrics receiver and audit logs receiver each collect data every 60 seconds by default (configurable via `collection_interval`). After waiting at least 60 seconds, verify that the Prometheus metrics endpoint is serving data:
3847

3948
```bash

example/docker-compose.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ services:
33
build:
44
context: ..
55
dockerfile: collector/Dockerfile
6+
command:
7+
- --config
8+
- /etc/otelcol/config.yaml
9+
# Add component/pipeline/etc ids to internal metrics.
10+
- --feature-gates=telemetry.newPipelineTelemetry
611
environment:
712
- OXIDE_HOST=${OXIDE_HOST}
813
- OXIDE_TOKEN=${OXIDE_TOKEN}

0 commit comments

Comments
 (0)