AnalyticsSessionSummaryManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AnalyticsEventAttribute.h"
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "HAL/PlatformCrt.h"
#include "Interfaces/IAnalyticsPropertyStore.h"
#include "Misc/Timespan.h"
#include "Templates/SharedPointer.h"
 
class IAnalyticsPropertyStore;
class IAnalyticsSessionSummarySender;
struct FAnalyticsEventAttribute;
template <typename T> class TAnalyticsProperty;
 
enum class EAnalyticsSessionShutdownType : int32
{
    Shutdown,
    Terminated,
    Debugged,
    Crashed,
    Abnormal,
    Unknown,
};
 
ANALYTICSET_API const TCHAR* LexToString(EAnalyticsSessionShutdownType ShutdownTypeCode);
 
class FAnalyticsSessionSummaryManager
{
public:
    static ANALYTICSET_API const TAnalyticsProperty<int32> ShutdownTypeCodeProperty;
 
    static ANALYTICSET_API const TAnalyticsProperty<bool> IsUserLoggingOutProperty;
 
public:
    ANALYTICSET_API FAnalyticsSessionSummaryManager(const FString& ProcessName, const FString& ProcessGroupId, const FString& UserId, const FString& AppId, const FString& AppVersion, const FString& SessionId, const FString& SavedDir = TEXT(""));
 
    ANALYTICSET_API FAnalyticsSessionSummaryManager(const FString& ProcessName, const FString& ProcessGroupId, uint32 PrincipalProcessId, const FString& SavedDir = TEXT(""));
 
    ANALYTICSET_API ~FAnalyticsSessionSummaryManager();
 
    ANALYTICSET_API void Tick();
 
    ANALYTICSET_API TSharedPtr<IAnalyticsPropertyStore> MakeStore(uint32 InitialCapacity);
 
    ANALYTICSET_API void SetSender(TSharedPtr<IAnalyticsSessionSummarySender> Sender);
 
    ANALYTICSET_API void SetUserId(const FString& UserId);
 
    ANALYTICSET_API void Shutdown(bool bDiscard = false);
 
    static ANALYTICSET_API void CleanupExpiredFiles(const FString& SavedDir = TEXT(""));
 
    static FTimespan GetSessionExpirationAge() { return FTimespan::FromDays(30); }
 
private:
    struct FPropertyFileInfo
    {
        uint32 ProcessId = 0;
 
        FString ProcessName;
 
        FString Pathname;
    };
 
    struct FProcessGroup
    {
        uint32 PrincipalProcessId = 0;
 
        FString PrincipalProcessName;
 
        TArray<FPropertyFileInfo> PropertyFiles;
    };
 
private:
    ANALYTICSET_API 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);
 
    ANALYTICSET_API TMap<FString, FProcessGroup> GetSessionFiles() const;
 
    ANALYTICSET_API void ProcessSummary(const FString& ProcessGroupId, const FProcessGroup& ProcessGroup);
 
    ANALYTICSET_API bool AggregateSummaries(const FString& ProcessGroupId, const FProcessGroup& ProcessGroup, TArray<FAnalyticsEventAttribute>& OutSummaryProperties, TArray<FAnalyticsEventAttribute>& OutInternalProperties);
 
    ANALYTICSET_API bool CleanupFiles(const TArray<FPropertyFileInfo>& PropertyFiles, bool bOnSuccess);
 
    bool IsOrphanGroupsOwner() const { return bOrphanGroupOwner; }
 
    ANALYTICSET_API bool IsPrincipalProcess() const;
 
    ANALYTICSET_API void PruneTrackedPropertyStores();
 
private:
    TArray<TWeakPtr<IAnalyticsPropertyStore>> WeakPropertyStores;
    TSharedPtr<IAnalyticsSessionSummarySender> SummarySender;
    FString ProcessName;
    FString ProcessGroupId;
    FString UserId;
    FString AppId;
    FString AppVersion;
    FString SessionId;
    FString SessionRootPath;
    uint32 CurrentProcessId;
    uint32 PrincipalProcessId;
    uint32 StoreCounter;
    double NextOrphanSessionCheckTimeSecs;
    bool bOrphanGroupOwner = false;
    bool bIsPrincipal = false;
};