Slack enrichment with Playbooks

Setup quick display of critical metrics, db query and log search results in your slack alerts within seconds

Once setup, go to http://localhost or your installation location. Signup for an account in your local instance.

Setup your Slack integration

  1. Generate Slack app Manifest - Go to http://localhost/integrations/slack, enter the hostname of your setup (include http or https as the prefix in this). Click on Get Manifest to generate the manifest you'll need to create a private slack app for your workspace. Copy it to clipboard.

πŸ“˜

In case you are running on local, use the ngrok tool to create a https proxy for your localhost to give in this manifest. Its free and easy to use.

  1. Use Manifest to create App - Go to https://api.slack.com/apps to create a new slack app. Follow the instructions and paste the manifest we generated and create the app. This slack app lets your Playbooks instance pull from and publish into Slack.

πŸ“˜

You can modify the name of the Slack app by changing in the generated manifest when creating the app.

  1. Submit App ID & Auth token - Once the slack app is created, install it in your workspace. You'll need someone with admin role to be able to install it. Once installed, obtain its App ID and Bot Auth Token and save them in the Slack integration page.
  2. Add app in your slack channels - Now your slack app and backend are connected. You can now start adding your app in the channels you want to setup enrichment in. Typically, these will be channels where you receive your alerts. Just write @MyDroid (or whatever you named your app) in the channel and add them to the channel.

Create Workflow

  1. Select the filter criteria for your alerts - Go to create workflow and filter the alerts you want to enrich.

    1. The string entered in "Filter" will be searched within your alert text while evaluating if the workflow needs to be triggered for a specific alert or not.

  2. Link a Playbook to the workflow.

  3. Setup Schedule - Once the alert criteria and playbook are selected, choose how you want to execute this playbook. Schedule options available:

    1. Execute only once post the alert comes.
    2. Execute it periodically after a fixed interval for a certain duration. (Every 15 minutes for next 4 hours)
    3. Choose a custom cron schedule of your choice. (The cron schedule will work in UTC timezone) (* 5 * * *)
  4. Setup Notification - You can choose one of the following:

    1. Reply back with the executed playbook summary in the same alert's thread (only possible if you chose Slack as trigger type)
    2. Publish the execute playbook summary into a slack channel directly (you'll have to enter the channel's name once you select this option)

Once you create the workflow, you are set for getting playbook execution summaries against every workflow execution (as per the schedule).