Namespaces | Classes | Typedefs | Enumerations | Variables
Aws::CloudWatchLogs Namespace Reference

Namespaces

 Utils
 

Classes

struct  CloudWatchOptions
 
class  LogBatcher
 
class  LogPublisher
 
class  LogService
 
class  LogServiceFactory
 

Typedefs

using LogCollection = std::list< LogType >
 
using LogType = Aws::CloudWatchLogs::Model::InputLogEvent
 

Enumerations

enum  LogPublisherRunState { LOG_PUBLISHER_RUN_CREATE_GROUP, LOG_PUBLISHER_RUN_CREATE_STREAM, LOG_PUBLISHER_RUN_INIT_TOKEN, LOG_PUBLISHER_ATTEMPT_SEND_LOGS }
 Defines the different runtime states for the Publisher This enum is used by the LogPublisher to track the current runtime state of the Run function. More...
 
enum  ROSCloudWatchLogsErrors {
  CW_LOGS_SUCCEEDED = 0, CW_LOGS_FAILED, CW_LOGS_NULL_PARAMETER, CW_LOGS_DATA_LOCKED,
  CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED, CW_LOGS_THREAD_BUSY, CW_LOGS_EMPTY_PARAMETER, CW_LOGS_LOG_STREAM_LIST_EMPTY,
  CW_LOGS_CREATE_LOG_GROUP_FAILED, CW_LOGS_CREATE_LOG_STREAM_FAILED, CW_LOGS_LOG_GROUP_ALREADY_EXISTS, CW_LOGS_LOG_STREAM_ALREADY_EXISTS,
  CW_LOGS_LOG_GROUP_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_CONFIGURED, CW_LOGS_NOT_CONNECTED,
  CW_LOGS_INVALID_PARAMETER, CW_LOGS_SUCCEEDED = 0, CW_LOGS_FAILED, CW_LOGS_NULL_PARAMETER,
  CW_LOGS_DATA_LOCKED, CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED, CW_LOGS_THREAD_BUSY, CW_LOGS_EMPTY_PARAMETER,
  CW_LOGS_LOG_STREAM_LIST_EMPTY, CW_LOGS_CREATE_LOG_GROUP_FAILED, CW_LOGS_CREATE_LOG_STREAM_FAILED, CW_LOGS_LOG_GROUP_ALREADY_EXISTS,
  CW_LOGS_LOG_STREAM_ALREADY_EXISTS, CW_LOGS_LOG_GROUP_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_CONFIGURED,
  CW_LOGS_NOT_CONNECTED
}
 
enum  ROSCloudWatchLogsErrors {
  CW_LOGS_SUCCEEDED = 0, CW_LOGS_FAILED, CW_LOGS_NULL_PARAMETER, CW_LOGS_DATA_LOCKED,
  CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED, CW_LOGS_THREAD_BUSY, CW_LOGS_EMPTY_PARAMETER, CW_LOGS_LOG_STREAM_LIST_EMPTY,
  CW_LOGS_CREATE_LOG_GROUP_FAILED, CW_LOGS_CREATE_LOG_STREAM_FAILED, CW_LOGS_LOG_GROUP_ALREADY_EXISTS, CW_LOGS_LOG_STREAM_ALREADY_EXISTS,
  CW_LOGS_LOG_GROUP_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_CONFIGURED, CW_LOGS_NOT_CONNECTED,
  CW_LOGS_INVALID_PARAMETER, CW_LOGS_SUCCEEDED = 0, CW_LOGS_FAILED, CW_LOGS_NULL_PARAMETER,
  CW_LOGS_DATA_LOCKED, CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED, CW_LOGS_THREAD_BUSY, CW_LOGS_EMPTY_PARAMETER,
  CW_LOGS_LOG_STREAM_LIST_EMPTY, CW_LOGS_CREATE_LOG_GROUP_FAILED, CW_LOGS_CREATE_LOG_STREAM_FAILED, CW_LOGS_LOG_GROUP_ALREADY_EXISTS,
  CW_LOGS_LOG_STREAM_ALREADY_EXISTS, CW_LOGS_LOG_GROUP_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_FOUND, CW_LOGS_LOG_STREAM_NOT_CONFIGURED,
  CW_LOGS_NOT_CONNECTED
}
 Defines error return codes for functions This enum defines standard error codes that will be returned by AWS CloudWatch Logs libraries. More...
 

Variables

static const CloudWatchOptions kDefaultCloudWatchOptions
 
constexpr int kMaxRetries = 1
 
const long ONE_DAY_IN_MILLISEC = 24*60*60*1000
 
