Monitor Latency Using Our API

In this example we do the following:

  1. Start a test execution
  2. Wait for it to finish. If the median latency (technically time until the first byte is received) while running rises above 1 second after we have at least 5 results, stop the test immediately.
  3. Save all results to a CSV.

It assumes you have already created a test configuration and scenario via the API or website first and have the trigger URL for the configuration available. See the concepts, new configuration guide, new scenario guide, configuration API, and scenario API for more details.

A trigger URL is required in the first API call below.


echo "[$(date)] Start a new execution for existing trigger"
execution_id=$(curl -X POST --silent | jq -r ".id")

# This next part keeps checking the median first received latency once we have 5 results until the test is done.
# If it goes above 1 second it stops execution.

echo "[$(date)] Waiting for execution to complete (view online at$execution_id)"
echo "[$(date)] Will stop execution if the median latency (first byte received) goes above 1 second"
while : ; do
  echo -n "."
  sleep 5
  details=$(curl -H "X-Testable-Key:$API_KEY" --silent$execution_id)
  running=$(echo "$details" | jq -r ".running")
  if [[ $running = "true" ]]; then
    count=$(echo "$details" | jq -r ".summary.count")
    latency=$(echo "$details" | jq -r '.summary.metrics | .[] | select(.metricDef=="firstReceivedMs") | .metricValueMap.p50')
    if [[ $count > 5 && $latency > 1000 ]]; then
      echo "[$(date)] Median latency up to $latency ms, stopping execution"
      curl -H "X-Testable-Key:$API_KEY" -X PATCH --silent$execution_id/stop &>/dev/null
      echo "[$(date)] Stopped execution"
  [[ $(echo "$details" | jq -r ".completed") = "false" ]] || break

epoch=$(date +"%s")
echo "[$(date)] Storing CSV results at results-$epoch.csv"
curl -H "X-Testable-Key:$API_KEY" --silent$execution_id/results.csv > results-$epoch.csv