sdk::metrics::MeterConfig Class Reference

Detailed Description

MeterConfig defines various configurable aspects of a Meter's behavior.

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

Definition at line 19 of file includes/opentelemetry/sdk/metrics/meter_config.h.

Public Member Functions
bool	operator== (const MeterConfig &other) const noexcept
bool	IsEnabled () const noexcept
	Returns if the Meter is enabled or disabled. More...
bool	operator== (const MeterConfig &other) const noexcept
bool	IsEnabled () const noexcept
	Returns if the Meter is enabled or disabled. More...

Static Public Member Functions
static MeterConfig	Disabled ()
	Returns a MeterConfig that represents a disabled Meter. More...
static MeterConfig	Enabled ()
	Returns a MeterConfig that represents an enabled Meter. More...
static MeterConfig	Default ()
	Returns a MeterConfig that represents a Meter configured with the default behavior. More...
static MeterConfig	Disabled ()
	Returns a MeterConfig that represents a disabled Meter. More...
static MeterConfig	Enabled ()
	Returns a MeterConfig that represents an enabled Meter. More...
static MeterConfig	Default ()
	Returns a MeterConfig that represents a Meter configured with the default behavior. More...

Member Function Documentation

Default() [1/2]

static MeterConfig sdk::metrics::MeterConfig::Default ( )

static

Returns a MeterConfig that represents a Meter configured with the default behavior.

The default behavior is guided by the OpenTelemetry specification.

Returns

a static constant MeterConfig that represents a meter configured with default behavior.

Default() [2/2]

static MeterConfig sdk::metrics::MeterConfig::Default ( )

static

Returns a MeterConfig that represents a Meter configured with the default behavior.

The default behavior is guided by the OpenTelemetry specification.

Returns

a static constant MeterConfig that represents a meter configured with default behavior.

Disabled() [1/2]

static MeterConfig sdk::metrics::MeterConfig::Disabled ( )

static

Returns a MeterConfig that represents a disabled Meter.

A disabled meter behaves like a no-op meter.

Returns

a static constant MeterConfig that represents a disabled meter.

Disabled() [2/2]

static MeterConfig sdk::metrics::MeterConfig::Disabled ( )

static

Returns a MeterConfig that represents a disabled Meter.

A disabled meter behaves like a no-op meter.

Returns

a static constant MeterConfig that represents a disabled meter.

Enabled() [1/2]

static MeterConfig sdk::metrics::MeterConfig::Enabled ( )

static

Returns a MeterConfig that represents an enabled Meter.

Returns

a static constant MeterConfig that represents an enabled meter.

Enabled() [2/2]

static MeterConfig sdk::metrics::MeterConfig::Enabled ( )

static

Returns a MeterConfig that represents an enabled Meter.

Returns

a static constant MeterConfig that represents an enabled meter.

IsEnabled() [1/2]

bool sdk::metrics::MeterConfig::IsEnabled ( ) const

noexcept

Returns if the Meter is enabled or disabled.

Meters are enabled by default.

Returns

a boolean indicating if the Meter is enabled. Defaults to true.

IsEnabled() [2/2]

bool sdk::metrics::MeterConfig::IsEnabled ( ) const

noexcept

Returns if the Meter is enabled or disabled.

Meters are enabled by default.

Returns

a boolean indicating if the Meter is enabled. Defaults to true.

operator==() [1/2]

bool sdk::metrics::MeterConfig::operator== ( const MeterConfig &  other ) const

noexcept

operator==() [2/2]

bool sdk::metrics::MeterConfig::operator== ( const MeterConfig &  other ) const

noexcept

---

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

• includes/opentelemetry/sdk/metrics/meter_config.h