Google.Cloud.Logging.Console - Class GoogleCloudConsoleFormatter (1.3.0) 

public sealed class GoogleCloudConsoleFormatter : ConsoleFormatter, IDisposable

Reference documentation and code samples for the Google.Cloud.Logging.Console class GoogleCloudConsoleFormatter.

Console formatter for use with Google Cloud Logging.

Inheritance

object > ConsoleFormatter > GoogleCloudConsoleFormatter

Implements

IDisposable

Namespace

Google.Cloud.Logging.Console

Assembly

Google.Cloud.Logging.Console.dll

Constructors

GoogleCloudConsoleFormatter(IOptionsMonitor<GoogleCloudConsoleFormatterOptions>)

public GoogleCloudConsoleFormatter(IOptionsMonitor<GoogleCloudConsoleFormatterOptions> optionsMonitor)

Constructs a new formatter which uses the specified monitor to retrieve options and watch for options changes.

Parameter
Name Description
optionsMonitor IOptionsMonitorGoogleCloudConsoleFormatterOptions

The monitor to observe for changes in options. Must not be null.

Properties

FormatterName

public static string FormatterName { get; }

The name for the Google Cloud console formatter.

Property Value
Type Description
string

Methods

Write<TState>(in LogEntry<TState>, IExternalScopeProvider, TextWriter)

public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider scopeProvider, TextWriter textWriter)

Writes the log message to the specified TextWriter.

Parameters
Name Description
logEntry LogEntry

The log entry.
scopeProvider IExternalScopeProvider

The provider of scope data.
textWriter TextWriter

The string writer embedding ansi code for colors.
Type Parameter
Name Description
TState

The type of the object to be written.
Overrides Remarks

if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string