AnalyticsPerfTracker.h File Reference

#include "Misc/Build.h"
#include "CoreMinimal.h"
#include "Containers/Ticker.h"
#include "Misc/OutputDeviceFile.h"
#include "Misc/Paths.h"
#include "Misc/LazySingleton.h"
#include "HAL/PlatformTime.h"

Go to the source code of this file.

Classes
struct	FAnalyticsPerfTracker

Macros
#define	ANALYTICS_PERF_TRACKING_ENABLED   !UE_BUILD_SHIPPING
#define	ANALYTICS_FLUSH_TRACKING_BEGIN()   double FlushStartTime = FPlatformTime::Seconds()
#define	ANALYTICS_FLUSH_TRACKING_END(NumBytes, NumEvents)   GetAnalyticsPerfTracker().RecordFlush(NumBytes, NumEvents, FPlatformTime::Seconds() - FlushStartTime)

Functions
ANALYTICSET_API void	SetAnayticsETPerfTrackingRunID (const FString &RunID)
ANALYTICSET_API FAnalyticsPerfTracker &	GetAnalyticsPerfTracker ()
ANALYTICSET_API void	TearDownAnalyticsPerfTracker ()

Macro Definition Documentation

ANALYTICS_FLUSH_TRACKING_BEGIN

#define ANALYTICS_FLUSH_TRACKING_BEGIN

(

)

double FlushStartTime = FPlatformTime::Seconds()

ANALYTICS_FLUSH_TRACKING_END

#define ANALYTICS_FLUSH_TRACKING_END	(		NumBytes,
			NumEvents
	)		GetAnalyticsPerfTracker().RecordFlush(NumBytes, NumEvents, FPlatformTime::Seconds() - FlushStartTime)

ANALYTICS_PERF_TRACKING_ENABLED

#define ANALYTICS_PERF_TRACKING_ENABLED   !UE_BUILD_SHIPPING

When enabled (and -AnalyticsTrackPerf is specified on the command line, will log out analytics flush timings on a regular basis to Saved/AnalyticsTiming.csv.

Function Documentation

GetAnalyticsPerfTracker()

ANALYTICSET_API FAnalyticsPerfTracker & GetAnalyticsPerfTracker

(

)

Used to get the analytics perf tracker singleton

SetAnayticsETPerfTrackingRunID()

ANALYTICSET_API void SetAnayticsETPerfTrackingRunID

(

const FString &

RunID

)

Used to set the RunID between matches in game code. Must be carefully called only in situations where ANALYTICS_PERF_TRACKING_ENABLED = 1

TearDownAnalyticsPerfTracker()

ANALYTICSET_API void TearDownAnalyticsPerfTracker

(

)

Used to tear down the analytics perf tracker singleton