Skip to content

API for Amazon CloudWatch Logs

ABAP Package /AWS1/API_CWL_IMPL
ABAP SDK "TLA" CWL
ABAP Interface /AWS1/IF_CWL

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon CloudWatch Logs is CWL. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the CloudWatch Logs module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

  • Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException"). You can also count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.

  • Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.

  • Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

Using the SDK

In your code, create a client using the SDK module for Amazon CloudWatch Logs, which is created with factory method /AWS1/CL_CWL_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_cwl)       = /aws1/cl_cwl_factory=>create( go_session ).

Your variable go_cwl is an instance of /AWS1/IF_CWL, and all of the operations in the Amazon CloudWatch Logs service are accessed by calling methods in /AWS1/IF_CWL.

API Operations

For an overview of ABAP method calls corresponding to API operations in Amazon CloudWatch Logs, see the Operation List.

Factory Method

/AWS1/CL_CWL_FACTORY=>create( )

Creates an object of type /AWS1/IF_CWL.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_CWL

/AWS1/IF_CWL represents the ABAP client for the CloudWatch Logs service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_cwl)->get_config( ).

lo_config is a variable of type /AWS1/CL_CWL_CONFIG. See the documentation for /AWS1/CL_CWL_CONFIG for details on the settings that can be configured.

Paginators

Paginators for Amazon CloudWatch Logs can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CWL_PAGINATOR. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next() and get_next() methods.

Details about the paginator methods available for service Amazon CloudWatch Logs can be found in interface /AWS1/IF_CWL_PAGINATOR.