You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Aligning with where we put this in moby, and contrib is a slightly
more suitable location for this.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Copy file name to clipboardExpand all lines: contrib/otel/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,21 +5,21 @@ To test the OTEL functionality present in the CLI, you can spin up a small demo
5
5
- a Prometheus container;
6
6
- an Aspire Dashboard container
7
7
8
-
The `hack/otel` directory contains the compose file with the services configured, along with 2 basic configuration files: one for the OTEL collector and one for Prometheus.
8
+
The `contrib/otel` directory contains the compose file with the services configured, along with 2 basic configuration files: one for the OTEL collector and one for Prometheus.
9
9
10
10
## How can I use it?
11
11
12
-
1) Start the compose stack by running `docker compose up -d` in the `hack/otel/` directory;
12
+
1) Start the compose stack by running `docker compose up -d` in the `contrib/otel/` directory;
13
13
2) Export the env var used to override the OTLP endpoint:
14
14
`export DOCKER_CLI_OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317` (if running the CLI in a devcontainer or in other ways, you might have to change how you pass this env var);
15
15
3) Run the CLI to send some metrics to the endpoint;
16
16
4) Browse Prometheus at `http://localhost:9091/graph` or the Aspire Dashboard at `http://localhost:18888/metrics`;
17
17
5) In Prometheus, query `command_time_milliseconds_total` to see some metrics. In Aspire, select the resource in the dropdown.
18
18
19
-
> **Note**: The precise steps may vary based on how you're working on the codebase (buiding a binary and executing natively, running/debugging in a devcontainer, running the normal CLI as usual, etc... )
19
+
> **Note**: The precise steps may vary based on how you're working on the codebase (building a binary and executing natively, running/debugging in a devcontainer, running the normal CLI as usual, etc... )
20
20
21
21
## Cleanup?
22
22
23
-
Run `docker compose down` in the `hack/otel/` directory.
23
+
Run `docker compose down` in the `contrib/otel/` directory.
24
24
25
25
You can also run `unset DOCKER_CLI_OTEL_EXPORTER_OTLP_ENDPOINT` to get rid of the OTLP override from your environment.
0 commit comments