The web services section displays the configured Synthetic monitors.
Once you create a web service monitor, you can click the desired monitor to view details such as
Overview, Metrics, and Monitors
Dashboards
The dashboard displays the total number of configured web services,
the status of each web services configured in Infrastructure page, Add, Delete button, and a Refresh button.
Status of web services
Status of Synthetics
Field
Description
Indicates the total number of web monitors created in OpsRamp
Indicates the number of web monitors that are up and running
Indicates the number of monitors that have Open, Warning or Critical alerts
Indicates the number of monitors for which the Template Thresholds aren't configured and are facing issues
Click to add web service monitors
Click to Delete web service monitor
Click to refresh the Synthetic items
To search for any Synthetic monitor
Important
Availability is calculated based on the configured Component Thresholds of monitors in templates for every Synthetic.
When you do not configure component thresholds for availability or response time,
the availability is displayed as Unknown (Grey color) even when the website is down.
Overview
Overview displays various details like basic information, metric type, availability log and recent log.
Overview
Metric type
Metric type displays a graphical representation of each metric for a selected web service monitor.
Basic information
Basic Information section displays the fundamental information about the selected web service monitor. For example, the type of web service monitor, the time period since the web service monitor is UP/DOWN, Response Time (if any), configured URL, Frequency, Locations, and Service.
Availability log
Availability Log section displays the log details of the availability status (Up or Down) for the selected web service monitor. The Availability Log section displays a view Root Cause icon when the availability status of the web service monitor is Down. The view Root Cause displays the root cause for the unavailability of the Synthetic monitor.
Availability Log
View root cause
To view Root Cause in Availability Log:
From the Availability Log section, click view Root Cause. Last Collected Root Cause Analysis window appears.
From Last Collected Root Cause Analysis window, analyze the below details from the configured location.
Analysis started time – The Root Cause Analysis (RCA) collection start time.
Analysis ended time – The RCA collection end time.
Analysis elapsed time – The time taken to perform the RCA.
Initial Validation – Displays the reason for the Down availability status for the selected Synthetic monitor.
TraceRoute Test – Displays details that allow you to debug the issue.
Last Collected RCA
TraceRoute test
The TraceRoute Test section focuses on the reachability of the host from a configured location. The status of the web service monitor displays Down (red color) when the configured host is inaccessible from the configured location in the OpsRamp Console. The TraceRoute Test information helps you to analyze and track the exact point of failure.
Traceroute Test
The TraceRoute Test section displays the following details:
Route Info – The path taken by packets from the configured location to the host.
Error Log – Displays that Traceroute is a failure.
Important
TraceRoute Test supports only 30 hops maximum and 60-byte packets.
Recent log
Recent Log displays information about the recently collected metrics.
Attributes
Attributes display all basic information on the configured web service monitor.
Attributes
Location availability
Location availability highlights the uptime or downtime of a web service monitor from each location.
HTTP test
For HTTP/HTTPS monitors, OpsRamp provides HTTP Response Headers and HTTP Raw Response Time to identify the issue that makes your website unavailable at a location. The HTTP Test section displays the following:
URL: Refers to the URL of the website.
Method: Refers to the REST method of the connected website.
Status Code: Refers to the HTTP response code or Libcurl error code of the Website.
Response Headers: Refers to the HTTP response headers of the website.
Raw Data Response: Refers to the HTTP response provided by the website.
Status: Refers to the success or failure of the test.
HTTP Test
Monitors
Displays templates and monitors assigned to the configured web service monitor.
Templates
Displays the templates available for the selected web service monitor. You can assign templates to enable the monitoring of your web services using the Assign Templates option. You can also implement a device management policy on specific web service resources.
Important
To create a device management policy, you can filter web services either using web service
Name or Type when applying Resource filters as Filter Criteria.
For example, to apply HTTPS templates, select HTTPS as Synthetic Type for the resource type Web Services.
Filter Criteria - Device Management Policy
You can use the following Web Service types to filter:
HTTPS
HTTP
TCP
PING
UDP
DNS
SMTP
POP3
IMAP
SCRIPT
SSL
FTP
SIP
RTT
Assigning templates
OpsRamp can start monitoring only after assigning the templates to your web service monitor. You can assign only one template per web service monitor. Monitoring does not work as expected if you assign more than one template.
Important
You can assign templates that pertain to a specific web service monitor. For example, you can assign DNS Templates to DNS web service monitors and not to PING web service monitors.
You can create templates using Setup > Monitoring > Templates.
Notes
You can select the following basic details while creating a template:
Collector Type: Web Service
Applicable For: Web Service
Type: Select the desired web service monitor
To receive alerts for configured metrics from all the configured locations assigned to a template, you must enable the Alert option and configure the Component Threshold for each metric while creating the template.
To assign templates:
From Templates, click Assign Templates. Apply Templates screen is displayed.
Apply Templates
From Select Templates > Available templates, select the desired templates. Selected templates display the chosen templates.
Click Assign. Enter Configurations section is displayed.
Enter Configurations
Provide Value for the Assigned Templates and Configuration Parameters and click Submit.
Configuration Parameter and Value
The templates screen displays the selected templates.
The following table describes the configuration parameters for each monitor:
Configuration Parameters for Web Service Monitors
Web Service Monitor
Configuration Parameters
Description
Example
HTTP/HTTPS
Connection Timed Out
Maximum time out required to connect to the given website.
Check the presence of any text in the response of the URL.
True
Response Should Not Contain
-
Check the absence of any text string in the response of the URL.
Null
Method
-
Type of method to execute while monitoring the website.
GET
Validate SSL
-
Validate the SSL certificate of the URL under consideration. Important: This option lets you validate only the last redirected website.
-
DNS
Connection Timed Out
Maximum time out to resolve the DNS Query.
5
Expected Server
-
The expected IPV4 address.
1.2.3.0
Name Server
-
Converts the English URL to physical IP Address.
8.8.8.8
PING
Connection Timed Out
Maximum time out to verify the accessibility of the chosen host.
5
TCP
Connection Timed Out
Maximum time out to connect to a given port of the TCP server.
5
Days
-
Configure the number of days to set notification regarding the SSL expiry in the Days field.
10
Port
-
Port number of TCP port. You must manually configure the port number.
443
Response Should Contain
-
Check the presence of any text string in the response of the TCP server.
True
Response Should Not Contain
-
Check the absence of any text string in the response of the TCP server.
Null
Command/Message to Send
-
The command that is sent to the TCP server.
Tokens
Validate SSL
-
Validate the SSL certificate of the URL under consideration.
Important: This option lets you validate only the last redirected website.
-
UDP
Connection Timed Out
Maximum time out to connect to a given port of the UDP server.
5
Port
Port number of UDP port. You must manually configure the port number.
80
Response Should Contain
Check the presence of any text string in the response of the UDP server.
true
Response Should Not Contain
Check the absence of any text string in the response of the UDP server.
null
Command/Message To Send
The command that is sent to the UDP server.
tokens
IMAP
Connection Timed Out
Maximum time out to connect to the IMAP server.
5
Port
-
Port Number of IMAP server.
993
POP3
Connection Timed Out
Maximum timeout to connect to the IMAP server.
5
Port
-
Port Number of POP3 server.
110
SMTP
Connection Timed Out
Maximum time out to send an email through the SMTP server.
5
Port
-
Port Number of SMTP. The default port number is 587. However, if you wants to configure SMTP Web Service Monitor with different port numbers: 465, 25; then you must configure those port numbers manually.
587
Command/Message To Send
-
The message that is sent to the SMTP server.
Tokens
Recipient Email Ids
-
The Email IDs of the recipients.
abc@gmail.com
RTT
Connection Timed Out
Maximum time out to perform the RTT monitoring.
5
Port
-
Port number for SMTP.
587
Receiver Host
-
IMAP/POP3 hostname.
pop.gmail.com
Receiver Host Port
-
IMAP/POP3 host port number.
995
Email Receiver Type
-
IMAP/POP3 host port number.
IMAP
SSL
Connection Timed Out
Maximum time out to connect to a host or a website.
5
Days
-
Checks the number of days remaining for the expiry of the SSL Certificate.
10
FTP
Connection Timed Out
Maximum timeout to connect to the FTP server.
4
Port
-
Port number of the FTP server.
21
SCRIPT – HTTP Synthetic Transaction Web Service Monitor
Connection Timed Out
Maximum time out to complete the synthetic transaction.
5
Script Type
-
Provide content from the .side file.
-
Unassigning templates
You can remove an assigned template from the monitor. Use the Unassign Templates option to unassign the templates from the web service monitors. OpsRamp removes every graph associated with the templates.
Unassign Templates
Monitors
Monitors allow you to configure alerts and edit threshold values assigned to any metric in the selected web service monitor.
Monitors
Availability rule
Availability lets you configure rules to confirm the status of the resources with the availability check depending on the critical alerts received for the metrics.
Availability Rule
After clicking Availability Rule, select one of the following options to determine the status of the resource:
Resource is Up if ALL availability monitors are OK, Resource is Down otherwise
Resource is Up if ANY availability monitor is OK, Resource is Down otherwise
Parameters
Parameters display the parameters migrated from web services to the Monitoring Templates section. You can modify the values for the migrated parameters of the selected web service monitor.
Parameters
Metrics
Metrics displays a pictorial representation of all metrics configured in the assigned templates.
Synchronize tooltips
Synchronize Tooltips
Tooltip
Description
Enable or disable tooltips.
Decrease (S) or Increase (L) the size of the graphical representations for each metric.
Credentials
Credential Set enables you to create or assign credentials to your web service monitors.
You can use these credentials to mask plain text usernames and passwords in the web services script.
Notes
Notes enable you to record special instructions for any web service monitor under consideration.
Notes
To add Notes:
Click Add displayed on Notes window.
On the Notes window, provide the required details.
Click Save.
You can modify existing notes from the Notes window using Edit Notes.
Articles
Articles display notes tagged to the configured web service monitor.
Articles
ADD/MODIFY
The ADD/MODIFY option allows you to add or remove articles for the selected web service monitor.
To ADD/MODIFY articles:
Click ADD/MODIFY. The Articles window appears.
Select the check-box of desired articles from the Articles window.
Click Add. Articles section displays the selected articles.
