IAnalyticsTracer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"
#include "IAnalyticsProvider.h"
 
class IAnalyticsSpan : FNoncopyable
{
public:
 
    IAnalyticsSpan(const FName Name) {};
    virtual ~IAnalyticsSpan() {};
 
    virtual void SetProvider(TSharedPtr<IAnalyticsProvider> AnalyticsProvider) = 0;
    
    virtual void Start(const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {}) = 0;
 
    virtual void End(const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {}) = 0;
 
    virtual void AddAttributes(const TArray<FAnalyticsEventAttribute>& AdditionalAttributes) = 0;
    
    virtual void RecordEvent(const FString& EventName, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {}) = 0;
 
    virtual const FName& GetName() const = 0;
 
    virtual const TArray<FAnalyticsEventAttribute>& GetAttributes()const = 0;
 
    virtual void SetStackDepth(uint32 Depth)=0;
 
    virtual uint32 GetStackDepth() const = 0;
 
    virtual double GetDuration() const = 0;
 
    virtual double GetElapsedTime() = 0;
 
    // Is the span active?
    virtual bool GetIsActive() const = 0;
 
    // Get unique Id?
    virtual FGuid GetId()  const = 0;
};
 
class IAnalyticsTracer : FNoncopyable
{
public:
    IAnalyticsTracer() {};
    virtual ~IAnalyticsTracer() {};
 
    // Starts a new session, creates and Starts the SessionSpan object
    virtual void StartSession() =0;
 
    // Ends the running session and Ends the SessionSpan object
    virtual void EndSession() = 0;
 
    virtual void SetProvider(TSharedPtr<IAnalyticsProvider> AnalyticsProvider) =0;
 
    virtual TSharedPtr<IAnalyticsSpan> StartSpan(const FName Name, TSharedPtr<IAnalyticsSpan> ParentSpan=TSharedPtr<IAnalyticsSpan>(), const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {}) = 0;
 
    virtual bool EndSpan(TSharedPtr<IAnalyticsSpan>, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {}) = 0;
 
    virtual TSharedPtr<IAnalyticsSpan> GetCurrentSpan() const = 0;
 
    virtual TSharedPtr<IAnalyticsSpan> GetSessionSpan() const = 0;
 
    virtual TSharedPtr<IAnalyticsSpan> GetSpan(const FName Name) = 0;
 
    TSharedPtr<IAnalyticsSpan> StartSpan(const FName Name, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {})
    {
        return StartSpan(Name, GetCurrentSpan(), AdditionalAttributes);
    };
 
    bool EndSpan(const FName Name, const TArray<FAnalyticsEventAttribute>& AdditionalAttributes = {})
    {
        return EndSpan(GetSpan(Name), AdditionalAttributes);
    }
 
private:
};