API reference
ICoreLogger Interface
A common interface to core logging functionality
Properties
CorrelationID CorrelationID[Get]
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 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 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 Verbose
( string message,
object p1,
object p2,
object p3,
object p4,
string memberName,
string sourceFilePath,
int sourceLineNumber )
Logs a verbose message with edit time callsite information.
Parameters
message
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.
void 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 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 Info
( string message,
object p1,
object p2,
object p3,
object p4,
string memberName,
string sourceFilePath,
int sourceLineNumber )
Logs an info message with edit time callsite information.
Parameters
message
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.
void 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 Debug
( string message,
object p1,
object p2,
object p3,
object p4,
string memberName,
string sourceFilePath,
int sourceLineNumber )
Logs a debug message with edit time callsite information.
Parameters
message
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.
void 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 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 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 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 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 Error
( CorrelationID correlationId,
Exception exception,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception.
Parameters
correlationId
The correlation ID.
exception
The exception to log.
errorCode
The error code.
message
The message as a format string (e.g "My value is: {0}).</param>
<param name="parameters">The parameters.
void Error
( CorrelationID correlationId,
string message,
params object [] parameters )
Logs an error without an exception.
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 Error
( string message,
params object [] parameters )
Logs an error with a message.
Parameters
message
The message as a format string (e.g "My value is: {0}).</param>
<param name="parameters">The parameters.
void Error
( CorrelationID correlationId,
Exception exception,
string message,
params object [] parameters )
Logs an error with an exception.
Parameters
correlationId
The correlation ID.
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 Error
( Exception exception,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs an error with an exception, and an error code.
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 Error
( Exception exception,
string message,
params object [] parameters )
Logs an error with an exception, without an error code.
Parameters
exception
The exception to log.
message
The message as a format string (e.g "My value is: {0}).</param>
<param name="parameters">The parameters.
ILogScope 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.
ILogScope Scope
( CorrelationID correlationId,
VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Returns a logging scope to be used in a "using" block.
Parameters
correlationId
The correlation ID to use for the scope.
verbosity
The verbosity of the logging.
message
The message to log.
parameters
The parameter
Returns
The scope.
int Start
( CorrelationID correlationId,
VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Explicitly start a scope.
Parameters
correlationId
The correlation ID.
verbosity
The verbosity of the logging.
message
The message to log.
parameters
The parameter
Returns
int Start
( VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Explicitly start a scope.
Parameters
verbosity
The verbosity of the logging.
message
The message to log.
parameters
The parameter
Returns
void End
( int sequenceId )
Explicitly end a scope. Must have been started already.
Parameters
sequenceId
void Correlate
( CorrelationID newCorrelationId,
CorrelationID 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.
Parameters
newCorrelationId
The source correlation ID (eg. child operation).
rootCorrelationId
The target correlation ID (eg. root operation).
void Log
( CorrelationID correlationId,
VLoggerVerbosity verbosity,
string message,
params object [] parameters )
Logs a message.
Parameters
correlationId
The correlation ID.
verbosity
The verbosity of the logging.
message
The message to log.
parameters
The parameter
void Log
( CorrelationID correlationId,
VLoggerVerbosity verbosity,
Exception exception,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs a message with an exception.
Parameters
correlationId
The correlation ID.
verbosity
The verbosity of the logging.
exception
The exception to log.
errorCode
The error code.
message
The message to log.
parameters
The parameter
void Log
( CorrelationID correlationId,
VLoggerVerbosity verbosity,
ErrorCode errorCode,
string message,
params object [] parameters )
Logs a message without an exception.
Parameters
correlationId
The correlation ID.
verbosity
The verbosity of the logging.
errorCode
The error code.
message
The message to log.
parameters
The parameter
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta