Class EventPipeProfiler

Inheritance

Object

EventPipeProfiler

Implements

IDiagnoser

Namespace: BenchmarkDotNet.Diagnosers

Assembly: BenchmarkDotNet.dll

Syntax

public class EventPipeProfiler : IDiagnoser

Constructors

EventPipeProfiler()

Declaration

public EventPipeProfiler()

EventPipeProfiler(EventPipeProfile, IReadOnlyCollection<EventPipeProvider>, Boolean)

Creates a new instance of EventPipeProfiler

Declaration

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

Parameters

Type	Name	Description
EventPipeProfile	profile	A named pre-defined set of provider configurations that allows common tracing scenarios to be specified succinctly.
IReadOnlyCollection<EventPipeProvider>	providers	A list of EventPipe providers to be enabled.
Boolean	performExtraBenchmarksRun	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

Declaration

public static readonly EventPipeProfiler Default

Field Value

Type	Description
EventPipeProfiler

Properties

Analysers

Declaration

public IEnumerable<IAnalyser> Analysers { get; }

Property Value

Type	Description
IEnumerable<IAnalyser>

Exporters

Declaration

public IEnumerable<IExporter> Exporters { get; }

Property Value

Type	Description
IEnumerable<IExporter>

Ids

Declaration

public IEnumerable<string> Ids { get; }

Property Value

Type	Description
IEnumerable<String>

ShortName

Declaration

public string ShortName { get; }

Property Value

Type	Description
String

Methods

DisplayResults(ILogger)

Declaration

public void DisplayResults(ILogger resultLogger)

Parameters

Type	Name	Description
ILogger	resultLogger

GetRunMode(BenchmarkCase)

Declaration

public RunMode GetRunMode(BenchmarkCase benchmarkCase)

Parameters

Type	Name	Description
BenchmarkCase	benchmarkCase

Returns

Type	Description
RunMode

Handle(HostSignal, DiagnoserActionParameters)

Declaration

public void Handle(HostSignal signal, DiagnoserActionParameters parameters)

Parameters

Type	Name	Description
HostSignal	signal
DiagnoserActionParameters	parameters

ProcessResults(DiagnoserResults)

Declaration

public IEnumerable<Metric> ProcessResults(DiagnoserResults results)

Parameters

Type	Name	Description
DiagnoserResults	results

Returns

Type	Description
IEnumerable<Metric>

RequiresBlockingAcknowledgments(BenchmarkCase)

Declaration

public bool RequiresBlockingAcknowledgments(BenchmarkCase benchmarkCase)

Parameters

Type	Name	Description
BenchmarkCase	benchmarkCase

Returns

Type	Description
Boolean

Validate(ValidationParameters)

Declaration

public IEnumerable<ValidationError> Validate(ValidationParameters validationParameters)

Parameters

Type	Name	Description
ValidationParameters	validationParameters

Returns

Type	Description
IEnumerable<ValidationError>

Implements

IDiagnoser