Probes automatically execute Test Cases at specified intervals, notify you on failures or poor API performance, capture API call details, and graph analytics on API performance and call success rates. (Executing Test Cases with webhooks provides none of these features.)
Creating and configuring Probes is fairly straightforward, and the user interface guides you through the process.
You can also create Probes with the Create a Probe API.
About probe execution
When a Step fails in a probe, the probe stops executing even if more Steps remain. For more information, see "What determines Step success or failure" in Test Cases.
Following is guidance on the different Probe settings you can configure.
Select the Test Case containing the Steps you want the Probe to execute.
If you use Config Set (environment) variables in your Step configurations, select the Config Set containing the variables you want to use in the Step execution.
You can configure different success/failure and performance conditions that trigger alert notifications. For example, you may want to know if a Test Case fails 3 times in a row, or if API performance consistently exceeds a certain threshold.
- Select If failures are at least if you want to be notified after Steps fail a certain number of consecutive times in the probe. Set a number. For example, if you set 3, you'll be notified if step failure in the probe occurs 3 times, regardless of which Step fails. Note that probe execution stops at the first Step failure. For more information, see "What determines Step success or failure" in Test Cases.
- Select If Response Time exceeds (ms) if you want to be notified when the combined response times for all Steps in a probe take longer than the number of milliseconds you specify. For example, if you set 500 ms and 5 times consecutively, you'll be notified if the total response time of all Steps in the probe exceeds 500 ms 6 times in a row.
- Select If Latency Anomaly is detected if you want to be notified when Apigee Test detects uncharacteristically high latency over a period of time.
Configure how you want to be notified. (To see what the alerts look like, see What Apigee Test alerts look like).
- Email: If you select email notifications, enter one or more email addresses separated by commas.
- HipChat: If you select HipChat, you'll need a room name or ID and a notification access token for the room. Contact your HipChat administrator. On the HipChat room administration page, the HipChat admin can generate a "Send Notification" token and get the room ID.
- Slack: If you select Slack, provide the URL for the Incoming Webhook that Apigee Test will use to send alerts to your Slack room. For information on generating an incoming webhook, see https://api.slack.com/incoming-webhooks.https://api.slack.com/incoming-webhooks
- Pager Duty: If you select Pager Duty for notifications, provide the Token and Service Key for desired the Pager Duty location.
Configure how often you want the probe to make its API calls. Click the Run Every bar at the desired interval that the API call should be made.
Select the world locations you want Apigee Test to make API calls from. Apigee Test provides predefined locations. A call is made from each selected location at the interval you set. For example, if you set the probe to make a call every 5 minutes, and you select Oregon and Dublin, the probe executes all its Steps every 5 minutes from both Oregon and Dublin.
- Oregon - USA
- Washington, D.C. - USA
- Dublin - Ireland
- Sydney - Australia
- Tokyo - Japan
Viewing Probe metrics
Probes also capture Step details and metrics. For more information, see View Apigee Test metrics.
Help or comments?
- If something's not working: Ask the Apigee Community or see Apigee Support.
- If something's wrong with the docs: Send Docs Feedback
(Incorrect? Unclear? Broken link? Typo?)