abap-message-logger

Message Logger for ABAP Cloud (AML)

A logger class for the most use-cases in ABAP Cloud. Focus is the logging of messages and types with the posibility to save the log to the Application Logs.

ABAP Cloud

Support of ABAP Cloud (ABAP Environment, Public Cloud and Private Cloud S/4HANA 2023+) with key capabilities:

• Mock- and testable
• Configuration via Settings
• Factory for Creation and/or Singleton
• Support for Application Job, 2nd DB Connection
• Support for RAP exceptions
• Context data [Planned]

Configuration

You can configure the log during the creation. Here are the different settings explained. All settions and fields are optional.

You can create your own configuration, if you want to overwrite archive settings from ZCL_AML_DEFAULT_CONFIG.

Methods

Methods to add messages to the object:

Methods to get the collected messages:

Methods that help to get more informations:

Unit Tests

The framework is tested using unit tests, and currently all components are covered. If errors or enhancements are made, we would expand the unit tests.

Usage

Here you get some informations, how to use the log. You could also check the Unit Tests for message handling.

Creation

The normal creation of a log object.

DATA(log) = zcl_aml_log_factory=>create( ).

When you want to set some settings in the class, manage them via the constructor.

DATA(log) = zcl_aml_log_factory=>create( VALUE #( default_message_class = 'Z_AML'
                                                  default_message_type  = 'I' ) ).

If you want to reuse the log or havn't saved it, you can use the Singleton principle. You can get the DEFAULT log or create different versions with the identification.

DATA(log) = zcl_aml_log_factory=>get_instance( ).

Messages

Add messages via the different methods. Here to add a simple T100 message:

log->add_message( '001' ).

... or if you have catched an exception:

  CATCH cx_bali_runtime INTO DATA(bali_error).
    log->add_message_exception( bali_error ).
ENDTRY.

Analysis

If you want to validate the erros, you could use the helper methods to check for errors.

IF log->has_error( ).
ENDIF

Save

To save the log you simple need to call the save method. Ensure that the settings

log->save( ).

Where-Used list

If you want to use the where-used list of messages without creating dummy variables each time and using pragmas for ATC and ABAP Cleaner, you can use the corresponding variable in the log directly in your code before logging the message.

MESSAGE s005(z_aml) INTO log->message_text.
log->add_message_system( ).

Error

The framework catch possible exceptions and wrapps it in a NO_CHECK exception ZCX_AML_ERROR. For example if you want to save the log and an instance is not created, the exception could be raised.