Unify instrumentation *Provider options

[MrAlias]

Currently there are many instrumentation packages that are directly configurable with a Tracer or Meter to use in the telemetry they gather.

• opentelemetry-go-contrib/instrumentation/go.mongodb.org/mongo-driver/config.go

  Line 50 in 32a76fe

  func WithTracer(tracer trace.Tracer) Option {

• opentelemetry-go-contrib/instrumentation/github.com/gin-gonic/gin/option.go

  Line 36 in 370078e

  func WithTracer(tracer oteltrace.Tracer) Option {

• opentelemetry-go-contrib/instrumentation/github.com/gorilla/mux/config.go

  Line 35 in 370078e

  func WithTracer(tracer oteltrace.Tracer) Option {

• opentelemetry-go-contrib/instrumentation/github.com/labstack/echo/config.go

  Line 35 in 370078e

  func WithTracer(tracer oteltrace.Tracer) Option {

• opentelemetry-go-contrib/instrumentation/github.com/emicklei/go-restful/config.go

  Line 35 in 19be05c

  func WithTracer(tracer oteltrace.Tracer) Option {

• opentelemetry-go-contrib/instrumentation/github.com/Shopify/sarama/option.go

  Line 55 in 70957fc

  func WithTracer(tracer trace.Tracer) Option {

• opentelemetry-go-contrib/instrumentation/github.com/gocql/gocql/config.go

  Line 84 in 7066c08

  func WithTracer(tracer trace.Tracer) TracedSessionOption {

• opentelemetry-go-contrib/instrumentation/net/http/config.go

  Line 62 in 3fc65dc

  func WithTracer(tracer trace.Tracer) Option {

• opentelemetry-go-contrib/instrumentation/net/http/config.go

  Line 70 in 3fc65dc

  func WithMeter(meter metric.Meter) Option {

They should not be configurable to do this. It is the instrumentations job to define the Tracer or Meter they use from a *Provider.

The global package was made to provide this functionality. It provides a shim until an SDK is registered that will make sure all instrumentation use the correct *Providers. However, since these instrumentation packages are expected to be wrapped in other instrumentation that might want the functionality to use a unique *Provider and the possible aversion some uses will have with the idea of globals, the instrumentation needs to be configurable to accept *Providers instead of Tracers and Meters directly.

TODO

• Remove all configuration for Tracer and Meter in the existing instrumentation.
• Refactor instrumentation to accept a TraceProvider if it uses a Tracer, a MeterProvider if it uses a Meter, and Propagators if it handles any context propagation. The default for each of these needs to be the one provided by the global package.
• Update the instrumentation guidelines to include this info.

Originally posted by @XSAM in #209 (comment)

[MrAlias]

Optionally, the instrumentation could be configured to accept a *Provider instead that would override the global package. As well maybe the configuration of Propagators could remain as well.

These could be useful to an operator if they wanted to separate out functionality. Though, outside of the propagators, I'm not immediately sure why.

[MrAlias]

From the SIG meeting today, instrumentation in this repo ...

1. MUST provide an option to accept a TraceProvider if it uses a Tracer, a MeterProvider if it uses a Meter, and Propagators if it handles any context propagation
2. MUST use the default TraceProvider, MeterProvider, and Propagators supplied by the global package if no optional one is provided.
3. MUST not provide an option to accept a Tracer or Meter.
4. MUST create any used Tracer or Meter with a name matching the instrumentation package name.

[XSAM]

I'd like to take this up.

[reggiemcdonald]

@XSAM yesterday I started a fix for the gocql instrumentation. Did you mind skipping that one?

[XSAM]

@reggiemcdonald Not at all, I will skip that part.

[XSAM]

@MrAlias

Refactor instrumentation to accept a TraceProvider if it uses a Tracer, a MeterProvider if it uses a Meter, and Propagators if it handles any context propagation. The default for each of these needs to be the one provided by the global package.

Maybe we can use TracerProvider instead of TraceProvider, because it brings more consistency for naming since the other provider is called MeterProvider.

[MrAlias]

@MrAlias

Refactor instrumentation to accept a TraceProvider if it uses a Tracer, a MeterProvider if it uses a Meter, and Propagators if it handles any context propagation. The default for each of these needs to be the one provided by the global package.

Maybe we can use TracerProvider instead of TraceProvider, because it brings more consistency for naming since the other provider is called MeterProvider.

Yes, wow, that is indeed the correct approach. That was definitely a mistake on my part. 😥

Looks like this mistake was propagated to implementation already. @XSAM if you want to update the existing options that would be awesome, but I feel responsible for this mistake and happy to clean it up myself. Let me know what you think.

[XSAM]

if you want to update the existing options that would be awesome

No problem, I would like to update the existing options. It looks like a global replacement command could address that typo. :)