Skip to content

Commit 1edd545

Browse files
committed
add readme section about locally testing metrics
1 parent 239db7d commit 1edd545

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,22 @@ $ just compose-down
198198
$ just compose-down-and-wipe
199199
```
200200

201+
#### testing opentelemetry metrics
202+
203+
When you add or update any metrics you might want to test them. While there is
204+
a way to check metric in unit-tests (see `TestEnvironment::collected_metrics`),
205+
you might also want to test manually.
206+
207+
We have set up a small docker-compose service (`opentelemetry`) you can start up
208+
via `docker compose up opentelemetry`. This start up a local instance of
209+
the [opentelemetry collector
210+
contrib](https://hub.docker.com/r/otel/opentelemetry-collector-contrib) image,
211+
configured for debug-logging.
212+
213+
After configuring your local environment for `OTEL_EXPORTER_OTLP_ENDPOINT` => `http://localhost:4317`
214+
(either in `.env` or `.docker.env`, depending on how you run the webserver), you
215+
can see any metrics you report and how they are exported to your collector.
216+
201217
#### FAQ
202218

203219
##### I see the error `standard_init_linux.go:211: exec user process caused "no such file or directory"` when I use docker-compose.

0 commit comments

Comments
 (0)