EventSourceDocumentor.MSBuild 1.0.5

ETW EventSource Events Document (csv) generator.

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

Install-Package EventSourceDocumentor.MSBuild -Version 1.0.5
dotnet add package EventSourceDocumentor.MSBuild --version 1.0.5
<PackageReference Include="EventSourceDocumentor.MSBuild" Version="1.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EventSourceDocumentor.MSBuild --version 1.0.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

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.
         1.0.1: Fixing Output csv file to be placed at OutDir.
         1.0.2: CSV name would match style of .Man files ie AssemblyName.EventSourceName.csv
         1.0.3: Preserving line breaks from comments into the csv columns
         1.0.4: Re-ordering the columns in csv output
         1.0.5: Show code warnings if <summary> is not defined.
                Show code warning if <resolution> is not defined for Error or Critical level events.  
         Note: only supports .Net4.5

Dependencies

This package has no dependencies.

Version History

Version Downloads Last updated
1.0.5 1,484 11/13/2014
1.0.4 1,042 11/10/2014
1.0.3 1,002 11/10/2014
1.0.2 648 11/10/2014
1.0.1 712 11/10/2014
1.0.0 681 11/10/2014