Tyk v2.2 Documentation Components

HomeTyk v2.2 Documentation ComponentsUptime 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

What does the above configuration do?

  • "disable": false – This tells Tyk to run uptime tests, if you do not want any uptime tests to run on a node, select “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": true – Tyk supports the recording of the data that is generated by the uptime tests, these can then be tabulated in the dashboard. 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": 3 – Here we tell Tyk to trigger a HostDown or HostUp` event after the tests has failed or passed at least three times (this can protect against false positives, but can increase lead incident time due to the verification)
  • "time_wait": 300 – Run the tests every 300 seconds
  • "checker_pool_size": 50 The worker pool for uptime tests, here we say that yk should 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.
Was this article helpful to you? Yes No