Skip to content
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.

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

Create a utility to automatically wire-up Open Telemetry to the Google Cloud Observability suite. #380

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

michaelsafyan
Copy link

Reduce friction to set up Open Telemetry with Google Cloud backends.

As can be seen with tests/test_automatic.sh, this enables auto-instrumentation like:

opentelemetry-instrument  \
    --configurator=gcp \
    python \
    the/path/to/your/script.py

And with manual instrumentation, it enables very simple logic like:

from opentelemetry.configurator.gcp import OpenTelemetryGcpConfigurator

OpenTelemetryGcpConfigurator().configure()

Compare this with the much more complicated (and incomplete/confusing) instructions found here:

Note that in addition to reducing setup friction, this provides a means of unifying configuration steps across different environments as well as across future changes in the ingestion landscape. For example, if the preferred means of ingestion were to change, the API interface here could stay the same, while changing the core implementation logic. (For implementation logic that could break clients, that could come with a change in major version, even though the code interface did not change (making it still very easy for clients to upgrade to the new ingestion path).

@michaelsafyan michaelsafyan requested a review from a team as a code owner February 14, 2025 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant