Skip to content

Add support for OTEL_SDK_DISABLED environment variable #6568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
+131 −1
Open

Add support for OTEL_SDK_DISABLED environment variable #6568

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3603f51
add support for OTEL_SDK_DISABLED environment variable
hannahhaering Oct 3, 2025
947fcb1
added changelog entry
hannahhaering Oct 3, 2025
ba7d7ae
fix environment variable parsing
hannahhaering Oct 3, 2025
6244098
Merge branch 'main' into support-sdk-disabled-envVar
hannahhaering Oct 3, 2025
ae28768
retry workflow
hannahhaering Oct 4, 2025
583b34b
Merge branch 'support-sdk-disabled-envVar' of https://github.com/hann…
hannahhaering Oct 4, 2025
ca695bf
Merge branch 'main' into support-sdk-disabled-envVar
hannahhaering Oct 6, 2025
bbf01d4
parameterize tests for OTEL_SDK_DISABLED
hannahhaering Oct 6, 2025
d35a343
Update src/OpenTelemetry/CHANGELOG.md
hannahhaering Oct 6, 2025
c51cd9e
parameterize tests for OTEL_SDK_DISABLED
hannahhaering Oct 6, 2025
0aa2dc3
Merge branch 'main' into support-sdk-disabled-envVar
hannahhaering Oct 6, 2025
ecacbf2
Add helper and refactor tests for sdk disabled env var
hannahhaering Oct 7, 2025
86b050b
Merge branch 'main' into support-sdk-disabled-envVar
hannahhaering Oct 7, 2025
d35c752
Update test/OpenTelemetry.Tests/Logs/LoggerProviderBuilderBaseTests.cs
hannahhaering Oct 7, 2025
dee73a9
Merge branch 'main' into support-sdk-disabled-envVar
hannahhaering Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/OpenTelemetry/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ Notes](../../RELEASENOTES.md).

## Unreleased

* Added support for the `OTEL_SDK_DISABLED` environment variable in TracerProvider,
MeterProvider, and LoggerProvider. When `OTEL_SDK_DISABLED=true`,
the SDK returns no-op implementations for all telemetry signals. Any other value
or absence of the variable leaves the SDK enabled, per the OpenTelemetry specification.
([#6568](https://github.com/open-telemetry/opentelemetry-dotnet/pull/6568))

## 1.13.0

Released 2025-Oct-01
Expand Down
10 changes: 10 additions & 0 deletions src/OpenTelemetry/Logs/Builder/LoggerProviderBuilderBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using OpenTelemetry.Internal;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Logs;

Expand Down Expand Up @@ -91,6 +93,14 @@ internal LoggerProvider Build()
bool validateScopes = false;
#endif
var serviceProvider = services.BuildServiceProvider(validateScopes);
var configuration = serviceProvider.GetRequiredService<IConfiguration>();
configuration.TryGetStringValue(SdkConfigDefinitions.SdkDisableEnvVarName, out var envVarValue);

if (bool.TryParse(envVarValue, out bool result) && result)
{
serviceProvider.Dispose();
return new NoopLoggerProvider();
}

return new LoggerProviderSdk(serviceProvider, ownsServiceProvider: true);
}
Expand Down
10 changes: 10 additions & 0 deletions src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using OpenTelemetry.Internal;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Metrics;

Expand Down Expand Up @@ -108,6 +110,14 @@ protected MeterProvider Build()
bool validateScopes = false;
#endif
var serviceProvider = services.BuildServiceProvider(validateScopes);
var configuration = serviceProvider.GetRequiredService<IConfiguration>();
configuration.TryGetStringValue(SdkConfigDefinitions.SdkDisableEnvVarName, out var envVarValue);

if (bool.TryParse(envVarValue, out bool result) && result)
{
serviceProvider.Dispose();
return new NoopMeterProvider();
}

return new MeterProviderSdk(serviceProvider, ownsServiceProvider: true);
}
Expand Down
9 changes: 9 additions & 0 deletions src/OpenTelemetry/SdkConfigDefinitions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

namespace OpenTelemetry;

internal static class SdkConfigDefinitions
{
public const string SdkDisableEnvVarName = "OTEL_SDK_DISABLED";
}
10 changes: 10 additions & 0 deletions src/OpenTelemetry/Trace/Builder/TracerProviderBuilderBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using OpenTelemetry.Internal;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Trace;

