# Web Check
This package monitors a Web server Availability and Response Time using ServicePilot Agent.
This package automatically configures the ServicePilot Manager to collect statistics from a Web Server using the ServicePilot Agent by checking Server Response Time to HTTP(S) requests.
Network Flows - It is is necessary to ensure network connectivity between ServicePilot and the monitored device. In case of a network infrastructure using a firewall, all the ports below must be opened:
- TCP/80 (Default) (HTTP): Between ServicePilot Agent and Web Server
- ServicePilot Manager minimum version: 8.5
- ServicePilot Agent minimum version: 8.5 installed and configured
Before adding a resource to monitor, make certain that all pre-requisites are in place and that ServicePilot Agent is communicating correctly with the ServicePilot Manager.
Add resource using Views Configuration web interface
- As an administrative user of ServicePilot, open the ServicePilot web interface.
- Navigate to Administration. The Configuration > Views web page will open.
- Click on the view in which to place the new resource in the Views hierarchy on the left of the interface. The View editor section will show the existing view contents.
- From the Packages list on the right of the interface, click and drag the application-webcheck package into the View editor and let go.
- The Resource properties dialog box will open to allow resource configuration.
- Click OK to close the Resource properties dialog box. Note that the dialog box will not close if required parameters are not set.
- Click Save to apply the new resource to ServicePilot configuration.
- Check if the object has been created in your map and that indicators are populated after a few minutes.
|Object Type||License object Consumed||Condition|
Key field notes
In the Monitoring Policies tab, specify the policy or policies to apply to the resource
Basic Parameters tab:
- Web site URL: The full URL of the web page to request. The DNS name will be resolved by the server running the ServicePilot Agent.
- Extra Request headers: Request header key: value pairs to include when making HTTP or HTTPS requests. Specify these one per line is they would be found in an HTTP request header section.
- Method: Select between GET or POST HTTP request methods
- POST request body text: When making a POST request, body text can be sent to the web server
- Polling Interval (sec): Time interval (in seconds) at which ServicePilot will poll the web server (default 60)
HTTP Authentication tab:
- HTTP Login: Username or DOMAIN\User (if the user is a Windows domain user). This is only required if the web server requires HTTP authentication to return the web data.
- HTTP Password: Password for the HTTP Login user specified. This is only required if the web server requires HTTP authentication to return the web data.
Web Proxy tab:
- Proxy IP address: If a web proxy is required to reach the web server specified in the URL then set the web proxy IP address to use
- Proxy Port: If a web proxy is required to reach the web server specified in the URL then set the web proxy IP port number to use.
- Proxy User ID: If the web proxy requires login credentials then specify the proxy user id required
- Proxy Password: If the web proxy requires login credentials then specify the proxy password required
- Proxy Domain: If the web proxy requires a domain for the proxy user id then set this domain name
Indicator Extraction tab:
- Indicator Extraction Type: It is optionally possible to extract indicators from the web page returned by the web request made. Indicator data may be extracted by matching based on a list of pattern definitions or by using a regular expression.
- Data #: A comma separated list of elements used to search of an indicator in the resulting web page. The first element is a quoted search string. The second parameter is the number of delimiters from 0 upwards to skip after the search string. The third parameter is the length of the element to extract (set to 0 to take characters between two delimiters). The next parameter is yes if numeric conversion is requested or no otherwise. The last parameter is a | separated list of hexadecimal ASCII character codes defining the delimiters.
- Regex: A regular expression pattern match. The brackets in the pattern match will be used to fill in the indicator number specified by the ? placeholders. Indicators available are i6 and i7.
Test HTTP Response tab:
- Expected HTTP return code: Web servers will respond with a return code that indicates if the request succeeded or an error occured. Indicate the expected HTTP return code for the web request made. The value can include a * if multiple responsed are acceptable.
- Validate HTTPS certificate chain: Should the ServicePilot Agent check the validity of the HTTPS certificates provided by the web server when making HTTPS web requests
- Expected value for Data #: Optionally check to see if the indicator value found in the web page maches this value. An alarm will be raised if this field is filled in and the values do not match.