API reference

ICoreLogger Interface

A common interface to core logging functionality

Properties

CorrelationID : CorrelationID
[Get][Set]
The correlation ID allows the tracing of an operation from beginning to end. It can be linked to other IDs to form a full chain when it branches out or moves to other domains. If not supplied explicitly while logging, it will be inherited from the thread storage or a new one will be generated if none exist.
Signature
CorrelationID Meta.Voice.Logging.ICoreLogger.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.ICoreLogger.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.ICoreLogger.Debug(string message, params object [] parameters)
Parameters
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
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.ICoreLogger.Debug(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
Debug ( correlationId , message , parameters )
Logs a debug message.
Signature
void Meta.Voice.Logging.ICoreLogger.Debug(CorrelationID correlationId, string message, params object [] parameters)
Parameters
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: params object []
Returns
void
End ( sequenceId )
Explicitly end a scope. Must have been started already.
Signature
void Meta.Voice.Logging.ICoreLogger.End(int sequenceId)
Parameters
sequenceId: int
Returns
void
Error ( correlationId , errorCode , message , parameters )
Logs an error with an exception.
Signature
void Meta.Voice.Logging.ICoreLogger.Error(CorrelationID correlationId, ErrorCode errorCode, string message, params object[] parameters)
Parameters
correlationId: CorrelationID  The correlation ID.
errorCode: ErrorCode  The error code.
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Error ( errorCode , message , parameters )
Logs an error with an exception.
Signature
void Meta.Voice.Logging.ICoreLogger.Error(ErrorCode errorCode, string message, params object[] parameters)
Parameters
errorCode: ErrorCode  The error code.
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Error ( correlationId , exception , errorCode , message , parameters )
Logs an error with an exception.
Signature
void Meta.Voice.Logging.ICoreLogger.Error(CorrelationID correlationId, Exception exception, ErrorCode errorCode, string message, params object[] parameters)
Parameters
correlationId: CorrelationID  The correlation ID.
exception: Exception  The exception to log.
errorCode: ErrorCode  The error code.
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Error ( correlationId , message , parameters )
Logs an error without an exception.
Signature
void Meta.Voice.Logging.ICoreLogger.Error(CorrelationID correlationId, string message, params object[] parameters)
Parameters
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: params object []
Returns
void
Error ( message , parameters )
Logs an error with a message.
Signature
void Meta.Voice.Logging.ICoreLogger.Error(string message, params object[] parameters)
Parameters
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Error ( correlationId , exception , message , parameters )
Logs an error with an exception.
Signature
void Meta.Voice.Logging.ICoreLogger.Error(CorrelationID correlationId, Exception exception, string message="", params object[] parameters)
Parameters
correlationId: CorrelationID  The correlation ID.
exception: Exception  The exception to log.
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
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.ICoreLogger.Error(Exception exception, ErrorCode errorCode, string message="", params object[] parameters)
Parameters
exception: Exception  The exception to log.
errorCode: ErrorCode  The error code.
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Error ( exception , message , parameters )
Logs an error with an exception, without an error code.
Signature
void Meta.Voice.Logging.ICoreLogger.Error(Exception exception, string message="", params object[] parameters)
Parameters
exception: Exception  The exception to log.
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Info ( message , parameters )
Logs an info message.
Signature
void Meta.Voice.Logging.ICoreLogger.Info(string message, params object [] parameters)
Parameters
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Info ( correlationId , message , parameters )
Logs an info message.
Signature
void Meta.Voice.Logging.ICoreLogger.Info(CorrelationID correlationId, string message, params object [] parameters)
Parameters
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: 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.ICoreLogger.Info(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
Log ( correlationId , verbosity , message , parameters )
Logs a message.
Signature
void Meta.Voice.Logging.ICoreLogger.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.ICoreLogger.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.ICoreLogger.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
Scope ( verbosity , message , parameters )
Returns a logging scope to be used in a "using" block.
Signature
ILogScope Meta.Voice.Logging.ICoreLogger.Scope(VLoggerVerbosity verbosity, string message, params object[] parameters)
Parameters
verbosity: VLoggerVerbosity  The verbosity of the logging.
message: string  The message to log.
parameters: params object []  The parameter
Returns
ILogScope  The scope.
Scope ( correlationId , verbosity , message , parameters )
Returns a logging scope to be used in a "using" block.
Signature
ILogScope Meta.Voice.Logging.ICoreLogger.Scope(CorrelationID correlationId, VLoggerVerbosity verbosity, string message, params object[] parameters)
Parameters
correlationId: CorrelationID  The correlation ID to use for the scope.
verbosity: VLoggerVerbosity  The verbosity of the logging.
message: string  The message to log.
parameters: params object []  The parameter
Returns
ILogScope  The scope.
Start ( correlationId , verbosity , message , parameters )
Explicitly start a scope.
Signature
int Meta.Voice.Logging.ICoreLogger.Start(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
int
Start ( verbosity , message , parameters )
Explicitly start a scope.
Signature
int Meta.Voice.Logging.ICoreLogger.Start(VLoggerVerbosity verbosity, string message, params object[] parameters)
Parameters
verbosity: VLoggerVerbosity  The verbosity of the logging.
message: string  The message to log.
parameters: params object []  The parameter
Returns
int
Verbose ( message , parameters )
Logs a verbose message.
Signature
void Meta.Voice.Logging.ICoreLogger.Verbose(string message, params object [] parameters)
Parameters
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void
Verbose ( correlationId , message , parameters )
Logs a verbose message.
Signature
void Meta.Voice.Logging.ICoreLogger.Verbose(CorrelationID correlationId, string message, params object [] parameters)
Parameters
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: 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.ICoreLogger.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 ( correlationId , message , parameters )
Logs a warning message.
Signature
void Meta.Voice.Logging.ICoreLogger.Warning(CorrelationID correlationId, string message, params object [] parameters)
Parameters
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: params object []
Returns
void
Warning ( message , parameters )
Logs a warning message.
Signature
void Meta.Voice.Logging.ICoreLogger.Warning(string message, params object [] parameters)
Parameters
message: string  The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
parameters: params object []
Returns
void