Navigation
API > API/Runtime > API/Runtime/Analytics
IAnalyticsTracer Interface
Inspired by OpenTelemety model for Tracer/Span. A tracer manages and create spans. It is not permitted to create or start a span outside of the owning tracer object. By default, new spans are added as a child of the last added span but can be added to a child of a specified parent for clarity The tracer has a valid SessionSpan object which is the root of the span hierarchy which is expected to be valid between the StartSession and EndSession calls. Spans are hierarchical and are not expected to overlap, even though the API or implementation might well allow that.
| Name | IAnalyticsTracer |
| Type | class |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsTracer.h |
| Include Path | #include "Interfaces/IAnalyticsTracer.h" |
Syntax
class IAnalyticsTracer : private FNoncopyable
Inheritance Hierarchy
- FNoncopyable → IAnalyticsTracer
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IAnalyticsTracer() |
Interfaces/IAnalyticsTracer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAnalyticsTracer() |
Interfaces/IAnalyticsTracer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EndSession() |
Ends the running session and Ends the SessionSpan object. | Interfaces/IAnalyticsTracer.h | |
bool EndSpan
(
TSharedPtr< IAnalyticsSpan >, |
End an existing span | Interfaces/IAnalyticsTracer.h | |
bool EndSpan
(
const FName Name, |
End an existing span by name | Interfaces/IAnalyticsTracer.h | |
TSharedPtr< IAnalyticsSpan > GetCurrentSpan() |
Get the currently active span | Interfaces/IAnalyticsTracer.h | |
TSharedPtr< IAnalyticsSpan > GetSessionSpan() |
Get the session span, this will always be valid for an active session | Interfaces/IAnalyticsTracer.h | |
TSharedPtr< IAnalyticsSpan > GetSpan
(
const FName Name |
Get an active span by name, non active spans will not be available | Interfaces/IAnalyticsTracer.h | |
void SetProvider
(
TSharedPtr< IAnalyticsProvider > AnalyticsProvider |
Sets the analytics provider for the tracer | Interfaces/IAnalyticsTracer.h | |
void StartSession() |
Starts a new session, creates and Starts the SessionSpan object. | Interfaces/IAnalyticsTracer.h | |
TSharedPtr< IAnalyticsSpan > StartSpan
(
const FName Name, |
Start a new span without a parent | Interfaces/IAnalyticsTracer.h | |
TSharedPtr< IAnalyticsSpan > StartSpan
(
const FName Name, |
Start a new span specifying an optional parent. | Interfaces/IAnalyticsTracer.h |