Aws::CloudWatchLogs::Utils Namespace Reference

Classes
class	CloudWatchLogsFacade
class	LogFileManager
class	LogNode

Functions
void	ReadCloudWatchOptions (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, Aws::CloudWatchLogs::CloudWatchOptions &cloudwatch_options)
void	ReadFileManagerStrategyOptions (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, Aws::FileManagement::FileManagerStrategyOptions &file_manager_strategy_options)
Aws::AwsError	ReadIgnoreNodesSet (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, std::unordered_set< std::string > &ignore_nodes)
Aws::AwsError	ReadLogGroup (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, std::string &log_group)
Aws::AwsError	ReadLogStream (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, std::string &log_stream)
Aws::AwsError	ReadMinLogVerbosity (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, int8_t &min_log_verbosity)
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	ReadOption (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, const std::string &option_key, const bool &default_value, bool &option_value)
Aws::AwsError	ReadPublishFrequency (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, double &publish_frequency)
Aws::AwsError	ReadPublishTopicNames (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, bool &publish_topic_names)
Aws::AwsError	ReadSubscriberList (bool subscribe_to_rosout, const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, const boost::function< void(const rosgraph_msgs::Log::ConstPtr &)> &callback, ros::NodeHandle &nh, std::vector< ros::Subscriber > &subscriptions)
Aws::AwsError	ReadSubscribeToRosout (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, bool &subscribe_to_rosout)
void	ReadUploaderOptions (const std::shared_ptr< Aws::Client::ParameterReaderInterface > &parameter_reader, Aws::DataFlow::UploaderOptions &uploader_options)

Variables
constexpr uint16_t	kMaxLogsPerRequest
const std::chrono::milliseconds	kMinPutLogsPeriod
constexpr char	kNodeLogGroupNameDefaultValue [] = "ros_log_group"
constexpr char	kNodeLogStreamNameDefaultValue [] = "ros_log_stream"
constexpr int8_t	kNodeMinLogVerbosityDefaultValue = rosgraph_msgs::Log::DEBUG
constexpr char	kNodeParamBatchMaxQueueSize [] = "batch_max_queue_size"
constexpr char	kNodeParamBatchTriggerPublishSize [] = "batch_trigger_publish_size"
constexpr char	kNodeParamDeleteStaleData [] = "delete_stale_data"
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	kNodeParamIgnoreNodesKey [] = "ignore_nodes"
constexpr char	kNodeParamLogGroupNameKey [] = "log_group_name"
constexpr char	kNodeParamLogStreamNameKey [] = "log_stream_name"
constexpr char	kNodeParamLogTopicsListKey [] = "topics"
constexpr char	kNodeParamMaximumFileSize [] = "maximum_file_size"
constexpr char	kNodeParamMinLogVerbosityKey [] = "min_log_verbosity"
constexpr char	kNodeParamPublishFrequencyKey [] = "publish_frequency"
constexpr char	kNodeParamPublishTopicNamesKey [] = "publish_topic_names"
constexpr char	kNodeParamStorageDirectory [] = "storage_directory"
constexpr char	kNodeParamStorageLimit [] = "storage_limit"
constexpr char	kNodeParamStreamMaxQueueSize [] = "stream_max_queue_size"
constexpr char	kNodeParamSubscribeToRosoutKey [] = "sub_to_rosout"
constexpr double	kNodePublishFrequencyDefaultValue = 5.0
constexpr bool	kNodePublishTopicNamesDefaultValue = true
constexpr char	kNodeRosoutAggregatedTopicName [] = "rosout_agg"
constexpr int	kNodeSubQueueSize = 100
constexpr bool	kNodeSubscribeToRosoutDefaultValue = true

Function Documentation

void Aws::CloudWatchLogs::Utils::ReadCloudWatchOptions	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		Aws::CloudWatchLogs::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 249 of file log_node_param_helper.cpp.

void Aws::CloudWatchLogs::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 305 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::Utils::ReadIgnoreNodesSet	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		std::unordered_set< std::string > &	ignore_nodes
	)

Fetch the set of node names to ignore incoming logs from.

Parameters

parameter_reader	to retrieve the parameters from.
ignore_nodes	all node names to ignore logs from are added here.

Returns

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

Definition at line 227 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::Utils::ReadLogGroup	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		std::string &	log_group
	)

Fetch the parameter for the AWS CloudWatch log group name.

Parameters

parameter_reader	to retrieve the parameters from.
log_group	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 53 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::Utils::ReadLogStream	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		std::string &	log_stream
	)

Fetch the parameter for the AWS CloudWatch log stream name.

Parameters

parameter_reader	to retrieve the parameters from.
log_stream	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 76 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::Utils::ReadMinLogVerbosity	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		int8_t &	min_log_verbosity
	)

Fetch the parameter for the minimum log severity for sending logs selectively to AWS CloudWatch Logs.

