- Connect Data: Ingest data and ensure ownership is assigned to your entities
- Standardize: Configure a Scorecard to enforce and measure Production Readiness
- Streamline: Set up data verification in Cortex to ensure your data is up to date and automate production standards via Workflows
- Improve: Review Eng Intelligence metrics and take action when issues are surfaced
Use Cortex features to meet production readiness standards
Expand the tiles below to learn about configuring Cortex features to meet production readiness standards.Step 1: Ingest data and solve ownership 🔌
Step 1: Ingest data and solve ownership 🔌
Action Items:

Relevant integrations
To focus on Production Readiness, Cortex recommends integrating with tools that provide visibility and control over code, deployments, monitoring, on-call, and documentation. Make sure you have configured integrations for the following categories:- Version control: Azure DevOps, Bitbucket, GitHub, GitLab
- Enforce best practices like peer reviews, CI/CD pipelines, and versioning
- On-call: PagerDuty, Opsgenie, Splunk On-Call (formerly VictorOps), xMatters
- Track on-call responsibilities to confirm that support teams are always assigned
- Project management: GitHub, Jira, Azure DevOps, ClickUp
- Track incidents, bugs, and compliance issues
- Code quality and security: Checkmarx, Codecov, Mend, Snyk, SonarQube, Veracode, Wiz
- Enforce code coverage, vulnerability scanning, and other quality measures
Step 2: Configure a Scorecard for Production Readiness 📋
Step 2: Configure a Scorecard for Production Readiness 📋
Action Item: Create a Scorecard for Production Readiness
Step 2.1: Create the Scorecard and configure the basics
- On the Scorecards page in your workspace, click Create Scorecard.
- On the
Production Readinesstemplate, click Use.

- Configure basic settings, including the Scorecard’s name, unique identifier, description, and more.
- Learn about configuring the basic settings in the Creating a Scorecard documentation.
Step 2.2: Review and modify the rules
While Cortex’s template is based on common industry standards, you may need to adjust the rules based on which tools you use and how your organization prioritizes standards and requirements. You can reorder, delete, and edit rules, you can add more rules to a level, and you can assign more points to a rule to signify its importance.The Scorecard template contains rules that enforce industry best practices, such as:- Enforce ownership, linked docs, and linked Slack channels to enable quick action during incidents.
- Enforce having monitors documented to have visibility into service health, performance, and reliability.
- Enforce CI/CD pipelines set, merge approval required, high code coverage, and last commit within 1 week, helping reduce the likelihood of bugs being shipped into your code.
- Enforce SLOs met and 2 tiers in on-call escalation policy, ensuring reliability, stability, and reduced downtime in case of an incident.
Step 3: Configure data verification ✔️
Step 3: Configure data verification ✔️
Action item: Set up data verification
- Follow the Data Verification documentation to define verification periods for your entities.
- You can select entity types that this verification process will apply to, or you can define a CQL expression to specify which entities the process will apply to.
- You can choose who is responsible for verifying the entities. If you do not specify, then any owner of an entity can complete the verification.
Step 4: Automate processes via Workflows ⚙️
Step 4: Automate processes via Workflows ⚙️
Action item: Configure Workflows
Workflows to establish adherence to best practices
- You can add manual approval steps in a Workflow to require sign-off from specific team members before a service is considered production-ready, ensuring accountability and providing an audit trail.
- See the documentation on configuring a Manual approval block.
- When Scaffolding new services, you can use templates to ensure that every new service starts with baseline standards (e.g., on-call information, runbooks, SLOs configured, and more).
- See the documentation on registering a Scaffolder template and configuring a Scaffolder block.
Workflows based on Production Readiness Scorecards
In a Workflow, you can use an HTTP request to get an individual entity’s score or the latest scores for all entities on your Production Readiness Scorecard, then configure additional blocks to take actions based on the score.For example, you could create a Workflow that blocks deployment based on Scorecard scores, ensuring that a deployment is blocked if the entity has not met your standards for Production Readiness.-
See an example of this Workflow in the template “Deploy to prod based on Scorecard score” in your Cortex workspace:

- When the Workflow runs, it checks whether the entity has achieved the “Gold” level standard in the Scorecard. If it has, the deployment continues. If it has not, the Workflow automatically sends a Slack message to notify the entity owner.
- Add an HTTP request block to your Workflow.
- Enter a name and unique slug for the block, then configure the remaining fields:
- HTTP method:
GET - URL: Enter the Cortex API URL for obtaining the scores, e.g.,
https://api.getcortexapp.com/api/v1/scorecards/<unique-scorecard-tag>/scores?entityTag={{context.entity.tag}}. - Headers: Add the following headers:
- Content-Type: application/json
- Authorization: Bearer
{{context.secrets.cortex_api_key}}
- HTTP method:
- Save the block.
Step 5: Review and act on Eng Intelligence 📈
Step 5: Review and act on Eng Intelligence 📈
Action Item: Review Eng Intelligence metrics
