SAP Business Technology Platform - Neo
Available Monitoring Content
| Category | Type | Description |
|---|---|---|
| Alert Notifications | Exceptions | Collects events sent from the Alert Notification Service |
| Java Application Logs | Exceptions | Collects 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 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:
- SAP Business Technology Platform (SAP BTP) → SAP BTP, Neo Environment → Regions in the Neo Environment → Regions and Hosts Available for the Neo Environment
- e.g. If your host 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 Focused Run 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
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:
- SAP Cloud Platform Alert Notification → SAP Cloud Platform Alert Notification, Neo Environment → Initial Setup
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 Platform Alert Notification → SAP Cloud Platform Alert Notification, 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 Cloud ALM.
- In your Subaccount navigate to Services → Alert Notification → Security
- Root URL: Use 'Consume Events' URL under Endpoints (up to .com)
- OAuth URL: Use 'OAuth Token' under Endpoints (full URL)
- Client ID: Use 'Client ID' of the created OAuth client
- Client Secret: Use client secret noted down during client creation
Setup Steps in SAP Cloud ALM
Create HTTP End-Points
You have to create two endpoints for the SAP Business Technology Platform service. One for the collection of Java exceptions and one for Alert Notifications.
- Open the Landscape Management application from the launchpad
- Select your SAP Business Technology Platform - Neo service
- Press the > button at the end of the line
- On the tab "Endpoints" press the Add button to create a new end-point
- Enter a description
- Choose the use-case "Exception Monitoring"
- The Root URL will differ between the end-point for Java exceptions and Alert Notifications:
- Enter the Root URL that you determined earlier for the Java API or the 'Consume Events' URL
- Choose your authentication method and enter the respective connection information
- For Java Exceptions: Choose BASIC authentication and enter the user and password created in SAP CP
- For Alert Notifications: Choose OAuth authentication and enter the Token Service URL, client ID and client secret
- Repeat the steps above for the second end-point.
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.
- Open the Integration & Exception Monitoring application from the launchpad
- The scope selection will appear automatically
- Change the drop-down for Display Service to "All"
- Make sure to select your cloud service in the scope
- Click the Configuration button in the upper right corner to access the configuration
- Expand the Configuration panel
- In the configuration panel, click on the name of the cloud service
- The "Configuration of Services" screen opens
- 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
- Use the toggle button in the column Active to turn a monitoring category ON or OFF
- Choose the correct end-point for each category
Adjust Alerting
- Use the toggle button in the column Active to turn a standard alert ON or OFF
- 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
- Adjust the display name if desired
- Expand the Filter Configuration tray
- Enter a filter name
- Select the filter category
- 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
- 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