Using Rollbar To Track Deployments With CloudBees CodeShip Pro

1 minute read

About Rollbar

Rollbar lets you collect and track errors and events related to your web applications. During your continuous deployment workflow with CloudBees CodeShip Pro, you can use Rollbar to log information related to your deployments.

By using Rollbar you can track important logs for future analysis and alerting.

Their documentation does a great job of providing more information, in addition to the setup instructions below.

CloudBees CodeShip Pro

Setting Your Access Token

You will need to add your Rollbar access token to your encrypted environment variables that you encrypt and include in your codeship-services.yml file.

Logging During Deployment

Next, you will need to add the following commands to a script, placed in your repository, that you will call from your codeship-steps.yml file:

curl https://api.rollbar.com/api/1/deploy/ \ -F access_token=$ACCESS_TOKEN \ -F environment=$CI_BRANCH \ -F revision=$CI_COMMIT_ID \ -F local_username=$CI_COMMITTER_USERNAME

You will need to call this script on all deployment-related branches by specifying the tag. Be sure to add this step _after your deployment commands, so that it only runs if the deployments were successful. For example:

- name: deploy service: app tag: master command: your deployment commands - name: rollbar service: app tag: master command: deploy-rollbar.sh

CloudBees CodeShip Basic

Setting Your Access Token

You will need to add your Rollbar access token to your to your project’s environment variables.

You can do this by navigating to Project Settings and then clicking on the Environment tab.

Logging During Deployment

To log a deployment-related datapoint in Rollbar, you will want to add a new custom-script step to all of your deployment pipelines.

This new step will either run the following commands, or run a script that includes the following commands:

curl https://api.rollbar.com/api/1/deploy/ -F access_token=$ACCESS_TOKEN -F environment=$CI_BRANCH -F revision=$CI_COMMIT_ID -F local_username=$CI_COMMITTER_USERNAME