Detailed Description

Definition at line 37 of file includes/opentelemetry/sdk/metrics/meter_provider.h.

Inheritance diagram for sdk::metrics::MeterProvider:

Collaboration diagram for sdk::metrics::MeterProvider:

Public Member Functions
	MeterProvider (std::unique_ptr< ViewRegistry > views=std::unique_ptr< ViewRegistry >(new ViewRegistry()), const sdk::resource::Resource &resource=sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< MeterConfig >> meter_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< MeterConfig >>(instrumentationscope::ScopeConfigurator< MeterConfig >::Builder(MeterConfig::Default()) .Build())) noexcept
	Initialize a new meter provider. More...

	MeterProvider (std::unique_ptr< MeterContext > context) noexcept
	Initialize a new meter provider with a specified context. More...

nostd::shared_ptr< opentelemetry::metrics::Meter >	GetMeter (nostd::string_view name, nostd::string_view version="", nostd::string_view schema_url="") noexcept override

const sdk::resource::Resource &	GetResource () const noexcept
	Obtain the resource associated with this meter provider. More...

void	AddMetricReader (std::shared_ptr< MetricReader > reader, std::unique_ptr< MetricFilter > metric_filter=nullptr) noexcept
	Create a MetricCollector from a MetricReader using the MeterContext of this MeterProvider and add it to the list of configured collectors. More...

void	AddView (std::unique_ptr< InstrumentSelector > instrument_selector, std::unique_ptr< MeterSelector > meter_selector, std::unique_ptr< View > view) noexcept
	Attaches a View to list of configured Views for this Meter provider. More...

bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the meter provider. More...

bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the meter provider. More...

	~MeterProvider () override

	MeterProvider (std::unique_ptr< ViewRegistry > views=std::unique_ptr< ViewRegistry >(new ViewRegistry()), const sdk::resource::Resource &resource=sdk::resource::Resource::Create({}), std::unique_ptr< instrumentationscope::ScopeConfigurator< MeterConfig >> meter_configurator=std::make_unique< instrumentationscope::ScopeConfigurator< MeterConfig >>(instrumentationscope::ScopeConfigurator< MeterConfig >::Builder(MeterConfig::Default()) .Build())) noexcept
	Initialize a new meter provider. More...

	MeterProvider (std::unique_ptr< MeterContext > context) noexcept
	Initialize a new meter provider with a specified context. More...

nostd::shared_ptr< opentelemetry::metrics::Meter >	GetMeter (nostd::string_view name, nostd::string_view version="", nostd::string_view schema_url="") noexcept override

const sdk::resource::Resource &	GetResource () const noexcept
	Obtain the resource associated with this meter provider. More...

void	AddMetricReader (std::shared_ptr< MetricReader > reader, std::unique_ptr< MetricFilter > metric_filter=nullptr) noexcept
	Create a MetricCollector from a MetricReader using the MeterContext of this MeterProvider and add it to the list of configured collectors. More...

void	AddView (std::unique_ptr< InstrumentSelector > instrument_selector, std::unique_ptr< MeterSelector > meter_selector, std::unique_ptr< View > view) noexcept
	Attaches a View to list of configured Views for this Meter provider. More...

bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the meter provider. More...

bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the meter provider. More...

	~MeterProvider () override

Constructor & Destructor Documentation

◆ MeterProvider() [1/4]

sdk::metrics::MeterProvider::MeterProvider	(	std::unique_ptr< ViewRegistry >	views = `std::unique_ptr< ViewRegistry >(new ViewRegistry())`,
		const sdk::resource::Resource &	resource = `sdk::resource::Resource::Create({})`,
		std::unique_ptr< instrumentationscope::ScopeConfigurator< MeterConfig >>	meter_configurator = `std::make_unique< instrumentationscope::ScopeConfigurator< MeterConfig >>(instrumentationscope::ScopeConfigurator< MeterConfig >::Builder(MeterConfig::Default()) .Build())`
	)

noexcept

Initialize a new meter provider.

Parameters

views	The views for this meter provider
resource	The resources for this meter provider.
meter_configurator	Provides access to a function that computes the MeterConfig for Meters provided by this MeterProvider.

◆ MeterProvider() [2/4]

sdk::metrics::MeterProvider::MeterProvider ( std::unique_ptr< MeterContext > context )

explicitnoexcept

Initialize a new meter provider with a specified context.

Parameters

context The owned meter configuration/pipeline for this provider.

◆ ~MeterProvider() [1/2]

sdk::metrics::MeterProvider::~MeterProvider ( )

override

◆ MeterProvider() [3/4]

sdk::metrics::MeterProvider::MeterProvider	(	std::unique_ptr< ViewRegistry >	views = `std::unique_ptr< ViewRegistry >(new ViewRegistry())`,
		const sdk::resource::Resource &	resource = `sdk::resource::Resource::Create({})`,
		std::unique_ptr< instrumentationscope::ScopeConfigurator< MeterConfig >>	meter_configurator = `std::make_unique< instrumentationscope::ScopeConfigurator< MeterConfig >>(instrumentationscope::ScopeConfigurator< MeterConfig >::Builder(MeterConfig::Default()) .Build())`
	)

noexcept

Initialize a new meter provider.

