Pre-requisites for Monitoring SAP BTP Neo Environment

The eG agent connects to the SAP BTP Neo environment and pulls metrics from it using REST API. To enable the eG agent to make these API calls, the following are required:

  • API Endpoint URL - This is the URL that provides the location of the resources that are to be monitored on the SAP Cloud platform. To know how to identify this URL, follow the procedure outlined in Identifying the API Endpoint URL and Subaccount of this document. Once identified, use that URL to manage the target SAP BTP Neo component using the eG admin interface.

  • Subaccount - In SAP Neo, you can structure a global account according to an organization's or project's requirements, by creating multiple Subaccounts within. Each Subaccount will have its own members, authorizations, and entitlements, and will be associated with a specific region. The eG agent must be allowed access to a specific Subaccount, so it can monitor the resources located in the corresponding region. To identify the Subaccount that is associated with the region that is monitored, use the procedure outlined in Identifying the API Endpoint URL and Subaccount of this document.

  • Client ID and Client Secret - For collecting performance statistics, the eG agent has to connect to the SAP BTP Neo platform as a valid 'API client'. For this purpose, you should first register the eG agent as an API client, and obtain its unique Client ID and Client Secret. To achieve this, follow the procedure detailed in Registering the eG Agent as an API Client of this document. Then, you should configure the eG tests with this ID and Secret.

  • HTML5 Applications - To enable the eG agent to monitor specific HTML5 applications, the corresponding eG test should be configured with the names of those applications. To identify these names, follow the procedure detailed in section Determining the Name of the HTML5 Applications to be Monitored of this document.

  • HANA XS Applications - To enable the eG agent to monitor specific HANA XS applications, the corresponding eG test should be configured with the names of those applications. To identify these names, follow the procedure detailed in Determining the Name of the HANA XS Applications to be Monitored of this document.

  • HANA/ASE Databases - To enable the eG agent to monitor specific HANA/ASE databases, the corresponding eG test should be configured with the names of those databases. To identify the database names, follow the procedure detailed in Determining the Name of HANA/ASE Databases to be Monitored of this document.

Registering the eG Agent as an API Client

  1. To register an API client, you first need to login to the SAP Cloud Platform Cockpit using valid account credentials. The cockpit is a central Web-based user interface for administrators, providing access to a number of functions for configuring and managing applications and connecting them to services on SAP BTP. In the left navigation pane of SAP Cloud Platform Cockpit, click on Services menu (see Figure 1). In the DevOps section, make sure that the Monitoring option is active (see Figure 1).

    Figure 1 : Monitoring option in Services menu

  2. Navigate to Security -> OAuth option in the left navigation pane and select the Platform API tab (see Figure 2).

    Figure 2 : Platform API tab option in OAuth submenu of Security menu

  3. Click the Create API Client button in the Platform API tab (see Figure 2) and it will lead you to the Create Platform API OAuth Client page (see Figure 3). Enter a description and select the Monitoring Service, Lifecycle Management, Configuration Service, Authorization Management, Virtual Machines checkboxes in this page.

    Figure 3 : Create Platform API OAuth Client page

  4. Confirm the selection and it will lead you to the OAuth Client Credentials pop-up (see Figure 4) in next step.

    Figure 4 : OAuth Client Credentials pop-up

  5. Note down the Client ID and Client Secret in this pop-up. You will need them during the eG test configuration.

Identifying the API Endpoint URL and Subaccount

To find the test configuration parameters for SAP Neo Environment in eG Test Configuration page, make sure that the below steps are followed in the SAP Cloud Platform Cockpit:

Login to the SAP Cloud Platform Cockpit. Navigate to Security -> OAuth option in the left navigation pane (see Figure 5).

Figure 5 : Region details in SAP Cloud Platform Cockpit

In this page, you can identify the Region in SAP Neo environment (see Figure 5). Each SAP BTP Neo Region is mapped to a different host / endpoint URL. To know which URL corresponds to the Region that is being monitored, refer to the table below.

