API Test with TCP

The TCP tests API allows you to send TCP packets to servers running services with the TCP protocol, allowing you to test whether TCP connections are established or not.

To perform API Test creation with TCP method, follow the instructions below:

1. Log in to vMonitor Platform here.

2. Select the Synthetic test folder .

3. Select API test.

4. Select Create an API test.

5. Enter information including:

• Test Information: define basic information, select TCP method and specify hostname to test

  • Test name: name of the API test

  • Test type : test protocol, you choose TCP

  • Hostname: select the server or device you need to check, can be domain name or IP address

  • Port : select the Port you want to check.

• After filling in the Test Information, you can choose Run Test or Test Again if you have tested before to check, you can see returned information such as whether TCP was successful or not, latency.

• Test Assertion

  • Assertion defines what you expect about the API Test results. If the returned results meet what you define, API Test will show that the hostname you are testing is successful, and vice versa, API Test will show that the hostname you are testing is successful. test is failed. The system will automatically add Assertion for you after you Run the test, you need to define at least one Assertion for the API test

• Location

  • Select the Location that will run TCP Tests to your hostname. TCP tests can be run from both Public Locations (managed by VNG Cloud) and Private Locations (installed and managed by customers) based on your needs for running tests from outside (internet) or inside the network. your. Public Locations managed by VNG Cloud currently has 2 locations: HCM and Hanoi.

• Alarm conditions: Set up alarm conditions to define the cases where you want the test to fail and trigger the alarm.

  • Interval : how often API Test will test once, default will be 1p

  • Time of failure : how many consecutive failures will alert

  • Locations with failure : how many locations fail to warn

  • For example, when you select Time of failure: 1 and Locations with failure: 2, it will be understood as: you will be warned if the Test fails 1 time in a row from 2 out of 2 locations.

  • Notifications : you choose notification channels when switching to In-alarm, Up or Undertermine states, the system will notify according to this list.

6. Then press the " Create " button to initialize the API test. After creating, you will see the API test is in Undertermine state, until the next inteval the Test API will be updated to the correct state.

• API Test has entered the Up state when the hostname is working normally