Class TraceFilteringSettings

Used to determine which types of messages should be filtered out of or into a new trace we're creating. This is designed to ultimately help reduce the amount of noise generated by the tracing system and to help break up large perpetual streams of messages into smaller, more easily digestible traces.

Inheritance

object

TraceFilteringSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phobos.Actor.Configuration

Assembly: Phobos.Actor.dll

Syntax

public sealed class TraceFilteringSettings

Constructors

TraceFilteringSettings(ITraceFilter)

Only accepts an ITraceFilter and creates a filtration engine that uses only that class.

Declaration

public TraceFilteringSettings(ITraceFilter filter)

Parameters

Type	Name	Description
ITraceFilter	filter	A user-defined ITraceFilter.

TraceFilteringSettings(ImmutableHashSet<IFilterRule>)

Declaration

public TraceFilteringSettings(ImmutableHashSet<IFilterRule> rules)

Parameters

Type	Name	Description
ImmutableHashSet<IFilterRule>	rules

TraceFilteringSettings(ImmutableHashSet<IFilterRule>, bool)

Declaration

public TraceFilteringSettings(ImmutableHashSet<IFilterRule> rules, bool alwaysIncludeMessagesInTrace)

Parameters

Type	Name	Description
ImmutableHashSet<IFilterRule>	rules
bool	alwaysIncludeMessagesInTrace

TraceFilteringSettings(ImmutableHashSet<IFilterRule>, bool, bool)

Declaration

public TraceFilteringSettings(ImmutableHashSet<IFilterRule> rules, bool alwaysIncludeMessagesInTrace, bool verboseTracing)

Parameters

Type	Name	Description
ImmutableHashSet<IFilterRule>	rules
bool	alwaysIncludeMessagesInTrace
bool	verboseTracing

Fields

ExplicitFiltering

Declaration

public static readonly TraceFilteringSettings ExplicitFiltering

Field Value

Type	Description
TraceFilteringSettings

IncludeOnlyExplicitlyTaggedMessagesRule

Only start new traces for messages tagged with the IWithTracing interface.

Declaration

public static readonly IFilterRule IncludeOnlyExplicitlyTaggedMessagesRule

Field Value

Type	Description
IFilterRule

NoFiltering

Declaration

public static readonly TraceFilteringSettings NoFiltering

Field Value

Type	Description
TraceFilteringSettings

Properties

AlwaysIncludeMessagesInTrace

Declaration

public bool AlwaysIncludeMessagesInTrace { get; }

Property Value

Type	Description
bool

Rules

Declaration

public ImmutableHashSet<IFilterRule> Rules { get; }

Property Value

Type	Description
ImmutableHashSet<IFilterRule>

UserDefinedTraceFilter

A user-defined ITraceFilter. Can be null.

When this value is set, overrides all of the Rules and is the sole determinant of what does or does not get traced inside Phobos.

Declaration

public ITraceFilter UserDefinedTraceFilter { get; }

Property Value

Type	Description
ITraceFilter

VerboseTracing

Consider including all traces that have been given a NoDecision by the filtering system.

Declaration

public bool VerboseTracing { get; }

Property Value

Type	Description
bool