Navigation
API > API/Plugins > API/Plugins/StudioTelemetry
Inheritance Hierarchy
- IModuleInterface
- FStudioTelemetry
References
| Module | StudioTelemetry |
| Header | /Engine/Plugins/Experimental/StudioTelemetry/Source/StudioTelemetry/Public/StudioTelemetry.h |
| Include | #include "StudioTelemetry.h" |
Syntax
class FStudioTelemetry : public IModuleInterface
Remarks
Studio Telemetry Plugin API
Notes: Telemetry for Common Editor and Core Engine is collected automatically via the EditorTelemetry plugin. Telemetry Sessions are started and ended automatically with the plugin initialization and shutdown. As such telemetry will not be captured prior to the plugin initialization. Developers are encouraged to add their own telemetry via this API or to intercept the event recording via the supplied callback on the SetRecordEventCallback API below. It is strongly recommended that developers implement their own IAnalyticsProviderModule where custom recording of telemetry events is desired. Custom AnalyticsProviders can be added to the plugin via the .ini. See FAnalyticsProviderLog or FAnalyticsProviderET for example. Telemetry events are recored to all registered IAnalyticsProviders supplied in the .ini file using the FAnalyticsProviderMulticast provider, except where specifically recorded with the RecordEvent(ProviderName,.. ) API below
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | EndSpan
(
TSharedPtr< IAnalyticsSpan > Span, |
End an existing span | |
| bool | EndSpan
(
const FName Name, |
End an existing span by name | |
| FStudioTelemetry & | Get () |
Access to the module singleton | |
| FOnEndSession & | |||
| FOnRecordEvent & | |||
| FOnStartSession & | |||
| TWeakPtr< IAnalyticsProvider > | GetProvider () |
Access to the broadcast analytics provider for the system | |
| TWeakPtr< IAnalyticsProvider > | GetProvider
(
const FString& ProviderName |
Access to the a specific named analytics provider within the system | |
| TSharedPtr< IAnalyticsSpan > | Get the root session span | ||
| TSharedPtr< IAnalyticsSpan > | Get an active span by name, non active spans will not be available | ||
| TWeakPtr< IAnalyticsTracer > | GetTracer () |
Access to the tracer for the system | |
| bool | IsAvailable () |
Check whether the module is available | |
| void | RecordEvent
(
const FName CategoryName, |
Thread safe method to record an event to all registered analytics providers | |
| void | RecordEvent
(
const FString& EventName, |
Thread safe method to record an event to all registered analytics providers | |
| void | RecordEventToProvider
(
const FString& ProviderName, |
Thread safe method to record an event to the specifically named analytics provider | |
| void | Callback for interception of telemetry events recording that can be used by Developers to send telemetry events to their own back end, though it is recommended that Developers implement their own IAnalyticsProvider via their own IAnalyticsProviderModule | ||
| TSharedPtr< IAnalyticsSpan > | StartSpan
(
const FName Name, |
Start a new span specifying the parent | |
| TSharedPtr< IAnalyticsSpan > | StartSpan
(
const FName Name, |
Start a new span specifying the parent |
Classes
| Type | Name | Description | |
|---|---|---|---|
| ScopedSpan | Scoped Span helper class |
Typedefs
| Name | Description |
|---|---|
| FOnEndSession | |
| FOnRecordEvent | |
| FOnStartSession | Delegates for event callbacks |
| OnRecordEventCallback |