EngineAnalytics.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Containers/ContainersFwd.h"
#include "Delegates/Delegate.h"
#include "IAnalyticsProviderET.h" // NOTE: Consider changing the code to replace IAnalyticProvider.h by IAnalyticProviderET.h
 
class FEngineSessionManager;
class FAnalyticsSessionSummaryManager;
class IAnalyticsProvider;
class IAnalyticsProviderET;
struct FAnalyticsEventAttribute;
 
class FEngineAnalytics : FNoncopyable
{
public:
    static ENGINE_API IAnalyticsProviderET& GetProvider();
 
#if WITH_EDITOR
    static ENGINE_API FAnalyticsSessionSummaryManager& GetSummaryManager();
#endif
 
    static bool IsAvailable() { return Analytics.IsValid(); }
 
    static ENGINE_API void Initialize();
#if WITH_EDITOR
    static ENGINE_API FSimpleMulticastDelegate OnInitializeEngineAnalytics;
#endif
 
    static ENGINE_API void Shutdown(bool bIsEngineShutdown = false);
#if WITH_EDITOR
    static ENGINE_API FSimpleMulticastDelegate OnShutdownEngineAnalytics;
#endif
 
    static ENGINE_API void Tick(float DeltaTime);
 
    static ENGINE_API void LowDriveSpaceDetected();
 
private:
    static void AppendMachineStats(TArray<FAnalyticsEventAttribute>& EventAttributes);
    static void SendMachineInfoForAccount(const FString& EpicAccountId);
    static void OnEpicAccountIdChanged(const FString& EpicAccountId);
 
    static bool bIsInitialized;
    static ENGINE_API TSharedPtr<IAnalyticsProviderET> Analytics;
    static ENGINE_API TSet<FString> SessionEpicAccountIds;
};
 
namespace UE::Analytics::Private {
 
DECLARE_DELEGATE_OneParam(FOnEpicAccountIdChanged, const FString&);
 
class IEngineAnalyticsConfigOverride
{
public:
    virtual ~IEngineAnalyticsConfigOverride() = default;
    virtual void ApplyConfiguration(FAnalyticsET::Config& Config) = 0;
    virtual void OnInitialized(IAnalyticsProviderET& provider, const FOnEpicAccountIdChanged& OnEpicAccountIdChanged) = 0;
};
 
extern ENGINE_API IEngineAnalyticsConfigOverride* EngineAnalyticsConfigOverride;
 
/* UE::Analytics::Private */ }