ConsoleMonsterLoggerOptions
ConsoleMonster.Extensions.Logging
Options for ConsoleMonsterLoggerProvider.
Inheritance
- object
- ConsoleMonsterLoggerOptions
Usage
Explore 43 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 21
- Extension method ConsoleMonsterLoggerOptions.Category
- Extension method ConsoleMonsterLoggerOptions.IncludeEventId
- Extension method ConsoleMonsterLoggerOptions.IncludeScopes
- Extension method ConsoleMonsterLoggerOptions.LogRegion
- Extension method ConsoleMonsterLoggerOptions.MaxExceptionLines
- Extension method ConsoleMonsterLoggerOptions.MinimumLevel
- Extension method ConsoleMonsterLoggerOptions.Profile
- Extension method ConsoleMonsterLoggerOptions.TimestampFormat
- Extension method ConsoleMonsterLoggerOptions.UseUtcTimestamp
- Extension method ConsoleMonsterLoggerOptions.Writer
- Property ConsoleMonsterLoggerProvider.Options
- Method LoggingFluent.Category
- Method LoggingFluent.IncludeEventId
- Method LoggingFluent.IncludeScopes
- Method LoggingFluent.LogRegion
- Method LoggingFluent.MaxExceptionLines
- Method LoggingFluent.MinimumLevel
- Method LoggingFluent.Profile
- Method LoggingFluent.TimestampFormat
- Method LoggingFluent.UseUtcTimestamp
- Method LoggingFluent.Writer
Accepted by parameters 22
- Extension method ConsoleMonsterLoggerOptions.Category
- Extension method ConsoleMonsterLoggerOptions.IncludeEventId
- Extension method ConsoleMonsterLoggerOptions.IncludeScopes
- Extension method ConsoleMonsterLoggerOptions.LogRegion
- Extension method ConsoleMonsterLoggerOptions.MaxExceptionLines
- Extension method ConsoleMonsterLoggerOptions.MinimumLevel
- Extension method ConsoleMonsterLoggerOptions.Profile
- Extension method ConsoleMonsterLoggerOptions.TimestampFormat
- Extension method ConsoleMonsterLoggerOptions.UseUtcTimestamp
- Extension method ConsoleMonsterLoggerOptions.Writer
- Constructor ConsoleMonsterLoggerProvider.ConsoleMonsterLoggerProvider
- Method ConsoleMonsterLoggingExtensions.AddConsoleMonster
- Method LoggingFluent.Category
- Method LoggingFluent.IncludeEventId
- Method LoggingFluent.IncludeScopes
- Method LoggingFluent.LogRegion
- Method LoggingFluent.MaxExceptionLines
- Method LoggingFluent.MinimumLevel
- Method LoggingFluent.Profile
- Method LoggingFluent.TimestampFormat
- Method LoggingFluent.UseUtcTimestamp
- Method LoggingFluent.Writer
Constructors
public ConsoleMonsterLoggerOptions() #Inherited Methods
Properties
public LogLevel MinimumLevel { get; set; } #The lowest level written (default LogLevel.Trace; the logging builder's filters apply first).
public string? TimestampFormat { get; set; } #The timestamp format (a .NET date format, default HH:mm:ss), or null for no timestamp.
public bool UseUtcTimestamp { get; set; } #Whether timestamps are UTC (default false: local time).
public LogCategoryFormat Category { get; set; } #How the category is shown (default LogCategoryFormat.Short).
public bool IncludeScopes { get; set; } #Whether scopes are shown after the category (default true).
public bool IncludeEventId { get; set; } #Whether the event id is shown (default false).
public int MaxExceptionLines { get; set; } #The most stack frames of an exception printed under its log line (default 12; framework frames are collapsed; 0 for the type and message only).
public string? LogRegion { get; set; } #The log region of a running live session that receives the lines (default $log, the dashboard's log); when no session with that region runs, lines are printed. Null always prints.
public TerminalProfile? Profile { get; set; } #The terminal profile to write for, or null for the current terminal (colour, glyphs and redirection detected).
public ITerminalWriter? Writer { get; set; } #Where printed lines go, or null for the current terminal.
Extension Methods
public static ConsoleMonsterLoggerOptions Category(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, LogCategoryFormat value) #Sets ConsoleMonsterLoggerOptions.Category: How the category is shown (default LogCategoryFormat.Short).
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value ConsoleMonster.Extensions.Logging.LogCategoryFormat
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { Category = value }; consoleMonsterLoggerOptions.Category(value);public static ConsoleMonsterLoggerOptions IncludeEventId(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, bool value) #Sets ConsoleMonsterLoggerOptions.IncludeEventId: Whether the event id is shown (default false).
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { IncludeEventId = value }; consoleMonsterLoggerOptions.IncludeEventId(value);public static ConsoleMonsterLoggerOptions IncludeEventId(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions) #Sets ConsoleMonsterLoggerOptions.IncludeEventId to true.
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance to configure.
public static ConsoleMonsterLoggerOptions IncludeScopes(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, bool value) #Sets ConsoleMonsterLoggerOptions.IncludeScopes: Whether scopes are shown after the category (default true).
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { IncludeScopes = value }; consoleMonsterLoggerOptions.IncludeScopes(value);public static ConsoleMonsterLoggerOptions IncludeScopes(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions) #Sets ConsoleMonsterLoggerOptions.IncludeScopes to true.
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance to configure.
public static ConsoleMonsterLoggerOptions LogRegion(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, string? value) #Sets ConsoleMonsterLoggerOptions.LogRegion: The log region of a running live session that receives the lines (default $log, the dashboard's log); when no session with that region runs, lines are printed. Null always prints.
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { LogRegion = value }; consoleMonsterLoggerOptions.LogRegion(value);public static ConsoleMonsterLoggerOptions MaxExceptionLines(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, int value) #Sets ConsoleMonsterLoggerOptions.MaxExceptionLines: The most stack frames of an exception printed under its log line (default 12; framework frames are collapsed; 0 for the type and message only).
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { MaxExceptionLines = value }; consoleMonsterLoggerOptions.MaxExceptionLines(value);public static ConsoleMonsterLoggerOptions MinimumLevel(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, LogLevel value) #Sets ConsoleMonsterLoggerOptions.MinimumLevel: The lowest level written (default LogLevel.Trace; the logging builder's filters apply first).
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value Microsoft.Extensions.Logging.LogLevel
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { MinimumLevel = value }; consoleMonsterLoggerOptions.MinimumLevel(value);public static ConsoleMonsterLoggerOptions Profile(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, TerminalProfile? value) #Sets ConsoleMonsterLoggerOptions.Profile: The terminal profile to write for, or null for the current terminal (colour, glyphs and redirection detected).
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value ConsoleMonster.Capabilities.TerminalProfile?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { Profile = value }; consoleMonsterLoggerOptions.Profile(value);public static ConsoleMonsterLoggerOptions TimestampFormat(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, string? value) #Sets ConsoleMonsterLoggerOptions.TimestampFormat: The timestamp format (a .NET date format, default HH:mm:ss), or null for no timestamp.
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { TimestampFormat = value }; consoleMonsterLoggerOptions.TimestampFormat(value);public static ConsoleMonsterLoggerOptions UseUtcTimestamp(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, bool value) #Sets ConsoleMonsterLoggerOptions.UseUtcTimestamp: Whether timestamps are UTC (default false: local time).
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { UseUtcTimestamp = value }; consoleMonsterLoggerOptions.UseUtcTimestamp(value);public static ConsoleMonsterLoggerOptions UseUtcTimestamp(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions) #Sets ConsoleMonsterLoggerOptions.UseUtcTimestamp to true.
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance to configure.
public static ConsoleMonsterLoggerOptions Writer(ConsoleMonsterLoggerOptions consoleMonsterLoggerOptions, ITerminalWriter? value) #Sets ConsoleMonsterLoggerOptions.Writer: Where printed lines go, or null for the current terminal.
Parameters
- consoleMonsterLoggerOptions ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions
- The instance.
- value ConsoleMonster.Output.ITerminalWriter?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { Writer = value }; consoleMonsterLoggerOptions.Writer(value);