Skip to content

Commit 5153769

Browse files
committed
docs
1 parent fee63f9 commit 5153769

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

src/TraceEvent/TraceLog.cs

+12-6
Original file line numberDiff line numberDiff line change
@@ -224,17 +224,29 @@ public static TraceLogEventSource CreateFromEventPipeSession(EventPipeSession se
224224
return traceLog.realTimeSource;
225225
}
226226

227+
/// <summary>
228+
/// EventPipe real-time tracelog session configuration, used to populate the method and module information.
229+
/// </summary>
227230
public class EventPipeRundownConfiguration
228231
{
229232
internal readonly DiagnosticsClient m_client;
230233

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

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

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

321-
// Skip samples from the idle thread.
322-
if (data.ProcessID == 0 && data is SampledProfileTraceData)
323-
{
324-
return;
325-
}
326-
327333
var extendedDataCount = data.eventRecord->ExtendedDataCount;
328334
if (extendedDataCount != 0)
329335
{

0 commit comments

Comments
 (0)