Parameters

views	The views for this meter provider
resource	The resources for this meter provider.
meter_configurator	Provides access to a function that computes the MeterConfig for Meters provided by this MeterProvider.

◆ MeterProvider() [4/4]

sdk::metrics::MeterProvider::MeterProvider ( std::unique_ptr< MeterContext > context )

explicitnoexcept

Initialize a new meter provider with a specified context.

Parameters

context The owned meter configuration/pipeline for this provider.

◆ ~MeterProvider() [2/2]

sdk::metrics::MeterProvider::~MeterProvider ( )

override

Member Function Documentation

◆ AddMetricReader() [1/2]

void sdk::metrics::MeterProvider::AddMetricReader	(	std::shared_ptr< MetricReader >	reader,
		std::unique_ptr< MetricFilter >	metric_filter = `nullptr`
	)

noexcept

Create a MetricCollector from a MetricReader using the MeterContext of this MeterProvider and add it to the list of configured collectors.

Parameters

reader	The MetricReader for which a MetricCollector is to be created. This must not be a nullptr.
metric_filter	The optional MetricFilter used when creating the MetricCollector.

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

◆ AddMetricReader() [2/2]

void sdk::metrics::MeterProvider::AddMetricReader	(	std::shared_ptr< MetricReader >	reader,
		std::unique_ptr< MetricFilter >	metric_filter = `nullptr`
	)

noexcept

Create a MetricCollector from a MetricReader using the MeterContext of this MeterProvider and add it to the list of configured collectors.

Parameters

reader	The MetricReader for which a MetricCollector is to be created. This must not be a nullptr.
metric_filter	The optional MetricFilter used when creating the MetricCollector.

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

◆ AddView() [1/2]

void sdk::metrics::MeterProvider::AddView	(	std::unique_ptr< InstrumentSelector >	instrument_selector,
		std::unique_ptr< MeterSelector >	meter_selector,
		std::unique_ptr< View >	view
	)

noexcept

Attaches a View to list of configured Views for this Meter provider.

Parameters

view	The Views for this meter provider. This must not be a nullptr.

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

◆ AddView() [2/2]

void sdk::metrics::MeterProvider::AddView	(	std::unique_ptr< InstrumentSelector >	instrument_selector,
		std::unique_ptr< MeterSelector >	meter_selector,
		std::unique_ptr< View >	view
	)

noexcept

Attaches a View to list of configured Views for this Meter provider.

Parameters

view	The Views for this meter provider. This must not be a nullptr.

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

◆ ForceFlush() [1/2]

bool sdk::metrics::MeterProvider::ForceFlush ( std::chrono::microseconds timeout = (std::chrono::microseconds::max)() )

noexcept

Force flush the meter provider.

◆ ForceFlush() [2/2]

bool sdk::metrics::MeterProvider::ForceFlush ( std::chrono::microseconds timeout = (std::chrono::microseconds::max)() )

noexcept

Force flush the meter provider.

◆ GetMeter() [1/2]

nostd::shared_ptr<opentelemetry::metrics::Meter> sdk::metrics::MeterProvider::GetMeter	(	nostd::string_view	name,
		nostd::string_view	version = `""`,
		nostd::string_view	schema_url = `""`
	)

overridenoexcept

◆ GetMeter() [2/2]

nostd::shared_ptr<opentelemetry::metrics::Meter> sdk::metrics::MeterProvider::GetMeter	(	nostd::string_view	name,
		nostd::string_view	version = `""`,
		nostd::string_view	schema_url = `""`
	)

overridenoexcept

◆ GetResource() [1/2]

const sdk::resource::Resource& sdk::metrics::MeterProvider::GetResource ( ) const

noexcept

Obtain the resource associated with this meter provider.

Returns: The resource for this meter provider.

◆ GetResource() [2/2]

const sdk::resource::Resource& sdk::metrics::MeterProvider::GetResource ( ) const

noexcept

Obtain the resource associated with this meter provider.

Returns: The resource for this meter provider.

◆ Shutdown() [1/2]

bool sdk::metrics::MeterProvider::Shutdown ( std::chrono::microseconds timeout = (std::chrono::microseconds::max)() )

noexcept

Shutdown the meter provider.

◆ Shutdown() [2/2]

bool sdk::metrics::MeterProvider::Shutdown ( std::chrono::microseconds timeout = (std::chrono::microseconds::max)() )

noexcept

Shutdown the meter provider.

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

includes/opentelemetry/sdk/metrics/meter_provider.h

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ MeterProvider() [1/4]

◆ MeterProvider() [2/4]

◆ ~MeterProvider() [1/2]

◆ MeterProvider() [3/4]

◆ MeterProvider() [4/4]

◆ ~MeterProvider() [2/2]

Member Function Documentation

◆ AddMetricReader() [1/2]

◆ AddMetricReader() [2/2]

◆ AddView() [1/2]

◆ AddView() [2/2]

◆ ForceFlush() [1/2]

◆ ForceFlush() [2/2]

◆ GetMeter() [1/2]

◆ GetMeter() [2/2]

◆ GetResource() [1/2]

◆ GetResource() [2/2]

◆ Shutdown() [1/2]

◆ Shutdown() [2/2]