Class TelemetryLogger

Inheritance

System.Object

CloudShareSyncILogger

TelemetryLogger

Inherited Members

CloudShareSyncILogger.Log4NetLog

CloudShareSyncILogger.BeginScope<TState>(TState)

CloudShareSyncILogger.IsEnabled(LogLevel)

CloudShareSyncILogger.IsFatalEnabled()

CloudShareSyncILogger.IsErrorEnabled()

CloudShareSyncILogger.IsWarnEnabled()

CloudShareSyncILogger.IsInfoEnabled()

CloudShareSyncILogger.IsDebugEnabled()

CloudShareSyncILogger.Log<TState>(LogLevel, EventId, TState, Nullable<Exception>, Func<TState, Nullable<Exception>, String>)

CloudShareSyncILogger.WriteFatalMessage(ILog, LogLevel, String)

CloudShareSyncILogger.WriteErrorMessage(ILog, LogLevel, String)

CloudShareSyncILogger.WriteWarnMessage(ILog, LogLevel, String)

CloudShareSyncILogger.WriteInfoMessage(ILog, LogLevel, String)

CloudShareSyncILogger.WriteDebugMessage(ILog, LogLevel, String)

Namespace: Cloud_ShareSync.Core.Logging

Assembly: Cloud-ShareSync.Core.Logging.dll

Syntax

public class TelemetryLogger : CloudShareSyncILogger

Constructors

TelemetryLogger(String)

Creates an CloudShareSyncILogger based ILogger implementation for the provided serviceName.

Declaration

public TelemetryLogger(string serviceName)

Parameters

Type	Name	Description
System.String	serviceName

TelemetryLogger(String, String[])

Configures the OpenTelemetry settings for the provided sources and passes the serviceName to TelemetryLogger(String).

Declaration

public TelemetryLogger(string serviceName, string[] sources)

Parameters

Type	Name	Description
System.String	serviceName
System.String[]	sources

Fields

OpenTelemetry

The that will collect activities for the sources provided in TelemetryLogger(String, String[]).

Declaration

public readonly TracerProvider? OpenTelemetry

Field Value

Type	Description
System.Nullable<TracerProvider>

Properties

LoggerRepository

The used as a to store Log4Net appenders.

Declaration

ILoggerRepository LoggerRepository { }

Property Value

Type	Description
ILoggerRepository

Methods

AddColoredConsoleErrorLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels)

If useStdErr is true then adds a ColoredConsoleErrorLogAppender(SupportedLogLevels) to the hierarchy.Root

Declaration

static void AddColoredConsoleErrorLogAppender(Hierarchy? hierarchy, bool useStdErr, SupportedLogLevels logLevels)

Parameters

Type	Name	Description
System.Nullable<Hierarchy>	hierarchy
System.Boolean	useStdErr
SupportedLogLevels	logLevels

AddColoredConsoleLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels)

Adds a ColoredConsoleLogAppender(SupportedLogLevels, Boolean) to the hierarchy.Root

If useStdErr is false then ColoredConsoleLogAppender(SupportedLogLevels, Boolean) addErrorLevels is true."

Declaration

static void AddColoredConsoleLogAppender(Hierarchy? hierarchy, bool useStdErr, SupportedLogLevels logLevels)

Parameters

Type	Name	Description
System.Nullable<Hierarchy>	hierarchy
System.Boolean	useStdErr
SupportedLogLevels	logLevels

AddConsoleAppender(Boolean, SupportedLogLevels, Boolean)

Converts the LoggerRepository into a . Then checks UseColoredConsoleAppenders(Boolean).

If UseColoredConsoleAppenders(Boolean) is true it then calls AddColoredConsoleLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels) and AddColoredConsoleErrorLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels).

If UseColoredConsoleAppenders(Boolean) is false it then calls AddConsoleLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels) and AddConsoleErrorLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels) instead.

Declaration

public void AddConsoleAppender(bool useStdErr, SupportedLogLevels logLevels, bool enableColoredConsole = true)

Parameters

Type	Name	Description
System.Boolean	useStdErr
SupportedLogLevels	logLevels
System.Boolean	enableColoredConsole

AddConsoleErrorLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels)

If useStdErr is true then adds a ConsoleErrorLogAppender(SupportedLogLevels) to the hierarchy.Root

Declaration

static void AddConsoleErrorLogAppender(Hierarchy? hierarchy, bool useStdErr, SupportedLogLevels logLevels)

Parameters

Type	Name	Description
System.Nullable<Hierarchy>	hierarchy
System.Boolean	useStdErr
SupportedLogLevels	logLevels

AddConsoleLogAppender(Nullable<Hierarchy>, Boolean, SupportedLogLevels)

Adds a ConsoleLogAppender(SupportedLogLevels, Boolean) to the hierarchy.Root

If useStdErr is false then ConsoleLogAppender(SupportedLogLevels, Boolean) addErrorLevels is true."

Declaration

static void AddConsoleLogAppender(Hierarchy? hierarchy, bool useStdErr, SupportedLogLevels logLevels)

Parameters

Type	Name	Description
System.Nullable<Hierarchy>	hierarchy
System.Boolean	useStdErr
SupportedLogLevels	logLevels

AddRollingLogAppender(String, Int32, Int32, SupportedLogLevels)

Converts the LoggerRepository into a . Then adds a RollingLogAppender(String, Int32, Int32, SupportedLogLevels) to the hierarchy.Root

Declaration

public void AddRollingLogAppender(string path, int maxSizeRollBackups, int maximumFileSize, SupportedLogLevels logLevels)

Parameters

Type	Name	Description
System.String	path
System.Int32	maxSizeRollBackups
System.Int32	maximumFileSize
SupportedLogLevels	logLevels

AddTelemetryAppender(String, Int32, Int32)

If OpenTelemetry is configured via TelemetryLogger(String, String[]) then this converts the LoggerRepository into a and adds a TelemetryLogAppender(String, Int32, Int32) to the hierarchy.Root

Otherwise does nothing.

Declaration

public void AddTelemetryAppender(string path, int maxSizeRollBackups, int maximumFileSize)

Parameters

Type	Name	Description
System.String	path
System.Int32	maxSizeRollBackups
System.Int32	maximumFileSize

ConfigureFromLog4NetXmlConfigFile(FileInfo)

Ensures the configFile exists then uses to configure the LoggerRepository.

Declaration

public void ConfigureFromLog4NetXmlConfigFile(FileInfo configFile)

Parameters

Type	Name	Description
FileInfo	configFile

ConfigureOpenTelemetrySources(String[], String)

Used to configure OpenTelemetry with the serviceName and sources provided in TelemetryLogger(String, String[]).

Telemetry is exported via the TelemetryExporter.

Declaration

TracerProvider ConfigureOpenTelemetrySources(string[] sources, string serviceName)

Parameters

Type	Name	Description
System.String[]	sources
System.String	serviceName

Returns

Type	Description
TracerProvider	A configured .

LogTelemetry(String)

Declaration

public void LogTelemetry(string message)

Parameters

Type	Name	Description
System.String	message

SetConfigured()

Converts the LoggerRepository into a and sets the hierarchy.Configured property to true if it exists.

Declaration

public void SetConfigured()

UseColoredConsoleAppenders(Boolean)

Checks that enableColoredConsole is true and that $Env:NO_COLOR does not exist.

Declaration

static bool UseColoredConsoleAppenders(bool enableColoredConsole)

Parameters

Type	Name	Description
System.Boolean	enableColoredConsole

Returns

Type	Description
System.Boolean	True if enableColoredConsole is true and $Env:NO_COLOR is not set. Otherwise returns false.