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
System.Object
TraceFilteringSettings
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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
TraceFilteringSettings(ImmutableHashSet<IFilterRule>)
Declaration
public TraceFilteringSettings(ImmutableHashSet<IFilterRule> rules)
Parameters
| Type |
Name |
Description |
| System.Collections.Immutable.ImmutableHashSet<IFilterRule> |
rules |
|
TraceFilteringSettings(ImmutableHashSet<IFilterRule>, Boolean)
Declaration
public TraceFilteringSettings(ImmutableHashSet<IFilterRule> rules, bool alwaysIncludeMessagesInTrace)
Parameters
| Type |
Name |
Description |
| System.Collections.Immutable.ImmutableHashSet<IFilterRule> |
rules |
|
| System.Boolean |
alwaysIncludeMessagesInTrace |
|
TraceFilteringSettings(ImmutableHashSet<IFilterRule>, Boolean, Boolean)
Declaration
public TraceFilteringSettings(ImmutableHashSet<IFilterRule> rules, bool alwaysIncludeMessagesInTrace, bool verboseTracing)
Parameters
| Type |
Name |
Description |
| System.Collections.Immutable.ImmutableHashSet<IFilterRule> |
rules |
|
| System.Boolean |
alwaysIncludeMessagesInTrace |
|
| System.Boolean |
verboseTracing |
|
Fields
ExplicitFiltering
Declaration
public static readonly TraceFilteringSettings ExplicitFiltering
Field Value
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
Properties
AlwaysIncludeMessagesInTrace
Declaration
public bool AlwaysIncludeMessagesInTrace { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Rules
Declaration
public ImmutableHashSet<IFilterRule> Rules { get; }
Property Value
| Type |
Description |
| System.Collections.Immutable.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
VerboseTracing
Consider including all traces that have been given a FilterDecision.NoDecision
by the filtering system.
Declaration
public bool VerboseTracing { get; }
Property Value
| Type |
Description |
| System.Boolean |
|