onnxruntime::logging Namespace Reference

Classes
class	Capture
class	ISink
struct	Category
class	LoggingManager
	The logging manager. Owns the log sink and potentially provides a default Logger instance. Provides filtering based on a minimum LogSeverity level, and of messages with DataType::User if enabled. More...
class	Logger

Typedefs
using	Timestamp = std::chrono::time_point< std::chrono::system_clock >

Enumerations
enum	DataType { DataType::SYSTEM = 0, DataType::USER = 1 }
enum	ORTTraceLoggingKeyword : uint64_t {   ORTTraceLoggingKeyword::Session = 0x1, ORTTraceLoggingKeyword::Logs = 0x2, ORTTraceLoggingKeyword::Reserved1 = 0x4, ORTTraceLoggingKeyword::Reserved2 = 0x8,   ORTTraceLoggingKeyword::Reserved3 = 0x10, ORTTraceLoggingKeyword::Reserved4 = 0x20, ORTTraceLoggingKeyword::Reserved5 = 0x40, ORTTraceLoggingKeyword::Reserved6 = 0x80,   ORTTraceLoggingKeyword::Profiling = 0x100 }
	ORT TraceLogging keywords for categories of dynamic logging enablement More...
enum	Severity {   Severity::kVERBOSE = 0, Severity::kINFO = 1, Severity::kWARNING = 2, Severity::kERROR = 3,   Severity::kFATAL = 4 }
enum	SinkType { SinkType::BaseSink, SinkType::CompositeSink, SinkType::EtwSink }

Functions
unsigned int	GetThreadId ()
unsigned int	GetProcessId ()
std::unique_ptr< ISink >	EnhanceSinkWithEtw (std::unique_ptr< ISink > existingSink, logging::Severity originalSeverity, logging::Severity etwSeverity)
Severity	OverrideLevelWithEtw (Severity originalSeverity)

Variables
constexpr const char *	SEVERITY_PREFIX = "VIWEF"

Typedef Documentation

using onnxruntime::logging::Timestamp = typedef std::chrono::time_point<std::chrono::system_clock>

Definition at line 59 of file logging.h.

Enumeration Type Documentation

enum onnxruntime::logging::DataType

strong

Enumerator
SYSTEM	System data.
USER	Contains potentially sensitive user data.

Definition at line 103 of file logging.h.

enum onnxruntime::logging::ORTTraceLoggingKeyword : uint64_t

strong

ORT TraceLogging keywords for categories of dynamic logging enablement

Enumerator
Session
Logs
Reserved1
Reserved2
Reserved3
Reserved4
Reserved5
Reserved6
Profiling

Definition at line 119 of file logging.h.

enum onnxruntime::logging::Severity

strong

Enumerator
kVERBOSE
kINFO
kWARNING
kERROR
kFATAL

Definition at line 11 of file severity.h.

enum onnxruntime::logging::SinkType

strong

Enumerator
BaseSink
CompositeSink
EtwSink

Definition at line 5 of file sink_types.h.

Function Documentation

std::unique_ptr<ISink> onnxruntime::logging::EnhanceSinkWithEtw	(	std::unique_ptr< ISink >	existingSink,
		logging::Severity	originalSeverity,
		logging::Severity	etwSeverity
	)

If the ONNXRuntimeTraceLoggingProvider ETW Provider is enabled, then adds to the existing logger.

unsigned int onnxruntime::logging::GetProcessId

(

)

Return the current process id.

unsigned int onnxruntime::logging::GetThreadId

(

)

Return the current thread id.

Severity onnxruntime::logging::OverrideLevelWithEtw

(

Severity

originalSeverity

)

If the ONNXRuntimeTraceLoggingProvider ETW Provider is enabled, then can override the logging level. But this overrided level only applies to the ETW sink. The original logger(s) retain their original logging level

Variable Documentation

constexpr const char* onnxruntime::logging::SEVERITY_PREFIX = "VIWEF"

Definition at line 19 of file severity.h.