Aws::CloudWatchMetrics::Utils Namespace Reference

Classes
class	CloudWatchMetricsFacade
class	MetricFileManager
struct	MetricObject
class	MetricsCollector

Typedefs
typedef Aws::Utils::Json::JsonValue	JsonValue

Enumerations
enum	CloudWatchMetricsStatus
enum	StatisticValuesType { StatisticValuesType::MINIMUM, StatisticValuesType::MAXIMUM, StatisticValuesType::SUM, StatisticValuesType::SAMPLE_COUNT }

Functions
MetricDatum	deserializeMetricDatum (const Aws::String &basic_string)
const std::string	kNodeParamMonitorTopicsListKey ("aws_monitored_metric_topics")
static MetricDatum	metricObjectToDatum (const MetricObject &metrics, const int64_t timestamp)
void	ReadCloudWatchOptions (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, Aws::CloudWatchMetrics::CloudWatchOptions &cloudwatch_options)
void	ReadFileManagerStrategyOptions (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, Aws::FileManagement::FileManagerStrategyOptions &file_manager_strategy_options)
void	ReadMetricDimensions (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, Aws::String &dimensions_param, std::map< std::string, std::string > &metric_dims)
void	ReadMetricNamespace (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, std::string &metric_namespace)
void	ReadOption (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, const std::string &option_key, const std::string &default_value, std::string &option_value)
void	ReadOption (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, const std::string &option_key, const size_t &default_value, size_t &option_value)
void	ReadPublishFrequency (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, double &publish_frequency)
void	ReadStorageResolution (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, int &storage_resolution)
void	ReadTopics (std::vector< std::string > &topics)
void	ReadUploaderOptions (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, Aws::DataFlow::UploaderOptions &uploader_options)
Aws::String	serializeMetricDatum (const MetricDatum &datum)

Variables
	FAILURE
	INVALID_DATA
static constexpr const char *	kDimensionsKey
static constexpr const char *	kDimensionsNameKey
static constexpr const char *	kDimensionsValueKey
static constexpr const char *	kMetricNameKey
const std::string	kNodeDefaulMetricsTopic = "metrics"
constexpr int	kNodeDefaultMetricDatumStorageResolution = 60
const std::string	kNodeDefaultMetricNamespace = "ROS"
const int	kNodeMetricServiceTimeSec = 1
const std::string	kNodeName = "cloudwatch_metrics_collector"
constexpr char	kNodeParamBatchMaxQueueSize [] = "batch_max_queue_size"
constexpr char	kNodeParamBatchTriggerPublishSize [] = "batch_trigger_publish_size"
const std::string	kNodeParamDefaultMetricDimensionsKey = "aws_default_metric_dimensions"
constexpr char	kNodeParamFileExtension [] = "file_extension"
constexpr char	kNodeParamFileMaxQueueSize [] = "file_max_queue_size"
constexpr char	kNodeParamFilePrefix [] = "file_prefix"
constexpr char	kNodeParamFileUploadBatchSize [] = "file_upload_batch_size"
constexpr char	kNodeParamMaximumFileSize [] = "maximum_file_size"
const std::string	kNodeParamMetricDatumStorageResolutionKey = "storage_resolution"
const std::set< int >	kNodeParamMetricDatumStorageResolutionValidValues = {1, 60}
const std::string	kNodeParamMetricNamespaceKey = "aws_metrics_namespace"
const char	kNodeParamPublishFrequencyKey [] = "publish_frequency"
constexpr char	kNodeParamStorageDirectory [] = "storage_directory"
constexpr char	kNodeParamStorageLimit [] = "storage_limit"
constexpr char	kNodeParamStreamMaxQueueSize [] = "stream_max_queue_size"
constexpr int	kNodePublishFrequencyDefaultValue = 10
constexpr int	kNodeSubQueueSize = 100
static constexpr const char *	kStorageResolutionKey
static constexpr const char *	kTimestampKey
static constexpr const char *	kUnitKey
static constexpr const char *	kValueKey
	NETWORK_FAILURE
static const std::vector< Aws::String >	required_properties
	SUCCESS
static std::unordered_map< std::string, Aws::CloudWatch::Model::StandardUnit >	units_mapper

Function Documentation

const std::string Aws::CloudWatchMetrics::Utils::kNodeParamMonitorTopicsListKey

(

"aws_monitored_metric_topics"

)

void Aws::CloudWatchMetrics::Utils::ReadCloudWatchOptions	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		Aws::CloudWatchMetrics::CloudWatchOptions &	cloudwatch_options
	)

Fetch the options related to cloudwatch uploading and offline file mangement

Parameters

parameter_reader	to retrieve the parameters from
cloudwatch_options	a struct of uploader and file_manager options

Returns

an error code that indicates whether the parameter was read successfully or not, as returned by parameter_reader

Definition at line 176 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadFileManagerStrategyOptions	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		Aws::FileManagement::FileManagerStrategyOptions &	file_manager_strategy_options
	)

Fetch the options related to cloudwatch offline file management

Parameters

parameter_reader	to retrieve the parameters from
file_manager_strategy_options	a struct of file management options

Returns

an error code that indicates whether the parameter was read successfully or not, as returned by parameter_reader

Definition at line 232 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadMetricDimensions	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		Aws::String &	dimensions_param,
		std::map< std::string, std::string > &	metric_dims
	)

Parameters

parameter_reader
dimensions_param
metric_dims

Returns

