API reference
API reference
Select your platform
No SDKs available
No versions available

IVLogger Interface

The VSDK Logger. Each class should have its own instance of the logger. Instances should be created via ILoggerRegistry.

Overview

Properties

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.

Public Member Functions

void
Verbose
( string message,
params object [] parameters )
Logs a verbose message.
void
Verbose
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs a verbose message.
void
Info
( string message,
params object [] parameters )
Logs an info message.
void
Info
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs an info message.
void
Debug
( string message,
params object [] parameters )
Logs a debug message.
void
Debug
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs a debug message.
void
Warning
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs a warning message.
void
Warning
( string message,
params object [] parameters )
Logs a warning message.
void
Error
( CorrelationID correlationId,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception.
void
Error
( ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception.
void
Error
( CorrelationID correlationId,
ErrorCode errorCode,
Exception exception,
string message,
params object [] parameters )
Logs an error with an exception.
void
Error
( Exception exception,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception.
void
Correlate
( CorrelationID originalCorrelationId,
CorrelationID newCorrelationId )
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.
Scope
( VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Returns a logging scope to be used in a "using" block.
Scope
( VLoggerVerbosity verbosity,
CorrelationID correlationId,
string message,
params object [] parameters )
Returns a logging scope to be used in a "using" block.
int
Start
( VLoggerVerbosity verbosity,
CorrelationID correlationId,
string message,
params object [] parameters )
Explicitly start a scope.
int
Start
( VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Explicitly start a scope.
void
End
( int sequenceId )
Explicitly end a scope. Must have been started already.
void
Flush
( CorrelationID correlationID )
Writes out any high verbosity logs that have been suppressed as part of the specified correlation ID.
void
Flush ( )
Writes out any high verbosity logs that have been suppressed.

Details

Properties

CorrelationID Meta.Voice.Logging.IVLogger.CorrelationID
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.

Member Functions

void Meta.Voice.Logging.IVLogger.Verbose
( string message,
params object [] parameters )
Logs a verbose message.
Parameters
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Verbose
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs a verbose message.
Parameters
correlationId
The correlation ID.
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Info
( string message,
params object [] parameters )
Logs an info message.
Parameters
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Info
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs an info message.
Parameters
correlationId
The correlation ID.
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Debug
( string message,
params object [] parameters )
Logs a debug message.
Parameters
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Debug
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs a debug message.
Parameters
correlationId
The correlation ID.
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Warning
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs a warning message.
Parameters
correlationId
The correlation ID.
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Warning
( string message,
params object [] parameters )
Logs a warning message.
Parameters
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Error
( CorrelationID correlationId,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception.
Parameters
correlationId
The correlation ID.
errorCode
The error code.
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Error
( ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception.
Parameters
errorCode
The error code.
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Error
( CorrelationID correlationId,
ErrorCode errorCode,
Exception exception,
string message,
params object [] parameters )
Logs an error with an exception.
Parameters
correlationId
The correlation ID.
errorCode
The error code.
exception
The exception to log
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Error
( Exception exception,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception.
Parameters
errorCode
The error code.
exception
The exception to log
message
The message as a format string (e.g "My value is: {0}).</param> <param name="parameters">The parameters.
void Meta.Voice.Logging.IVLogger.Correlate
( CorrelationID originalCorrelationId,
CorrelationID newCorrelationId )
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.
Parameters
originalCorrelationId
The original correlation ID.
newCorrelationId
The new correlation ID.
LogScope Meta.Voice.Logging.IVLogger.Scope
( VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Returns a logging scope to be used in a "using" block.
Parameters
verbosity
The verbosity of the logging.
message
The message to log.
parameters
The parameter
Returns
The scope.
LogScope Meta.Voice.Logging.IVLogger.Scope
( VLoggerVerbosity verbosity,
CorrelationID correlationId,
string message,
params object [] parameters )
Returns a logging scope to be used in a "using" block.
Parameters
verbosity
The verbosity of the logging.
correlationId
The correlation ID to use for the scope.
message
The message to log.
parameters
The parameter
Returns
The scope.
int Meta.Voice.Logging.IVLogger.Start
( VLoggerVerbosity verbosity,
CorrelationID correlationId,
string message,
params object [] parameters )
Explicitly start a scope.
Parameters
verbositycorrelationIdmessageparameters
Returns
int Meta.Voice.Logging.IVLogger.Start
( VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Explicitly start a scope.
Parameters
verbositymessageparameters
Returns
void Meta.Voice.Logging.IVLogger.End
( int sequenceId )
Explicitly end a scope. Must have been started already.
Parameters
sequenceId
void Meta.Voice.Logging.IVLogger.Flush
( CorrelationID correlationID )
Writes out any high verbosity logs that have been suppressed as part of the specified correlation ID.
void Meta.Voice.Logging.IVLogger.Flush ( )
Writes out any high verbosity logs that have been suppressed.
Did you find this page helpful?