Alexa Auto SDK  2.0.0
Classes | Public Types | Public Member Functions | List of all members
aace::metrics::MetricsUploader Class Referenceabstract

Classes

class  Datapoint
 

Public Types

enum  DatapointType {
  DatapointType::TIMER,
  DatapointType::STRING,
  DatapointType::COUNTER
}
 

Public Member Functions

virtual bool record (const std::vector< Datapoint > &datapoints, const std::unordered_map< std::string, std::string > &metadata)=0
 

Detailed Description

MetricsUploader interface for recording metrics

Member Enumeration Documentation

◆ DatapointType

Describes the different types a datapoint can be

Enumerator
TIMER 

Datapoint is a timer capturing time data.

STRING 

Datapoint is a string capturing key, value pair data.

COUNTER 

Datapoint is a counter capturing data on # of occurrences.

Member Function Documentation

◆ record()

virtual bool aace::metrics::MetricsUploader::record ( const std::vector< Datapoint > &  datapoints,
const std::unordered_map< std::string, std::string > &  metadata 
)
pure virtual

A method that can be overridden by the platform to upload the metric datapoints and metadata to the cloud

Parameters
[in]datapointsThe list of datapoints to be added to the metric and recorded
[in]metadataAdditional information in the form of key, value pairs to be added to the metric
Returns
Returns true if record was successful and false if not implemented or recording failed

Alexa Auto SDK 2.0.0 - Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0