Skip to content
Open
Show file tree
Hide file tree
Changes from all 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);
Copy link
Member

Choose a reason for hiding this comment

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

nit: Call TryGetBoolValue


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

Choose a reason for hiding this comment

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

2 comments:

  1. Would probably be good to add a log here. Don't want support tickets raised for missing telemetry when users have shot themselves in the foot 😄

  2. This won't work for hosting scenarios. See line 80. This code is only invoked for manual/detached bootstrap. Something else will need to be done for hosting style. Ideally we would have a single solution for both but I haven't looked at where that might go.

}

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
17 changes: 17 additions & 0 deletions test/OpenTelemetry.Tests/EnvironmentVariableScope.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

internal sealed class EnvironmentVariableScope : IDisposable
{
private readonly string name;
private readonly string? previous;

public EnvironmentVariableScope(string name, string? value)
{
this.name = name;
this.previous = Environment.GetEnvironmentVariable(name);
Environment.SetEnvironmentVariable(name, value);
}

public void Dispose() => Environment.SetEnvironmentVariable(this.name, this.previous);
}
26 changes: 26 additions & 0 deletions test/OpenTelemetry.Tests/Logs/LoggerProviderBuilderBaseTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using Xunit;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Logs.Tests;

public sealed class LoggerProviderBuilderBaseTests
{
[Theory]
[InlineData("true", typeof(NoopLoggerProvider))]
[InlineData("false", typeof(LoggerProviderSdk))]
[InlineData(null, typeof(LoggerProviderSdk))]
public void LoggerProviderIsExpectedType(string? value, Type expected)
{
using (new EnvironmentVariableScope("OTEL_SDK_DISABLED", 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,26 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using Xunit;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Metrics.Tests;

public sealed class MeterProviderBuilderBaseTests
{
[Theory]
[InlineData("true", typeof(NoopMeterProvider))]
[InlineData("false", typeof(MeterProviderSdk))]
[InlineData(null, typeof(MeterProviderSdk))]
public void LoggerProviderIsExpectedType(string? value, Type expected)
{
using (new EnvironmentVariableScope("OTEL_SDK_DISABLED", 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,28 @@
// SPDX-License-Identifier: Apache-2.0

using Xunit;
using static OpenTelemetry.OpenTelemetrySdk;

namespace OpenTelemetry.Trace.Tests;

public class TracerProviderBuilderBaseTests
public sealed class TracerProviderBuilderBaseTests
{
[Theory]
[InlineData("true", typeof(NoopTracerProvider))]
[InlineData("false", typeof(TracerProviderSdk))]
[InlineData(null, typeof(TracerProviderSdk))]
public void TracerProviderIsExpectedType(string? value, Type expected)
{
using (new EnvironmentVariableScope("OTEL_SDK_DISABLED", value))
{
var builder = new TestTracerProviderBuilder();

using var provider = builder.Build();

Assert.IsType(expected, provider);
}
}

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