Navigation
API > API/Runtime > API/Runtime/TelemetryUtils
References
| Module | TelemetryUtils |
| Header | /Engine/Source/Runtime/Analytics/TelemetryUtils/Public/TelemetryRouter.h |
| Include | #include "TelemetryRouter.h" |
Syntax
class FTelemetryRouter
Remarks
Provides an interface for routing structured telemetry data between prooducers (engine/editor systems) and consumers (modules which will format the data for a particular telemetry endpoint)
Usage: Declare a unique type for telemetry data. This type needs a static FGuid data member called TelemetryID. Provide data to any interested aggregators with the method ProvideTelemetry. Aggregators can register a callback for telemetry data with the method OnTelemetry.
The guid associated with a type for routing should not be relied on by consumers to be stable across engine versions or even across different processes, it is only used for runtime routing purposes. It should not be sent to telemetry endpoints.
@thread_safety Functions are internally synchronized. Re-entrant calls to the public API during callbacks are unsupported. Data is routed on the same thread it is provided. Users should copy data and schedule tasks to execute on a specified thread if they require that.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FTelemetryRouter & | Get () |
|
 |
FDelegateHandle | OnTelemetry
(
TDelegate< void(const DATA_TYPE&)> Sink |
Registers a delegate as callback to receive telemetry of a certain type. |
 |
FDelegateHandle | OnTelemetry
(
CALLABLE&& Sink |
Registers a callable object as a callback receive telemetry of a certain type. |
 |
void | ProvideTelemetry
(
const DATA_TYPE& Data |
Sends data in a type-safe manner to consumers expecting this data type. |
 |
void | UnregisterTelemetrySink
(
FDelegateHandle Handle |
Removes a previously registered callback. |