Navigation
API > API/Runtime > API/Runtime/Analytics > API/Runtime/Analytics/Interfaces
Inheritance Hierarchy
- FNoncopyable
- IAnalyticsTracer
- FAnalyticsTracer
References
| Module | Analytics |
| Header | /Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsTracer.h |
| Include | #include "Interfaces/IAnalyticsTracer.h" |
Syntax
class IAnalyticsTracer : private FNoncopyable
Remarks
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.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | EndSession () |
Ends the running session and Ends the SessionSpan object. |
 |
bool | EndSpan
(
TSharedPtr< IAnalyticsSpan >, |
End an existing span |
 |
bool | EndSpan
(
const FName Name, |
End an existing span by name |
  |
TSharedPtr< IAnalyticsSpan > | Get the currently active span | |
  |
TSharedPtr< IAnalyticsSpan > | Get the session span, this will always be valid for an active session | |
 |
TSharedPtr< IAnalyticsSpan > | Get an active span by name, non active spans will not be available | |
 |
void | SetProvider
(
TSharedPtr< IAnalyticsProvider > AnalyticsProvider |
Sets the analytics provider for the tracer |
 |
void | StartSession () |
Starts a new session, creates and Starts the SessionSpan object. |
 |
TSharedPtr< IAnalyticsSpan > | StartSpan
(
const FName Name, |
Start a new span without a parent |
 |
TSharedPtr< IAnalyticsSpan > | StartSpan
(
const FName Name, |
Start a new span specifying an optional parent. |