opentelemetry-instrumentation-pubsub 0.0.1b1

Instrument Open Telemetry tracing within the GCP PubSub library

Open Telemetry GCP PubSub Instrumentation for Python

This package provides automatic instrumentation for the google-cloud-pubsub client library.

Installation

pip install opentelemetry-instrumentation-pubsub

Usage

Initiate the instrumentor after configuring your Open Telemetry trace provider.

from google.cloud import pubsub_v1
from pubsub_opentelemetry import PubSubInstrumentationProvider


# Instrument PubSub
PubSubInstrumentationProvider().instrument()

# Publish creates a span with PubSub specific attributes
with pubsub_v1.PublisherClient() as publisher:
    publisher.publish(topic_name, b'My first message!')

# Subscribe propagates the context from the received message
with pubsub_v1.SubscriberClient() as subscriber:
    subscriber.subscribe(subscription_name, callback)

---

Development

Install dependencies:

make install

Run lint checks:

make lint

Run unit tests:

make test

Run tests against supported Python versions (using tox):

make tox

License