Skip to content
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

Document EventSource trim feature switch behavior #23325

Open
1 task
LakshanF opened this issue Mar 15, 2021 · 0 comments
Open
1 task

Document EventSource trim feature switch behavior #23325

LakshanF opened this issue Mar 15, 2021 · 0 comments
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-fundamentals/svc Pri2

Comments

@LakshanF
Copy link
Member

LakshanF commented Mar 15, 2021

Issue description
Developers can also use feature switches to get additional size benefits when they trim an application. One such feature switch is turning off generated events from an application (through the feature switch, EventSourceSupport) which can be confusing to consumers of the applications since event support has been always present in .NET applications. For example, a customer using dotnet-trace on the trimmed application that has this feature switch turned on (set to false) will not get expected behavior from the application.

We don't expect mainline server scenarios to use this feature switch but for those who do (primarily client side applications looking to run in size constrained environments), documenting the impact is an important strategy we plan to adopt for end-users to check when their .NET application doesn't generate events. This issue comment discusses the planned behavior but a high level overview is the message quoted in that issue, "if you do X, all events will be disabled". We plan to fix our diagnostics tools (for example, see this issue where external tracing tools will get some notification of events being turned off) but as mentioned above, documentation of the behavior is a critical part for users.

Target framework

  • .NET

[Edited to add document details]


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Mar 15, 2021
@tdykstra tdykstra added doc-enhancement Improve the current content [org][type][category] Pri2 and removed ⌚ Not Triaged Not triaged Pri3 labels May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-fundamentals/svc Pri2
Projects
None yet
Development

No branches or pull requests

5 participants