AnalyticsPerfTracker.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Misc/Build.h"
 
#define ANALYTICS_PERF_TRACKING_ENABLED !UE_BUILD_SHIPPING
#if ANALYTICS_PERF_TRACKING_ENABLED
 
#include "CoreMinimal.h"
#include "Containers/Ticker.h"
#include "Misc/OutputDeviceFile.h"
#include "Misc/Paths.h"
#include "Misc/LazySingleton.h"
#include "HAL/PlatformTime.h"
 
struct FAnalyticsPerfTracker : FTSTickerObjectBase
{
    FAnalyticsPerfTracker();
 
    void RecordFlush(uint64 Bytes, uint64 NumEvents, double TimeSec);
 
    bool IsEnabled() const;
 
    void SetRunID(const FString& InRunID);
 
private:
    virtual bool Tick(float DeltaTime) override;
 
    bool WindowExpired(double Now);
 
    void ResetWindow(double Now);
 
    FOutputDeviceFile LogFile{ *FPaths::Combine(*FPaths::ProjectSavedDir(), TEXT("AnalyticsTiming.csv")) };
    FString StartDate;
    FString CL;
    FString RunID = FGuid().ToString().ToLower();
    // Window tracking data
    double LastSubmitTime = 0.0;
    double TimeThisWindow = 0.0;
    uint64 BytesThisWindow = 0;
    uint64 NumEventsThisWindow = 0;
    int FlushesThisWindow = 0;
    int FramesThisWindow = 0;
    // time when the first measurement was made.
    double StartTime = FPlatformTime::Seconds();
    bool bEnabled = false;
};
 
ANALYTICSET_API void SetAnayticsETPerfTrackingRunID(const FString& RunID);
 
ANALYTICSET_API FAnalyticsPerfTracker& GetAnalyticsPerfTracker();
 
ANALYTICSET_API void TearDownAnalyticsPerfTracker();
 
#define ANALYTICS_FLUSH_TRACKING_BEGIN() double FlushStartTime = FPlatformTime::Seconds()
#define ANALYTICS_FLUSH_TRACKING_END(NumBytes, NumEvents) GetAnalyticsPerfTracker().RecordFlush(NumBytes, NumEvents, FPlatformTime::Seconds() - FlushStartTime)
 
#else
 
#define ANALYTICS_FLUSH_TRACKING_BEGIN(...)
#define ANALYTICS_FLUSH_TRACKING_END(...)
 
#endif