FAnalyticsSpan Class Reference

#include <AnalyticsTracer.h>

Inheritance diagram for FAnalyticsSpan:

Public Member Functions
	FAnalyticsSpan (FName SpanName)
	~FAnalyticsSpan ()
virtual void	SetProvider (TSharedPtr< IAnalyticsProvider > AnalyticsProvider) override
virtual void	Start (const TArray< FAnalyticsEventAttribute > &AdditionalAttributes={})
virtual void	End (const TArray< FAnalyticsEventAttribute > &AdditionalAttributes={}) override
virtual void	AddAttributes (const TArray< FAnalyticsEventAttribute > &AdditionalAttributes) override
virtual void	RecordEvent (const FString &EventName, const TArray< FAnalyticsEventAttribute > &AdditionalAttributes={}) override
virtual const FName &	GetName () const override
virtual const TArray< FAnalyticsEventAttribute > &	GetAttributes () const override
virtual void	SetStackDepth (uint32 Depth) override
virtual uint32	GetStackDepth () const override
virtual double	GetElapsedTime () override
virtual double	GetDuration () const override
virtual bool	GetIsActive () const override
virtual FGuid	GetId () const override
Public Member Functions inherited from IAnalyticsSpan
	IAnalyticsSpan (const FName Name)
virtual	~IAnalyticsSpan ()

Detailed Description

Implementation of an IAnalyticsSpan interface

Constructor & Destructor Documentation

FAnalyticsSpan()

FAnalyticsSpan::FAnalyticsSpan ( FName  SpanName )

inline

~FAnalyticsSpan()

FAnalyticsSpan::~FAnalyticsSpan ( )

inline

Member Function Documentation

AddAttributes()

void FAnalyticsSpan::AddAttributes ( const TArray< FAnalyticsEventAttribute > &  AdditionalAttributes )

overridevirtual

Append attributes to this span context

Implements IAnalyticsSpan.

End()

void FAnalyticsSpan::End ( const TArray< FAnalyticsEventAttribute > &  AdditionalAttributes = {} )

overridevirtual

End this span

Implements IAnalyticsSpan.

GetAttributes()

const TArray< FAnalyticsEventAttribute > & FAnalyticsSpan::GetAttributes ( ) const

overridevirtual

Get context attributes for the span

Implements IAnalyticsSpan.

GetDuration()

double FAnalyticsSpan::GetDuration ( ) const

overridevirtual

Get the span duration in seconds

Implements IAnalyticsSpan.

GetElapsedTime()

double FAnalyticsSpan::GetElapsedTime ( )

overridevirtual

Get the elapsed time for the span in seconds

Implements IAnalyticsSpan.

GetId()

FGuid FAnalyticsSpan::GetId ( ) const

overridevirtual

Implements IAnalyticsSpan.

GetIsActive()

bool FAnalyticsSpan::GetIsActive ( ) const

overridevirtual

Implements IAnalyticsSpan.

GetName()

const FName & FAnalyticsSpan::GetName ( ) const

overridevirtual

Get the internal name for the span

Implements IAnalyticsSpan.

GetStackDepth()

uint32 FAnalyticsSpan::GetStackDepth ( ) const

overridevirtual

Get the scope depth for the span

Implements IAnalyticsSpan.

RecordEvent()

void FAnalyticsSpan::RecordEvent ( const FString &  EventName, const TArray< FAnalyticsEventAttribute > &  AdditionalAttributes = {}  )

overridevirtual

Record an event from this span, appends the attributes for the span context

Implements IAnalyticsSpan.

SetProvider()

void FAnalyticsSpan::SetProvider ( TSharedPtr< IAnalyticsProvider >  AnalyticsProvider )

overridevirtual

Sets the analytics provider for the tracer

Implements IAnalyticsSpan.

SetStackDepth()

void FAnalyticsSpan::SetStackDepth ( uint32  Depth )

overridevirtual

Set the scope depth for the span

Implements IAnalyticsSpan.

Start()

void FAnalyticsSpan::Start ( const TArray< FAnalyticsEventAttribute > &  AdditionalAttributes = {} )

virtual

Start this span

Implements IAnalyticsSpan.

---

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

• Engine/Source/Runtime/Analytics/Analytics/Public/AnalyticsTracer.h
• Engine/Source/Runtime/Analytics/Analytics/Private/AnalyticsTracer.cpp