AWSMetrics::AWSMetricsRequests Class Reference

AWSMetrics request interface. More...

#include <AWSMetricsBus.h>

Inherits AZ::EBusTraits.

Public Types
using	MutexType = AZStd::recursive_mutex

Public Member Functions
virtual bool	SubmitMetrics (const AZStd::vector< MetricsAttribute > &metricsAttributes, int eventPriority=0, const AZStd::string &eventSourceOverride="", bool bufferMetrics=true)
virtual void	FlushMetrics ()
	Flush all metrics buffered in memory.

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single

Detailed Description

AWSMetrics request interface.

Member Function Documentation

SubmitMetrics()

virtual bool AWSMetrics::AWSMetricsRequests::SubmitMetrics ( const AZStd::vector< MetricsAttribute > &  metricsAttributes, int  eventPriority = 0, const AZStd::string &  eventSourceOverride = "", bool  bufferMetrics = true  )

inlinevirtual

Submit metrics to the backend or a local file.

Parameters

eventName	Name of the metrics event.
metricsAttributes	Attributes of the metrics.
eventPriority	Priority of the event. Default to 0 which is considered as the highest priority.
eventSourceOverride	Event source used to override the default value.
bufferMetrics	Whether to buffer metrics and send them in batch.

Returns

Whether the request is sent successfully.

---

The documentation for this class was generated from the following file:

• Gems/AWSMetrics/Code/Include/AWSMetricsBus.h