PerfCountersModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "Templates/SharedPointer.h"
 
class FName;
class FOutputDevice;
struct FHistogram;
template <class CharType, class PrintPolicy>
class TJsonWriter;
template <class CharType>
struct TPrettyJsonPrintPolicy;
template <class CharType> struct TPrettyJsonPrintPolicy;
 
typedef TSharedRef< TJsonWriter<TCHAR,TPrettyJsonPrintPolicy<TCHAR> > > FPrettyJsonWriter;
struct FHistogram;
 
DECLARE_DELEGATE_OneParam(FProduceJsonCounterValue, const FPrettyJsonWriter& /* JsonWriter */);
 
DECLARE_DELEGATE_RetVal_TwoParams(bool, FPerfCounterExecCommandCallback, const FString& /*ExecCmd*/, FOutputDevice& /*Output*/);
 
class IPerfCounters
{
public:
 
    enum Flags : uint32
    {
        Transient = (1 << 0)
    };
 
    struct FJsonVariant
    {
        enum { Null, String, Number, Callback } Format;
        FString     StringValue;
        double      NumberValue;
        FProduceJsonCounterValue CallbackValue;
        uint32      Flags;
 
        FJsonVariant() : Format(Null), NumberValue(0) {}
    };
 
    struct Histograms
    {
        static PERFCOUNTERS_API const FName FrameTime;
        static PERFCOUNTERS_API const FName FrameTimePeriodic;
        static PERFCOUNTERS_API const FName FrameTimeWithoutSleep;
        static PERFCOUNTERS_API const FName ServerReplicateActorsTime;
        static PERFCOUNTERS_API const FName SleepTime;
 
        static PERFCOUNTERS_API const FName ZeroLoadFrameTime;
    };
 
    typedef TMap<FName, FHistogram>     TPerformanceHistogramMap;
 
 
    virtual ~IPerfCounters() {};
 
    virtual const FString& GetInstanceName() const = 0;
 
    virtual double GetNumber(const FString& Name, double DefaultValue = 0.0) = 0;
 
    virtual void SetNumber(const FString& Name, double Value, uint32 Flags = 0) = 0;
 
    virtual void SetString(const FString& Name, const FString& Value, uint32 Flags = 0) = 0;
 
    virtual void SetJson(const FString& Name, const FProduceJsonCounterValue& Callback, uint32 Flags = 0) = 0;
 
    virtual FPerfCounterExecCommandCallback& OnPerfCounterExecCommand() = 0;
 
    virtual const TMap<FString, FJsonVariant>& GetAllCounters() = 0;
 
    virtual FString GetAllCountersAsJson() = 0;
 
    virtual void ResetStatsForNextPeriod() = 0;
 
    virtual TPerformanceHistogramMap& PerformanceHistograms() = 0;
 
    virtual bool StartMachineLoadTracking() = 0;
 
    virtual bool StartMachineLoadTracking(double TickRate, const TArray<double>& FrameTimeHistogramBucketsMs) = 0;
 
    virtual bool StopMachineLoadTracking() = 0;
 
    virtual bool ReportUnplayableCondition(const FString& ConditionDescription) = 0;
 
public:
 
    int32 Get(const FString& Name, int32 Val = 0)
    {
        return static_cast<int32>(GetNumber(Name, static_cast<double>(Val)));
    }
 
    uint32 Get(const FString& Name, uint32 Val = 0)
    {
        return static_cast<uint32>(GetNumber(Name, static_cast<double>(Val)));
    }
 
    float Get(const FString& Name, float Val = 0.0f)
    {
        return static_cast<float>(GetNumber(Name, static_cast<double>(Val)));
    }
 
    double Get(const FString& Name, double Val = 0.0)
    {
        return GetNumber(Name, Val);
    }
 
    int32 Increment(const FString & Name, int32 Add = 1, int32 DefaultValue = 0, uint32 Flags = IPerfCounters::Flags::Transient)
    {
        int32 CurrentValue = Get(Name, DefaultValue) + Add;
        Set(Name, CurrentValue, Flags);
        return CurrentValue;
    }
 
    void Set(const FString& Name, int32 Val, uint32 Flags = 0)
    {
        SetNumber(Name, (double)Val, Flags);
    }
 
    void Set(const FString& Name, uint32 Val, uint32 Flags = 0)
    {
        SetNumber(Name, (double)Val, Flags);
    }
 
    void Set(const FString& Name, float Val, uint32 Flags = 0)
    {
        SetNumber(Name, (double)Val, Flags);
    }
 
    void Set(const FString& Name, double Val, uint32 Flags = 0)
    {
        SetNumber(Name, Val, Flags);
    }
 
    void Set(const FString& Name, int64 Val, uint32 Flags = 0)
    {
        SetString(Name, FString::Printf(TEXT("%lld"), Val), Flags);
    }
 
    void Set(const FString& Name, uint64 Val, uint32 Flags = 0)
    {
        SetString(Name, FString::Printf(TEXT("%llu"), Val), Flags);
    }
 
    void Set(const FString& Name, const FString& Val, uint32 Flags = 0)
    {
        SetString(Name, Val, Flags);
    }
 
    void Set(const FString& Name, const FProduceJsonCounterValue& Callback, uint32 Flags = 0)
    {
        SetJson(Name, Callback, Flags);
    }
};
 
 
class IPerfCountersModule : public IModuleInterface
{
public:
 
    static inline IPerfCountersModule& Get()
    {
        return FModuleManager::LoadModuleChecked< IPerfCountersModule >("PerfCounters");
    }
 
    static inline bool IsAvailable()
    {
        return FModuleManager::Get().IsModuleLoaded("PerfCounters");
    }
 
    static PERFCOUNTERS_API int32 GetHTTPStatsPort();
 
    virtual IPerfCounters* GetPerformanceCounters() const = 0;
 
    virtual IPerfCounters* CreatePerformanceCounters(const FString& UniqueInstanceId = TEXT("")) = 0;
};