HANA XS Applications Log Test

For each application deployed on SAP HANA XS Advanced system , this test periodically searches the application logs for specific patterns of error/general information/status messages and reports the count and nature of such messages, so as to enable administrators to troubleshoot better. This test also reports the response size and response time of the application towards the requests. Using this test, administrators can determine the application that is frequently prone to errors.

Target of the test : A SAP HANA XS advanced Application server

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each space:application on the target server being monitored.

Configurable parameters for the test
Parameter Description

Test period

How often should the test be executed

Host

The host for which the test is to be configured.

Port

The port number at which the specified Host listens to. By default, this will be 30015.

Organization

Specify the name of the Organization that contains the spaces in which the applications are deployed on HANA XS in this text box. Example: org

Spaces

Specify a comma-separated list of Spaces for the specified Organization in HANA XS in this text box. The Spaces specified in this text box need to be included for monitoring. Example: SAP,PROD

XS Path

Specify the full path to the location where the HANA XS is installed in this text box. Example: /HANA/shared/HDB/xs/bin/

CLI User

Typically, to connect to a HANA XS and run tests, the eG agent requires the permissions of a HANA XS client user who has been assigned the role collections as XS_CONTROLLER_ADMIN_READ_ONLY, also assigned the OrgAuditor, SpaceAuditor roles for specified organization and spaces. Ideally, you will have to create a new user role on the HANA XS for this purpose, associate the above-mentioned collections with that role, and assign the new role to an existing HANA XS client user. Once the new role is assigned to a HANA XS client user, specify the name of this user against CLI User text box.

Example: To create user as XSA_ADMIN2. Execute below query in SAP HANA studio.

CREATE USER XSA_ADMIN2 PASSWORD “admin”;

Assign roles for HANA XS CLI user using HANA XS Client commands mentioned below:

  • xs assign-role-collection XS_CONTROLLER_ADMIN_READ_ONLY XSA_ADMIN2;

  • xs set-org-role XSA_ADMIN2 orgname OrgAuditor;

  • xs set-space-role XSA_ADMIN2 SAP SpaceAuditor;

CLI Password

Specify the password of the specified CLI User in this text box.

Confirm Password

Confirm the password by retyping it in this text box.

CLI Location

The XS CLI client tools are installed by default on the SAP HANA server. However, you can also download and install the client tools locally, if you want to connect to SAP HANA from your local machine. Hence, set this flag to Remote or Local based on the location of HANA XS Client.

CLI Endpoint

Specify the URL of the API end point to connect to the XS advanced controller on the SAP HANA server in this text box. Syntax for this CLI endpoint is : https://<Hostname>: 3<Instance Number>30. Example: https://vhcalhdbdb.dummy.nodomain:30030.

Include Applications

Specify a comma-separated list of destination patterns that need to be included for monitoring in this text box. Example:hrtt-service,hrtt-core. By default, this parameter is set to Few Applications.

Exclude Applications

Specify a comma-separated list of destination patterns that need to be excluded for monitoring in this text box. Example:hrtt-service,hrtt-core. By default, this parameter is set to None.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Total messages

Indicates the total number of messages recorded for this application during the last measurement period.

Number

 

Total message rate

Indicates the rate at which messages were recorded for this application during the last measurement period.

Logs/minute

 

Total Routing messages

Indicates the total number of routing messages recorded in the logs for this application during the last measurement period.

Number

 

Total API messages

Indicates the total number of API messages recorded in the logs for this application during the last measurement period.

Number

 

Total Application messages

Indicates the total number of Application messages recorded in the logs for this application during the last measurement period.

Number

 

Total Staging messages

Indicates the total number of staging messages recorded for this application during the last measurement period.

Number

Staging denotes the process of transforming the application files into an executable representation by adding an appropriate runtime environment with an integrated web server.

2XX status messages

Indicates the number of times HTTP requests for this application recorded during the last measurement period.

Number

 

3XX status messages

Indicates the number of times messages of redirecting the HTTP requests for this application recorded during the last measurement period.

Number

 

4XX status messages

Indicates the number of times messages of HTTP client errors for this application were recorded during the last measurement period.

Number

The detailed diagnosis of this measure lists the Created time, Remote IP, Client ID, Username, Host, Port, Request method, Request URL, Status, Response size, and Response time.

5XX status messages

Indicates the number of times messages of HTTP server errors for this application were recorded during the last measurement period.

Number

The detailed diagnosis of this measure lists the Created time, Remote IP, Client ID, Username, Host, Port, Request method, Request URL, Status, Response size, and Response time.

Response time

Indicates the time taken by this application to respond to the requests.

Seconds

 

Response size

Indicates the size of application response.

MB

 

API error messages

Indicates the number of API error messages recorded in the logs for this application during the last measurement period.

Number

Use the detailed diagnosis of this measure to know the created time and message relevant to this error.

Other API messages

Indicates the number of API messages other than error messages recorded in the logs for this application during the last measurement period.

Number

 

Application error messages

Indicates the number of Application error messages recorded in the logs for this application during the last measurement period.

Number

Use the detailed diagnosis of this measure to know the created time and message relevant to this error.

Other application messages

Indicates the number of Application messages other than error messages recorded in the logs for this application during the last measurement period.

Number

 

Staging error messages

Indicates the number of Staging error messages recorded in the logs for this application during the last measurement period.

Number

Use the detailed diagnosis of this measure to know the created time and message relevant to this error.

Other staging messages

Indicates the number of Staging messages other than error messages recorded in the logs for this application during the last measurement period.

Number