Class LoggingBackend

Base class for all logging backends (sometimes called sinks, targets, or listeners) of the PostSharp logging system.

Inheritance

object

LoggingBackend

MultiplexerBackend

NullLoggingBackend

TextLoggingBackend

Implements

IDisposable

Namespace: PostSharp.Patterns.Diagnostics

Assembly: PostSharp.Patterns.Diagnostics.dll

Syntax

Full screen

public abstract class LoggingBackend : IDisposable

Remarks

To implement your own logging backend, derive from the TextLoggingBackend class, which implements the standard logic for logging text. A custom backend usually also derives a class from LoggingTypeSource, returned by CreateTypeSource(LoggingNamespaceSource, Type), a class from TextLogRecordBuilder, returned by CreateRecordBuilder(), and an options class from TextLoggingBackendOptions. Override the factory methods of the context classes only when the contexts must store more information.

To use a backend, assign an instance to DefaultBackend when the application starts. To write to several backends at the same time, use the MultiplexerBackend.

Constructors

Name	Description
LoggingBackend()	Initializes a new instance of the LoggingBackend class.

Properties

Name	Description
CurrentContext	Gets the current LoggingContext.
CurrentContextLocalConfiguration	Gets the LoggingContextLocalConfiguration for the current execution. Returns DefaultContextLocalConfiguration unless the context has been overwritten by WithContextLocalConfiguration(LoggingContextLocalConfiguration).
DefaultContextLocalConfiguration	Gets the default LoggingContextLocalConfiguration, used unless it has been overwritten by WithContextLocalConfiguration(LoggingContextLocalConfiguration) for the current execution context.
DefaultVerbosity	Gets the LoggingVerbosityConfiguration of the DefaultContextLocalConfiguration.
IsCorrupted	Gets a value indicating whether the current LoggingBackend is in a state where it can no longer be recovered. This typically happens when an exception occurs while disabling or enabling.
IsDisposed	Gets a value indicating whether the current LoggingBackend has been disposed.
IsEnabled	Gets or sets a value indicating whether the current LoggingBackend is enabled. This property has precedence over, and does not affect, the minimum log levels set through the SetLevel(LogLevel) method.
Options	Gets the formatting and rendering options for the current LoggingBackend.
TransactionPolicySelector	Gets or sets the selector that determines what policy to apply for each transaction or whether the transaction should be logged as a transaction at all.

Methods

Name	Description
CreateAsyncCustomActivityContext()	Creates a new AsyncCustomActivityLoggingContext.
CreateAsyncMethodContext()	Creates a new AsyncMethodLoggingContext for a given async method.
CreateContextLocalConfiguration(LoggingVerbosityConfiguration)	Creates a new LoggingContextLocalConfiguration.
CreateEphemeralContext(ThreadLoggingContext)	Creates a new EphemeralLoggingContext.
CreateExecutionContextData()	Creates a new empty instance of PostSharp.Patterns.Diagnostics.LoggingBackend.ExecutionContextData. The instance can be of a subclass that holds backend-specific data.
CreateIteratorContext()	Creates a new IteratorLoggingContext for a given iterator method.
CreateRecordBuilder()	Creates a new LogRecordBuilder.
CreateSyncCustomActivityContext(ThreadLoggingContext)	Creates a new SyncCustomActivityLoggingContext.
CreateSyncMethodContext(ThreadLoggingContext)	Creates a new SyncMethodLoggingContext for a given normal (non-async, non-iterator) method.
CreateThreadContext()	Creates a new ThreadLoggingContext.
CreateTransaction(LoggingTypeSource, in TransactionProperties, ITransactionPolicy)	Creates a LoggingTransaction instance.
CreateTypeSource(LoggingNamespaceSource, Type)	Creates a LoggingTypeSource for the given role and type.
CreateTypeSourceBySourceName(LoggingNamespaceSource, string)	Creates a LoggingTypeSource for the given role and logger name.
CreateVerbosityConfiguration()	Creates a new LoggingVerbosityConfiguration for the current LoggingBackend.
Dispose()
Dispose(bool)	Disposes the current object.
GetAsyncContextOfTask(Task)	Gets the AsyncMethodLoggingContext associated with a Task.
GetBackendOptions()	Gets the formatting and rendering options for the current LoggingBackend.
GetSource(string, string)	Returns a LoggingNamespaceSource for the given role and, optionally, namespace.
GetSource(string, Type)	Returns a LoggingTypeSource for the given role and type.
GetThreadContext()	Returns the ThreadLoggingContext for the current Thread.
OpenAsyncContext(AsyncCallId, ref LogMemberInfo)	Gets an AsyncMethodLoggingContext for a given async method.
OpenEphemeralContext(ref LogMemberInfo)	Gets an EphemeralLoggingContext for use in a given method. An EphemeralLoggingContext is a degenerate kind of context that is used to emit a single record.
OpenEphemeralContext(LoggingTypeSource, ref ThreadLoggingContext)	Gets an EphemeralLoggingContext for use in a given LoggingTypeSource. An EphemeralLoggingContext is a degenerate kind of context that is used to emit a single record.
OpenIteratorContext(IEnumerator, ref LogMemberInfo)	Gets an IteratorLoggingContext for a given iterator method.
OpenSyncContext(ref LogMemberInfo)	Gets a SyncMethodLoggingContext for a given normal (non-async, non-iterator) method.
ToString()
WithContextLocalConfiguration(LoggingContextLocalConfiguration)	Changes the LoggingContextLocalConfiguration for the current execution context.
WithVerbosityConfiguration(LoggingVerbosityConfiguration)	Changes the verbosity for the current execution context.