NVIDIA DeepStream SDK API Reference

9.2 Release
sdk::logs::LoggerConfig Class Reference

Detailed Description

LoggerConfig defines various configurable aspects of a Logger's behavior.

This class should not be used directly to configure a Logger's behavior, instead a ScopeConfigurator should be used to compute the desired LoggerConfig which can then be used to configure a Logger.

Definition at line 19 of file includes/opentelemetry/sdk/logs/logger_config.h.

Public Member Functions

bool operator== (const LoggerConfig &other) const noexcept
 
bool IsEnabled () const noexcept
 Returns if the Logger is enabled or disabled. More...
 
bool operator== (const LoggerConfig &other) const noexcept
 
bool IsEnabled () const noexcept
 Returns if the Logger is enabled or disabled. More...
 

Static Public Member Functions

static LoggerConfig Enabled ()
 Returns a LoggerConfig that represents an enabled Logger. More...
 
static LoggerConfig Disabled ()
 Returns a LoggerConfig that represents a disabled Logger. More...
 
static LoggerConfig Default ()
 Returns a LoggerConfig that represents a Logger configured with the default behavior. More...
 
static LoggerConfig Enabled ()
 Returns a LoggerConfig that represents an enabled Logger. More...
 
static LoggerConfig Disabled ()
 Returns a LoggerConfig that represents a disabled Logger. More...
 
static LoggerConfig Default ()
 Returns a LoggerConfig that represents a Logger configured with the default behavior. More...
 

Member Function Documentation

◆ Default() [1/2]

static LoggerConfig sdk::logs::LoggerConfig::Default ( )
static

Returns a LoggerConfig that represents a Logger configured with the default behavior.

The default behavior is guided by the OpenTelemetry specification.

Returns
a static constant LoggerConfig that represents a logger configured with default behavior.

◆ Default() [2/2]

static LoggerConfig sdk::logs::LoggerConfig::Default ( )
static

Returns a LoggerConfig that represents a Logger configured with the default behavior.

The default behavior is guided by the OpenTelemetry specification.

Returns
a static constant LoggerConfig that represents a logger configured with default behavior.

◆ Disabled() [1/2]

static LoggerConfig sdk::logs::LoggerConfig::Disabled ( )
static

Returns a LoggerConfig that represents a disabled Logger.

A disabled logger behaves like a no-op logger.

Returns
a static constant LoggerConfig that represents a disabled logger.

◆ Disabled() [2/2]

static LoggerConfig sdk::logs::LoggerConfig::Disabled ( )
static

Returns a LoggerConfig that represents a disabled Logger.

A disabled logger behaves like a no-op logger.

Returns
a static constant LoggerConfig that represents a disabled logger.

◆ Enabled() [1/2]

static LoggerConfig sdk::logs::LoggerConfig::Enabled ( )
static

Returns a LoggerConfig that represents an enabled Logger.

Returns
a static constant LoggerConfig that represents an enabled logger.

◆ Enabled() [2/2]

static LoggerConfig sdk::logs::LoggerConfig::Enabled ( )
static

Returns a LoggerConfig that represents an enabled Logger.

Returns
a static constant LoggerConfig that represents an enabled logger.

◆ IsEnabled() [1/2]

bool sdk::logs::LoggerConfig::IsEnabled ( ) const
noexcept

Returns if the Logger is enabled or disabled.

Loggers are enabled by default.

Returns
a boolean indicating if the Logger is enabled. Defaults to true.

◆ IsEnabled() [2/2]

bool sdk::logs::LoggerConfig::IsEnabled ( ) const
noexcept

Returns if the Logger is enabled or disabled.

Loggers are enabled by default.

Returns
a boolean indicating if the Logger is enabled. Defaults to true.

◆ operator==() [1/2]

bool sdk::logs::LoggerConfig::operator== ( const LoggerConfig &  other) const
noexcept

◆ operator==() [2/2]

bool sdk::logs::LoggerConfig::operator== ( const LoggerConfig &  other) const
noexcept

The documentation for this class was generated from the following file: