EventSourceDocumentor.MSBuild
1.0.0
See the version list below for details.
dotnet add package EventSourceDocumentor.MSBuild --version 1.0.0
NuGet\Install-Package EventSourceDocumentor.MSBuild -Version 1.0.0
<PackageReference Include="EventSourceDocumentor.MSBuild" Version="1.0.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
paket add EventSourceDocumentor.MSBuild --version 1.0.0
#r "nuget: EventSourceDocumentor.MSBuild, 1.0.0"
// Install EventSourceDocumentor.MSBuild as a Cake Addin
#addin nuget:?package=EventSourceDocumentor.MSBuild&version=1.0.0
// Install EventSourceDocumentor.MSBuild as a Cake Tool
#tool nuget:?package=EventSourceDocumentor.MSBuild&version=1.0.0
This MSBuild task generates documentation for Events in a ETW EventSource class. This can combine event method comments like summary and resolution to helps Operations take action on the events.
/// <summary>
/// The request processing error during processing.
/// </summary>
/// <param name="RequestID">
/// The request id.
/// </param>
/// <param name="Url">
/// The url.
/// </param>
/// <resolution>Try fixing the configured url</resolution>
[Event(5, Keywords = Keywords.Requests,
Task = Tasks.Request, Opcode = EventOpcode.Suspend, Level = EventLevel.Error)]
public void RequestProcessingError(int RequestID, string Url)
{ WriteEvent(5, RequestID, Url); }
generates csv file named <EventSourceName>.csv
with record
EventName,EventId, EventLevel, Description, Resolution
RequestProcessingError,5, Error, The request processing error during processing., Try fixing the configured url
Note: only supports .Net4.5
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
GitHub repositories
This package is not used by any popular GitHub repositories.
1.0.0: First version of EventSource Event doc generator, handles cases where CustomEventSource is directly derived from EventSource class, rather than Interface deriving from EventSource.
Note: only supports .Net4.5