feat: Add OpenTelemetry integration for API service #2251
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Running Code Quality on PRs by uploading data to Trunk will soon be removed. You can still run checks on your PRs using trunk-action - see the migration guide for more information. |
This change introduces OpenTelemetry dependencies, and uses `opentelemetry-instrument` auto-instrumentation to allow users to configure OpenTelemetry settings via environment variables [1]. The only custom environment variable added is `OTEL_SERVICE_NAME_PREFIX`, which allows users to set a prefix to the service names included by RomM to differentiate between `api`, `worker`, and `watcher` services. The instrumentation of RQ workers and file watcher will be added in subsequent pull requests. [1] https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/
2ca63b9 to
652df5d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change introduces OpenTelemetry dependencies, and uses
opentelemetry-instrumentauto-instrumentation to allow users to configure OpenTelemetry settings via environment variables [1].The only custom environment variable added is
OTEL_SERVICE_NAME_PREFIX, which allows users to set a prefix different thanromm(default) for the generated service names. We need to use different services names forapi,worker, andwatcher.The instrumentation of RQ workers and file watcher will be added in subsequent pull requests.
[1] https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/
Checklist