Global Account Type Region (all operated by SAP) Technical Key Host Cockpit Logon IP Ranges

Enterprise account

Australia (Sydney)

neo-ap1

https://ap1.hana.ondemand.com

Link

210.80.140.0/24 and 157.133.96.0/23

Brazil (São Paulo)

neo-br1

https://br1.hana.ondemand.com

Link

157.133.246.0/24

Canada (Toronto)

neo-cal

https://cal.hana.ondemand.com

Link

157.133.54.0/24

Europe (Rot)

neo-eul

https://hana.ondemand.com https://eul.hana.ondemand.com

Link

155.56.128.0/17

Japan (Tokyo)

neo-jp1

https://jp1.hana.ondemand.com

Link

157.133.150.0/24

Trial account

Europe (Rot) Trial

neo-eul-trial

https://hanatrial.ondemand.com

Link

155.56.128.0/17

Note down the host from the above table. This will be the Host/IP of the eG SAP Neo component.

Example :

If your account is in Japan (Tokyo) region, then host must be jp1.hana.ondemand.com (refer the table above). If the account is a trial account, then Host is hanatrial.ondemand.com. For our example, the Host for the trial account has been added (see Figure 6).

Figure 6 : Host Parameter details for trial account

For identifying the Subaccount in SAP Neo environment, navigate to Overview tab in SAP Cloud Platform Cockpit (see Figure 7).

Figure 7 : Subaccount information in Overview Menu of SAP Cloud Platform Cockpit

Note down the Name of the Subaccount. You will need to provide the name of this subaccount while configuring the details for Subaccount parameter in the eG Specific Test Configuration page (see Figure 8).

Figure 8 : Subaccount parameter in specific test configuration page

Determining the Name of the HTML5 Applications to be Monitored

For configuring the tests for HTML5 applications, you need to know the names of the HTML5 applications that need to be monitored. To identify HTML5 Applications in SAP Neo environment, navigate to Applications menu -> HTML5 Applications sub menu in SAP Cloud Platform Cockpit (see Figure 9).

Figure 9 : HTML5 application name in Applications Menu of SAP Cloud Platform Cockpit

Note down the name of HTML5 Application (see Figure 9). For our example, the name of HTML5 Application is sampleapp . You will need to provide the name of this HTML5 application while configuring the Html5 Application Status Test (see Figure 10).

Figure 10 : HTML5 Application Names parameter in specific test configuration page

Determining the Name of the HANA XS Applications to be Monitored

For configuring the tests for HANA XS applications, you need to know the names of the HANA XS applications that need to be monitored. For this, navigate to Applications menu -> HANA XS Applications sub menu in SAP Cloud Platform Cockpit (see Figure 11).

Figure 11 : HANA XS Application name in Applications Menu of SAP Cloud Platform Cockpit

Note down the name of HANA XS application (see Figure 11). For our example, the name of HANA XS Application is hanaapp. Then, make sure that you configure the eG test monitoring HANA XS applications with the name of this application (see Figure 12).

Figure 12 : HANA XS Application Names parameter in specific test configuration page

Determining the Name of HANA/ASE Databases to be Monitored

For configuring the tests for HANA/ASE Databases, you need to know the names of the HANA/ASE Databases that need to be monitored. To identify HANA/ASE Databases in SAP Neo environment, navigate to SAP HANA/SAP ASE menu -> Database System sub menu in SAP Cloud Platform Cockpit (see Figure 13).

Figure 13 : HANA/ASE Database name in SAP HANA/SAP ASE Menu of SAP Cloud Platform Cockpit

Note down the name of HANA/ASE Database. For our example, the name of HANA/ASE Database is hana64. Then, make sure that you configure the eG test monitoring HANA/ASE Database with the name of this database (see Figure 14

Figure 14 : Database Names parameter in specific test configuration page