smithy::components::tracing::TelemetryProvider Class Reference

#include <TelemetryProvider.h>

Inheritance diagram for smithy::components::tracing::TelemetryProvider:

Public Member Functions

 TelemetryProvider (Aws::UniquePtr< TracerProvider > tracerProvider, Aws::UniquePtr< MeterProvider > meterProvider, std::function< void()> init, std::function< void()> shutdown)

 

virtual ~TelemetryProvider ()

 

std::shared_ptr< Tracer > getTracer (Aws::String scope, const Aws::Map< Aws::String, Aws::String > &attributes)

 

std::shared_ptr< Meter > getMeter (Aws::String scope, const Aws::Map< Aws::String, Aws::String > &attributes)

 

void RunInit ()

 

void RunShutDown ()

 

Detailed Description

A Utility holder class that manages the creation and management of telemetry related operations.

Definition at line 21 of file TelemetryProvider.h.

Constructor & Destructor Documentation

TelemetryProvider()

smithy::components::tracing::TelemetryProvider::TelemetryProvider ( Aws::UniquePtr< TracerProvider >  tracerProvider,

Aws::UniquePtr< MeterProvider >  meterProvider,

std::function< void()>  init,

std::function< void()>  shutdown 

)

inline

Creates a Telemetry provider with given providers and a init and shutdown function that is run during its ctor/dtor.

Parameters

tracerProvider	The TracerProvider to be used in the SDK.
meterProvider	The MeterProvider to be used in the SDK.
init	The initialization function that will be run at creation.
shutdown	The shutdown function that will be run at destruction.

Definition at line 31 of file TelemetryProvider.h.

~TelemetryProvider()

virtual smithy::components::tracing::TelemetryProvider::~TelemetryProvider ( )

inlinevirtual

Definition at line 43 of file TelemetryProvider.h.

Member Function Documentation

getMeter()

std::shared_ptr< Meter > smithy::components::tracing::TelemetryProvider::getMeter ( Aws::String  scope,

const Aws::Map< Aws::String, Aws::String > &  attributes 

)

inline

Returns a reference to a Meter used to create metrics.

Parameters

scope	The scope of the Meter that is being used.
attributes	the attributes or dimensions associate with this measurement.

Returns

A reference to a Meter instance.

Definition at line 67 of file TelemetryProvider.h.

getTracer()

std::shared_ptr< Tracer > smithy::components::tracing::TelemetryProvider::getTracer ( Aws::String  scope,

const Aws::Map< Aws::String, Aws::String > &  attributes 

)

inline

Returns a reference to a Tracer used to create spans.

Parameters

scope	The scope of the Tracer that is being used.
attributes	the attributes or dimensions associate with this measurement.

Returns

A reference to a Tracer instance.

Definition at line 55 of file TelemetryProvider.h.

RunInit()

void smithy::components::tracing::TelemetryProvider::RunInit ( )

inline

Runs initialization of the Tracer Provider and the MeterProvider. Will only be run once during initialization.

Definition at line 75 of file TelemetryProvider.h.

RunShutDown()

void smithy::components::tracing::TelemetryProvider::RunShutDown ( )

inline

Runs shutdown of the Tracer Provider and the MeterProvider. Will only be run once during destruction.

Definition at line 83 of file TelemetryProvider.h.

---

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

• src/aws-cpp-sdk-core/include/smithy/tracing/TelemetryProvider.h