This article is about General Codeship Configuration.

Tracking Deployments With Atatus

You'll need roughly 2 minutes to read this article.

About Atatus

Atatus lets you monitor performance and track errors related to your web and back-end applications in real-time. During your continuous deployment workflow with Codeship Pro, you can record your deployments in Atatus.

By using Atatus, you can compare performance metrics and errors with previous deployment.

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

Codeship Pro

Setting Your Admin API Key

You will need to add your Atatus admin api key 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:

In this case we are calling a script named deploy-atatus.sh.

curl https://api.atatus.com/api/deployments \
  -F admin_api_key=$ADMIN_API_KEY \
  -F revision=$CI_COMMIT_ID \
  -F release_stage=$CI_BRANCH \
  -F user=$CI_COMMITTER_USERNAME \
  -F changes="$DEPLOYMENT_NOTES"

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: atatus
  service: app
  tag: master
  command: deploy-atatus.sh

Codeship Basic

Setting Your Admin API Key

You will need to add your Atatus admin api key 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 Atatus, 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.atatus.com/api/deployments \
  -F admin_api_key=$ADMIN_API_KEY \
  -F revision=$CI_COMMIT_ID \
  -F release_stage=$CI_BRANCH \
  -F user=$CI_COMMITTER_USERNAME \
  -F changes="$DEPLOYMENT_NOTES"