1. SAP Support Portal Home
  2. Application Lifecycle Management
  3. SAP Cloud ALM
  4. SAP Cloud ALM for Operations
  5. SAP Cloud ALM for Operations Expert Portal
  6. Integration & Exception Monitoring

SAP Business Technology Platform - Neo

SAP Business Technology Platform - Neo

Available Monitoring Content

CategoryTypeDescription
Alert NotificationsExceptionsCollects events sent from the Alert Notification Service
Java Application LogsExceptionsCollects exceptions in Java Logs for applications running in SAP Business Technology Platform

SAP Business Technology Platform - Neo

Preparations for Java Application Error Monitoring

Determine Root URL

The Java API Root URL for SAP Business Technology Platform depends on the host on which your account is hosted on. The host depends on the region as described here:

  • Check the region of your subaccount in SAP BTP Cockpit. You find it on the subaccount card on your global account page in the field "Region"
  • Check the host domain name for the region via SAP Business Technology Platform (SAP BTP) → SAP BTP, Neo Environment → Regions in the Neo Environment → Regions and Hosts Available for the Neo Environment 
  • Build the root URL, e.g. If your host domain name is us1.hana.ondemand.com, the Root URL to configure is https://publicapingplog.us1.hana.ondemand.com

Create User for Java Log Monitoring

To connect to SAP Business Technology Platform to collect Java application exceptions you need to provide SAP Cloud ALM with a user that is allowed to read the default trace.

  • The user needs at least the role 'Support User' in SAP Business Technology Platform

Retrieve Technical Name for the Subaccount

To successfully read Java application logs you need to provide the technical name of the subaccount in which the Java application is running in the Landscape Management of SAP Cloud ALM. 

You find the technical name of the sub-account on the sub-account "Overview" page under Subaccount Information → Technical Name.

  • Note down the technical name for the subaccount for later use

Write Java Errors into Default Trace

This last preparation step starts already during the development of the SAP Business Technology Platform application. To be able to collect application errors, these errors must exist in the default trace for the SAP Business Technology Platform java application. Hence developers must write meaningful errors in this trace. The quality of the monitored exceptions completely depends on the quality of the exceptions written by the developer.

  • Please see this blog for more information on logging for SAP Business Technology Platform Java applications 

Preparations for Alert Notifications

Enable SAP Business Technology Platform Alert Notifications

Receiving alert notifications is done via the Alert Notification Service which can be enabled for your SAP Business Technology Platform account. 

Important: Please be aware that the use of this service is quota based (billable)!

To enable the service please follow the documentation:

Gather Connection Information

To authenticate towards the service you have to create an OAuth client in SAP Business Technology Platform. Information how to do this you find here:

Please make sure to note down or copy the client secret, as it cannot be retrieved later on. 

You will need the following connection information to connect SAP Cloud ALM.

  1. In your Subaccount navigate to Services → Alert Notification → Security
  2. Root URL: Use 'Consume Events' URL under Endpoints (up to .com)
  3. OAuth URL: Use 'OAuth Token' under Endpoints (full URL)
  4. Client ID: Use 'Client ID' of the created OAuth client
  5. Client Secret: Use client secret noted down during client creation

Setup Steps in SAP Cloud ALM

Setup Steps for Java Application Error Monitoring

Create a new SAP BTP Neo Service in Landscape Management

While your SAP BTP - Neo service is already imported in the Landscape Management via the SLIS import, the imported tenant ID is currently not sufficient to retrieve Java application errors.

Hence you have to manually create an additional entry in Landscape Management for the SAP BTP - Neo service with the correct tenant ID.

  1. Go to Administration → Landscape Management
  2. Find your SAP BTP - Neo service and note down
    1. the Root URL for the service
    2. the Tenant ID
  3. Click the "Add" button to create a new service
    1. Name/Description: Enter name and description
    2. Tenant ID: Enter <Tenant ID>/<Technical name of the subaccount> (e.g. $12345678/abc4567ef)
    3. Cloud Service Type: Select "SAP BTP Neo environment"
    4. Tenant Type: Enter the same value as your SLIS imported SAP BTP Neo service
    5. Root URL: Paste in the root URL from the SLIS imported SAP BTP Neo service
  4. Save the cloud service.

