Class TextLoggingBackendOptions

Options for the TextLoggingBackend class.

Inheritance

object

LoggingBackendOptions

TextLoggingBackendOptions

ApplicationInsightsLoggingBackendOptions

AuditBackendOptions

CommonLoggingLoggingBackendOptions

ConsoleLoggingBackendOptions

EventSourceLoggingBackendOptions

Log4NetLoggingBackendOptions

MicrosoftLoggingBackendOptions

NLogLoggingBackendOptions

SerilogLoggingBackendOptions

TraceLoggingBackendOptions

TraceSourceLoggingBackendOptions

Namespace: PostSharp.Patterns.Diagnostics.Backends

Assembly: PostSharp.Patterns.Diagnostics.dll

Syntax

Full screen

public class TextLoggingBackendOptions : LoggingBackendOptions

Remarks

These run-time options control the formatting of text records, for example their maximum length, the delimiter, the indentation, and the inclusion of type names and exception details. Set them through the Options property of the backend when the application starts. Unlike the build-time options of LoggingProfile, they apply to all logging profiles that use the backend.

Constructors

Name	Description
TextLoggingBackendOptions()

Properties

Name	Description
ActionMaxLength	Gets or sets the maximum length of a log record. The default value is 2048.
AppendTrailingPeriod	Gets or sets a value indicating whether log messages should end with a trailing period. The default value is `true` because PostSharp prefers trailing periods, but other conventions are valid.
Delimiter	Gets or sets the string used to separate different parts of the logging record. The default value is a pipe surrounded by spaces (`\|`).
ExceptionFormatter	Gets or sets the Formatter<T> used to format the Exception in which a method or custom activity results. This is different from the formatter used to format parameter or property values of Exception type. The default implementation prints the full type name of the Exception.
IncludeExceptionDetails	Gets or sets a value indicating whether exception details (basically `Exception.ToString`) should be appended to the log. The default value is `false`.
IncludeNamespace	Gets or sets a value indicating whether the full namespace of types should be included in the log. The default value is `false`.
IncludeType	Gets or sets a value indicating whether the name of the type of the logged method should be included in the log. The default value is `true`.
IndentSpaces	Gets or sets the number of spaces for each indentation level. The default value is 2.
ParameterPrefix	Gets or sets the prefix used for parameter names. The default value is `@`.
PropertyPrefix	Gets or sets the prefix used for custom property names. The default value is `#`.
ReturnItemPrefix	Gets or sets the prefix used for return values. The default value is `$`.
ShouldLogExceptionPredicate	Gets or sets a predicate that determines whether an exception should be logged. This predicate is evaluated only when the method entry is not logged. When the method entry is logged, exceptions are always logged.