TCP | OpsRamp Documentation

TCP synthetic monitor connects to the target IP address on a given port and monitors the time taken for the connection.

Configure parameters of TCP synthetic monitor

Enter the follwoing details to configure the TCP synthetic monitor:

Section	Field Name	Description	Values/Example	Field Type
Basic Details	Name	Enter a name for the synthetic monitor.		Text
	Type	Select the type of synthetic monitor.	TCP	Dropdown
TCP Configuration	Host	Enter the IP address/host name of the synthetics. It should be accessible from Gateway.	10.1.2.3 www.google.com	Text
	validateSSL	Enable to validate the SSL.		Checkbox
	Connection Timeout	Maximum time-out to connect to the TCP server.	Default value: not NULL Valid values: 1 - 540 seconds Example: 280	String
	Port	Enter the port number of the TCP server to communicate with OpsRamp's endpoints. It should be accessible from Gateway.	Default value: 0 Valid values: 0 - 65535 seconds Example: 25	String
	Response Should Contain	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	String
	Response Should Not Contain	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 >	String
	Message To send	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	String
Locations	Public Locations	Select the public locations where the monitor will run.	INT Public1	Checkbox
	Private Locations	Select the private locations where the monitor will run.	INT Private1	Checkbox

After configuring, view metrics, and graphical representations for more information.

Graphical metrics representation

Supported metrics

Metric Name	Units
availability.down.location.count Location Count. Number of locations where the configured host is down	-
synthetic.response.time Response time. Time taken to connect to the port of the target TCP server	milliseconds