sdk::trace::TracerConfig Class Reference

Detailed Description

TracerConfig defines various configurable aspects of a Tracer's behavior.

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

Definition at line 19 of file includes/opentelemetry/sdk/trace/tracer_config.h.

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

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

Member Function Documentation

Default() [1/2]

static TracerConfig sdk::trace::TracerConfig::Default ( )

static

Returns a TracerConfig that represents a Tracer configured with the default behavior.

The default behavior is guided by the OpenTelemetry specification.

Returns

a static constant TracerConfig that represents a tracer configured with default behavior.

Default() [2/2]

static TracerConfig sdk::trace::TracerConfig::Default ( )

static

Returns a TracerConfig that represents a Tracer configured with the default behavior.

The default behavior is guided by the OpenTelemetry specification.

Returns

a static constant TracerConfig that represents a tracer configured with default behavior.

Disabled() [1/2]

static TracerConfig sdk::trace::TracerConfig::Disabled ( )

static

Returns a TracerConfig that represents a disabled Tracer.

A disabled tracer behaves like a no-op tracer.

Returns

a static constant TracerConfig that represents a disabled tracer.

Disabled() [2/2]

static TracerConfig sdk::trace::TracerConfig::Disabled ( )

static

Returns a TracerConfig that represents a disabled Tracer.

A disabled tracer behaves like a no-op tracer.

Returns

a static constant TracerConfig that represents a disabled tracer.

Enabled() [1/2]

static TracerConfig sdk::trace::TracerConfig::Enabled ( )

static

Returns a TracerConfig that represents an enabled Tracer.

Returns

a static constant TracerConfig that represents an enabled tracer.

Enabled() [2/2]

static TracerConfig sdk::trace::TracerConfig::Enabled ( )

static

Returns a TracerConfig that represents an enabled Tracer.

Returns

a static constant TracerConfig that represents an enabled tracer.

IsEnabled() [1/2]

bool sdk::trace::TracerConfig::IsEnabled ( ) const

noexcept

Returns if the Tracer is enabled or disabled.

Tracers are enabled by default.

Returns

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

IsEnabled() [2/2]

bool sdk::trace::TracerConfig::IsEnabled ( ) const

noexcept

Returns if the Tracer is enabled or disabled.

Tracers are enabled by default.

Returns

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

operator==() [1/2]

bool sdk::trace::TracerConfig::operator== ( const TracerConfig &  other ) const

noexcept

operator==() [2/2]

bool sdk::trace::TracerConfig::operator== ( const TracerConfig &  other ) const

noexcept

---

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

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