opentelemetry-instrumentation-google-api-client 0.1.0

OpenTelemetry google-api-python-client instrumentation

This library allows tracing requests made through the google-api-python-client library. Every call to HttpRequest.execute produces a CLIENT span named gcp.api/<methodId> with the following attributes:

• rpc.method — the fully-qualified API method, e.g. storage.buckets.list

• gcp.client.service — the GCP service, e.g. storage (OTel semconv)

• http.request.method — the HTTP method

• server.address / server.port — the request host (port only when non-default)

• url.full — the request URL, with credentials and sensitive query values (e.g. X-Goog-Signature) redacted

On failure the span status is set to ERROR with error.type, and for googleapiclient.errors.HttpError the http.response.status_code is recorded.

Installation

pip install opentelemetry-instrumentation-google-api-client

Usage

from opentelemetry.instrumentation.google_api_client import (
    GoogleApiClientInstrumentor,
)
from googleapiclient.discovery import build

GoogleApiClientInstrumentor().instrument()

service = build("storage", "v1")
service.buckets().list(project="my-project").execute()

References

• google-api-python-client

• OpenTelemetry Project