Rigor’s Changelog shows logged changes that we can reference for reporting on changes to performance before and after events.
Changes to System Events automatically update the Changelog. We can also make annotations to the Changelog in the Rigor monitoring app’s UI or programmatically via the API using Control Groups.
Annotations via Control Groups allow us to add events to the Performance History and Changelog of Rigor Checks. These annotations can then serve as a record of what changes were made and when they occurred, which makes it easy to find the cause of performance improvements or regressions. Read more about reporting on performance before and after changes here.
How To Annotate Check History Via The API
- First, navigate to Admin > Control Groups and create a group for the checks you’d like to annotate.
- On the Control Group read screen, find the endpoint and post token by clicking the ‘Help’ button. Copy the API endpoint and post token for your Control Group.
- Using cURL (or your favorite HTTP client), send a request to the API endpoint with the Control Group post token, the annotate command, and a message and title (optional). Rigor will automatically append a timestamp to the annotation.
- Visit the Performance History or Changelog for any Check in your Control Group to view your annotation. Click the flag icon to view annotations in the Performance History graph.
