Assign Synthetic Monitor Templates

Important Note

The old UI and its associated documentation are valid until the 2024.08.U1 release. The new UI and its related documentation will apply starting from the 2024.09.U1 release, see (New UI Document).

Prerequisite

Before assigning a template, remember the following points:

You can assign only one template per synthetic monitor. Monitoring does not work as expected if you assign more than one template.
Templates should match the type of synthetic monitor. For example, assign DNS templates to DNS synthetic monitors.
To get 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.
If you make any changes to a synthetics template, remember that the template won’t update automatically. You need to reassign the template to the synthetic resources to apply those changes.
Monitoring starts only after assigning templates to your synthetic monitor.

Create Synthetic Template

Create a template using the following steps:

Navigate to Setup > Monitoring > Templates.
Select the following basic details while creating a template:
- Collector Type: Synthetics
- Applicable For: Synthetics
- Type: Select the type of synthetic
- Template Name: Name of a template

For detailed instructions on how to create a template, refer the documentation.

Assign Synthetic Templates

Assign templates using the following steps:

Select a client from the All Clients list.
Navigate to Infrastructure > Resources > Synthetics.
Choose the synthetic resource you want to assign the template from the list.
Go to Monitor > Template.
Select the template you wish to assign from the list, then click +Assign Templates.
The Apply Templates screen is displayed.
Select the templates from Available Templates list and move them to the Selected Template section using forward arrow symbol.
Click Assign. The Enter Configurations section is displayed.
Enter Value for the Assigned Templates and Configuration Parameters.
Click Submit.

The selected templates are displayed in the templates screen.

Note

You can assign only one template per synthetic monitor. Monitoring does not work as expected if you assign more than one template.

Configuration Parameters of Synthetic Monitor

The following table describes the configuration parameters for each monitor:

Synthetic Monitor	Configuration Parameters	Description	Values/Example
HTTP	Timeout	Connection timed out. Maximum time-out required to connect to the given website.	Default value: not NULL Valid values: 1 - 540 seconds Example: 80
	HttpHeaders	HTTP headers	Default value: empty string Valid values: valid JSON Example: {"Accept":"application/json","Content-Type":"application/json"}
	HttpParams	HTTP parameters	Default value: empty string Valid values: valid JSON Example: {"Content-Type":"application/json"}
	ShouldContain	Response body should contain specific content. Check the presence of any text in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: test <123> _testing # test
	ShouldNotContain	Response body should not contain specific content. Check the absence of any text string in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: test123_sample # testing
	Method	Method. Type of method to execute while monitoring the website.	Default value: GET Valid values: GET, PUT, HEAD, POST Example: GET
	PostData	Post data.	Default value: empty string Valid values: ASCII only Example: name123<123*%#&!>1234567
	Expected Response Code	The response code returned from the end server should be one from the mentioned response codes (which is in csv format).	Default value: NULL (OpsRamp considers 200 and 300 series as default at the backend) Valid values: 100, 200, 300, 400, 500 series response codes Example: 401, 402, 404
	Payload Regular Expression	Create Regex Patterns to validate the HTTP Response body received from the webserver.	Default value: NULL Example: john\|Bat\|check
HTTPS	Timeout	Connection timed out. Maximum time-out required to connect to the given website.	Default value: not NULL Valid values: 1 - 540 seconds Example: 80
	HttpHeaders	HTTP headers	Default value: empty string Valid values: valid JSON Example: {"Accept":"application/json","Content-Type":"application/json"}
	HttpParams	HTTP parameters	Default value: empty string Valid values: valid JSON Example: {"Content-Type":"application/json"}
	ShouldContain	Response body should contain specific content. Check the presence of any text in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: test <123> _testing # test
	ShouldNotContain	Response body should not contain specific content. Check the absence of any text string in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: test123_sample # testing
	Method	Method. Type of method to execute while monitoring the website.	Default value: GET Valid values: GET, PUT, HEAD, POST Example: GET
	SslValidation	Validates the SSL certificate of the URL under consideration. This option validates only the last redirected website.	Default value: False Valid values: True or False Example: FALSE
	PostData	Post data.	Default value: empty string Valid values: ASCII only Example: name123<123*%#&!>1234567
	Expected Response Code	The response code returned from the end server should be one from the mentioned response codes (which is in csv format).	Default value: NULL (OpsRamp considers 200 and 300 series as default at the backend) Valid values: 100, 200, 300, 400, 500 series response codes Example: 401, 402, 404
	Payload Regular Expression	Create Regex Patterns to validate the HTTP Response body received from the webserver.	Default value: NULL Example: john\|Bat\|check
