Skip to main content

Deploys

When you add deployment data to Cortex, it is visible on entity pages, in Eng Intelligence reporting, in executive reports, and can be accessed via CQL.

Add deployment data to Cortex​

To get deploys into Cortex, you must use the Add deployment for entity API endpoint.

Add custom data to deployments​

Adding a customData object to your API call allows you the flexibility to add metadata that is important to your organization.

If there is custom data included for a deploy, you can view it under "Recent activity" on an entity. Click the 3 dots icon to expand and view the custom data: Expand to view the custom data

Viewing deploy data​

View deployments on entity pages​

Deployment information appears in several places on an entity page:

  • While viewing an entity page, you can see "last deployment" information in the center of the page:
    Last deployment information appears on the entity
  • In the Operations tab, the number of deployments per day, per environment is displayed in a graph:
    Deploy information is displayed in a graph
  • Beneath the deploys graph, deploys will also show up under "Recent activity."
  • In the left sidebar of an entity, click Events. This page lists all recent events for the entity. In the upper right corner of this page, click the Filter icon to narrow the list down to only view deploys:
    Deploy events are listed in the entity's Events page

View deployments in Eng Intelligence​

When you send deploy data into Cortex, you can use this information in Eng Intelligence reporting to gain insight into your deploy metrics. Deploy metrics include average number of deploys per week and deploy change failure rate.

In Eng Intelligence, click into an entity to open a side panel with a historical performance graph.

Read more about using Eng Intelligence in the documentation.

Use deployment data in CQL and Scorecards​

You can use deploy data to write rules for Scorecards and to create CQL reports.

See more examples in the CQL Explorer in Cortex.

Deploys

Deploys added to an entity through the public API.

Definition: deploys(lookback: Duration, types: List<Text>): List<Deploy>

Example

In a Scorecard, you can write a rule to check whether an entity had fewer than 5 bug fixes in the last month:

deploys(lookback = duration("P1M"), types = ["DEPLOY"]).filter((deploy) => deploy.customData != null AND deploy.customData.get("bugFix") == true).length < 5

Write a rule to check whether there were, on average, at least 2 deploys per week in the past month:

deploys(lookback = duration("P1M")).length / duration("P1M").toWeeks() >= 2

Write a rule to verify that there was, on average, less than 1 rollback for every 4 deploys in the past month:

deploys(lookback=duration("P1M"),types=["ROLLBACK"]).length / deploys(lookback=duration("P1M"),types=["DEPLOY", "ROLLBACK", "RESTART"]).length < 0.25