LogScope Class

Implements Meta.Voice.Logging.ILogScope

A logging scope to be used in "using" blocks.

Constructors

LogScope ( logger , verbosity , correlationID , message , parameters )

Constructs a logging scope to be used in "using" blocks.

Signature

Meta.Voice.Logging.LogScope.LogScope(ICoreLogger logger, VLoggerVerbosity verbosity, CorrelationID correlationID, string message, object [] parameters)

Parameters

logger: ICoreLogger The logger.

verbosity: VLoggerVerbosity The verbosity.

correlationID: CorrelationID The correlation ID.

message: string The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.

parameters: object []

Properties

CorrelationID : CorrelationID

[Get][Set]

Signature

CorrelationID Meta.Voice.Logging.LogScope.CorrelationID

Methods

Correlate ( newCorrelationId , rootCorrelationId )	Correlates two correlation IDs. This is used to indicate nesting, branching, or exchanges. The purpose is to allow a complete trail up to the source when needed. Signature void Meta.Voice.Logging.LogScope.Correlate(CorrelationID newCorrelationId, CorrelationID rootCorrelationId) Parameters `newCorrelationId: CorrelationID` The source correlation ID (eg. child operation). `rootCorrelationId: CorrelationID` The target correlation ID (eg. root operation). Returns `void`
Debug ( message , parameters )	Logs a debug message. Signature void Meta.Voice.Logging.LogScope.Debug(string message, params object [] parameters) Parameters `message: string` `parameters: params object []` Returns `void`
Debug ( message , p1 , p2 , p3 , p4 , memberName , sourceFilePath , sourceLineNumber )	Logs a debug message with edit time callsite information. Signature void Meta.Voice.Logging.LogScope.Debug(string message, object p1=null, object p2=null, object p3=null, object p4=null, string memberName="", string sourceFilePath="", int sourceLineNumber=0) Parameters `message: string` `p1: object` `p2: object` `p3: object` `p4: object` `memberName: string` `sourceFilePath: string` `sourceLineNumber: int` Returns `void`
Debug ( correlationId , message , parameters )	Logs a debug message. Signature void Meta.Voice.Logging.LogScope.Debug(CorrelationID correlationId, string message, params object [] parameters) Parameters `correlationId: CorrelationID` `message: string` `parameters: params object []` Returns `void`
Dispose ()	Disposes the scope. Signature void Meta.Voice.Logging.LogScope.Dispose() Returns `void`
End ( sequenceId )	Explicitly end a scope. Must have been started already. Signature void Meta.Voice.Logging.LogScope.End(int sequenceId) Parameters `sequenceId: int` Returns `void`
Error ( errorCode , message , parameters )	Logs an error with an exception. Signature void Meta.Voice.Logging.LogScope.Error(ErrorCode errorCode, string message, params object [] parameters) Parameters `errorCode: ErrorCode` `message: string` `parameters: params object []` Returns `void`
Error ( correlationId , errorCode , message , parameters )	Logs an error with an exception. Signature void Meta.Voice.Logging.LogScope.Error(CorrelationID correlationId, ErrorCode errorCode, string message, params object [] parameters) Parameters `correlationId: CorrelationID` `errorCode: ErrorCode` `message: string` `parameters: params object []` Returns `void`
Error ( correlationId , exception , message , parameters )	Logs an error with an exception. Signature void Meta.Voice.Logging.LogScope.Error(CorrelationID correlationId, Exception exception, string message, params object[] parameters) Parameters `correlationId: CorrelationID` `exception: Exception` `message: string` `parameters: params object []` Returns `void`
Error ( exception , errorCode , message , parameters )	Logs an error with an exception, and an error code. Signature void Meta.Voice.Logging.LogScope.Error(Exception exception, ErrorCode errorCode, string message, params object[] parameters) Parameters `exception: Exception` `errorCode: ErrorCode` `message: string` `parameters: params object []` Returns `void`
Error ( exception , message , parameters )	Logs an error with an exception, without an error code. Signature void Meta.Voice.Logging.LogScope.Error(Exception exception, string message="", params object[] parameters) Parameters `exception: Exception` `message: string` `parameters: params object []` Returns `void`
Error ( correlationId , exception , errorCode , message , parameters )	Logs an error with an exception. Signature void Meta.Voice.Logging.LogScope.Error(CorrelationID correlationId, Exception exception, ErrorCode errorCode, string message, params object[] parameters) Parameters `correlationId: CorrelationID` `exception: Exception` `errorCode: ErrorCode` `message: string` `parameters: params object []` Returns `void`
Error ( correlationId , message , parameters )	Logs an error without an exception. Signature void Meta.Voice.Logging.LogScope.Error(CorrelationID correlationId, string message, params object[] parameters) Parameters `correlationId: CorrelationID` `message: string` `parameters: params object []` Returns `void`
Error ( message , parameters )	Logs an error with a message. Signature void Meta.Voice.Logging.LogScope.Error(string message, params object[] parameters) Parameters `message: string` `parameters: params object []` Returns `void`
Info ( message , parameters )	Logs an info message. Signature void Meta.Voice.Logging.LogScope.Info(string message, params object [] parameters) Parameters `message: string` `parameters: params object []` Returns `void`
Info ( correlationId , message , parameters )	Logs an info message. Signature void Meta.Voice.Logging.LogScope.Info(CorrelationID correlationId, string message, params object [] parameters) Parameters `correlationId: CorrelationID` `message: string` `parameters: params object []` Returns `void`
Info ( message , p1 , p2 , p3 , p4 , memberName , sourceFilePath , sourceLineNumber )	Logs an info message with edit time callsite information. Signature void Meta.Voice.Logging.LogScope.Info(string message, object p1=null, object p2=null, object p3=null, object p4=null, string memberName="", string sourceFilePath="", int sourceLineNumber=0) Parameters `message: string` `p1: object` `p2: object` `p3: object` `p4: object` `memberName: string` `sourceFilePath: string` `sourceLineNumber: int` Returns `void`
Log ( correlationId , verbosity , message , parameters )	Logs a message. Signature void Meta.Voice.Logging.LogScope.Log(CorrelationID correlationId, VLoggerVerbosity verbosity, string message, params object[] parameters) Parameters `correlationId: CorrelationID` The correlation ID. `verbosity: VLoggerVerbosity` The verbosity of the logging. `message: string` The message to log. `parameters: params object []` The parameter Returns `void`
Log ( correlationId , verbosity , exception , errorCode , message , parameters )	Logs a message with an exception. Signature void Meta.Voice.Logging.LogScope.Log(CorrelationID correlationId, VLoggerVerbosity verbosity, Exception exception, ErrorCode errorCode, string message, params object[] parameters) Parameters `correlationId: CorrelationID` The correlation ID. `verbosity: VLoggerVerbosity` The verbosity of the logging. `exception: Exception` The exception to log. `errorCode: ErrorCode` The error code. `message: string` The message to log. `parameters: params object []` The parameter Returns `void`
Log ( correlationId , verbosity , errorCode , message , parameters )	Logs a message without an exception. Signature void Meta.Voice.Logging.LogScope.Log(CorrelationID correlationId, VLoggerVerbosity verbosity, ErrorCode errorCode, string message, params object[] parameters) Parameters `correlationId: CorrelationID` The correlation ID. `verbosity: VLoggerVerbosity` The verbosity of the logging. `errorCode: ErrorCode` The error code. `message: string` The message to log. `parameters: params object []` The parameter Returns `void`
Start ( correlationId , verbosity , message , parameters )	Explicitly start a scope. Signature int Meta.Voice.Logging.LogScope.Start(CorrelationID correlationId, VLoggerVerbosity verbosity, string message, params object[] parameters) Parameters `correlationId: CorrelationID` `verbosity: VLoggerVerbosity` `message: string` `parameters: params object []` Returns `int`
Start ( verbosity , message , parameters )	Explicitly start a scope. Signature int Meta.Voice.Logging.LogScope.Start(VLoggerVerbosity verbosity, string message, params object[] parameters) Parameters `verbosity: VLoggerVerbosity` `message: string` `parameters: params object []` Returns `int`
Verbose ( message , parameters )	Logs a verbose message. Signature void Meta.Voice.Logging.LogScope.Verbose(string message, params object [] parameters) Parameters `message: string` `parameters: params object []` Returns `void`
Verbose ( correlationId , message , parameters )	Logs a verbose message. Signature void Meta.Voice.Logging.LogScope.Verbose(CorrelationID correlationId, string message, params object [] parameters) Parameters `correlationId: CorrelationID` `message: string` `parameters: params object []` Returns `void`
Verbose ( message , p1 , p2 , p3 , p4 , memberName , sourceFilePath , sourceLineNumber )	Logs a verbose message with edit time callsite information. Signature void Meta.Voice.Logging.LogScope.Verbose(string message, object p1=null, object p2=null, object p3=null, object p4=null, [CallerMemberName] string memberName="", [CallerFilePath] string sourceFilePath="", [CallerLineNumber] int sourceLineNumber=0) Parameters `message: string` The message as a format string (e.g "My value is: {0}).</param> <param name="p1">Parameter 1.</param> <param name="p2">Parameter 2.</param> <param name="p3">Parameter 3.</param> <param name="p4">Parameter 4.</param> <param name="memberName">The caller site name.</param> <param name="sourceFilePath">The caller source file path.</param> <param name="sourceLineNumber">The caller source line number. `p1: object` `p2: object` `p3: object` `p4: object` `memberName: string` `sourceFilePath: string` `sourceLineNumber: int` Returns `void`
Warning ( message , parameters )	Logs a warning message. Signature void Meta.Voice.Logging.LogScope.Warning(string message, params object [] parameters) Parameters `message: string` `parameters: params object []` Returns `void`
Warning ( correlationId , message , parameters )	Logs a warning message. Signature void Meta.Voice.Logging.LogScope.Warning(CorrelationID correlationId, string message, params object [] parameters) Parameters `correlationId: CorrelationID` `message: string` `parameters: params object []` Returns `void`