SAP Alert Notification service for SAP BTP is a service in the DevOps portfolio of SAP Business Technology Platform (SAP BTP). It supports the operations by exposing real-time information about cloud-native as well as hybrid solutions. The service standardizes an environment-agnostic model across SAP Business Technology Platform, so that users can benefit from the same configuration lifecycle and information model.
Service offers a variety of Built-In Events. The complete list can be found here
For this scenario you will define the following alerts:
- Application Events - get notifications when an application crashes, a process crashes or alike
- Multitarget Application Events - get notified when the deployment or removal of a specific multi-target application has been initiated
Note, add the required entitlement SAP Alert Notification service for SAP BTP, in case it is missing in your SAP BTP subaccount. Follow the steps of "Configure BTP Environment".
-
Navigate to the Service Marketplace and create a new service instance for the Alert Notification service.
-
Provide a service instance name (e.b. alert-notification) and continue with Create.
-
Select the newly created instance and click on Manage Instance to navigate the to Alert Notification service cockpit.
-
Navigate to Export and Import, copy and paste the below configuration JSON. Replace
<[email protected]>with your email, where you want to receive the notifications.
{ "actions": [ { "type": "EMAIL", "name": "send-email", "state": "ENABLED", "properties": { "destination": "[email protected]", "useHtml": "false" } }, { "type": "STORE", "name": "tmp-store", "state": "ENABLED" } ], "conditions": [ { "name": "Audit-App-Crash", "mandatory": false, "propertyKey": "eventType", "predicate": "EQUALS", "propertyValue": "app.crash", "labels": [], "description": "" }, { "name": "Audit-App-Update", "mandatory": false, "propertyKey": "eventType", "predicate": "EQUALS", "propertyValue": "audit.app.update", "labels": [], "description": "" }, { "name": "mta-category", "mandatory": false, "propertyKey": "category", "predicate": "EQUALS", "propertyValue": "NOTIFICATION", "labels": [], "description": "" }, { "name": "Audit-App-Stop", "mandatory": false, "propertyKey": "eventType", "predicate": "CONTAINS", "propertyValue": "audit.app.stop", "labels": [], "description": "" }, { "name": "Audit-App-Process-Crash", "mandatory": false, "propertyKey": "eventType", "predicate": "EQUALS", "propertyValue": "audit.app.process.crash", "labels": [], "description": "audit.app.process.crash" }, { "name": "Audit-App-Start", "mandatory": false, "propertyKey": "eventType", "predicate": "EQUALS", "propertyValue": "audit.app.start", "labels": [], "description": "" }, { "name": "mta-deployment", "mandatory": false, "propertyKey": "eventType", "predicate": "EQUALS", "propertyValue": "DEPLOYMENT", "labels": [], "description": "" }, { "name": "mta-undeployment", "mandatory": false, "propertyKey": "eventType", "predicate": "EQUALS", "propertyValue": "UNDEPLOYMENT", "labels": [], "description": "" } ], "subscriptions": [ { "name": "MTA", "conditions": [ "mta-deployment", "mta-undeployment" ], "actions": [ "tmp-store", "send-email" ], "state": "ENABLED" }, { "name": "App-Audit", "conditions": [ "Audit-App-Process-Crash", "Audit-App-Stop", "Audit-App-Crash", "Audit-App-Update" ], "actions": [ "tmp-store", "send-email" ], "state": "ENABLED" } ] } -
Select Import to finish the configuration import.
-
After the import process has finished, you will find two actions in your Alert Notification cockpit:
- send-email: sends e-mail when an alert gets raised happens
- tmp-store: stores the alert temporary in the service. Later it can be accessed e.g. via SAP Cloud ALM
There are much more notification channels like Slack, Microsoft Teams and many more. The full list can be found here. You can follow the documentation to configure further actions.
-
Confirm your e-mail to activate the e-mail channel.
-
To receive notifications about relevant events by the SAP Alert Notification service for SAP BTP, you need subscriptions to these alerts.
You have defined two Subscriptions while importing the configuration:
- App Audit - get notifications when an app has stopped, crashed, a process has crashed or alike
- MTA - get a notification when the deployment or removal of a multi-target application has been initiated
-
Open one of the above mentioned Subscriptions e.g. App Audit and check the conditions when the alert will be triggered.
Whenever one of following conditions will be matched, an alert notification will be triggered - in this example via e-mail:
- application stops
- application crashes
- application process crashes
- application gets updated
-
For application events, you need to add the respective existing technical users according to their relevant data center. This user must have the SpaceAuditor permission. Add the user to the Cloud Foundry space of your SAP BTP subaccount by using its e-mail address.
- the list of technical users depending on the data center can be found here
- in your case, the service should be running in AWS-Frankfurt and the technical user is: [email protected]
- go to the Cloud Foundry space of your SAP BTP subaccount where your application is deployed and add the user as a member with SpaceAuditor role
-
To test the alert notification, trigger an event for app audit. You can manually stop the application, which will trigger the event and notify you via e-mail.
-
Go to the Cloud Foundry space in your SAP BTP subaccount and stop the application.
-
Check your e-mail inbox. You should have received the information that the application was stopped.
-
