API for CloudWatch RUM¶
| ABAP Package | /AWS1/API_RUM_IMPL |
|---|---|
| ABAP SDK "TLA" | RUM |
| ABAP Interface | /AWS1/IF_RUM |
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 CloudWatch RUM is RUM.
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 RUM 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¶
With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.
You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.
Using the SDK¶
In your code, create a client using the SDK module for CloudWatch RUM, which is created with
factory method /AWS1/CL_RUM_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_rum) = /aws1/cl_rum_factory=>create( go_session ).
Your variable go_rum is an instance of /AWS1/IF_RUM,
and all of the operations
in the CloudWatch RUM service are accessed by calling methods in /AWS1/IF_RUM.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in CloudWatch RUM, see the Operation List.
Factory Method¶
/AWS1/CL_RUM_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_RUM.
IMPORTING¶
Optional arguments:¶
iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
oo_client TYPE REF TO /aws1/if_rum /AWS1/IF_RUM¶
/AWS1/IF_RUMrepresents the ABAP client for the RUM service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_rum)->get_config( ).
lo_config is a variable of type /AWS1/CL_RUM_CONFIG. See the documentation for /AWS1/CL_RUM_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for CloudWatch RUM can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_RUM_PAGINATOR`](./_AWS1_IF_RUM_PAGINATOR.md). 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 CloudWatch RUM can be found in interface [`/AWS1/IF_RUM_PAGINATOR`](./_AWS1_IF_RUM_PAGINATOR.md).