Create Endpoint for Java Application Error collection

  1. Open the Landscape Management application from the launchpad
  2. Select your manually created SAP Business Technology Platform - Neo service
  3. Press the > button at the end of the line
  4. On the tab "Endpoints" press the Add button to create a new end-point
  5. Enter a description
  6. Use Case: Choose "Exception Monitoring"
  7. Root URL: Enter the Root URL that you determined earlier for the Java API Root URL
  8. Authentication Type: Choose BASIC authentication as authentication method and enter the user and password created in SAP BTP Cockpit
  9. Save the endpoint

Setup Steps for Alert Notifications

Create Endpoint for Alert Notification Collection

  1. Open the Landscape Management application from the launchpad
  2. Select your SAP Business Technology Platform - Neo service
  3. Press the > button at the end of the line
  4. On the tab "Endpoints" press the Add button to create a new end-point
  5. Enter a description
  6. Use Case: Choose "Exception Monitoring"
  7. Root URL: Enter the Root URL that you determined earlier for the 'Consume Events' URL
  8. Authentication Type: For Alert Notifications choose OAuth2ClientCredentials and enter the Token Service URL, client ID and client secret
  9. Save the endpoint.

Activate Monitoring and Alerting

Because you have to choose the correct end-point for each of the categories in SAP Business Technology Platform - Neo you have to activate the monitoring manually.

  1. Open the Integration & Exception Monitoring application from the launchpad
  2. Open the scope selection via the target icon in the upper right corner
  3. Change the drop-down for Display Service to "All"
  4. Make sure to select your cloud service in the scope
  5. Click the rack-wheel icon in the upper right corner to access the configuration
  6. Expand the Configuration panel
  7. In the configuration panel, click on the name of the cloud service
  8. The "Configuration of Services" screen opens
  9. In the "Configuration for Services" screen, click the > button at the end of the line for the cloud service you want to change

Adjust Monitoring Categories

  1. Use the toggle button in the column Active to turn a monitoring category ON or OFF
  2. Choose the correct end-point for each category

Adjust Alerting

  1. Use the toggle button in the column Active to turn a standard alert ON or OFF
  2. Press the > button at the end of the line to access the detail setup for an existing alert or use the + button to create a new alert
  3. Adjust the display name if desired
  4. Expand the Filter Configuration tray
  5. Enter a filter name
  6. Select the filter category
  7. Maintain the available filter fields (see details below)

Available Alerts for SAP Business Technology Platform - Neo

  • Erroneous Java Application
  • Erroneous Alert Notification (Alert notifications w/o close event)
  • Erroneous Stateful Alert Notification (Alert notifications w/ close event)

Available Filter Fields for SAP Business Technology Platform - Neo

The filter fields depend on the monitoring category the alert is created for and additional on the filter category, if there is more than one available.

Java Application Logs

  • Application: Application Name
  • Logger: This field usually contains the area and the application name to identify the origin of the logged problem. Supports wildcards (e.g. com.sap*)
  • Message: Error text of the exception. Supports wildcards (e.g. Failed*cache)
  • Passport ID: The passport of the exceptions
  • Runtime: Runtime of the application (e.g. java or html5)
  • Severity: Comma-separated list of the severity of the exceptions (e.g. ERROR, FATAL)
  • Tenant: The account or sub-account ID for the exception
  • User: The user who triggered the exception
Alert Notifications
  • Body: Alert Notification long text
  • Category: ALERT, EXCEPTION, NOTIFICATION
  • Event Type: Type of the event (Find more information here)
  • Resource Name: Name of the resource causing the event 
  • Resource Group: Name of the resource group causing the event 
  • Severity: ERROR or WARNING
  • Source Event ID: ID of the source event
  • Status: Errors, Warnings, Resolved
  • Subject: Alert notification short text