Skip to main content

Slack

CatalogNotificationsScorecards

Summary​

Slack is a way to communicate with your team. You can use Slack to drive insights into values such as:

  • Ownership
  • Notifications
  • SlackBot

Setup​

In order to connect Cortex to your Slack instance, you’ll need to install the Slack application 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 the Slack app. Reach out to the support team to receive instructions.

Catalog Descriptor​

Ownership​

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

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

Slackbot​

We have a list of commands you can use with our Slackbot 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 the Slackbot.

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