Use the Enable method of synchronous metric instruments (original) (raw)

The Enabled method was added to all synchronous instruments in #7763. This new method should be used in all instrumentation within the project, and documentation should be updated/created to promote its use.

Instrumentation

Update all uses of the metric API to check if the instrument is enabled prior to performing any computationally expensive operations.

• go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc/internal/observ
  • Checked if Instrument Enabled before measuring in otlpgrpc #7824
• go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp/internal/observ
  • exporter/otlploghttp: guard observ metrics with Enabled checks #7813
• go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc/internal/observ
  • Checked if instrument enabled before measuring in oteltracegrpc #7825
• go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp/internal/observ
  • Checked if Operation Enabled in otlptracehttp before performing operation #7881
• go.opentelemetry.io/otel/exporters/prometheus/internal/observ
  • Checked if instrument enabled before measuring in prometheus #7866
• go.opentelemetry.io/otel/exporters/stdout/stdoutmetric/internal/observ
  • stdoutmetric observ: skip metric work when instruments are disabled #7868
• go.opentelemetry.io/otel/exporters/stdout/stdouttrace/internal/observ
  • stdouttrace observability: skip metric work when instruments are disabled #7853
• go.opentelemetry.io/otel/sdk/log/internal/observ
  • sdk/log/observ: guard LogProcessed with Enabled #7848
• go.opentelemetry.io/otel/sdk/trace/internal/observ
  • sdk/trace/internal/observ: guard SpanStarted and spanLive with Enabled #8067 (review)
• go.opentelemetry.io/otel/semconv/templates/registry/go/instrument.j2
  • Update semconv template and 1.40.0 to use Enabled for metrics #8172
• go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc
  • Check if otelgrpc metrics are enabled opentelemetry-go-contrib#8792
• go.opentelemetry.io/contrib/instrumentation/runtime
  • Does not include any synchronous instruments
• go.opentelemetry.io/contrib/instrumentation/runtime/internal/deprecatedruntime
  • Check instrument enabled in deprecatedruntime opentelemetry-go-contrib#8793

Documentation

• Update our contributing documentation to describe recommended use of this API
  • Update contributing to recommend using Enabled #8189
• Update opentelemetry.io documentation for Go instrumentation
  • Go: document that users should check Enabled when making sychronous metric API calls opentelemetry.io#9643