Tyk v2.2 Documentation Components

  1. Home
  2. Tyk v2.2 Documentation Components
  3. Uptime tests: Initial configuration

Uptime tests: Initial configuration

To configure uptime tests, add the relevant section to your tyk.conf:

"uptime_tests": {
    "disable": false, // disable uptime tests on the node completely
    "config": {
        "enable_uptime_analytics": true,
        "failure_trigger_sample_size": 3,
        "time_wait": 300,
        "checker_pool_size": 50
  • disable: When set to false this tells Tyk to run uptime tests, if you do not want any uptime tests to run on a node, set it to true and they will be disabled on those nodes (this could be useful if you are running uptime tests in a separate group of Tyk instances).
  • enable_uptime_analytics: Tyk supports the recording of the data that is generated by the uptime tests, these can then be tabulated in the dashboard. Set to true to enable uptime analytics. However, since uptime tests run constantly, they can generate large amounts of data, for some users who do not wish to manage this data, they can disable it by setting this value to false.
  • failure_trigger_sample_size: Here we tell Tyk to trigger a HostDown or HostUp event after the test has failed or passed a set number of times; 3 in this example. Setting the number to higher values can protect against false positives, but can increase lead incident time due to the verification.
  • time_wait: The number of seconds between running tests. In this example it is set to 300 seconds.
  • checker_pool_size: The worker pool for uptime tests. In this example we have configured Tyk to keep 50 idle workers in memory to send tests to, in other words, with this configuration, you are pretty much guaranteed asynchronous testing for up to 50 tests.