Skip to content
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
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
5 changes: 5 additions & 0 deletions src/OpenTelemetry/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ 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.
([#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
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
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
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
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
35 changes: 35 additions & 0 deletions test/OpenTelemetry.Tests/Logs/LoggerProviderBuilderBaseTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// 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.


[Theory]
[InlineData("true", typeof(NoopLoggerProvider))]
[InlineData("false", typeof(LoggerProviderSdk))]
[InlineData(null, typeof(LoggerProviderSdk))]
public void LoggerProviderIsExpectedType(string? value, Type expected)
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, value);
var builder = new LoggerProviderBuilderBase();

using var provider = builder.Build();

Assert.IsType(expected, provider);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// 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);
}

[Theory]
[InlineData("true", typeof(NoopMeterProvider))]
[InlineData("false", typeof(MeterProviderSdk))]
[InlineData(null, typeof(MeterProviderSdk))]
public void LoggerProviderIsExpectedType(string? value, Type expected)
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, value);
var builder = new MeterProviderBuilderBase();

using var provider = builder.Build();

Assert.IsType(expected, provider);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,37 @@
// 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);
}

[Theory]
[InlineData("true", typeof(NoopTracerProvider))]
[InlineData("false", typeof(TracerProviderSdk))]
[InlineData(null, typeof(TracerProviderSdk))]
public void TracerProviderIsExpectedType(string? value, Type expected)
{
Environment.SetEnvironmentVariable(SdkConfigDefinitions.SdkDisableEnvVarName, value);
var builder = new TestTracerProviderBuilder();

using var provider = builder.Build();

Assert.IsType(expected, provider);
}

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