[SDK] Support OTEL_SDK_DISABLED environment variable

[marcalff]

Fixes #1631

Changes

Please provide a brief description of the changes here.

For significant contributions please make sure you have completed the following items:

• CHANGELOG.md updated for non-trivial changes
• Unit tests have been added
• Changes in public API reviewed

[netlify]

✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.

Name	Link
🔨 Latest commit	5da4f7f
🔍 Latest deploy log	https://app.netlify.com/sites/opentelemetry-cpp-api-docs/deploys/67997132cbac2a00081e2ede

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.84%. Comparing base (6603c3a) to head (5da4f7f).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3245      +/-   ##
==========================================
+ Coverage   87.80%   87.84%   +0.05%     
==========================================
  Files         198      202       +4     
  Lines        6324     6345      +21     
==========================================
+ Hits         5552     5573      +21     
  Misses        772      772              

Files with missing lines	Coverage Δ
api/include/opentelemetry/logs/provider.h	100.00% <100.00%> (ø)
api/include/opentelemetry/metrics/provider.h	100.00% <ø> (ø)
api/include/opentelemetry/trace/provider.h	100.00% <ø> (ø)
exporters/ostream/test/ostream_log_test.cc	96.18% <100.00%> (ø)
sdk/src/common/disabled.cc	100.00% <100.00%> (ø)
sdk/src/logs/provider.cc	100.00% <100.00%> (ø)
sdk/src/metrics/provider.cc	100.00% <100.00%> (ø)
sdk/src/trace/provider.cc	100.00% <100.00%> (ø)

[lalitb]

@marcalff Thanks for the PR. Just a thought—rather than including set-provider methods in the SDK that check for the disabled , wouldn't it be better to offer more granular control within the get_logger/tracer/meter methods, allowing them to return no-op objects when the SDK is disabled? This way, users wouldn't need to use a new api, and it also ensures that new loggers or tracers won't function if the environment variable is disabled after the application starts.

[marcalff]

@marcalff Thanks for the PR. Just a thought—rather than including set-provider methods in the SDK that check for the disabled , wouldn't it be better to offer more granular control within the get_logger/tracer/meter methods, allowing them to return no-op objects when the SDK is disabled? This way, users wouldn't need to use a new api, and it also ensures that new loggers or tracers won't function if the environment variable is disabled after the application starts.

@lalib

Thanks for the suggestion.

I considered it as well, but decided against it for the following reasons:

• In terms or robustness, technical risk, and performance overhead,
  it is better to talk to the default Noop provider when the SDK is
  disabled, rather that invoke code in a real SDK implementation that will
  degrade itself to a Noop.

• For SDK code that opentelemetry-cpp has control of, this may work,
  but there are unknowns with SDK classes implemented by third parties,
  which still may not honor OTEL_SDK_DISABLED.

• Implementing a check in the SDK on get_tracer() implies that the SDK
  always honor environment variables defined in the spec.
  This is invalidated by the declarative configuration project
  (config.yaml), because the spec says explicitly that every environment
  variable beside OTEL_EXPERIMENTAL_CONFIG_FILE is to be ignored
  when a yaml configuration file is used.
  Implementing the check inside get_tracer() in the SDK would break this.
  See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#declarative-configuration

As a result, the current proposal:

• Puts the test for OTEL_SDK_DISABLED in the SetTracerProvider() code path,
  when a configured SDK is installed by the application main().

• Will work to support declarative configuration later, I plan to add
  opentelemetry::sdk::trace::Provider::SetTracerProviderNoEnv(),
  to be used with a config.yaml file.

• Leaves the SDK execution (Get() code path) unchanged,
  and independent on how the SDK was configured.

As for environment variables changing during the process execution,
I don't think there is any expectation for this to work.
For example, changing an endpoint URL after the SDK is already configured
will have no effect.

In my understanding,
environment variables are meant to be a simple way to change the SDK
configuration without having to change code in the main application,
but are not meant to change during execution.
Honoring a change in OTEL_SDK_DISABLED between start and end span will cause
chaos, for unclear benefit.