Track deployments with annotations

For enhanced visibility into your deployments, we offer deployment annotations on all transaction charts. This feature enables you to easily determine if your deployment has increased response times for an end-user, or if the memory/CPU footprint of your application has changed. Being able to quickly identify bad deployments enables you to rollback and fix issues without causing costly outages.

By default, automatic deployment annotations are enabled. This means the Applications UI will create an annotation on your data when the service.version of your application changes.

Alternatively, you can explicitly create deployment annotations with our annotation API. The API can integrate into your CI/CD pipeline, so that each time you deploy, a POST request is sent to the annotation API endpoint:

curl -X POST \
  http://localhost:5601/api/apm/services/${SERVICE_NAME}/annotation \ 
-H 'Content-Type: application/json' \
-H 'kbn-xsrf: true' \
-H 'Authorization: Basic ${API_KEY}' \ 
-d '{
      "@timestamp": "${DEPLOY_TIME}", 
      "service": {
        "version": "${SERVICE_VERSION}" 
      },
      "message": "${MESSAGE}" 
    }'

See the annotation API reference for more information.