New Updates to the API and Metric
18/03/2024 - our deployments API now allows you to send submit extra information with your deployment and use them in your breakdowns and filters (see below).
Overview
This metric shows you the total raw count of deployments that you have made. The deployments parameters will be defined based on the way that you have integrated with our Pipeline API. We advise that you only send data pertaining to full deployments to your production environment.
Click here for our deployment api integration documentation.
Use Case
This metric will allow you to see how often your services are changing overtime. Number of deployments can be coupled with our frequency of deployments & / or time between deployments metrics to provide a key overview of your engineering teams release throughput. An increase in deployments within a given time period can indicate your organisation is working more effectively and a decrease may outline a rise in inefficiencies. This is a critical feedback loop allowing companies to identify if their internal efforts are having a positive or negative impact on their software delivery lifecycle (SDLC).
You can also use this metric to validate your setup of the deployments API by sending through a test deployment and checking the data has pulled through correctly.
Setup
This metric is simply calculated by adding up the total number of deployments that you send to us via the deployment API.
In Plandek the default number of deployments metric looks at all of the deployments you have sent to us based on the 'deployment pipelines' you have selected for the specific workspace you're in and then provides a total summary (see above '201').
You can then break this metric down further, for example by pipeline which helps you understand exactly where your deployments are happening.
Another popular view is breaking the metric down by Status (for e.g. Success, Aborted or Failure).
In addition to the existing breakdowns and filtering by status, pipeline, context there are now some newly added fields which can be sent in to the new deployment API, for further information please consult our technical guide:
Application/Service Name- the name of the application or service that the deployment belongs
Application/Service ID - the release ID of the application or service that the deployment belongs
Environment Name - the name of the environment that the deployment was for (if not provided in the API default is not_provided)
Includes fix for previous failed deployment - if the deployment includes a fix for a previous failed deployment - (if not provided in the API default is no)
Is Prod Environment - if the deployment relates to a production environment (if not provided in the API default is Yes)
Marked as Deployed - if the deployment was used to mark commits as deployed (if not provided in the API default is Yes)
Attributes - a set of configurable json paired values which can be set to any string or list of string values you would like to send in to the API. Note: If you break down based on one of you attributes and a deployment has a list of values then the count of deployments will be increased as the deployment will appear in multiple breakdown categories.
Any questions please reach out to our customer success team via the chat icon in the bottom right.