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
  • How to configure Rootly with Cortex​
  • Prerequisites​
  • Configure the integration in Cortex​
  • Viewing incidents in Cortex​
  • How to connect Cortex entities to Rootly​
  • Discovery​
  • Trigger an incident​
  • Scorecards and CQL​
  • Still need help?​

Was this helpful?

Export as PDF
  1. Ingesting data into Cortex
  2. Integrations

Rootly

Last updated 1 month ago

Was this helpful?

is an on-call and incident response platform.

Integrating Rootly with Cortex allows you to:

  • directly from Cortex

  • on entity pages in Cortex

    • When active incidents are detected in Rootly, Cortex will display incident information on an entity's details page in the Overview and Operations tabs.

  • Create that track progress and drive alignment on projects involving incidents

How to configure Rootly with Cortex

Prerequisites

Before getting started:

  • Create an . Ensure the Rootly user account represented by the API key has admin permissions in Rootly.

Configure the integration in Cortex

  1. In Cortex, navigate to the :

    1. In Cortex, click your avatar in the lower left corner, then click Settings.

    2. Under "Integrations," click Rootly.

  2. Click Add configuration.

  3. Configure the Rootly integration form:

    • Account alias: Enter the alias for your configuration.

    • API token: Enter your Rootly API token.

  4. Click Save.

Once you save your configuration, you'll see it listed on the integration's settings page in Cortex. If you’ve set everything up correctly, you’ll see the option to Remove Integration in Settings.

You can also use the Test all configurations button to confirm that the configuration was successful. If your configuration is valid, you’ll see a banner that says “Configuration is valid. If you see issues, please see documentation or reach out to Cortex support.”

The Rootly integration has multi-account support. You can add a configuration for each additional instance by repeating the process above.

Each configuration requires an alias, which Cortex uses to correlate the designated instance with registrations for various entities. Registrations can also use a default configuration without a listed alias. You can edit aliases and default configurations from the Rootly page in your Cortex settings. Select the edit icon next to a given configuration and toggle Set as default on. If you only have one configuration, it will automatically be set as the default.

You can view incidents on an entity details page. Each incident is listed with its title, severity, status, and description.

To view the list of incidents:

  1. In Cortex, navigate to an entity.

  2. On the left side of the entity details page, click On-call & incidents.

  3. In the list, view all incidents from the last 30 days. To narrow the list by severity or or status, use the filters at the top of the page.

By default, Cortex will use the entity tag (e.g. my-entity) or entity name as the "best-guess" for a Rootly service. For example, if your entity tag is my-entity, then the corresponding service slug in Rootly should also be my-entity.

If your Rootly service name does not match the Cortex entity tag or name, you can override this in the Cortex entity descriptor.

For a given entity, you can define Rootly services by ID or slug.

Field
Description
Required

id

Service ID

****

slug

Service slug

****

Service ID

x-cortex-rootly:
  services:
    - id: ASDF1234

Service slug

x-cortex-rootly:
  services:
    - slug: service-slug

While viewing an entity in Cortex, you can trigger an incident in Rootly:

  1. In Cortex, navigate to an entity. On the left side of an entity details page, click Integrations > Rootly.

  2. In the upper right side of the entity's Rootly page, click Trigger incident.

  3. Configure the incident modal:

    • Name: Enter a name for the incident.

    • Summary: Enter a summary for the incident.

    • Description: Enter a long-form description of the incident.

    • Severity: Select a severity level.

    • Condition: Select a condition for the incident.

  4. At the bottom of the modal, click Trigger incident.

    • A confirmation screen will appear. In the confirmation, click the link to view the incident in Rootly.

With the Rootly integration, you can create Scorecard rules and write CQL queries based on Rootly incidents.

Check if Rootly service is set

Check if entity has a registered Rootly service in its entity descriptor.

If no registration exists, Cortex will try to automatically detect which corresponding Rootly service name or tag is associated with the entity.

Definition: rootly (==/!=) null

Example

For a Scorecard focused on operational maturity, you can use this expression to make sure each entity has an Rootly service set:

rootly != null
Incidents

List incidents, filterable by severity and status.

  • Created at

  • Mode

  • Name

  • Severity

  • Status

  • Summary

  • Type

  • URL

Definition: rootly.incidents()

Example

To assess entities' health in a Scorecard, you can write a rule to make sure a given entity has fewer than three incidents with a severity of SEV1:

rootly.incidents(severity = ["SEV1"]).length < 3

You can also use this expression to query for entities that have two or fewer critical incidents in the last three months:

  rootly.incidents(severity = ["Critical"]).filter((incident) => incident.createdAt.fromNow() > duration("-P90D")).length <= 2

The following options are available to get assistance from the Cortex Customer Engineering team:

  • Chat: Available in the Resource Center

  • Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your Customer Success Manager.

Configure the integration for multiple Rootly accounts

Viewing incidents in Cortex

In addition, active incidents will appear at the top of the .

How to connect Cortex entities to Rootly

Discovery

Editing the entity descriptor

Trigger an incident

Scorecards and CQL

See more examples in the in Cortex.

Still need help?

Email: , or open a support ticket in the in app Resource Center

​
​
entity details overview page
​
​
​
​
​
CQL Explorer
​
help@cortex.io
Rootly
Scorecards
​
​
API token in Rootly
​
Rootly settings page
Trigger an incident
View incident data