Friday, July 24, 2015

Chef Analytics + Slack = Awesome [feedly]

Chef Analytics + Slack = Awesome

Recently at Chef we moved to Slack for our internal messaging and collaboration tool. While this was awesome for us, our analytics product, Chef Analytics, had integrations written specifically for our old tool, Hipchat. If you're not familiar with Chef Analytics, it provides a real time event stream on events that occur on the Chef Server and on Chef Clients. Analytics allows you to write rules to notify different end points when an event takes place. Often you might want to send a notification to your messaging tool if for instance there is a failure in a Chef Audit Mode run.Integrating with Slack was super easy using a Slack Webhook and the Chef Analytics Webhook Notification.
  1. First, go create a new Slack Webhook. You'll need to choose the channel where you want messages sent, then Slack will give you a URL to post messages to. Copy that URL, you'll need it.Screen Shot 2015-07-16 at 4.57.24 PM
  2. Log into your Chef Analytics webui and Navigate to notifications. Click the + to add a new Webhook notification. Screen Shot 2015-07-16 at 4.58.47 PM
  3. Name the notification (I named mine 'slack') and paste the URL you got from Slack in step 1. Your notification is ready to use. Screen Shot 2015-07-16 at 5.01.32 PM
Now that the notification is created, you need to create rules that use it. You'll also want to study the  Slack Webhook message format. A very simple rule to test your integration is to just send a message on any action event that comes into Analytics.
rules 'org notifier'    rule on action     when       true     then       notify('slack', '  {  "text": "test from the blog post"  }  ')    end  end  
Slack expects a JSON document to be sent in the Webhook, and Chef Analytics 1.1.4 supports multi-line notifications to be written. The minimum payload you'll need to send is the "text" property. Save this rule, and you should start seeing messages in your Slack channel as things change on the Chef Server. That's cool, but the message could be formatted better. Slack lets you modify the message a few different ways. You can add the "username" property to set the username in the Slack channel, and you can specify an icon by setting the "icon_emoji" property. Say for instance we want to write a rule to notify Slack when an Chef Audit Mode rule fails.
rules 'failed-audit'   rule on run_control_group   when     status != 'success'   then     notify('slack', '  {  "username": "Audit Alarm",  "icon_emoji": ":rotating_light:",  "text": "{{}} (cookbook {{message.cookbook_name}}) had `{{message.number_failed}}` failed audit test(s) on node `{{}}` in organization `{{message.organization_name}}`"  }  ')   end  end  
This will result in a message in Slack that looks like the below.Screen Shot 2015-07-16 at 5.15.26 PMYou can enhance this message a bit more by using the message attachments feature. Say for instance you want audit rules to stand out a bit more in a channel, you can set the message attachment color to "warning", to make channel members see it better.
rules 'failed-audit'   rule on run_control_group   when     status != 'success'   then     alert:warn('{{message.cookbook_name}} {{message.recipe_name}} audit failed')     notify('slack', '  {  "username": "Audit Alarm",  "icon_emoji": ":rotating_light:",  "attachments": [ {  "text": "{{}} (cookbook {{message.cookbook_name}}) had `{{message.number_failed}}` failed audit test(s) on node `{{}}` in organization `{{message.organization_name}}`",  "color": "danger"  }]  }  ')   end  end  

This rule will give you a message like the one below.

Screen Shot 2015-07-16 at 3.53.07 PM

You can leverage all of Slack's formatting rules as well to make you messages stand out even more. Hopefully this post will help you get started with Analytics and Slack. The two tools combined give you a powerful combination to enhance your chatops experience and effectiveness.

 -- via my reader

No comments:

Post a Comment