LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page
  • Add deployment data to Cortex
  • Add custom data to deployments
  • Viewing deploy data
  • View deployments on entity pages
  • View deployments in Eng Intelligence
  • Use deployment data in CQL and Scorecards

Was this helpful?

Export as PDF
  1. Ingesting data into Cortex
  2. Managing Entities

Adding Deploy data

Last updated 19 days ago

Was this helpful?

When you add deployment data to Cortex, it is visible on , in reporting, in , and can be accessed via .

Add deployment data to Cortex

To get deploys into Cortex, you must use the 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:

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 near the top of the page:

  • Near the bottom of an entity page, deploys will also appear under "Recent activity."

  • In the left sidebar of an entity, click Events. This page includes:

    • A visual chart of deploys.

      • By default the chart shows data from the last month. Click the Last month dropdown in the upper right to change the timeframe.

    • All recent events for the entity. In the upper right corner of the events list, click Filter to select and apply filters for this list. You can choose to only view the deploy event types.

View deployments in Eng Intelligence

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

Use deployment data in CQL and Scorecards

Deploys

Definition: deploys(lookback: Duration, types: List): List

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 = 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

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

Read more about using .

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

See more examples in the in Cortex.

Deploys added to an entity through the .

Eng Intelligence
deploy metrics
Eng Intelligence in the documentation
Scorecards
CQL reports
CQL Explorer
public API
Eng Intelligence
executive reports
CQL
Add deployment for entity
entity pages
Deployment information appears near the top of an entity details page.
On an entity page, click "Events" in the sidebar to view recent events.