const long TWO_WEEK_IN_MILLISEC = 14*ONE_DAY_IN_MILLISEC
 
static const Aws::String UNINITIALIZED_TOKEN = "_NOT_SET_"
 

Typedef Documentation

◆ LogCollection

using Aws::CloudWatchLogs::LogCollection = typedef std::list<LogType>

Definition at line 29 of file definitions.h.

◆ LogType

using Aws::CloudWatchLogs::LogType = typedef Aws::CloudWatchLogs::Model::InputLogEvent

Definition at line 28 of file definitions.h.

Enumeration Type Documentation

◆ LogPublisherRunState

Defines the different runtime states for the Publisher This enum is used by the LogPublisher to track the current runtime state of the Run function.

Enumerator
LOG_PUBLISHER_RUN_CREATE_GROUP 
LOG_PUBLISHER_RUN_CREATE_STREAM 
LOG_PUBLISHER_RUN_INIT_TOKEN 
LOG_PUBLISHER_ATTEMPT_SEND_LOGS 

Definition at line 42 of file log_publisher.h.

◆ ROSCloudWatchLogsErrors [1/2]

Enumerator
CW_LOGS_SUCCEEDED 

Indicates that there is no error.

CW_LOGS_FAILED 

A generic error occured

CW_LOGS_NULL_PARAMETER 

An error when a NULL value is supplied as a parameter when a non-NULL value is required

CW_LOGS_DATA_LOCKED 

An error indicating that data cannot be used for other operations because it's locked.

CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED 

An error indicating that a thread is not initialized.

CW_LOGS_THREAD_BUSY 

An error indicating that a thread is not available.

CW_LOGS_EMPTY_PARAMETER 

An error indicating that a data structure is empty.

CW_LOGS_LOG_STREAM_LIST_EMPTY 

An error indicating that a log stream list is empty.

CW_LOGS_CREATE_LOG_GROUP_FAILED 

An error indicating that the attempt to create a log group failed.

CW_LOGS_CREATE_LOG_STREAM_FAILED 

An error indicating that the attempt to create a log stream failed.

CW_LOGS_LOG_GROUP_ALREADY_EXISTS 

An error indicating that a log group already exists.

CW_LOGS_LOG_STREAM_ALREADY_EXISTS 

An error indicating that a log stream already exists.

CW_LOGS_LOG_GROUP_NOT_FOUND 

An error indicating that a log group cannot be found.

CW_LOGS_LOG_STREAM_NOT_FOUND 

An error indicating that a log stream cannot be found in a log group.

CW_LOGS_LOG_STREAM_NOT_CONFIGURED 

Log stream was not configured properly.

CW_LOGS_NOT_CONNECTED 

No network connection available.

CW_LOGS_INVALID_PARAMETER 

Invalid data was sent and will never be accepted.

CW_LOGS_SUCCEEDED 

Indicates that there is no error.

CW_LOGS_FAILED 

A generic error occured

CW_LOGS_NULL_PARAMETER 

An error when a NULL value is supplied as a parameter when a non-NULL value is required

CW_LOGS_DATA_LOCKED 

An error indicating that data cannot be used for other operations because it's locked.

CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED 

An error indicating that a thread is not initialized.

CW_LOGS_THREAD_BUSY 

An error indicating that a thread is not available.

CW_LOGS_EMPTY_PARAMETER 

An error indicating that a data structure is empty.

CW_LOGS_LOG_STREAM_LIST_EMPTY 

An error indicating that a log stream list is empty.

CW_LOGS_CREATE_LOG_GROUP_FAILED 

An error indicating that the attempt to create a log group failed.

CW_LOGS_CREATE_LOG_STREAM_FAILED 

An error indicating that the attempt to create a log stream failed.

CW_LOGS_LOG_GROUP_ALREADY_EXISTS 

An error indicating that a log group already exists.

CW_LOGS_LOG_STREAM_ALREADY_EXISTS 

An error indicating that a log stream already exists.

CW_LOGS_LOG_GROUP_NOT_FOUND 

An error indicating that a log group cannot be found.

CW_LOGS_LOG_STREAM_NOT_FOUND 

An error indicating that a log stream cannot be found in a log group.

CW_LOGS_LOG_STREAM_NOT_CONFIGURED 

Log stream was not configured properly.

CW_LOGS_NOT_CONNECTED 

No network connection available.

Definition at line 29 of file ros_cloudwatch_logs_errors.h.

◆ ROSCloudWatchLogsErrors [2/2]

Defines error return codes for functions This enum defines standard error codes that will be returned by AWS CloudWatch Logs libraries.

Enumerator
CW_LOGS_SUCCEEDED 

Indicates that there is no error.

