1. Epic GamesDeveloper
  3. FAnalyticsSessionSummaryManager

FAnalyticsSessionSummaryManager

Manages the lifecycle of analytics summaries created by an application and its subsidiary processes.

API > API/Runtime > API/Runtime/AnalyticsET

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.

   
Name FAnalyticsSessionSummaryManager
Type class
Header File /Engine/Source/Runtime/Analytics/AnalyticsET/Public/AnalyticsSessionSummaryManager.h
Include Path #include "AnalyticsSessionSummaryManager.h"

Syntax

class FAnalyticsSessionSummaryManager

Constructors

Name Remarks Include Path Unreal Specifiers

FAnalyticsSessionSummaryManager ( const FString& ProcessName,
const FString& ProcessGroupId,
uint32 PrincipalProcessId,
const FString& SavedDir
)

 Constructs a manager for a subsidiary process, usually a companion process that collects extra information on the behalf of the principal process. AnalyticsSessionSummaryManager.h  

FAnalyticsSessionSummaryManager ( const FString& ProcessName,
const FString& ProcessGroupId,
const FString& UserId,
const FString& AppId,
const FString& AppVersion,
const FString& SessionId,
const FString& SavedDir
)

 Constructs a manager for the principal process, usually the main application. AnalyticsSessionSummaryManager.h  

FAnalyticsSessionSummaryManager ( const FString& ProcessName,
const FString& ProcessGroupId,
uint32 InCurrentProcessId,
uint32 PrincipalProcessId,
const FString& UserId,
const FString& AppId,
const FString& AppVersion,
const FString& SessionId,
const FString& SessionRootDir
)

 Delegate constructor. AnalyticsSessionSummaryManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAnalyticsSessionSummaryManager()

 Destructor. AnalyticsSessionSummaryManager.h  

Structs

Name Remarks
FProcessGroup Lists the files created by a process group.
FPropertyFileInfo Information about a property store used by a process.

Constants

Name Type Remarks Include Path
IsUserLoggingOutProperty const TAnalyticsProperty< bool > Special key handled in CRC to decide if an abnormal shutdown crash report should be generated. AnalyticsSessionSummaryManager.h
ShutdownTypeCodeProperty const TAnalyticsProperty< int32 > Special key handled by the manager for the analytics backend. AnalyticsSessionSummaryManager.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AppId FString   AnalyticsSessionSummaryManager.h  
AppVersion FString   AnalyticsSessionSummaryManager.h  
bIsPrincipal bool   AnalyticsSessionSummaryManager.h  
bOrphanGroupOwner bool   AnalyticsSessionSummaryManager.h  
CurrentProcessId uint32   AnalyticsSessionSummaryManager.h  
NextOrphanSessionCheckTimeSecs double   AnalyticsSessionSummaryManager.h  
PrincipalProcessId uint32   AnalyticsSessionSummaryManager.h  
ProcessGroupId FString   AnalyticsSessionSummaryManager.h  
ProcessName FString   AnalyticsSessionSummaryManager.h  
SessionId FString   AnalyticsSessionSummaryManager.h  
SessionRootPath FString   AnalyticsSessionSummaryManager.h  
StoreCounter uint32   AnalyticsSessionSummaryManager.h  
SummarySender TSharedPtr< IAnalyticsSessionSummarySender >   AnalyticsSessionSummaryManager.h  
UserId FString   AnalyticsSessionSummaryManager.h  
WeakPropertyStores TArray< TWeakPtr< IAnalyticsPropertyStore > >   AnalyticsSessionSummaryManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< IAnalyticsPropertyStore > MakeStore ( uint32 InitialCapacity
)

 Creates a new property store associated to this manager process group. AnalyticsSessionSummaryManager.h  
Sets a summary sender to enable the manager to send sessions. AnalyticsSessionSummaryManager.h  

void SetUserId ( const FString& UserId
)

 Sets a the user id used for reporting analytics. AnalyticsSessionSummaryManager.h  

void Shutdown ( bool bDiscard
)

 Shuts down and sends the session summaries that can be sent, if a sender is set. AnalyticsSessionSummaryManager.h  

void Tick ()

 Discovers and salvages/sends/cleans up left over from previous execution(s), if any. AnalyticsSessionSummaryManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CleanupExpiredFiles ( const FString& SavedDir
)

 Cleans up all expired files that match the analytics session filename pattern. AnalyticsSessionSummaryManager.h  

static FTimespan GetSessionExpirationAge()

 Returns the age at which a session is considered expired and shouldn't be sent anymore. AnalyticsSessionSummaryManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page