Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vaind committed May 23, 2024
1 parent fee63f9 commit 5153769
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions src/TraceEvent/TraceLog.cs
Original file line number Diff line number Diff line change
Expand Up @@ -224,17 +224,29 @@ public static TraceLogEventSource CreateFromEventPipeSession(EventPipeSession se
return traceLog.realTimeSource;
}

/// <summary>
/// EventPipe real-time tracelog session configuration, used to populate the method and module information.
/// </summary>
public class EventPipeRundownConfiguration
{
internal readonly DiagnosticsClient m_client;

private EventPipeRundownConfiguration(DiagnosticsClient client) { m_client = client; }

/// <summary>
/// No rundown will be requested, thus it may be impossible to symbolicate events. This is OK, if you don't
/// require method/module info the captured events.
/// </summary>
public static EventPipeRundownConfiguration None()
{
return new EventPipeRundownConfiguration(null);
}

/// <summary>
/// If the rundown is enabled and a DiagnosticsClient is given, TraceLog.CreateFromEventPipeSession will
/// create an additional short-lived diagnostics session to load all module/method information up to that
/// point.
/// </summary>
public static EventPipeRundownConfiguration Enable(DiagnosticsClient client)
{
return new EventPipeRundownConfiguration(client);
Expand Down Expand Up @@ -318,12 +330,6 @@ private unsafe void OnAllEventPipeEventsRealTime(TraceEvent data)
rawEventSourceToConvert.currentID = (EventIndex)eventCount;
}

// Skip samples from the idle thread.
if (data.ProcessID == 0 && data is SampledProfileTraceData)
{
return;
}

var extendedDataCount = data.eventRecord->ExtendedDataCount;
if (extendedDataCount != 0)
{
Expand Down

0 comments on commit 5153769

Please sign in to comment.