sdk::logs::LoggerProvider Class Reference

Detailed Description

Definition at line 31 of file includes/opentelemetry/sdk/logs/logger_provider.h.

Inheritance diagram for sdk::logs::LoggerProvider:

Collaboration diagram for sdk::logs::LoggerProvider:

Public Member Functions
	LoggerProvider (std::unique_ptr< LogRecordProcessor > &&processor, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >> logger_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())) noexcept
	Initialize a new logger provider. More...
	LoggerProvider (std::vector< std::unique_ptr< LogRecordProcessor >> &&processors, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >> logger_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())) noexcept
	Initialize a new logger provider. More...
	LoggerProvider () noexcept
	Initialize a new logger provider. More...
	LoggerProvider (std::unique_ptr< LoggerContext > context) noexcept
	Initialize a new logger provider with a specified context. More...
	~LoggerProvider () override
nostd::shared_ptr< opentelemetry::logs::Logger >	GetLogger (nostd::string_view logger_name, nostd::string_view library_name, nostd::string_view library_version="", nostd::string_view schema_url="", const opentelemetry::common::KeyValueIterable &attributes=opentelemetry::common::NoopKeyValueIterable()) noexcept override
	Creates a logger with the given name, and returns a shared pointer to it. More...
void	AddProcessor (std::unique_ptr< LogRecordProcessor > processor) noexcept
	Add the processor that is stored internally in the logger provider. More...
const opentelemetry::sdk::resource::Resource &	GetResource () const noexcept
	Obtain the resource associated with this logger provider. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the log processor associated with this log provider. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the log processor associated with this log provider. More...
	LoggerProvider (std::unique_ptr< LogRecordProcessor > &&processor, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >> logger_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())) noexcept
	Initialize a new logger provider. More...
	LoggerProvider (std::vector< std::unique_ptr< LogRecordProcessor >> &&processors, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >> logger_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())) noexcept
	Initialize a new logger provider. More...
	LoggerProvider () noexcept
	Initialize a new logger provider. More...
	LoggerProvider (std::unique_ptr< LoggerContext > context) noexcept
	Initialize a new logger provider with a specified context. More...
	~LoggerProvider () override
nostd::shared_ptr< opentelemetry::logs::Logger >	GetLogger (nostd::string_view logger_name, nostd::string_view library_name, nostd::string_view library_version="", nostd::string_view schema_url="", const opentelemetry::common::KeyValueIterable &attributes=opentelemetry::common::NoopKeyValueIterable()) noexcept override
	Creates a logger with the given name, and returns a shared pointer to it. More...
void	AddProcessor (std::unique_ptr< LogRecordProcessor > processor) noexcept
	Add the processor that is stored internally in the logger provider. More...
const opentelemetry::sdk::resource::Resource &	GetResource () const noexcept
	Obtain the resource associated with this logger provider. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the log processor associated with this log provider. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the log processor associated with this log provider. More...

Constructor & Destructor Documentation

LoggerProvider() [1/8]

sdk::logs::LoggerProvider::LoggerProvider ( std::unique_ptr< LogRecordProcessor > &&  processor, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >>  logger_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())  )

explicitnoexcept

Initialize a new logger provider.

Parameters

processor	The log record processor for this logger provider. This must not be a nullptr.
resource	The resources for this logger provider.

LoggerProvider() [2/8]

sdk::logs::LoggerProvider::LoggerProvider ( std::vector< std::unique_ptr< LogRecordProcessor >> &&  processors, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >>  logger_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())  )

explicitnoexcept

Initialize a new logger provider.

Parameters

processors	A list of log record processors for this logger provider.
resource	The resources for this logger provider.
logger_configurator	The scope configurator used to determine the configs for loggers created using this logger provider.

LoggerProvider() [3/8]

sdk::logs::LoggerProvider::LoggerProvider ( )

explicitnoexcept

Initialize a new logger provider.

A processor must later be assigned to this logger provider via the AddProcessor() method.

LoggerProvider() [4/8]

sdk::logs::LoggerProvider::LoggerProvider ( std::unique_ptr< LoggerContext >  context )

explicitnoexcept

Initialize a new logger provider with a specified context.

Parameters

context

The owned logger configuration/pipeline for this provider.

~LoggerProvider() [1/2]

sdk::logs::LoggerProvider::~LoggerProvider ( )

override

LoggerProvider() [5/8]

