UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAnalyticsTracer Class Reference

#include <AnalyticsTracer.h>

+ Inheritance diagram for FAnalyticsTracer:

Public Member Functions

 FAnalyticsTracer ()
 
 ~FAnalyticsTracer ()
 
virtual void StartSession () override
 
virtual void EndSession () override
 
virtual void SetProvider (TSharedPtr< IAnalyticsProvider > AnalyticsProvider) override
 
virtual TSharedPtr< IAnalyticsSpanStartSpan (const FName Name, TSharedPtr< IAnalyticsSpan > ParentSpan, const TArray< FAnalyticsEventAttribute > &AdditionalAttributes={}) override
 
virtual bool EndSpan (TSharedPtr< IAnalyticsSpan > Span, const TArray< FAnalyticsEventAttribute > &AdditionalAttributes={}) override
 
virtual TSharedPtr< IAnalyticsSpanGetCurrentSpan () const override
 
virtual TSharedPtr< IAnalyticsSpanGetSessionSpan () const override
 
virtual TSharedPtr< IAnalyticsSpanGetSpan (const FName Name) override
 
- Public Member Functions inherited from IAnalyticsTracer
 IAnalyticsTracer ()
 
virtual ~IAnalyticsTracer ()
 
TSharedPtr< IAnalyticsSpanStartSpan (const FName Name, const TArray< FAnalyticsEventAttribute > &AdditionalAttributes={})
 
bool EndSpan (const FName Name, const TArray< FAnalyticsEventAttribute > &AdditionalAttributes={})
 

Detailed Description

Implementation of an IAnalyticsTracer interface

Constructor & Destructor Documentation

◆ FAnalyticsTracer()

FAnalyticsTracer::FAnalyticsTracer ( )
inline

◆ ~FAnalyticsTracer()

FAnalyticsTracer::~FAnalyticsTracer ( )
inline

Member Function Documentation

◆ EndSession()

void FAnalyticsTracer::EndSession ( )
overridevirtual

Implements IAnalyticsTracer.

◆ EndSpan()

bool FAnalyticsTracer::EndSpan ( TSharedPtr< IAnalyticsSpan ,
const TArray< FAnalyticsEventAttribute > &  AdditionalAttributes = {} 
)
overridevirtual

End an existing span

Implements IAnalyticsTracer.

◆ GetCurrentSpan()

TSharedPtr< IAnalyticsSpan > FAnalyticsTracer::GetCurrentSpan ( ) const
overridevirtual

Get the currently active span

Implements IAnalyticsTracer.

◆ GetSessionSpan()

TSharedPtr< IAnalyticsSpan > FAnalyticsTracer::GetSessionSpan ( ) const
overridevirtual

Get the session span, this will always be valid for an active session

Implements IAnalyticsTracer.

◆ GetSpan()

TSharedPtr< IAnalyticsSpan > FAnalyticsTracer::GetSpan ( const FName  Name)
overridevirtual

Get an active span by name, non active spans will not be available

Implements IAnalyticsTracer.

◆ SetProvider()

void FAnalyticsTracer::SetProvider ( TSharedPtr< IAnalyticsProvider AnalyticsProvider)
overridevirtual

Sets the analytics provider for the tracer

Implements IAnalyticsTracer.

◆ StartSession()

void FAnalyticsTracer::StartSession ( )
overridevirtual

Implements IAnalyticsTracer.

◆ StartSpan()

TSharedPtr< IAnalyticsSpan > FAnalyticsTracer::StartSpan ( const FName  Name,
TSharedPtr< IAnalyticsSpan ParentSpan,
const TArray< FAnalyticsEventAttribute > &  AdditionalAttributes = {} 
)
overridevirtual

Start a new span specifying an optional parent. EndSpan is called recursively on children. Parent attributes are passed onto children

Implements IAnalyticsTracer.


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