-
Notifications
You must be signed in to change notification settings - Fork 737
Update AzureAppService integration to set new suppress configuration name #12878
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.
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
base: main
Are you sure you want to change the base?
Conversation
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12878Or
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12878" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the AzureAppService integration to use the new, simplified configuration name Dashboard__Otlp__SuppressUnsecuredMessage instead of the older Dashboard__Otlp__SuppressUnsecuredTelemetryMessage. The new name is consistent with the similar MCP configuration Dashboard__Mcp__SuppressUnsecuredMessage. Backward compatibility is maintained by keeping the old name as a legacy configuration option.
Key Changes
- Updated configuration name to align with naming conventions across Dashboard settings
- Maintained backward compatibility for the old configuration name
- Updated all test snapshots and playground files to reflect the new configuration name
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentUtility.cs |
Updated app settings to use new Dashboard__Otlp__SuppressUnsecuredMessage configuration name |
src/Shared/DashboardConfigNames.cs |
Removed old non-legacy config name and updated legacy config name to use proper naming suffix and environment variable format |
src/Aspire.Dashboard/Configuration/PostConfigureDashboardOptions.cs |
Updated reference to use the corrected legacy config name property |
tests/Aspire.Dashboard.Tests/DashboardOptionsTests.cs |
Updated test to use the corrected legacy config name property |
tests/Aspire.Hosting.Azure.Tests/Snapshots/*.verified.bicep |
Updated snapshot files to reflect new configuration name in generated Bicep templates |
playground/AzureAppService/AzureAppService.AppHost/infra.module.bicep |
Updated playground infrastructure to use new configuration name |
|
FYI @ShilpiRach |
src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentUtility.cs
Show resolved
Hide resolved
| dashboard.SiteConfig.AppSettings.Add(new AppServiceNameValuePair { Name = "Dashboard__Frontend__AuthMode", Value = "Unsecured" }); | ||
| dashboard.SiteConfig.AppSettings.Add(new AppServiceNameValuePair { Name = "Dashboard__Otlp__AuthMode", Value = "Unsecured" }); | ||
| dashboard.SiteConfig.AppSettings.Add(new AppServiceNameValuePair { Name = "Dashboard__Otlp__SuppressUnsecuredTelemetryMessage", Value = "true" }); | ||
| dashboard.SiteConfig.AppSettings.Add(new AppServiceNameValuePair { Name = "Dashboard__Otlp__SuppressUnsecuredMessage", Value = "true" }); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing we need to be careful of is that Azure AppService is not updated to the latest dashboard at all times. It takes a while. Currently, it is using 9.5.2 in Azure. So if we merged this, it will break for anyone using main builds.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When will it be safe to change? Merging now would make this change for 13.1. Should it wait a release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ShilpiRach - thoughts?
I think AppService is waiting on us producing a 13.0 dashboard docker image. And then it would need to roll that out to all AppService regions.
Description
Dashboard__Otlp__SuppressUnsecuredTelemetryMessagewas added in 9.5.1(?)Dashboard__Otlp__SuppressUnsecuredMessageis the new name in v13 (old name still works!) to be consistent withDashboard__Mcp__SuppressUnsecuredMessageThis PR changes AzureAppService intergration to use the new config name.
Checklist
<remarks />and<code />elements on your triple slash comments?doc-ideatemplatebreaking-changetemplatediagnostictemplate