A Speedway monitor is basically an API test that hits your API on a regular schedule. It can be a single request, or multiple requests chained together. It's kind of like an API regression test that runs live in production or a test environment, hitting your API with test traffic.
If any operation fails, or doesn't satisfy your custom validation, Speedway will mark that monitor as FAILING and notify you and your team immediately.
When you're ready to create your first monitor, go to your Speedway dashboard and hit the big button that says Add Monitor.
A monitor is a series of steps. The simplest monitors can be a single HTTP request, but more sophisticated monitors chain together multiple requests and process the response to each one dynamically before moving on to the next.
You can create steps manually, or import them from OpenAPI, or record them.
After you configure your monitor with one or more steps, you can designate a scheduled interval for Speedway to run it. The interval can range anywhere from every minute to every 24 hours (some of the more frequent intervals require a paid plan).
Every time your monitor runs, we call it a monitor cycle. With each cycle, Speedway plays through all the steps, and determines if it passed or failed.
It's generally a good idea to run your monitors frequently, so you can find out about problems as soon as possible, but for quieter or less important APIs, less frequent monitoring might be fine.
You can specify one or more locations from which your monitor traffic will originate. With basic plans, you may be limited to a single location per monitor. With paid plans, you can select multiple locations per monitor.
When you select multiple locations, your monitor will run from all selected locations with each cycle. That means if you tell Speedway to run your monitor every 5 minutes, but select 3 locations, it will actually run 3 times every 5 minutes: once from each monitoring location.
At a minimum, we recommend selecting a location that is geographically close to where your users are based. You may notice different response times from different locations, due to network latency, and occasionally you might even discover issues with your API's availability from different global regions.
You can toggle a monitor between active and inactive. When it is active, the monitor will run according to schedule. When it is inactive, Speedway will not run it, but you can still run it manually with the Play button.
Sometimes, when you know one of your API endpoints has changed and you haven't had a chance to update its monitor yet, you may want to temporarily turn off that monitor to spare your team the unnecessary alerts.
Generally, of course, you'll want to leave your monitors in the active state so Speedway can do its thing.