Skip to content

Commit 1950db6

Browse files
merge 1.1.1 hotfix to main (#43688)
* [AzureMonitorDistro] upgrade OpenTelemetry for hotfix (#43432) * hotfix * update changelog * update other packages as well * Update sdk/monitor/Azure.Monitor.OpenTelemetry.AspNetCore/CHANGELOG.md Co-authored-by: Rajkumar Rangaraj <[email protected]> * update changelog with feedback * fix link * add link to breaking changes section * change Distro to override Disable * update changelog * update changelog * update changelog * typo * update changelog --------- Co-authored-by: Rajkumar Rangaraj <[email protected]> * fix broken link * fix broken link * update changelog * edit changelog --------- Co-authored-by: Rajkumar Rangaraj <[email protected]>
1 parent 628f094 commit 1950db6

File tree

4 files changed

+56
-6
lines changed

4 files changed

+56
-6
lines changed

eng/Packages.Data.props

+6-6
Original file line numberDiff line numberDiff line change
@@ -168,11 +168,11 @@
168168

169169
<ItemGroup Condition="$(MSBuildProjectName.StartsWith('Azure.Monitor.OpenTelemetry'))">
170170
<!-- OpenTelemetry dependency approved for Azure.Monitor.OpenTelemetry.Exporter package only -->
171-
<PackageReference Update="OpenTelemetry" Version="1.8.0" />
172-
<PackageReference Update="OpenTelemetry.Exporter.InMemory" Version="1.8.0" />
173-
<PackageReference Update="OpenTelemetry.Extensions.Hosting" Version="1.8.0" />
174-
<PackageReference Update="OpenTelemetry.Instrumentation.AspNetCore" Version="1.7.0" />
175-
<PackageReference Update="OpenTelemetry.Instrumentation.Http" Version="1.7.0" />
171+
<PackageReference Update="OpenTelemetry" Version="1.8.1" />
172+
<PackageReference Update="OpenTelemetry.Exporter.InMemory" Version="1.8.1" />
173+
<PackageReference Update="OpenTelemetry.Extensions.Hosting" Version="1.8.1" />
174+
<PackageReference Update="OpenTelemetry.Instrumentation.AspNetCore" Version="1.8.1" />
175+
<PackageReference Update="OpenTelemetry.Instrumentation.Http" Version="1.8.1" />
176176
<PackageReference Update="OpenTelemetry.PersistentStorage.FileSystem" Version="1.0.0" />
177177
<PackageReference Update="Microsoft.AspNetCore.Http.Abstractions" Version="[2.1.1,6.0)" />
178178
<PackageReference Update="Microsoft.AspNetCore.Http.Features" Version="[2.1.1,6.0)" />
@@ -334,7 +334,7 @@
334334
<PackageReference Update="NSubstitute" Version="3.1.0" />
335335
<PackageReference Update="NUnit" Version="3.13.2" />
336336
<PackageReference Update="NUnit3TestAdapter" Version="4.4.2" />
337-
<PackageReference Update="OpenTelemetry" Version="1.8.0" />
337+
<PackageReference Update="OpenTelemetry" Version="1.8.1" />
338338
<PackageReference Update="OpenTelemetry.Instrumentation.SqlClient" Version="1.6.0-beta.3" />
339339
<PackageReference Update="Polly" Version="7.1.0" />
340340
<PackageReference Update="Polly.Contrib.WaitAndRetry" Version="1.1.1" />

sdk/monitor/Azure.Monitor.OpenTelemetry.AspNetCore/CHANGELOG.md

+12
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,18 @@
101101
resource detector to include the Azure Container Apps resource detector.
102102
([#41803](https://github.com/Azure/azure-sdk-for-net/pull/41803))
103103

104+
## 1.1.1 (2024-04-26)
105+
106+
### Other Changes
107+
108+
* Update OpenTelemetry dependencies.
109+
([#43432](https://github.com/Azure/azure-sdk-for-net/pull/43432))
110+
- OpenTelemetry 1.8.1
111+
- OpenTelemetry.Extensions.Hosting 1.8.1
112+
- OpenTelemetry.Instrumentation.AspNetCore 1.8.1
113+
- OpenTelemetry.Instrumentation.Http 1.8.1
114+
- This update is a response to [CVE-2024-32028](https://nvd.nist.gov/vuln/detail/CVE-2024-32028)
115+
104116
## 1.1.0 (2024-01-25)
105117

106118
### Other Changes

sdk/monitor/Azure.Monitor.OpenTelemetry.AspNetCore/src/OpenTelemetryBuilderExtensions.cs

+20
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
using Azure.Monitor.OpenTelemetry.AspNetCore.LiveMetrics;
99
using Azure.Monitor.OpenTelemetry.Exporter;
1010
using Azure.Monitor.OpenTelemetry.Exporter.Internals.Platform;
11+
using Microsoft.Extensions.Configuration;
1112
using Microsoft.Extensions.DependencyInjection;
1213
using Microsoft.Extensions.DependencyInjection.Extensions;
1314
using Microsoft.Extensions.Logging;
@@ -221,6 +222,25 @@ public static OpenTelemetryBuilder UseAzureMonitor(this OpenTelemetryBuilder bui
221222
return new Manager(options, new DefaultPlatform());
222223
});
223224

225+
builder.Services.AddOptions<AzureMonitorOptions>()
226+
.Configure<IConfiguration>((options, config) =>
227+
{
228+
// This is a temporary workaround for hotfix GHSA-vh2m-22xx-q94f.
229+
// https://github.com/open-telemetry/opentelemetry-dotnet/security/advisories/GHSA-vh2m-22xx-q94f
230+
// We are disabling the workaround set by OpenTelemetry.Instrumentation.AspNetCore v1.8.1 and OpenTelemetry.Instrumentation.Http v1.8.1.
231+
// The OpenTelemetry Community is deciding on an official stance on this issue and we will align with that final decision.
232+
// TODO: FOLLOW UP ON: https://github.com/open-telemetry/semantic-conventions/pull/961 (2024-04-26)
233+
if (config[EnvironmentVariableConstants.ASPNETCORE_DISABLE_URL_QUERY_REDACTION] == null)
234+
{
235+
config[EnvironmentVariableConstants.ASPNETCORE_DISABLE_URL_QUERY_REDACTION] = Boolean.TrueString;
236+
}
237+
238+
if (config[EnvironmentVariableConstants.HTTPCLIENT_DISABLE_URL_QUERY_REDACTION] == null)
239+
{
240+
config[EnvironmentVariableConstants.HTTPCLIENT_DISABLE_URL_QUERY_REDACTION] = Boolean.TrueString;
241+
}
242+
});
243+
224244
return builder;
225245
}
226246

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/Platform/EnvironmentVariableConstants.cs

+18
Original file line numberDiff line numberDiff line change
@@ -67,5 +67,23 @@ internal static class EnvironmentVariableConstants
6767
/// When set to true, exporter will emit resources as metric telemetry.
6868
/// </summary>
6969
public const string EXPORT_RESOURCE_METRIC = "OTEL_DOTNET_AZURE_MONITOR_ENABLE_RESOURCE_METRICS";
70+
71+
/// <summary>
72+
/// By default, OpenTelemetry.Instrumenation.AspNetCore v1.8.1 will redact query strings values from URLs.
73+
/// This environment variable can be set to true to disable this behavior.
74+
/// </summary>
75+
/// <remarks>
76+
/// <see href="https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/CHANGELOG.md#181"/>.
77+
/// </remarks>
78+
public const string ASPNETCORE_DISABLE_URL_QUERY_REDACTION = "OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION";
79+
80+
/// <summary>
81+
/// By default, OpenTelemetry.Instrumenation.Http v1.8.1 will redact query string values from URLs.
82+
/// This environment variable can be set to true to disable this behavior.
83+
/// </summary>
84+
/// <remarks>
85+
/// <see href="https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md#181"/>.
86+
/// </remarks>
87+
public const string HTTPCLIENT_DISABLE_URL_QUERY_REDACTION = "OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION";
7088
}
7189
}

0 commit comments

Comments
 (0)