Navigation
Unreal Engine C++ API Reference > Runtime > AnalyticsET
References
| Module | AnalyticsET |
| Header | /Engine/Source/Runtime/Analytics/AnalyticsET/Public/AnalyticsSessionSummaryManager.h |
| Include | #include "AnalyticsSessionSummaryManager.h" |
Syntax
class FAnalyticsSessionSummaryManager
Remarks
Manages the lifecycle of analytics summaries created by an application and its subsidiary processes. It manages the summary files created by the processes, tracks which processes are working together, aggregates the summaries from collaborating processes, discards outdated sessions and sends the final summary reports.
Several processes can collaborate to collect analytics for one principal process. The common case being the Editor acting as the principal process and CrashReportClient (CRC) acting as a subsidiary process. The principal process and its subsidiaries form a group of processes tied together. The last process of the group to exit is responsible to aggregates and sends the final report for the principal process. For any reasons, if the final report cannot be sent by a group, the responsibility to deal with the left over is put on the principal process. The principal process is responsible to clean up the left over from its previous execution(s) and possibly salvage and send reports delayed.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FAnalyticsSessionSummaryManager
(
const FString& ProcessName, |
Constructs a manager for a subsidiary process, usually a companion process that collects extra information on the behalf of the principal process. | |
 |
Constructs a manager for the principal process, usually the main application. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | CleanupExpiredFiles
(
const FString& SavedDir |
Cleans up all expired files that match the analytics session filename pattern. |
  |
FTimespan | Returns the age at which a session is considered expired and shouldn't be sent anymore. | |
 |
TSharedPtr< IAnalyticsPropertyStore > | MakeStore
(
uint32 InitialCapacity |
Creates a new property store associated to this manager process group. |
 |
void | SetSender
(
TSharedPtr< IAnalyticsSessionSummarySender > Sender |
Sets a summary sender to enable the manager to send sessions. |
 |
void | Sets a the user id used for reporting analytics. | |
 |
void | Shutdown
(
bool bDiscard |
Shuts down and sends the session summaries that can be sent, if a sender is set. |
 |
void | Tick () |
Discovers and salvages/sends/cleans up left over from previous execution(s), if any. |
Constants
| Name | Description |
|---|---|
| IsUserLoggingOutProperty | Special key handled in CRC to decide if an abnormal shutdown crash report should be generated. |
| ShutdownTypeCodeProperty | Special key handled by the manager for the analytics backend. |