aace::metrics::config::MetricsConfiguration Class Reference

Static Public Member Functions
static std::shared_ptr< aace::core::config::EngineConfiguration >	createMetricsTagConfig (const std::string &metricDeviceIdTag)
static std::shared_ptr< aace::core::config::EngineConfiguration >	createMetricsStorageConfig (const std::string &storagePath)

Detailed Description

MetricsConfiguration is a utility class to create metrics service aace::core::config::EngineConfiguration objects.

Member Function Documentation

createMetricsTagConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::metrics::config::MetricsConfiguration::createMetricsTagConfig ( const std::string &  metricDeviceIdTag )

static

Factory function used to programmatically generate device info configuration for the metrics Engine service. The data generated by this function is equivalent to providing the following JSON object in a configuration file:

{
     "aace.metrics" : {
         "metricDeviceIdTag": "<ALPHANUMERIC_TAG>"
     }
}

Parameters

[in]

metricDeviceIdTag

A tag that Auto SDK Engine will use in combination with DSN to generate a unique anonymous device identifier. Neither Alexa nor Auto SDK will store this tag and hence cannot reverse the hash to identify a single DSN from an individual metric. The metricDeviceIdTag may be any nonempty alphanumeric string that does not change across device reboots, factory resets, app data reset, or software updates. The recommended value is a 32 character string that is not the DSN or VIN. The value may be unique to an individual vehicle, provided it is stable, but it is not required to be unique.

createMetricsStorageConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::metrics::config::MetricsConfiguration::createMetricsStorageConfig ( const std::string &  storagePath )

static

Factory function used to programmatically generate storage configuration for the metrics Engine service. The data generated by this function is equivalent to providing the following JSON object in a configuration file:

{
     "aace.metrics" : {
         "metricStoragePath": "</some/path/to/metrics/directory/>"
     }
}

Parameters

[in]

storagePath

An absolute path to a directory where metrics may be stored prior to upload. The directory must exist and should not be used for any other purpose.