Skip to content

/AWS1/IF_CWL=>GETLOGEVENTS()

About GetLogEvents

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

GetLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.

Partially full or empty pages don't necessarily mean that pagination is finished. As long as the nextBackwardToken or nextForwardToken returned is NOT equal to the nextToken that you passed into the API call, there might be more log events available. The token that you use depends on the direction you want to move in along the log stream. The returned tokens are never null.

If you set startFromHead to true and you don’t include endTime in your request, you can end up in a situation where the pagination doesn't terminate. This can happen when the new log events are being added to the target log streams faster than they are being read. This situation is a good use case for the CloudWatch Logs Live Tail feature.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

If you are using log transformation, the GetLogEvents operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query.

Method Signature

METHODS /AWS1/IF_CWL~GETLOGEVENTS
  IMPORTING
    !IV_LOGGROUPNAME TYPE /AWS1/CWLLOGGROUPNAME OPTIONAL
    !IV_LOGGROUPIDENTIFIER TYPE /AWS1/CWLLOGGROUPIDENTIFIER OPTIONAL
    !IV_LOGSTREAMNAME TYPE /AWS1/CWLLOGSTREAMNAME OPTIONAL
    !IV_STARTTIME TYPE /AWS1/CWLTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/CWLTIMESTAMP OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CWLNEXTTOKEN OPTIONAL
    !IV_LIMIT TYPE /AWS1/CWLEVENTSLIMIT OPTIONAL
    !IV_STARTFROMHEAD TYPE /AWS1/CWLSTARTFROMHEAD OPTIONAL
    !IV_UNMASK TYPE /AWS1/CWLUNMASK OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwlgetlogeventsrsp
  RAISING
    /AWS1/CX_CWLINVALIDPARAMETEREX
    /AWS1/CX_CWLRESOURCENOTFOUNDEX
    /AWS1/CX_CWLSERVICEUNAVAILEX
    /AWS1/CX_CWLCLIENTEXC
    /AWS1/CX_CWLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_logstreamname TYPE /AWS1/CWLLOGSTREAMNAME /AWS1/CWLLOGSTREAMNAME

The name of the log stream.

Optional arguments:

iv_loggroupname TYPE /AWS1/CWLLOGGROUPNAME /AWS1/CWLLOGGROUPNAME

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

iv_loggroupidentifier TYPE /AWS1/CWLLOGGROUPIDENTIFIER /AWS1/CWLLOGGROUPIDENTIFIER

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

iv_starttime TYPE /AWS1/CWLTIMESTAMP /AWS1/CWLTIMESTAMP

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

iv_endtime TYPE /AWS1/CWLTIMESTAMP /AWS1/CWLTIMESTAMP

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

iv_nexttoken TYPE /AWS1/CWLNEXTTOKEN /AWS1/CWLNEXTTOKEN

The token for the next set of items to return. (You received this token from a previous call.)

iv_limit TYPE /AWS1/CWLEVENTSLIMIT /AWS1/CWLEVENTSLIMIT

The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

iv_startfromhead TYPE /AWS1/CWLSTARTFROMHEAD /AWS1/CWLSTARTFROMHEAD

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

iv_unmask TYPE /AWS1/CWLUNMASK /AWS1/CWLUNMASK

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwlgetlogeventsrsp /AWS1/CL_CWLGETLOGEVENTSRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getlogevents(
  iv_endtime = 123
  iv_limit = 123
  iv_loggroupidentifier = |string|
  iv_loggroupname = |string|
  iv_logstreamname = |string|
  iv_nexttoken = |string|
  iv_startfromhead = ABAP_TRUE
  iv_starttime = 123
  iv_unmask = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_events( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_timestamp = lo_row_1->get_timestamp( ).
      lv_eventmessage = lo_row_1->get_message( ).
      lv_timestamp = lo_row_1->get_ingestiontime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nextforwardtoken( ).
  lv_nexttoken = lo_result->get_nextbackwardtoken( ).
ENDIF.