Skip to content

Commit 4aa0774

Browse files
committed
chore(docs): update dependency instructions for otel
1 parent 39be16b commit 4aa0774

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/dependency-updates.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,3 +346,16 @@ npm run create-location-data -- --skip-upload
346346

347347
TODO: Describe how to verify that uploading auto-complete locations still works
348348
as expected.
349+
350+
### `@opentelemetry/*`
351+
352+
Opentelemetry is an open source observability framework. We use it for capturing traces and metrics.
353+
354+
To test locally, follow instructions for local setup with docker-compose in the main [README](../README.md#observability). Check the console to ensure that you see the following logs:
355+
356+
- "\[INSTRUMENTATION] OTLP Collector provided" - indicates that you have correctly set the variables for sending to collector rather than console
357+
- "\[INSTRUMENTATION] Otel setup is valid" - the setup has been validated with Sentry and is compatible
358+
359+
Click around the site to generate traces, and make requests to endpoints with metrics enabled (e.g. /hibp/notify) to generate metrics data. These data are visible in the local grafana instance using the dashboard or explore pane. If traces and metrics appear (may take 30 seconds or so to propagate) then the system is working properly.
360+
361+
To validate in the cloud environment, you can push the update to the `dev` branch to automatically deploy it. Use the dev environment similarly to generate traces and metrics, then look for data in [Yardstick](https://yardstick.mozilla.org/) to confirm.

0 commit comments

Comments
 (0)