sdk::trace::TracerProvider Class Reference

Detailed Description

Definition at line 30 of file includes/opentelemetry/sdk/trace/tracer_provider.h.

Inheritance diagram for sdk::trace::TracerProvider:

Collaboration diagram for sdk::trace::TracerProvider:

Public Member Functions
	TracerProvider (std::unique_ptr< SpanProcessor > processor, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler > sampler=std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator > id_generator=std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >> tracer_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())) noexcept
	Initialize a new tracer provider with a specified sampler. More...
	TracerProvider (std::vector< std::unique_ptr< SpanProcessor >> &&processors, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler > sampler=std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator > id_generator=std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >> tracer_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())) noexcept
	TracerProvider (std::unique_ptr< TracerContext > context) noexcept
	Initialize a new tracer provider with a specified context. More...
	~TracerProvider () override
opentelemetry::nostd::shared_ptr< opentelemetry::trace::Tracer >	GetTracer (nostd::string_view name, nostd::string_view version="", nostd::string_view schema_url="") noexcept override
void	AddProcessor (std::unique_ptr< SpanProcessor > processor) noexcept
	Attaches a span processor to list of configured processors for this tracer provider. More...
const opentelemetry::sdk::resource::Resource &	GetResource () const noexcept
	Obtain the resource associated with this tracer provider. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the span processor associated with this tracer provider. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the span processor associated with this tracer provider. More...
	TracerProvider (std::unique_ptr< SpanProcessor > processor, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler > sampler=std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator > id_generator=std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >> tracer_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())) noexcept
	Initialize a new tracer provider with a specified sampler. More...
	TracerProvider (std::vector< std::unique_ptr< SpanProcessor >> &&processors, const opentelemetry::sdk::resource::Resource &resource=opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler > sampler=std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator > id_generator=std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >> tracer_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())) noexcept
	TracerProvider (std::unique_ptr< TracerContext > context) noexcept
	Initialize a new tracer provider with a specified context. More...
	~TracerProvider () override
opentelemetry::nostd::shared_ptr< opentelemetry::trace::Tracer >	GetTracer (nostd::string_view name, nostd::string_view version="", nostd::string_view schema_url="") noexcept override
void	AddProcessor (std::unique_ptr< SpanProcessor > processor) noexcept
	Attaches a span processor to list of configured processors for this tracer provider. More...
const opentelemetry::sdk::resource::Resource &	GetResource () const noexcept
	Obtain the resource associated with this tracer provider. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the span processor associated with this tracer provider. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the span processor associated with this tracer provider. More...

Constructor & Destructor Documentation

TracerProvider() [1/6]

sdk::trace::TracerProvider::TracerProvider ( std::unique_ptr< SpanProcessor >  processor, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler >  sampler = std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator >  id_generator = std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >>  tracer_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())  )

explicitnoexcept

Initialize a new tracer provider with a specified sampler.

Parameters

processor	The span processor for this tracer provider. This must not be a nullptr.
resource	The resources for this tracer provider.
sampler	The sampler for this tracer provider. This must not be a nullptr.
id_generator	The custom id generator for this tracer provider. This must not be a nullptr
tracer_configurator	Provides access to a function that computes the TracerConfig for Tracers provided by this TracerProvider.

TracerProvider() [2/6]

sdk::trace::TracerProvider::TracerProvider ( std::vector< std::unique_ptr< SpanProcessor >> &&  processors, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler >  sampler = std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator >  id_generator = std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >>  tracer_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())  )

explicitnoexcept

TracerProvider() [3/6]

sdk::trace::TracerProvider::TracerProvider ( std::unique_ptr< TracerContext >  context )

explicitnoexcept

Initialize a new tracer provider with a specified context.

Parameters

context

The owned tracer configuration/pipeline for this provider.

~TracerProvider() [1/2]

sdk::trace::TracerProvider::~TracerProvider ( )

override

TracerProvider() [4/6]

sdk::trace::TracerProvider::TracerProvider ( std::unique_ptr< SpanProcessor >  processor, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler >  sampler = std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator >  id_generator = std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >>  tracer_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())  )

explicitnoexcept

