AnalyticsFlowTracker.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"
#include "IAnalyticsProviderET.h"
 
using FThreadId = uint32;
 
class UE_DEPRECATED(5.4, "Use FAnalyticsTracer instead.") FAnalyticsFlowTracker : FNoncopyable
{
public:
    FAnalyticsFlowTracker() {};
    ~FAnalyticsFlowTracker() {};
 
    ANALYTICSET_API void SetProvider(TSharedPtr<IAnalyticsProvider> AnalyticsProvider);
 
    ANALYTICSET_API void StartSession();
 
    ANALYTICSET_API void EndSession();
    
    ANALYTICSET_API FGuid StartFlow(const FName& FlowName);
 
    ANALYTICSET_API bool EndFlow(bool bSuccess = true, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {});
 
    ANALYTICSET_API bool EndFlow(const FName& FlowName, bool bSuccess = true, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {});
 
    ANALYTICSET_API bool EndFlow(const FGuid& FlowGuid, bool bSuccess = true, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {});
 
    ANALYTICSET_API FGuid StartSubFlow(const FName& SubFlowName);
 
    ANALYTICSET_API FGuid StartSubFlow(const FName& SubFlowName, const FGuid& FlowGuid);
 
    ANALYTICSET_API bool EndSubFlow(const FName& SubFlowName, bool bSuccess = true, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {});
 
    ANALYTICSET_API bool EndSubFlow(const FGuid& SubFlowGuid, bool bSuccess = true, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {});
 
private:
 
    struct FSubFlowData
    {
        FName       FlowName;
        FGuid       FlowGuid = FGuid();
        FName       SubFlowName;
        FGuid       SubFlowGuid;
        FDateTime   StartTime = 0;
        FDateTime   EndTime = 0;
        FThreadId   ThreadId = 0;
        double      TimeInSeconds = 0;
        bool        bSuccess = false;
        int32       ScopeDepth;
        TArray<FAnalyticsEventAttribute> AdditionalEventAttributes;
    };
 
 
    struct FFlowData
    {
        FName                       FlowName = TEXT("None");
        FGuid                       FlowGuid = FGuid();
        FDateTime                   StartTime = 0;
        FDateTime                   EndTime = 0;
        FThreadId                   ThreadId = 0 ;
        double                      TimeInSeconds = 0;
        TArray<FGuid>               SubFlowDataArray;
        TArray<FGuid>               SubFlowDataStack;
    };
 
    bool EndFlowInternal(const FGuid& FlowGuid, bool bSuccess = true, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {});
 
    FGuid StartSubFlowInternal(const FName& NewSubFlowName, const FGuid& FlowGuid);
    bool EndSubFlowInternal(const FGuid& SubFlowGuid, bool bSuccess = true, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {});
 
    TMap<FName, FGuid>              FlowGuidRegistry;
    TMap<FGuid, FFlowData>          FlowDataRegistry;
    TMap<FName, FGuid>              SubFlowGuidRegistry;
    TMap<FGuid, FSubFlowData>       SubFlowDataRegistry;
    TArray<FGuid>                   FlowDataStack;
    FCriticalSection                CriticalSection;
    TSharedPtr<IAnalyticsProvider>  AnalyticsProvider;
 
    const uint32 FlowSchemaVersion = 4;
    const FString FlowEventName = TEXT("Iteration.Flow");
 
    const uint32 SubFlowSchemaVersion = 4;
    const FString SubFlowEventName = TEXT("Iteration.SubFlow");
};