HTTP Response Test

REST server is the perfect and simple option for backing up and synchronizing your data in a secure way. The REST server performs backend operations using REST backend API via the target URL. The backup and sync operations performed by the target server should be seamless and fast enough to ensure peak performance. If any slowdown is detected due to server/web site unavailability and slow responses from the web site, then the data integrity will become questionable. This will adversely impact the user productivity and experience. Therefore, administrators should continuously track the availability and responsiveness of the server so as to ensure uninterrupted operations. This is what the HTTP Response test exactly does!

Using this test, administrators can check the server availability and responsiveness of the REST URL that is being configured for monitoring.

Target of the test : A REST server

Agent deploying the test : An external Agent

Outputs of the test : One set of results for the REST server being monitored

Configurable parameters for the test

Parameter	Description
Test Period	How often should the test be executed.
Host	The IP address of the host for which this test is to be configured.
Port	Refers to the port at which the specified host listens to. By default, this is NULL.
Rest URL	This test helps you to determine the availability and responsiveness of a specific web site on the web server. To enable this, you need to configure the test with the URL of the web page that it should access. Specify this URL against the Rest URL parameter. For example: http://192.168.58.78/isearch-admin/api/leap_sync/leap_sync_switch.
KeyValueMapping	eG Enterprise generates alerts based on the response received from the URL specified against the Rest URL field. For this purpose, the response from the URL should be mapped to a number value so that eG would apply the thresholds to send the alerts to the user. Lets say, the responses received from the URL are SYNC_OFF and SYNC_ON, these values may be mapped to 100 and 50, respectively. Now, you should configure the KeyValueMapping field in the following format: SYNC_ON:100,SYNC_OFF:50,default:0
ProduceDebugLog	By default, this parameter is set to false indicating that this test will not create log files that contain information required for troubleshooting. However, if you want to generate the log files for troubleshooting purpose, then, set this parameter to true.

Measurements made by the test

Measurement	Description	Measurement Unit	Interpretation
Web site availability	Indicates whether the web site is available or not.	Percent	The value 100% for this measure indicates that the site is available, and the value 0 indicates that it is not.
Web server availability	Indicates whether the web server is reachable or not.	Percent	The value 100% for this measure indicates that the web server is reachable, and the value 0 indicates that connection to the web server failed.
Response received	Indicates the number of responses received from the Rest URL.	Number
Response code	Indicates the response code that the server returned when the Rest URL was accessed.	Number	Typically, 2xx codes indicate success. The 4xx codes are intended for cases in which the client may have erred, and the 5xx codes for the cases in which the server is aware that it has erred. 3xx codes indicate action to be taken (normally automatically) by the client in order to fulfill the request.
Connection time	Indicates the time taken to establish a connection to the web server.	Milliseconds	A low value is preferred for this measure.
Data transfer time	Indicates the time taken for a data transfer between the web site and the web server.	Milliseconds	A high value for this measure denotes an issue in data transmission.
Total response time	Indicates the total time taken by the Rest URL to respond.	Milliseconds	The value of this measure is should be low.