DNS	Timeout	Connection timed out. Maximum time-out to resolve the DNS Query.	Default value: not NULL Valid values: 1 - 540 seconds Example: 5
	ExpectedIp	Expected server address.	Default value: empty string Valid values: ipv4 and ipv6 validation Example: 111.22.333.00
	NameServer	Name server - Converts the English URL to a physical IP Address.	Default value: empty string Valid values: hostname validation, ipv4 validation, and valid url Example: www.google.com, 111.22.333.00
FTP	Timeout	Connection timed out. Maximum time-out to connect to the FTP server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 180
	Port	Port number of the FTP server.	Default value: 0 Valid values: 0 - 65535 seconds Example: 21
PING	Timeout	Connection timed out. Maximum time-out to verify the accessibility of the chosen host.	Default value: not NULL Valid values: 1 - 540 seconds Example: 180
POP3	Timeout	Connection timed out. Maximum time-out to connect to the server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 180
	Port	Port number of the server.	Default value: 0 Valid values: 0 - 65535 seconds Example: 995
IMAP	Timeout	Connection timed out. Maximum time-out to connect to the server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 540
	Port	Port number of the server.	Default value: 0 Valid values: 0 - 65535 seconds Example: 993
RTT	Timeout	Connection timed out. Maximum time-out to do the RTT monitoring.	Default value: not NULL Valid values: 1 - 540 seconds Example: 540
	Port	Port number.	Default value: 0 Valid values: 0 - 65535 seconds Example: 465
	ReceiverHost	Receiver host name.	Default value: empty string Valid values: string Example: pop.gmail.com
	ReceiverHostPort	Receiver host port number.	Default value: 0 Valid values: 0 - 65535 seconds Example: 995
	EmailReceiverType	Email receiver type	Default value: IMAP Valid values: IMAP, POP3 Example: IMAP
SCRIPT	Timeout	Connection timed out. Maximum time-out to connect to the server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 80
	PostScreenshotOnError	Post a screenshot of a failure in the HTTP script synthetic transaction at the time of failure.	Default value: False Acceptable values: True/False Example: FALSE
	PostSuccessScreenshotAlongWithError	Post a screenshot from a previous successful iteration so that you can compare the case that failed with the one that is successful.	Default value: False Acceptable values: True/False Example: FALSE
	WebBrowserType	Option to choose a web browser type to run the HTTP Synthetic Transaction against.	Default value: Google Chrome Acceptable values: Google Chrome, Mozilla Firefox, Microsoft Edge
SMTP	Timeout	Connection timed out. Maximum time-out to send an email through the SMTP server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 540
	Port	Port number.	Default value: 0 Valid values: 0 - 65535 seconds Example: 465
	MessageToSend	The command or message that is sent to the server.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: sample # test < name >
	RecipientList	The Email IDs of the recipients.	Default values: empty string Valid values: Email address with comma separators. Example: abc@gmail.com
SSL	Timeout	Connection timed out. Maximum time-out to connect to the server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 180
TCP	Timeout	Connection timed out. Maximum time-out required to connect to the server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 180
	Port	Port number.	Default value: 0 Valid values: 0 - 65535 seconds Example: 80
	ShouldContain	Response body should contain specific content. Check the presence of any text in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: testing_123
	ShouldNotContain	Response body should not contain specific content. Check the absence of any text string in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: 123 # name_ < string >
	MessageToSend	The command or message that is sent to the server.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: 1234
	SslValidation	Validates the SSL certificate of the URL under consideration. This option validates only the last redirected website.	Default value: False Valid values: True or False Example: FALSE
UDP	Timeout	Connection timed out. Maximum time-out required to connect to the server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 180
	Port	Port number.	Default value: 0 Valid values: 0 - 65535 seconds Example: 37
	ShouldContain	Response body should contain specific content. Check the presence of any text in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: sample.123 #
	ShouldNotContain	Response body should not contain specific content. Check the absence of any text string in the response of the URL.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: Testing123. name< string >
	MessageToSend	The command or message that is sent to the server.	Default value: empty string Valid values: Alphanumeric characters, underscore (_), pound (#), period (.), less than (<), greater than (>), and spaces. Example: name123#

Unassign Synthetic Templates

You can remove an assigned template from the monitor. Use the Unassign Templates option to unassign the templates from the synthetic monitors. Every graph associated with the templates is removed.

Select a client from the All Clients list.
Navigate to Infrastructure > Resources > Synthetics.
Choose the synthetic resource you want to unassign the template from the list.
Go to Monitor > Template.
Select the template you wish to unassign from the list, then click +Unassign Templates.
Confirm the action by clicking Yes in the dialog box.
The selected template will now be unassigned from the synthetic resource.