Skip to content
ConsoleMonster
Class

LoggingFluent

ConsoleMonster.Extensions.Logging

Namespace
ConsoleMonster.Extensions.Logging
Assembly
ConsoleMonster.Extensions.Logging
Modifiers
static

The fluent methods of ConsoleMonsterLoggerOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • LoggingFluent

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 required
The instance.
value ConsoleMonster.Extensions.Logging.LogCategoryFormat required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

Examples

// C# initializer or property                                                                      // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { Category = value };    consoleMonsterLoggerOptions.Category(value);
IncludeEventId 2 overloads
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 required
The instance.
value bool required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

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 required
The instance to configure.

Returns

ConsoleMonsterLoggerOptions The same instance.
IncludeScopes 2 overloads
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 required
The instance.
value bool required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

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 required
The instance to configure.

Returns

ConsoleMonsterLoggerOptions The same instance.
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 required
The instance.
value string? required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

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 required
The instance.
value int required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

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 required
The instance.
value Microsoft.Extensions.Logging.LogLevel required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

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 required
The instance.
value ConsoleMonster.Capabilities.TerminalProfile? required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

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 required
The instance.
value string? required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

Examples

// C# initializer or property                                                                             // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { TimestampFormat = value };    consoleMonsterLoggerOptions.TimestampFormat(value);
UseUtcTimestamp 2 overloads
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 required
The instance.
value bool required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

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 required
The instance to configure.

Returns

ConsoleMonsterLoggerOptions The same instance.
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 required
The instance.
value ConsoleMonster.Output.ITerminalWriter? required
The value.

Returns

ConsoleMonsterLoggerOptions The same instance.

Examples

// C# initializer or property                                                                    // C# fluent
new global::ConsoleMonster.Extensions.Logging.ConsoleMonsterLoggerOptions { Writer = value };    consoleMonsterLoggerOptions.Writer(value);