note: The deployments API has recently changed. A high-level guide for migrating to the new API can be found here and legacy setup instructions can still be found here.

Raygun Deployment Tracking is designed to alert you to issues from problematic releases.

Deployment Tracking allows for a correlation of error groups with your deployment versions, making it possible to promptly identify and investigate deployments that may be causing issues. You can examine the commits involved in each deployment, see which errors occurred in each version, identify any regressed errors, and note which errors are ongoing.

Tracking Deployments in Raygun

Once set up, new deployments and their details will appear on the Deployments page inside Raygun. From here, you can view the deployment's version, determine who initiated the deployment, when it occurred and any release notes for additional context. Clicking into a deployment will show you the errors related to the deployment along with the commits that make up the deployment. You may also update the details of a deployment by clicking the cog icon in the top right corner.

Tracking Deployments in Raygun

To get started with Deployment Tracking, follow these steps:

  1. Include a version number in your error reports: The version number should correlate with a specific deployment version. Including the version number will vary depending on the provider you're using. Therefore, make sure to check the specific documentation of your provider for how to include it.

  2. Obtain a Personal Access Token (PAT): The PAT serves as your means of authenticating with our API. You will need this token to register your deployments. The token must have the deployments:write scope in order to register the deployments. Refer to the PAT documentation to get started.

  3. Add a new step to your application's deployment process: The new step involves registering the deployment with Raygun. The specifics of adding this new step will depend on your current deployment process. At a high level, you will send a POST request to the deployments endpoint with a JSON body containing information about your deployment. Refer to the API reference for more information about how the endpoint works.

We have provided some sample scripts to get you started:

On this page: