Using EventSource's Start/Stop opcodes - cover best-practices and potential caveats. #2908
Comments
26 tasks
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostcs#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
noahfalk
added a commit
to noahfalk/docs
that referenced
this issue
Mar 28, 2022
This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete
IEvangelist
pushed a commit
to dotnet/docs
that referenced
this issue
Mar 31, 2022
* Add EventSource docs This is an initial set of docs for using EventSource. The goal was to capture most of the beginner + intermediate material from https://github.com/Microsoft/dotnet-samples/blob/master/Microsoft.Diagnostics.Tracing/EventSource/docs/EventSource.md For brevity I dropped some info about lesser used functionality (event localization and ETW channel support) while adding some more info on usage outside the PerfView+ETW ecosystem. I also added information on ActivityIDs which I haven't found documented anywhere. After this PR goes in I'd like to trim the EventSource class api-docs and add a link to this content as the main place to show overall usage. I also want to add a link to this content from the dotnet-samples github page and mark that one as being no longer maintained. This PR is intended to address dotnet/diagnostics#2908 - EventSource start/stop dotnet/diagnostics#2904 - "fast" eventsource dotnet/diagnostics#2902 - custom EventSource with dotnet-trace+vs dotnet/diagnostics#1347 - activity ids It partially covers dotnet/diagnostics#2445 - special case LogAlways behavior but I think we should do more in the API docs before marking that one complete * Fix indentation for lists (and other stuff) * Fix trailing spaces * Feedback and misc edits - Use 2nd person (you rather than we) - Attempted to simplify/clarify language in a few places - Fixed a few typos * Feedback Change Log from static field to get-only property Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
Start/Stop opcodes are mentioned in the new EventSource docs (dotnet/docs#28826) in the instrumentation portion and in the Activity Ids portion. |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Walkthrough: see #515
The text was updated successfully, but these errors were encountered: