Class EventPipeProfiler

Namespace

BenchmarkDotNet.Diagnosers

Assembly

BenchmarkDotNet.dll

public class EventPipeProfiler : IDiagnoser

Inheritance

object

EventPipeProfiler

Implements

IDiagnoser

Constructors

EventPipeProfiler()

public EventPipeProfiler()

EventPipeProfiler(EventPipeProfile, IReadOnlyCollection<EventPipeProvider>?, bool)

Creates a new instance of EventPipeProfiler

public EventPipeProfiler(EventPipeProfile profile = EventPipeProfile.CpuSampling, IReadOnlyCollection<EventPipeProvider>? providers = null, bool performExtraBenchmarksRun = true)

Parameters

profile EventPipeProfile

A named pre-defined set of provider configurations that allows common tracing scenarios to be specified succinctly.

providers IReadOnlyCollection<EventPipeProvider>

A list of EventPipe providers to be enabled.

performExtraBenchmarksRun bool

if set to true, benchmarks will be executed one more time with the profiler attached. If set to false, there will be no extra run but the results will contain overhead. True by default.

Fields

Default

public static readonly EventPipeProfiler Default

Field Value

EventPipeProfiler

Properties

Analysers

public IEnumerable<IAnalyser> Analysers { get; }

Property Value

IEnumerable<IAnalyser>

Exporters

public IEnumerable<IExporter> Exporters { get; }

Property Value

IEnumerable<IExporter>

Ids

public IEnumerable<string> Ids { get; }

Property Value

IEnumerable<string>

ShortName

public string ShortName { get; }

Property Value

string

Methods

DisplayResults(ILogger)

public void DisplayResults(ILogger resultLogger)

Parameters

resultLogger ILogger

GetRunMode(BenchmarkCase)

public RunMode GetRunMode(BenchmarkCase benchmarkCase)

Parameters

benchmarkCase BenchmarkCase

Returns

RunMode

Handle(HostSignal, DiagnoserActionParameters)

public void Handle(HostSignal signal, DiagnoserActionParameters parameters)

Parameters

signal HostSignal

parameters DiagnoserActionParameters

ProcessResults(DiagnoserResults)

public IEnumerable<Metric> ProcessResults(DiagnoserResults results)

Parameters

results DiagnoserResults

Returns

IEnumerable<Metric>

Validate(ValidationParameters)

public IEnumerable<ValidationError> Validate(ValidationParameters validationParameters)

Parameters

validationParameters ValidationParameters

Returns

IEnumerable<ValidationError>