Definition at line 96 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadMetricNamespace	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		std::string &	metric_namespace
	)

Parameters

parameter_reader
metric_namespace

Returns

Definition at line 72 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadOption	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		const std::string &	option_key,
		const std::string &	default_value,
		std::string &	option_value
	)

Fetch a single string option

Parameters

parameter_reader	to retrieve the parameters from
option_key	the parameter key to read
default_value	a default value if the parameter doesn't exist or is unreadble
option_value	the string value for this option

Returns

an error code that indicates whether the parameter was read successfully or not, as returned by parameter_reader

Definition at line 267 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadOption	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		const std::string &	option_key,
		const size_t &	default_value,
		size_t &	option_value
	)

Fetch a single size_t option

Parameters

parameter_reader	to retrieve the parameters from
option_key	the parameter key to read
default_value	a default value if the parameter doesn't exist or is unreadble
option_value	the size_t value for this option

Returns

an error code that indicates whether the parameter was read successfully or not, as returned by parameter_reader

Definition at line 289 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadPublishFrequency	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		double &	publish_frequency
	)

Fetch the parameter for the log publishing frequency.

Parameters

parameter_reader	to retrieve the parameters from.
publish_frequency	the parameter is stored here when it is read successfully.

Returns

an error code that indicates whether the parameter was read successfully or not, as returned by parameter_reader

Definition at line 40 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadStorageResolution	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		int &	storage_resolution
	)

Parameters

parameter_reader
storage_resolution

Returns

Definition at line 133 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadTopics

(

std::vector< std::string > &

topics

)

Definition at line 163 of file metrics_collector_parameter_helper.cpp.

void Aws::CloudWatchMetrics::Utils::ReadUploaderOptions	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		Aws::DataFlow::UploaderOptions &	uploader_options
	)

Fetch the options related to cloudwatch log uploading

Parameters

parameter_reader	to retrieve the parameters from
uploader_options	a struct of uploader options

Returns

an error code that indicates whether the parameter was read successfully or not, as returned by parameter_reader

Definition at line 192 of file metrics_collector_parameter_helper.cpp.

Variable Documentation

const std::string Aws::CloudWatchMetrics::Utils::kNodeDefaulMetricsTopic = "metrics"

Definition at line 54 of file metrics_collector_parameter_helper.hpp.

constexpr int Aws::CloudWatchMetrics::Utils::kNodeDefaultMetricDatumStorageResolution = 60

Definition at line 55 of file metrics_collector_parameter_helper.hpp.

const std::string Aws::CloudWatchMetrics::Utils::kNodeDefaultMetricNamespace = "ROS"

Definition at line 53 of file metrics_collector_parameter_helper.hpp.

const int Aws::CloudWatchMetrics::Utils::kNodeMetricServiceTimeSec = 1

Definition at line 52 of file metrics_collector_parameter_helper.hpp.

const std::string Aws::CloudWatchMetrics::Utils::kNodeName = "cloudwatch_metrics_collector"

Definition at line 33 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamBatchMaxQueueSize[] = "batch_max_queue_size"

Configuration params for Aws::DataFlow::UploaderOptions

Definition at line 37 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamBatchTriggerPublishSize[] = "batch_trigger_publish_size"

Definition at line 38 of file metrics_collector_parameter_helper.hpp.

const std::string Aws::CloudWatchMetrics::Utils::kNodeParamDefaultMetricDimensionsKey = "aws_default_metric_dimensions"

Definition at line 32 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamFileExtension[] = "file_extension"

Configuration params for Aws::FileManagement::FileManagerStrategyOptions

Definition at line 44 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamFileMaxQueueSize[] = "file_max_queue_size"

Definition at line 39 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamFilePrefix[] = "file_prefix"

Definition at line 45 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamFileUploadBatchSize[] = "file_upload_batch_size"

Definition at line 40 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamMaximumFileSize[] = "maximum_file_size"

Definition at line 46 of file metrics_collector_parameter_helper.hpp.

const std::string Aws::CloudWatchMetrics::Utils::kNodeParamMetricDatumStorageResolutionKey = "storage_resolution"

Definition at line 56 of file metrics_collector_parameter_helper.hpp.

const std::set<int> Aws::CloudWatchMetrics::Utils::kNodeParamMetricDatumStorageResolutionValidValues = {1, 60}

Definition at line 57 of file metrics_collector_parameter_helper.hpp.

const std::string Aws::CloudWatchMetrics::Utils::kNodeParamMetricNamespaceKey = "aws_metrics_namespace"

Definition at line 31 of file metrics_collector_parameter_helper.hpp.

const char Aws::CloudWatchMetrics::Utils::kNodeParamPublishFrequencyKey[] = "publish_frequency"

Definition at line 34 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamStorageDirectory[] = "storage_directory"

Definition at line 47 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamStorageLimit[] = "storage_limit"

Definition at line 48 of file metrics_collector_parameter_helper.hpp.

constexpr char Aws::CloudWatchMetrics::Utils::kNodeParamStreamMaxQueueSize[] = "stream_max_queue_size"

Definition at line 41 of file metrics_collector_parameter_helper.hpp.

constexpr int Aws::CloudWatchMetrics::Utils::kNodePublishFrequencyDefaultValue = 10

Definition at line 51 of file metrics_collector_parameter_helper.hpp.

constexpr int Aws::CloudWatchMetrics::Utils::kNodeSubQueueSize = 100

Definition at line 50 of file metrics_collector_parameter_helper.hpp.