BTP CF Application Logs Test

Loggregator is a Cloud Foundry component responsible for logging that provides a stream of log output from your application and from Cloud Foundry system components that interact with your application during updates and execution. Cloud Foundry gathers and stores logs in a best-effort manner.

The BTP CF Application Logs 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 router time 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 BTP Cloud Foundry Environment

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for each Space:Application in the target SAP BTP Cloud Foundry Environment.

Configurable parameters for the test
Parameter	Description
Test Period	How often should the test be executed
Host	Host name of the server for which the test is to be configured.
PortNo	Enter the port to which the specified host listens. By default, this is 443.
Organization Name	In SAP BTP Cloud Foundry environment, an organization is a development account that an individual or multiple collaborators can own and use. All collaborators access an organization with user accounts which have different roles. So you can mention such name of the Organization in the Organization Name text box. To know how to determine the Organization Names, refer to Identifying the API Endpoint URL, Organization Name and Spaces topic in Pre-requisites for Monitoring SAP BTP Cloud Foundry Environment.
Exclude Spaces	A space in SAP BTP Cloud Foundry environment provides users with access to a shared location for application development, deployment, and maintenance. An organization can contain multiple spaces. For collecting metrics from the target environment, you need to decide on which of these spaces to be excluded and those names of the spaces to be provided as comma separated values in the Exclude Spaces text box. By default, it is none.
User ID	Specify the User ID (alias User Name) as already enrolled as an user for creating SAP user account.
Password	Specify the password of the specified User ID.
Confirm Password	Confirm the password by retyping it here in the Confirm Password text box.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.
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 logs	Indicates the total number of logs in this application.	Number
Total error logs	Indicates the total number of error logs in this application.	Number
Total logs rate	Indicates the rate at which the total logs were created in this application.	log/min
Total RTR logs	Indicates the total number of RTR logs in this application across all spaces in a particular organization.	Number	The Gorouter emits RTR logs when it routes HTTP requests to the application. Gorouter messages include the name of the application followed by a Gorouter timestamp and selections from the HTTP request.
Total API logs	Indicates the total number of API logs in this application across all spaces in a particular organization.	Number	Users make API calls to request changes in app state. The Cloud Foundry component is responsible for the APIs that logs the actions that Cloud Controller takes in response.
Total CELL logs	Indicates the total number of CELL logs in this application across all spaces in a particular organization.	Number	The Diego Cell emits CELL logs when it starts or stops the application. These actions implement the desired state requested by the user.
Total SSH logs	Indicates the total number of SSH logs in this application across all spaces in particular organization.	Number	The Diego Cell emits SSH logs when a user accesses an application container through SSH by using the Cloud Foundry Command Line Interface (cf CLI) cf ssh command.
Total APP logs	Indicates the total number of APP logs in all applications across all spaces in a particular organization.	Number	Every application emits logs according to choices by the developer.
Total LGR logs	Indicates the total number of LGR logs in this application across all spaces in a particular organization.	Number	Loggregator emits LGR to indicate problems with the logging process.
Total STG logs	Indicates the total number of STG logs in this application across all spaces in a particular organization.	Number	The Diego Cell or the Droplet Execution Agent emits STG logs when staging or restaging an application. These actions implement the desired state requested by the user. After the droplet has been uploaded, STG messages end and CELL messages begin. For STG, the instance index is almost always 0.
Total other logs	Indicates the total number of other logs in this application across all spaces in a particular organization.	Number	Apart from above RTR, API, CELL, SSH, APP, LGR and STG log type, remaining logs are showed as other logs.
RTR error logs	Indicates the total number of RTR error logs in this application across all spaces in a particular organization.	Number	The Gorouter emits RTR logs when it routes HTTP requests to the application, number of client and server error logs from HTTP response.
API error logs	Indicates the total number of API error logs in this application across all spaces in a particular organization.	Number	Users make API calls to request changes in app state. Cloud Controller, the Cloud Foundry component responsible for the API, error logs the actions that Cloud Controller takes in response. The detailed diagnosis of this measure provides the details like Timestamp and Message.
CELL error logs	Indicates the total number of CELL error logs in this application across all spaces in a particular organization.	Number	The Diego Cell also emits messages when an app crashes. The detailed diagnosis of this measure provides the details like Timestamp and Message.
SSH error logs	Indicates the total number of SSH error logs in this application across all spaces in a particular organization.	Number	The Diego Cell emits SSH error logs when a user accesses an app container through SSH using the Cloud Foundry Command Line Interface (cf CLI) cf ssh command. The detailed diagnosis of this measure provides the details like Timestamp and Message.
APP error logs	Indicates the total number of APP error logs in this application across all spaces in a particular organization.	Number	Every app emits some error logs according to choices by the developer. The detailed diagnosis of this measure provides the details like Timestamp and Message.
LGR error logs	Indicates the total number of LGR error logs in this application across all spaces in particular organization.	Number	Loggregator emits some LGR error to indicate problems with the logging process The detailed diagnosis of this measure provides the details like Timestamp and Message.
STG error logs	Indicates the total number of STG error logs in this application across all spaces in a particular organization.	Number	The Diego Cell or the Droplet Execution Agent emits some STG error logs when staging or restaging an app. These actions implement the desired state requested by the user. After the droplet has been uploaded, STG messages end and CELL messages begin. For STG, the instance index is almost always 0. The detailed diagnosis of this measure provides the details like Timestamp and Message.
Other error logs	Indicates the total number of other error logs in this application across all spaces in a particular organization.	Number	Apart from above RTR, API, CELL, SSH, APP, LGR and STG log type, remaining error logs are showed as other error logs The detailed diagnosis of this measure provides the details like Timestamp and Message.
2XX status logs	Indicates the number of HTTP 2XX response code status logs from this application's URL.	Number	2xx successful – the request was successfully received, understood, and accepted.
3XX status logs	Indicates the number of HTTP 3XX response code status logs from application's URL.	Number	3xx redirection – further action needs to be taken in order to complete the request.
4XX status logs	Indicates the number of HTTP 4XX response code status logs from this application's URL.	Number	4xx client error – the request contains bad syntax or cannot be fulfilled. The detailed diagnosis of this measure provides the details like Timestamp,Method,Protocol,Response status,Request,Request host,User agent,Dest ip and port,X forwarded for,X forwarded proto,Vcap request id,Response time(milliseconds),Gorouter time(milliseconds),Application id,Application index,Router error,Correlation id,Tenant id,Sap passport,Scp request id,Application instance,Trace id,Span id and Parent span id.
5XX status logs	Indicates the number of HTTP 5XX response code status logs from this application's URL.	Number	5xx server error – the server failed to fulfil an apparently valid request. The detailed diagnosis of this measure provides the details like Timestamp,Method,Protocol,Response status,Request,Request host,User agent,Dest ip and port,X forwarded for,X forwarded proto,Vcap request id,Response time(milliseconds),Gorouter time(milliseconds),Application id,Application index,Router error,Correlation id,Tenant id,Sap passport,Scp request id,Application instance,Trace id,Span id and Parent span id.
Response time	Indicates the HTTP response time from this application's URL.	milliseconds	Response Time is the total time taken for the request to go through the Gorouter to the app and for the response to travel back through the Gorouter. This includes the time that the request spends traversing the network to the app and back again to the Gorouter. It also includes the time the app spends forming a response.
Router time	Indicates the HTTP router time from this application's URL.	milliseconds	Gorouter Time is the total time taken for the request to go through the Gorouter initially plus the time it takes for the response to travel back through the Gorouter. This does not include the time the request spends traversing the network to the app. This also does not include the time the app spends forming a response.