Initialize a new tracer provider with a specified sampler.

Parameters

processor	The span processor for this tracer provider. This must not be a nullptr.
resource	The resources for this tracer provider.
sampler	The sampler for this tracer provider. This must not be a nullptr.
id_generator	The custom id generator for this tracer provider. This must not be a nullptr
tracer_configurator	Provides access to a function that computes the TracerConfig for Tracers provided by this TracerProvider.

TracerProvider() [5/6]

sdk::trace::TracerProvider::TracerProvider ( std::vector< std::unique_ptr< SpanProcessor >> &&  processors, const opentelemetry::sdk::resource::Resource &  resource = opentelemetry::sdk::resource::Resource::Create({}), std::unique_ptr< Sampler >  sampler = std::unique_ptr< AlwaysOnSampler >(new AlwaysOnSampler), std::unique_ptr< IdGenerator >  id_generator = std::unique_ptr< IdGenerator >(new RandomIdGenerator()), std::unique_ptr< instrumentationscope::ScopeConfigurator< TracerConfig >>  tracer_configurator = std::make_unique< instrumentationscope::ScopeConfigurator< TracerConfig >>(instrumentationscope::ScopeConfigurator< TracerConfig >::Builder(TracerConfig::Default()) .Build())  )

explicitnoexcept

TracerProvider() [6/6]

sdk::trace::TracerProvider::TracerProvider ( std::unique_ptr< TracerContext >  context )

explicitnoexcept

Initialize a new tracer provider with a specified context.

Parameters

context

The owned tracer configuration/pipeline for this provider.

~TracerProvider() [2/2]

sdk::trace::TracerProvider::~TracerProvider ( )

override

Member Function Documentation

AddProcessor() [1/2]

void sdk::trace::TracerProvider::AddProcessor ( std::unique_ptr< SpanProcessor >  processor )

noexcept

Attaches a span processor to list of configured processors for this tracer provider.

Parameters

processor

The new span processor for this tracer provider. This must not be a nullptr.

Note: This process may not receive any in-flight spans, but will get newly created spans. Note: This method is not thread safe, and should ideally be called from main thread.

AddProcessor() [2/2]

void sdk::trace::TracerProvider::AddProcessor ( std::unique_ptr< SpanProcessor >  processor )

noexcept

Attaches a span processor to list of configured processors for this tracer provider.

Parameters

processor

The new span processor for this tracer provider. This must not be a nullptr.

Note: This process may not receive any in-flight spans, but will get newly created spans. Note: This method is not thread safe, and should ideally be called from main thread.

ForceFlush() [1/2]

bool sdk::trace::TracerProvider::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Force flush the span processor associated with this tracer provider.

ForceFlush() [2/2]

bool sdk::trace::TracerProvider::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Force flush the span processor associated with this tracer provider.

GetResource() [1/2]

const opentelemetry::sdk::resource::Resource& sdk::trace::TracerProvider::GetResource ( ) const

noexcept

Obtain the resource associated with this tracer provider.

Returns

The resource for this tracer provider.

GetResource() [2/2]

const opentelemetry::sdk::resource::Resource& sdk::trace::TracerProvider::GetResource ( ) const

noexcept

Obtain the resource associated with this tracer provider.

Returns

The resource for this tracer provider.

GetTracer() [1/2]

opentelemetry::nostd::shared_ptr<opentelemetry::trace::Tracer> sdk::trace::TracerProvider::GetTracer ( nostd::string_view  name, nostd::string_view  version = "", nostd::string_view  schema_url = ""  )

overridenoexcept

GetTracer() [2/2]

opentelemetry::nostd::shared_ptr<opentelemetry::trace::Tracer> sdk::trace::TracerProvider::GetTracer ( nostd::string_view  name, nostd::string_view  version = "", nostd::string_view  schema_url = ""  )

overridenoexcept

Shutdown() [1/2]

bool sdk::trace::TracerProvider::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Shutdown the span processor associated with this tracer provider.

Shutdown() [2/2]

bool sdk::trace::TracerProvider::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Shutdown the span processor associated with this tracer provider.

---

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

• includes/opentelemetry/sdk/trace/tracer_provider.h