Parameters

parameter_reader	to retrieve the parameters from.
min_log_verbosity	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 128 of file log_node_param_helper.cpp.

void Aws::CloudWatchLogs::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 346 of file log_node_param_helper.cpp.

void Aws::CloudWatchLogs::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 368 of file log_node_param_helper.cpp.

void Aws::CloudWatchLogs::Utils::ReadOption	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		const std::string &	option_key,
		const bool &	default_value,
		bool &	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 392 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::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 27 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::Utils::ReadPublishTopicNames	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		bool &	publish_topic_names
	)

Fetch the parameter for whether or not to include topic name information in the log messsages that are uploaded to AWS CloudWatch Logs.

Parameters

parameter_reader	to retrieve the parameters from.
publish_topic_names	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 173 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::Utils::ReadSubscriberList	(	bool	subscribe_to_rosout,
		const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		const boost::function< void(const rosgraph_msgs::Log::ConstPtr &)> &	callback,
		ros::NodeHandle &	nh,
		std::vector< ros::Subscriber > &	subscriptions
	)

Fetch the parameter for the list of topics to get logs from, and subscribe nh to them. Also subscribe to rout if subscribe_to_rosout is true.

Parameters

parameter_reader	to retrieve the parameters from.
subscribe_to_rosout	whether or not to create an additional subscription to rosout.
callback	callback to use for all new subscriptions created by this method.
nh	node handler used to create the subscriptions.
subscriptions	all new subscriptions created by this method are pushed here.

Returns

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

Definition at line 204 of file log_node_param_helper.cpp.

Aws::AwsError Aws::CloudWatchLogs::Utils::ReadSubscribeToRosout	(	const std::shared_ptr< Aws::Client::ParameterReaderInterface > &	parameter_reader,
		bool &	subscribe_to_rosout
	)

Fetch the parameter for whether to subscribe to rosout_agg topic or not.

Parameters

parameter_reader	to retrieve the parameters from.
subscribe_to_rosout	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 99 of file log_node_param_helper.cpp.

void Aws::CloudWatchLogs::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 265 of file log_node_param_helper.cpp.

Variable Documentation

constexpr char Aws::CloudWatchLogs::Utils::kNodeLogGroupNameDefaultValue[] = "ros_log_group"

Default values for parameters

Definition at line 57 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeLogStreamNameDefaultValue[] = "ros_log_stream"

Definition at line 58 of file log_node_param_helper.h.

constexpr int8_t Aws::CloudWatchLogs::Utils::kNodeMinLogVerbosityDefaultValue = rosgraph_msgs::Log::DEBUG

Definition at line 59 of file log_node_param_helper.h.

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

Definition at line 44 of file log_node_param_helper.h.

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

Definition at line 45 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamDeleteStaleData[] = "delete_stale_data"

Definition at line 54 of file log_node_param_helper.h.

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

Definition at line 51 of file log_node_param_helper.h.

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

Definition at line 43 of file log_node_param_helper.h.

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

Configuration params for Aws::FileManagement::FileManagerStrategyOptions

Definition at line 49 of file log_node_param_helper.h.

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

Configuration params for Aws::DataFlow::UploaderOptions

Definition at line 42 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamIgnoreNodesKey[] = "ignore_nodes"

Definition at line 39 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamLogGroupNameKey[] = "log_group_name"

Definition at line 35 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamLogStreamNameKey[] = "log_stream_name"

Definition at line 32 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamLogTopicsListKey[] = "topics"

Definition at line 36 of file log_node_param_helper.h.

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

Definition at line 52 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamMinLogVerbosityKey[] = "min_log_verbosity"

Definition at line 37 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamPublishFrequencyKey[] = "publish_frequency"

Definition at line 33 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamPublishTopicNamesKey[] = "publish_topic_names"

Definition at line 38 of file log_node_param_helper.h.

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

Definition at line 50 of file log_node_param_helper.h.

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

Definition at line 53 of file log_node_param_helper.h.

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

Definition at line 46 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeParamSubscribeToRosoutKey[] = "sub_to_rosout"

Definition at line 34 of file log_node_param_helper.h.

constexpr double Aws::CloudWatchLogs::Utils::kNodePublishFrequencyDefaultValue = 5.0

Definition at line 60 of file log_node_param_helper.h.

constexpr bool Aws::CloudWatchLogs::Utils::kNodePublishTopicNamesDefaultValue = true

Definition at line 62 of file log_node_param_helper.h.

constexpr char Aws::CloudWatchLogs::Utils::kNodeRosoutAggregatedTopicName[] = "rosout_agg"

Definition at line 30 of file log_node_param_helper.h.

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

Definition at line 29 of file log_node_param_helper.h.

constexpr bool Aws::CloudWatchLogs::Utils::kNodeSubscribeToRosoutDefaultValue = true

Definition at line 61 of file log_node_param_helper.h.