Skip to content

chore(docs): update dependency instructions for otel #6467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kschelonka wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

chore(docs): update dependency instructions for otel #6467

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/dependency-updates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,3 +346,16 @@ npm run create-location-data -- --skip-upload

TODO: Describe how to verify that uploading auto-complete locations still works
as expected.

### `@opentelemetry/*`

Opentelemetry is an open source observability framework. We use it for capturing traces and metrics.

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:

- "\[INSTRUMENTATION] OTLP Collector provided" - indicates that you have correctly set the variables for sending to collector rather than console
- "\[INSTRUMENTATION] Otel setup is valid" - the setup has been validated with Sentry and is compatible

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.

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.
Loading