userver: tracing::DefaultTracingManagerLocator Class Reference
Loading...
Searching...
No Matches
tracing::DefaultTracingManagerLocator Class Referencefinal

#include <userver/tracing/manager_component.hpp>

Detailed Description

Component that provides access to the actual TracingManager that is used in handlers and clients.

This component allows conversion of tracing formats and allows working with multiple tracing formats. For example:

# yaml
incoming-format: ['opentelemetry', 'taxi']
new-requests-format: ['b3-alternative', 'opentelemetry']

means that tracing data is extracted from OpenTelemetry headers if they were received or from Yandex-Taxi specific headers. The outgoing requests will have the tracing::Format::kB3Alternative headers and OpenTelemetry headers at the same time.

The component can be configured in service config.

Static options:

Name Description Default value
component-name name of the component, that implements TracingManagerComponentBase <use tracing::GenericTracingManager with below settings>
incoming-format Array of incoming tracing formats supported by tracing::FormatFromString ['opentelemetry', 'taxi']
new-requests-format Send tracing data in those formats supported by tracing::FormatFromString ['opentelemetry', 'taxi']

Definition at line 52 of file manager_component.hpp.

+ Inheritance diagram for tracing::DefaultTracingManagerLocator:

Public Member Functions

 DefaultTracingManagerLocator (const components::ComponentConfig &, const components::ComponentContext &)
 
const TracingManagerBaseGetTracingManager () const
 
ComponentHealth GetComponentHealth () const override
 
void OnLoadingCancelled () override
 
void OnAllComponentsLoaded () override
 
void OnAllComponentsAreStopping () override
 

Static Public Member Functions

static yaml_config::Schema GetStaticConfigSchema ()
 

Static Public Attributes

static constexpr std::string_view kName = "tracing-manager-locator"
 The default name of tracing::DefaultTracingManagerLocator.
 

Protected Types

using LoggableComponentBase = ComponentBase
 Legacy alias, use ComponentBase instead.
 

Member Typedef Documentation

◆ LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase
protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Member Function Documentation

◆ GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const
inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning
The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

◆ OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )
inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, and components::Server.

Definition at line 58 of file component_base.hpp.

◆ OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )
inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

Definition at line 51 of file component_base.hpp.

◆ OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )
inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 42 of file component_base.hpp.


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