Deprecate AddServiceLogEnricher method with its overloads, introduce replacements #6529
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bbc09ed to
ed2d9bc
Compare
ed2d9bc to
79e5bec
Compare
mariamgerges
approved these changes
Jun 23, 2025
Member
Author
|
@joperezr please review for |
Member
It is adding obsolete attributes to some APIs which is a breaking change though. Should we delay that till next major version bump? |
Member
Author
|
to be merged for 10.0.0 release only |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames the "Service Log Enricher" API to "Application Log Enricher" to better reflect its functionality. The existing AddServiceLogEnricher() methods are marked as obsolete with redirects to the new AddApplicationLogEnricher() methods, ensuring backward compatibility during the transition period.
Key changes:
- New
AddApplicationLogEnricher()methods marked as experimental APIs - Obsoleted the old
AddServiceLogEnricher()methods with diagnostic ID EXTOBS0002 - Updated all test files, documentation, and internal references to use the new naming
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| ApplicationEnricherServiceCollectionExtensions.cs | Added new AddApplicationLogEnricher() methods and obsoleted old AddServiceLogEnricher() methods with forwarding implementations |
| DiagnosticIds.cs | Added EXTOBS0002 diagnostic ID and obsolete message for the telemetry API transition |
| ApplicationLogEnricherOptions.cs | Updated XML documentation from "service" to "application" log enricher |
| README.md | Updated documentation examples to use new AddApplicationLogEnricher() method names |
| list-of-diagnostics.md | Added documentation entry for EXTOBS0002 obsolete diagnostic |
| ApplicationEnricherExtensionsTests.cs | Updated tests to use new AddApplicationLogEnricher() method names |
| ApplicationEnricherOptionsTests.cs | Renamed test method to reflect new naming convention |
| ApplicationLogEnricherTests.cs | Renamed variables and test methods for consistency with new naming |
| ServiceEnricherExtensionsTests.cs | New test file for obsolete API validation |
| Microsoft.Extensions.Telemetry.Tests.csproj | Added NoWarn for CS0436 and InjectObsoleteAttributeOnLegacy configuration |
| Microsoft.Extensions.Telemetry.csproj | Added NoWarn for CS0436 and InjectObsoleteAttributeOnLegacy configuration |
.../Microsoft.Extensions.Telemetry/Enrichment/ApplicationEnricherServiceCollectionExtensions.cs
Outdated
Show resolved
Hide resolved
.../Microsoft.Extensions.Telemetry/Enrichment/ApplicationEnricherServiceCollectionExtensions.cs
Outdated
Show resolved
Hide resolved
…ationEnricherServiceCollectionExtensions.cs Co-authored-by: Copilot <[email protected]>
…ationEnricherServiceCollectionExtensions.cs Co-authored-by: Copilot <[email protected]>
Member
Author
|
@joperezr could you please review, approve, merge? |
joperezr
reviewed
Oct 30, 2025
.../Microsoft.Extensions.Telemetry/Enrichment/ApplicationEnricherServiceCollectionExtensions.cs
Show resolved
Hide resolved
joperezr
reviewed
Oct 30, 2025
.../Microsoft.Extensions.Telemetry/Enrichment/ApplicationEnricherServiceCollectionExtensions.cs
Show resolved
Hide resolved
joperezr
reviewed
Oct 30, 2025
.../Microsoft.Extensions.Telemetry/Enrichment/ApplicationEnricherServiceCollectionExtensions.cs
Outdated
Show resolved
Hide resolved
Member
|
/azp run extensions-ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
joperezr
reviewed
Nov 4, 2025
src/Libraries/Microsoft.Extensions.Telemetry/Microsoft.Extensions.Telemetry.csproj
Show resolved
Hide resolved
joperezr
approved these changes
Nov 4, 2025
Member
joperezr
left a comment
There was a problem hiding this comment.
Minor NIT but looks good otherwise.
Member
|
I queued a rebuild given we added net10 TFM to the repo, so just to make sure that these new tests work there as well |
eduherminio
approved these changes
Nov 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #6532