PerfCounters.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/CoreMisc.h"
#include "PerfCountersModule.h"
#include "Containers/Ticker.h"
#include "ProfilingDebugging/Histogram.h"
 
#include "HttpResultCallback.h"
#include "HttpPath.h"
#include "HttpRouteHandle.h"
 
class IHttpRouter;
struct FHttpServerRequest;
class FZeroLoad;
class FInternetAddr;
 
DECLARE_LOG_CATEGORY_EXTERN(LogPerfCounters, Log, All);
 
class FPerfCounters 
    : public FTSTickerObjectBase
    , public FSelfRegisteringExec
    , public IPerfCounters
    , public TSharedFromThis<FPerfCounters>
{
public:
 
    FPerfCounters(const FString& InUniqueInstanceId);
    virtual ~FPerfCounters();
 
    bool Initialize();
 
    virtual bool Tick(float DeltaTime) override;
 
    //~ Begin IPerfCounters Interface
    const FString& GetInstanceName() const override { return UniqueInstanceId; }
    virtual double GetNumber(const FString& Name, double DefaultValue = 0.0) override;
    virtual void SetNumber(const FString& Name, double Value, uint32 Flags) override;
    virtual void SetString(const FString& Name, const FString& Value, uint32 Flags) override;
    virtual void SetJson(const FString& Name, const FProduceJsonCounterValue& InCallback, uint32 Flags) override;
    virtual FPerfCounterExecCommandCallback& OnPerfCounterExecCommand() override { return ExecCmdCallback; }
    virtual const TMap<FString, FJsonVariant>& GetAllCounters() override { return PerfCounterMap; }
    virtual FString GetAllCountersAsJson() override;
    virtual void ResetStatsForNextPeriod() override;
    virtual TPerformanceHistogramMap& PerformanceHistograms() override { return PerformanceHistogramMap; }
    // Legacy load tracking, which is raw frame time, not overshoot.
    virtual bool StartMachineLoadTracking() override;
    // If OvershootBuckets is empty, will use legacy load tracking values, which is raw frame time, not overshoot.
    virtual bool StartMachineLoadTracking(double TickRate, const TArray<double>& FrameTimeHistogramBucketsMs) override;
    virtual bool StopMachineLoadTracking();
    virtual bool ReportUnplayableCondition(const FString& ConditionDescription);
    //~ Begin IPerfCounters Interface end
 
protected:
    //~ Begin Exec Interface
    virtual bool Exec_Runtime(UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar);
    //~ End Exec Interface
 
private:
    
    void TickZeroLoad(float DeltaTime);
    void TickSystemCounters(float DeltaTime);
 
    bool ProcessStatsRequest(const FHttpServerRequest& Request, const FHttpResultCallback& OnComplete);
 
    bool ProcessExecRequest(const FHttpServerRequest& Request, const FHttpResultCallback& OnComplete);
 
    FString UniqueInstanceId;
 
    float InternalCountersUpdateInterval;
 
    float LastTimeInternalCountersUpdated;
 
    TMap<FString, FJsonVariant>  PerfCounterMap;
 
    FPerfCounterExecCommandCallback ExecCmdCallback;
 
    TPerformanceHistogramMap PerformanceHistogramMap;
 
    FZeroLoad* ZeroLoadThread;
 
    FRunnableThread* ZeroLoadRunnable;
 
    TSharedPtr<IHttpRouter> HttpRouter = nullptr;
 
    FHttpRouteHandle StatsRouteHandle = nullptr;
 
    FHttpRouteHandle ExecRouteHandle = nullptr;
};