smithy::components::tracing::TraceSpan Class Reference

#include <TraceSpan.h>

Inheritance diagram for smithy::components::tracing::TraceSpan:

Public Member Functions

 TraceSpan (Aws::String name)

 

virtual ~TraceSpan ()=default

 

virtual void emitEvent (Aws::String name, const Aws::Map< Aws::String, Aws::String > &attributes)=0

 

virtual void setAttribute (Aws::String key, Aws::String value)=0

 

virtual void setStatus (TraceSpanStatus status)=0

 

virtual void end ()=0

 

Detailed Description

The basic unit of a "Trace". Represents a time period during which events occur. Child spans and events can take place within trace. It is a hierarchy and ledger of timing and events during a operation.

Definition at line 30 of file TraceSpan.h.

Constructor & Destructor Documentation

TraceSpan()

smithy::components::tracing::TraceSpan::TraceSpan ( Aws::String  name)

inline

Create a Span

Parameters

name	The name of the span.

Definition at line 36 of file TraceSpan.h.

~TraceSpan()

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

virtualdefault

Member Function Documentation

emitEvent()

virtual void smithy::components::tracing::TraceSpan::emitEvent ( Aws::String  name,

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

)

pure virtual

Emit a event associated with the span.

Parameters

name	The name of the event.
attributes	the attributes or dimensions associate with this measurement.

Implemented in smithy::components::tracing::OtelSpanAdapter, and smithy::components::tracing::NoopTracerSpan.

end()

virtual void smithy::components::tracing::TraceSpan::end ( )

pure virtual

End the span and mark as finished.

Implemented in smithy::components::tracing::OtelSpanAdapter, and smithy::components::tracing::NoopTracerSpan.

setAttribute()

virtual void smithy::components::tracing::TraceSpan::setAttribute ( Aws::String  key,

Aws::String  value 

)

pure virtual

Set a Attribute to span.

Parameters

key	The key of the dimension/attribute.
value	The value of the dimension/attribute.

Implemented in smithy::components::tracing::OtelSpanAdapter, and smithy::components::tracing::NoopTracerSpan.

setStatus()

virtual void smithy::components::tracing::TraceSpan::setStatus ( TraceSpanStatus  status)

pure virtual

Set the statue of the span.

Parameters

status

The status to be assigned.

Implemented in smithy::components::tracing::OtelSpanAdapter, and smithy::components::tracing::NoopTracerSpan.

---

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

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