sdk::logs::LoggerProvider::LoggerProvider ( std::unique_ptr< LogRecordProcessor > &&  processor, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >>  logger_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())  )

explicitnoexcept

Initialize a new logger provider.

Parameters

processor	The log record processor for this logger provider. This must not be a nullptr.
resource	The resources for this logger provider.

LoggerProvider() [6/8]

sdk::logs::LoggerProvider::LoggerProvider ( std::vector< std::unique_ptr< LogRecordProcessor >> &&  processors, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< LoggerConfig >>  logger_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< LoggerConfig >>(instrumentationscope::ScopeConfigurator< LoggerConfig >::Builder(LoggerConfig::Default()) .Build())  )

explicitnoexcept

Initialize a new logger provider.

Parameters

processors	A list of log record processors for this logger provider.
resource	The resources for this logger provider.
logger_configurator	The scope configurator used to determine the configs for loggers created using this logger provider.

LoggerProvider() [7/8]

sdk::logs::LoggerProvider::LoggerProvider ( )

explicitnoexcept

Initialize a new logger provider.

A processor must later be assigned to this logger provider via the AddProcessor() method.

LoggerProvider() [8/8]

sdk::logs::LoggerProvider::LoggerProvider ( std::unique_ptr< LoggerContext >  context )

explicitnoexcept

Initialize a new logger provider with a specified context.

Parameters

context

The owned logger configuration/pipeline for this provider.

~LoggerProvider() [2/2]

sdk::logs::LoggerProvider::~LoggerProvider ( )

override

Member Function Documentation

AddProcessor() [1/2]

void sdk::logs::LoggerProvider::AddProcessor ( std::unique_ptr< LogRecordProcessor >  processor )

noexcept

Add the processor that is stored internally in the logger provider.

Parameters

processor

The processor to be stored inside the logger provider. This must not be a nullptr.

AddProcessor() [2/2]

void sdk::logs::LoggerProvider::AddProcessor ( std::unique_ptr< LogRecordProcessor >  processor )

noexcept

Add the processor that is stored internally in the logger provider.

Parameters

processor

The processor to be stored inside the logger provider. This must not be a nullptr.

ForceFlush() [1/2]

bool sdk::logs::LoggerProvider::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Force flush the log processor associated with this log provider.

ForceFlush() [2/2]

bool sdk::logs::LoggerProvider::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Force flush the log processor associated with this log provider.

GetLogger() [1/2]

nostd::shared_ptr<opentelemetry::logs::Logger> sdk::logs::LoggerProvider::GetLogger ( nostd::string_view  logger_name, nostd::string_view  library_name, nostd::string_view  library_version = "", nostd::string_view  schema_url = "", const opentelemetry::common::KeyValueIterable &  attributes = opentelemetry::common::NoopKeyValueIterable()  )

overridenoexcept

Creates a logger with the given name, and returns a shared pointer to it.

If a logger with that name already exists, return a shared pointer to it

Parameters

logger_name	The name of the logger to be created.
library_name	The version of the library.
library_version	The version of the library.
schema_url	The schema URL.

GetLogger() [2/2]

nostd::shared_ptr<opentelemetry::logs::Logger> sdk::logs::LoggerProvider::GetLogger ( nostd::string_view  logger_name, nostd::string_view  library_name, nostd::string_view  library_version = "", nostd::string_view  schema_url = "", const opentelemetry::common::KeyValueIterable &  attributes = opentelemetry::common::NoopKeyValueIterable()  )

overridenoexcept

Creates a logger with the given name, and returns a shared pointer to it.

If a logger with that name already exists, return a shared pointer to it

Parameters

logger_name	The name of the logger to be created.
library_name	The version of the library.
library_version	The version of the library.
schema_url	The schema URL.

GetResource() [1/2]

const opentelemetry::sdk::resource::Resource& sdk::logs::LoggerProvider::GetResource ( ) const

noexcept

Obtain the resource associated with this logger provider.

Returns

The resource for this logger provider.

GetResource() [2/2]

const opentelemetry::sdk::resource::Resource& sdk::logs::LoggerProvider::GetResource ( ) const

noexcept

Obtain the resource associated with this logger provider.

Returns

The resource for this logger provider.

Shutdown() [1/2]

bool sdk::logs::LoggerProvider::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Shutdown the log processor associated with this log provider.

Shutdown() [2/2]

bool sdk::logs::LoggerProvider::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Shutdown the log processor associated with this log provider.

---

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

• includes/opentelemetry/sdk/logs/logger_provider.h