SAP BTP, Neo environment

This page explains how to connect SAP BTP, Neo environment to SAP Focused Run. For the setup of the supported monitoring applications, please click on the monitoring application below.

Currently the following monitoring application are supported for SAP BTP, Neo environment:

Choose Your SAP Focused Run Release

This page describes the connection setup for SAP BTP, Neo environment with SAP Focused Run 3.0 FP 02 or newer.

Please select the documentation appropriate for your SAP Focused Run release from the table below. 

SAP Focused Run ReleaseConnection Setup Documentation
SAP Focused Run 3.0 FP 02Stay on this page
SAP Focused Run 3.0 FP 01 and lowerSAP BTP, Neo environment - up to SAP Focused Run 3.0 FP01

Setup Steps in SAP BTP, Neo environment

Preparations for Java Application Monitoring

Determine Root URL

The API Root URL for SAP Business Technology Platform depends on the data center in which your account is hosted. 

  1. Check the region of your sub-account in SAP BTP Cockpit.
    1. You find it either on the sub-account card on your global account page in the field "Region"
    2. Or in the SAP Cloud ALM "Landscape Management" application in the service property "BTP Landscape ID"
  2. Find you region here: SAP Business Technology Platform (SAP BTP) → SAP Business Technology Platform, Neo Environment → Regions in the Neo Environment → Regions and Hosts Available for the Neo Environment 
  3. Note down the host for your region
  4. Build your root URLs, e.g. If your host is us1.hana.ondemand.com
    1. The Root URL for Exception Monitoring and Real User Monitoring is https://publicapingplog.us1.hana.ondemand.com
    2. The Root URL for Health Monitoring is https://api.us1.hana.ondemand.com

Create API Client

To connect to SAP Business Technology Platform to collect Java application exceptions you need to create the correct API client in the sub-account.

  1. Log on to SAP BTP Cockpit and navigate to the sub-account with the Java application that you want to collect logs for
  2. Navigate to Security > OAuth
  3. Go to the tab "Platform API"
  4. Click on "Create API Client"
  5. Add the following authorizations to the client:
    1. Under "Exception and Tracing API"
      1. Read Exception Logs
      2. Read End-to-End Traces
    2. Under "Monitoring Service"
      1. Read Monitoring Data
    3. Under "Lifecycle Management"
      1. "Read Applications"
  6. Click "Save"
  7. Save the client ID and the client secret for later use!

Turn on Performance Data Collection for SAP Cloud Portal Service

If you want to collect monitoring data for Real User Monitoring you have to activate the performance data collection for the SAP Fiori Launchpad

  1. Log on to SAP BTP Cockpit and navigate to the sub-account with the Java application that you want to collect performance data
  2. Navigate to Services
  3. Search for the "Cloud Portal Service"
  4. Click on the tile
  5. Under "Take Action" click on "Go to Service"
  6. In the new application go to "Site Directory"
  7. Click "Edit" in the Fiori Launchpad Portal (FLP) page you want to activate Real User Monitoring for (e.g. defaultsite)
  8. In the "Fiori Configuration Cockpit", select "Settings" from the side navigation menu.
  9. Click "Edit" at the bottom right side of the screen
  10. Under "System Settings" find "Collect Performance Data"
  11. Switch it to "YES"
  12. Save your changes

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:

  • SAP Cloud Alert Notification → SAP Business Technology Platform AlertNotification, Neo Environment → Administration → Credential Management

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 Focused Run.

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

Import the SSL certificate for Cloud Foundry

Even if used in the SAP Business Technology Platform (Neo) the alert notification service technically runs in SAP Business Technology Platform (Cloud Foundry). To make sure that SAP Focused Run can receive alert notifications successfully, you have to import the SSL certificate for Cloud Foundry additionally to the SSL certificate for Neo.

  1. In your Subaccount navigate to Services → Alert Notification → Security
  2. Click on the 'Consume Events' URL under Endpoints to open it in a browser
  3. Import the SSL certificate for this website into SAP Focused Run STRUST as described above

Preparations for E2E Application Tracing

Enable Automatic Trace Upload for SAPUI5 applications

You can enable the automatic upload of the client side trace data, which starts in the background when a trace is ended. Therefore, perform the following steps in your WebIDE or development platform for the SAPUI5 applications in focus.

Note: This operation has to be repeated for each relevant SAPUI5 application.

  1. Load the SAPUI5 application in your WebIDE
  2. Open the file: neo-app.json
  3. Edit the file, adding a "routes" record, of type destination, as shown here:
    {
      "welcomeFile": "index.html",
      "routes": [
        {
           ...
        }
        {
            "path": "/sap/bc/sdf/E2E_Trace_upl",
            "target": {
                "type": "destination",
                "name": "focusedrun",
                "entryPath": "/sap/bc/sdf/E2E_Trace_upl"
            },
            "destination": "SAP FRunUpload"
        }
      ]
    }
  4. Save the file
  5. Also maintain the above mentioned destination, within SAP Business Technology Platform and SAP Cloud Connector, specifying the gateway host and port used by your app.
    • Essentially you can copy the path for the odata services just replacing the path value.
  6. Finally, deploy the SAP UI5 application again to the SAP Business Technology Platform

Setup Steps in SAP Focused Run

Input Values for SAP BTP, Neo environment

  • Environment: Neo
  • Account: Your account ID
  • Root Account URL: Enter the URL for your subaccount, e.g. https://account.hana.ondemand.com/neo/#/globalaccount/xxx/neosubaccount/xxx
 

Input Values for SAP BTP, Neo environment

For SAP BTP, Neo environment the different monitoring information are collected from different APIs. Hence you have to create several endpoints addressing the respective API. 

Endpoint for Alert Notifications

  • Global:
    • API Type: Alert Notifications
    • API Root URL: The 'Consume Events' URL of the Alert Notification Service
  • Authentication:
    • Type: OAUTH
    • OAuth URL: The 'OAuth Token' URL of the Alert Notification Service
    • Client ID: Client ID of the technical client
    • Client Secret: Client secret of the technical client

Endpoint for Java Logs (Exception Monitoring) / Real User Monitoring

  • Global: 
    • API Type: Application Exceptions and Performance
    • API Root URL: https://publicapingplog.<host of your region>
  • Authentication:

Endpoint for Health Monitoring

  • Global: 
    • API Type: Java Monitoring
    • API Root URL: https://api.<host of your region>
  • Authentication: