Open 3D Engine AWSMetrics Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AWSMetrics::MetricsEventBuilder Class Reference

MetricsEventBuilder builds a new metrics event and adds metrics attributes to it. More...

#include <MetricsEventBuilder.h>

Public Member Functions

virtual MetricsEventBuilder & AddDefaultMetricsAttributes (const AZStd::string &clientId, const AZStd::string &metricSourceOverride="")
 
virtual MetricsEventBuilder & AddMetricsAttributes (const AZStd::vector< MetricsAttribute > &attributes)
 
MetricsEventBuilder & SetMetricsPriority (int priority)
 
MetricsEvent Build ()
 

Detailed Description

MetricsEventBuilder builds a new metrics event and adds metrics attributes to it.

Member Function Documentation

◆ AddDefaultMetricsAttributes()

virtual MetricsEventBuilder& AWSMetrics::MetricsEventBuilder::AddDefaultMetricsAttributes ( const AZStd::string &  clientId,
const AZStd::string &  metricSourceOverride = "" 
)
virtual

Add default attributes to the metrics event including event_id, source and timestamp.

Parameters
clientIdUnique identifier for the client.
metricSourceOverrideEvent source used to override the default value.
Returns
The builder itself.

◆ AddMetricsAttributes()

virtual MetricsEventBuilder& AWSMetrics::MetricsEventBuilder::AddMetricsAttributes ( const AZStd::vector< MetricsAttribute > &  attributes)
virtual

Add attributes to the metrics event.

Parameters
attributesList of attributes to add to the metrics event.
Returns
The builder itself.

◆ Build()

MetricsEvent AWSMetrics::MetricsEventBuilder::Build ( )

Build a metrics event. Make sure that this function is only called once for each builder instance. Otherwise it will a new metrics event.

Returns
Metrics event constructed by the builder.

◆ SetMetricsPriority()

MetricsEventBuilder& AWSMetrics::MetricsEventBuilder::SetMetricsPriority ( int  priority)

Set the priority of the metrics event.

Parameters
priorityPriority of the metrics event.
Returns
The builder itself.
The documentation for this class was generated from the following file: