GREsau.Tracing 0.1.0

GREsau.Tracing

GREsau.Tracing is a simplified alternative to dotnet-trace, consumable as a C# library rather than a CLI tool.

GREsau.Tracing will only output nettrace-format files. These can be viewed on Windows using PerfView, or converted to speedscope-format using dotnet-trace's convert command, and then viewed at https://www.speedscope.app.

# Converts nettrace file to speedscope, writing to trace.speedscope.json
$ dotnet-trace convert --format Speedscope trace.nettrace

This package has a dependency on Microsoft.Diagnostics.Tools.RuntimeClient, which is not yet available on NuGet (see dotnet/diagnostics#343). In the meantime, you can get it from the dotnet-core internal feed by adding the https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json NuGet source. This can be done by including this NuGet.Config file in your project:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <add key="dotnet-core" value="https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json" />
    </packageSources>
</configuration>

Basic Usage

To trace the current process for a period of time, saving the file as "trace.nettrace":

var client = new TraceClient();
await client.CollectAsync("trace.nettrace", TimeSpan.FromMinutes(1));

You can also trace a different process by passing in its ID:

var client = new TraceClient(processId: 123);
await client.CollectAsync("trace.nettrace", TimeSpan.FromMinutes(1));

By default, TraceClient will track CPU usage and general .NET runtime information, equivalent to running dotnet-trace with the cpu-sampling (default) profile. If you want to trace something different, you can pass in a collection of Microsoft.Diagnostics.Tools.RuntimeClient.Providers:

var gcCollectProvider = new Provider(
    "Microsoft-Windows-DotNETRuntime",
    (ulong)ClrTraceEventParser.Keywords.GC | (ulong)ClrTraceEventParser.Keywords.Exception,
    EventLevel.Informational);
var client = new TraceClient(new[] { gcCollectProvider });
await client.CollectAsync("trace.nettrace", TimeSpan.FromMinutes(1));