FEngineAnalyticsSessionSummary | Unreal Engine 5.7 Documentation

Collects engine events/stats and stores a summary on disk until reported by the analytics session summary manager.


Name	FEngineAnalyticsSessionSummary
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/Analytics/EngineAnalyticsSessionSummary.h
Include Path	#include "Analytics/EngineAnalyticsSessionSummary.h"

Syntax

class FEngineAnalyticsSessionSummary

Name	Remarks	Include Path	Unreal Specifiers
FEngineAnalyticsSessionSummary ( TSharedPtr< IAnalyticsPropertyStore > Storage, uint32 MonitorProcessId )	Constructs an analytics summary collector.	Analytics/EngineAnalyticsSessionSummary.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FEngineAnalyticsSessionSummary()	Destructor.	Analytics/EngineAnalyticsSessionSummary.h

Name	Type	Remarks	Include Path
bDebuggerIgnored	bool	Indicates whether the setting to ignore the debugger was set.	Analytics/EngineAnalyticsSessionSummary.h
bShutdown	bool	Indicates whether Shutdown() method was called.	Analytics/EngineAnalyticsSessionSummary.h
bWasEverDebugged	bool	Indicates whether the presence of the debugger was detected.	Analytics/EngineAnalyticsSessionSummary.h
CrcExitCode	TOptional< int32 >	Cache CRC exit code (if CRC was spawned in background and unexpectedly died before the engine).	Analytics/EngineAnalyticsSessionSummary.h
CrcProcessId	uint32	The monitor process id. CrashReportClient (CRC) acts as the monitoring/reporting process.	Analytics/EngineAnalyticsSessionSummary.h
CurrSessionTickCount	uint64	The number of time the summary was ticked.	Analytics/EngineAnalyticsSessionSummary.h
NextPersistTimeSeconds	double	The next time the session properties should be persisted to disk.	Analytics/EngineAnalyticsSessionSummary.h
PersistPeriod	FTimespan	The nominal period at which the session properties are persisted to disk.	Analytics/EngineAnalyticsSessionSummary.h
SessionStartTimeSecs	double	Session timestamp from FPlatformTime::Seconds().	Analytics/EngineAnalyticsSessionSummary.h
SessionStartTimeUtc	FDateTime	Session timestamp from FDateTime::UtcNow().	Analytics/EngineAnalyticsSessionSummary.h
Store	TSharedPtr< IAnalyticsPropertyStore >	The store used to persist the session properties until they are sent.	Analytics/EngineAnalyticsSessionSummary.h

Name	Remarks	Include Path
FTimespan GetPersistPeriod()	Get the period used to update and persist the properties to disk.	Analytics/EngineAnalyticsSessionSummary.h
void LowDriveSpaceDetected()	Invoked by the engine when the user is running low on disk space..	Analytics/EngineAnalyticsSessionSummary.h
void SetPersistPeriod ( const FTimespan& Period )	Set the period used to persist the properties to disk.	Analytics/EngineAnalyticsSessionSummary.h
void Shutdown()	Shuts down the session, unregistering the callbacks and closing the session.	Analytics/EngineAnalyticsSessionSummary.h
void Tick ( float DeltaTime )	Ticks the session.	Analytics/EngineAnalyticsSessionSummary.h

Name	Remarks	Include Path
IAnalyticsPropertyStore * GetStore()	Returns the property store used by the summary.	Analytics/EngineAnalyticsSessionSummary.h
virtual void ShutdownInternal ()	Invoked during Shutdown() to let derived classes hook in the shutdown.	Analytics/EngineAnalyticsSessionSummary.h
virtual bool UpdateSessionProgressInternal ( bool bCrashing )	Invoked during UpdateSessionProgress() to let derived classes hook in the update.	Analytics/EngineAnalyticsSessionSummary.h