CW_LOGS_FAILED 

A generic error occured

CW_LOGS_NULL_PARAMETER 

An error when a NULL value is supplied as a parameter when a non-NULL value is required

CW_LOGS_DATA_LOCKED 

An error indicating that data cannot be used for other operations because it's locked.

CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED 

An error indicating that a thread is not initialized.

CW_LOGS_THREAD_BUSY 

An error indicating that a thread is not available.

CW_LOGS_EMPTY_PARAMETER 

An error indicating that a data structure is empty.

CW_LOGS_LOG_STREAM_LIST_EMPTY 

An error indicating that a log stream list is empty.

CW_LOGS_CREATE_LOG_GROUP_FAILED 

An error indicating that the attempt to create a log group failed.

CW_LOGS_CREATE_LOG_STREAM_FAILED 

An error indicating that the attempt to create a log stream failed.

CW_LOGS_LOG_GROUP_ALREADY_EXISTS 

An error indicating that a log group already exists.

CW_LOGS_LOG_STREAM_ALREADY_EXISTS 

An error indicating that a log stream already exists.

CW_LOGS_LOG_GROUP_NOT_FOUND 

An error indicating that a log group cannot be found.

CW_LOGS_LOG_STREAM_NOT_FOUND 

An error indicating that a log stream cannot be found in a log group.

CW_LOGS_LOG_STREAM_NOT_CONFIGURED 

Log stream was not configured properly.

CW_LOGS_NOT_CONNECTED 

No network connection available.

CW_LOGS_INVALID_PARAMETER 

Invalid data was sent and will never be accepted.

CW_LOGS_SUCCEEDED 

Indicates that there is no error.

CW_LOGS_FAILED 

A generic error occured

CW_LOGS_NULL_PARAMETER 

An error when a NULL value is supplied as a parameter when a non-NULL value is required

CW_LOGS_DATA_LOCKED 

An error indicating that data cannot be used for other operations because it's locked.

CW_LOGS_PUBLISHER_THREAD_NOT_INITIALIZED 

An error indicating that a thread is not initialized.

CW_LOGS_THREAD_BUSY 

An error indicating that a thread is not available.

CW_LOGS_EMPTY_PARAMETER 

An error indicating that a data structure is empty.

CW_LOGS_LOG_STREAM_LIST_EMPTY 

An error indicating that a log stream list is empty.

CW_LOGS_CREATE_LOG_GROUP_FAILED 

An error indicating that the attempt to create a log group failed.

CW_LOGS_CREATE_LOG_STREAM_FAILED 

An error indicating that the attempt to create a log stream failed.

CW_LOGS_LOG_GROUP_ALREADY_EXISTS 

An error indicating that a log group already exists.

CW_LOGS_LOG_STREAM_ALREADY_EXISTS 

An error indicating that a log stream already exists.

CW_LOGS_LOG_GROUP_NOT_FOUND 

An error indicating that a log group cannot be found.

CW_LOGS_LOG_STREAM_NOT_FOUND 

An error indicating that a log stream cannot be found in a log group.

CW_LOGS_LOG_STREAM_NOT_CONFIGURED 

Log stream was not configured properly.

CW_LOGS_NOT_CONNECTED 

No network connection available.

Definition at line 29 of file definitions/ros_cloudwatch_logs_errors.h.

Variable Documentation

◆ kDefaultCloudWatchOptions

const CloudWatchOptions Aws::CloudWatchLogs::kDefaultCloudWatchOptions
static
Initial value:
{
}
static constexpr UploaderOptions kDefaultUploaderOptions
static const FileManagerStrategyOptions kDefaultFileManagerStrategyOptions

Definition at line 44 of file cloudwatch_options.h.

◆ kMaxRetries

constexpr int Aws::CloudWatchLogs::kMaxRetries = 1

Definition at line 39 of file log_publisher.cpp.

◆ ONE_DAY_IN_MILLISEC

const long Aws::CloudWatchLogs::ONE_DAY_IN_MILLISEC = 24*60*60*1000

Definition at line 76 of file log_file_manager.h.

◆ TWO_WEEK_IN_MILLISEC

const long Aws::CloudWatchLogs::TWO_WEEK_IN_MILLISEC = 14*ONE_DAY_IN_MILLISEC

Definition at line 77 of file log_file_manager.h.

◆ UNINITIALIZED_TOKEN

const Aws::String Aws::CloudWatchLogs::UNINITIALIZED_TOKEN = "_NOT_SET_"
static

Definition at line 49 of file log_publisher.h.



cloudwatch_logs_common
Author(s): AWS RoboMaker
autogenerated on Mon Feb 28 2022 22:02:00