Skip to main content

Slack

CatalogNotificationsScorecards

Summary​

Slack is a way to communicate with your team. By integrating with Cortex's app for Slack, you can use Slash Commands to drive insights into values such as:

  • Ownership
  • Notifications
  • Who's on call

Also with the integration, Cortex will message service owners regarding any Scorecard improvements or if are any action items for upcoming Initiatives.

Setup​

In order to connect Cortex to your Slack instance, you’ll need to install Cortex's app for Slack in Settings → Slack.

caution

If you do not see the Settings page you're looking for in the sidebar, you likely don't have the proper permissions and need to contact your admin.

caution

If using Cortex Server, you'll need to follow a manual configuration process to use Cortex's app for Slack. Reach out to the support team to receive instructions.

Catalog descriptor​

You can define the following block in your Cortex Catalog Descriptor to add your Slack channels by name or by ID.

x-cortex-slack:
  channels:
  # List Slack channels, *without* the preceeding "#"
  - name: team-engineering
    notificationsEnabled: true
    description: This is a description for this Slack channel # optional
  - id: ABCDEF123
    notificationsEnabled: true
    description: This is a description for this Slack channel # optional

Slash commands​

We have a list of commands you can use to quickly query catalog metadata and Scorecard scores. The <tag> refers to the entity tag.

caution

You need to be a Slack administrator in order to install Cortex's app for Slack.

  • /cortex dependencies <tag>
    • List all incoming and outgoing first-level dependencies
  • /cortex deploys <tag>
    • List recent deploys
  • /cortex docs <tag>
  • /cortex links <tag>
  • /cortex links [type] <tag>
    • List all links of optional type param such as "metrics" or "openapi"
  • /cortex logs <tag>
  • /cortex oncall <tag>
    • Find current on-call
  • /cortex owners <tag>
    • List all owners, along with their emails
  • /cortex resource <tag>
    • Lists resource information such as owners, current on-call, links, and timeline events
  • /cortex runbooks <tag>
  • /cortex scores <tag>
    • List all Scorecard scores
  • /cortex search <query>
  • /cortex sentry <tag>
  • /cortex service <tag>
    • Lists entity information such as owners, current on-call, links, and timeline events
  • /cortex timeline <tag>
    • List recent timeline events

Privacy policy​

We will retain basic Slack metadata like user IDs for the period necessary to fulfill the purposes outlined in our Privacy Policy unless a longer retention period is required or permitted by law, or where the Customer Agreement requires or permits specific retention or deletion periods.