This module contains instrumentation code for Google Cloud Pub/Sub producers and consumers that use cloud.google.com/go/pubsub library starting from v1.3.1 and above.
To add the module to your go.mod file run the following command in your project directory:
$ go get github.com/instana/go-sensor/instrumentation/cloud.google.com/go/pubsubThis module is a drop-in replacement for cloud.google.com/go/pubsub in common publisher/subscriber use cases. It provides
type aliases for pubsub.Message, pubsub.PublishResult and pubsub.Subscription, however if your code performs any
configuration calls to the Pub/Sub API, such as updating the topic configuration or creating subscriptions, you might need add the named import for cloud.google.com/go/pubsub as well.
The instrumentation is implemented as a thin wrapper around service object methods and does not change their behavior. Thus, any limitations/usage patterns/recommendations for the original method also apply to the wrapped one.
In most cases it is enough to change the import path from cloud.google.com/go/pubsub to github.com/instana/go-sensor/instrumentation/cloud.google.com/go/pubsub and add an instance of instana.Sensor to the list of pubsub.NewClient() arguments to start tracing your communication over Google Cloud Pub/Sub with Instana.
In case your service uses push method to receive Google Cloud Pub/Sub messages,
this instrumentation package provides an HTTP middleware pubsub.TracingHandlerFunc() that extracts
Instana trace context and ensures trace continuation:
http.Handle("/", pubsub.TracingHandlerFunc(sensor, func (w http.ResponseWriter, req *http.Request) {
// deserialize and process the message from req.Body
})The pubsub.TracingHandlerFunc() is a complete replacement for a more generic HTTP instrumentation
done with instana.TracingHandlerFunc(), and will use it for any non-Pub/Sub request, so there is
no need to use both middleware wrappers on one handler.