1. Epic GamesDeveloper
  3. FStudioTelemetry

FStudioTelemetry

Studio Telemetry Plugin API

API > API/Plugins > API/Plugins/StudioTelemetry

Inheritance Hierarchy

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
Public function bool

EndSpan ( TSharedPtr< IAnalyticsSpan > Span,
const TArray< FAnalyticsEventAttribute >& AdditionalAttributes
)

 End an existing span
Public function bool

EndSpan ( const FName Name,
const TArray< FAnalyticsEventAttribute >& AdditionalAttributes
)

 End an existing span by name
Public function Static FStudioTelemetry &

Get ()

 Access to the module singleton
Public function FOnEndSession &  
Public function FOnRecordEvent &  
Public function FOnStartSession &  
Public function TWeakPtr< IAnalyticsProvider > Access to the broadcast analytics provider for the system
Public function TWeakPtr< IAnalyticsProvider >

GetProvider ( const FString& ProviderName
)

 Access to the a specific named analytics provider within the system
Public function Const TSharedPtr< IAnalyticsSpan > Get the root session span
Public function TSharedPtr< IAnalyticsSpan >

GetSpan ( const FName Name
)

 Get an active span by name, non active spans will not be available
Public function TWeakPtr< IAnalyticsTracer > Access to the tracer for the system
Public function Static bool Check whether the module is available
Public function void

RecordEvent ( const FName CategoryName,
const FString& EventName,
const TArray< FAnalyticsEventAttribute >& Attributes
)

 Thread safe method to record an event to all registered analytics providers
Public function void

RecordEvent ( const FString& EventName,
const TArray< FAnalyticsEventAttribute >& Attributes
)

 Thread safe method to record an event to all registered analytics providers
Public function void

RecordEventToProvider ( const FString& ProviderName,
const FString& EventName,
const TArray< FAnalyticsEventAttribute >& Attributes
)

 Thread safe method to record an event to the specifically named analytics provider
Public function 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
Public function TSharedPtr< IAnalyticsSpan >

StartSpan ( const FName Name,
const TArray< FAnalyticsEventAttribute >& AdditionalAttributes
)

 Start a new span specifying the parent
Public function TSharedPtr< IAnalyticsSpan >

StartSpan ( const FName Name,
TSharedPtr< IAnalyticsSpan > ParentSpan,
const TArray< FAnalyticsEventAttribute >& AdditionalAttributes
)

 Start a new span specifying the parent

Classes

  Type Name Description
Public class ScopedSpan Scoped Span helper class  

Typedefs

Name Description
FOnEndSession  
FOnRecordEvent  
FOnStartSession Delegates for event callbacks
OnRecordEventCallback  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page