Expand Down Expand Up @@ -146,6 +148,14 @@ protected TracerProvider Build()
bool validateScopes = false;
#endif
var serviceProvider = services.BuildServiceProvider(validateScopes);
var configuration = serviceProvider.GetRequiredService<IConfiguration>();
configuration.TryGetStringValue(SdkConfigDefinitions.SdkDisableEnvVarName, out var envVarValue);

if (bool.TryParse(envVarValue, out bool result) && result)
{
serviceProvider.Dispose();
return new NoopTracerProvider();
}

return new TracerProviderSdk(serviceProvider, ownsServiceProvider: true);
}
Expand Down
43 changes: 43 additions & 0 deletions test/OpenTelemetry.Tests/Logs/LoggerProviderBuilderBaseTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using Xunit;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Logs.Tests;

public sealed class LoggerProviderBuilderBaseTests : IDisposable
{
public LoggerProviderBuilderBaseTests()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
}

public void Dispose()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
GC.SuppressFinalize(this);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A better way to do this, IMHO, would be to:

  1. Not set the value in the constructor
  2. Let the test set the value it's interested in
  3. Set it back to the original value when being disposed

You could use a similar pattern to this to implement it in a cross-cutting way, then the usage would be something like:

using (new EnvironmentVariableScope("OTEL_SDK_DISABLED", value))
{
    var builder = new LoggerProviderBuilderBase();

    using var provider = builder.Build();

    Assert.IsType(expected, provider);
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion, I've done that.

Is there any way I can retry the workflow without a commit? Sometimes the build fails even though I have no errors (like right now).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not without write access to the repo, no.


[Fact]
public void ReturnNoopLoggerProviderWhenSdkDisabledEnvVarSet()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, "true");
var builder = new LoggerProviderBuilderBase();

using var provider = builder.Build();

Assert.IsType<NoopLoggerProvider>(provider);
}

[Fact]
public void ReturnLoggerProviderSdkWhenSdkDisabledEnvVarNotSet()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
var builder = new LoggerProviderBuilderBase();

using var provider = builder.Build();

Assert.IsType<LoggerProviderSdk>(provider);
}
}
43 changes: 43 additions & 0 deletions test/OpenTelemetry.Tests/Metrics/MeterProviderBuilderBaseTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using Xunit;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Metrics.Tests;

public sealed class MeterProviderBuilderBaseTests : IDisposable
{
public MeterProviderBuilderBaseTests()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
}

public void Dispose()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
GC.SuppressFinalize(this);
}

[Fact]
public void ReturnNoopMeterProviderWhenSdkDisabledEnvVarSet()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, "true");
var builder = new MeterProviderBuilderBase();

using var provider = builder.Build();

Assert.IsType<NoopMeterProvider>(provider);
}

[Fact]
public void ReturnMeterProviderSdkWhenSdkDisabledEnvVarNotSet()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
var builder = new MeterProviderBuilderBase();

using var provider = builder.Build();

Assert.IsType<MeterProviderSdk>(provider);
}
}
36 changes: 35 additions & 1 deletion test/OpenTelemetry.Tests/Trace/TracerProviderBuilderBaseTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,45 @@
// SPDX-License-Identifier: Apache-2.0

using Xunit;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Trace.Tests;

public class TracerProviderBuilderBaseTests
public sealed class TracerProviderBuilderBaseTests : IDisposable
{
public TracerProviderBuilderBaseTests()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
}

public void Dispose()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
GC.SuppressFinalize(this);
}

[Fact]
public void ReturnNoopTracerProviderWhenSdkDisabledEnvVarSet()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, "true");
var builder = new TestTracerProviderBuilder();

using var provider = builder.Build();

Assert.IsType<NoopTracerProvider>(provider);
}

[Fact]
public void ReturnTracerProviderSdkWhenSdkDisabledEnvVarNotSet()
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, null);
var builder = new TestTracerProviderBuilder();

using var provider = builder.Build();

Assert.IsType<TracerProviderSdk>(provider);
}

[Fact]
public void AddInstrumentationInvokesFactoryTest()
{
Expand Down
Loading