Integrate with Honeycomb

What does the integration offer?

Use the Honeycomb integration to forward Honeycomb triggers to Compass. Compass determines the right people to notify based on on-call schedules, notifies via email, text messages (SMS), phone calls and iOS and Android push notifications, and escalates alerts until they are acknowledged or closed.

How does the integration work?

When a dataset query creates a trigger with the integration, it creates an alert in Compass.

Set up the integration

Honeycomb is an API-based integration. Setting it up involves the following steps:

Add a Honeycomb integration in Compass
Configure the integration in Honeycomb

Add a Honeycomb integration

In this release, only incoming integrations are fully supported in the Standard plan, at a team level. To use outgoing integrations or the outgoing part of bidirectional integrations, upgrade to a higher subscription plan. There may be restrictions on how you can create and apply integration rules as well.

You can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.

To add a Honeycomb integration in Compass, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Honeycomb”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the integration URL, which includes Compass’s endpoint and the API key.
You will use this URL while configuring the integration in Honeycomb later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Configure the integration in Honeycomb

To configure the integration in Honeycomb, complete the following steps:

In Honeycomb, from the bottom of the left menu, select Usage.
Go to the Integrations tab.
In the Trigger Recipients section, select Add Integration.
Select Webhook for Provider.
Enter values for Name and Team-oncall.
Paste the URL previously copied from Compass into Webhook URL.
Paste the API key previously copied from Compass into Shared Secret.
Select Add.
Select Test to check your integration.

Sample webhook message from Compass

When you select "Test" for integration, it does not send "result_groups" and "result_groups_triggered" in the JSON. You can test these using a Trigger Test.

Sample webhook message (in JSON format)

{
  "version": "v0.1.0",
  "id": "abdcefg",
  "name": "Compass alert",
  "trigger_description": "This is an alert trigger for Compass",
  "trigger_url": "https://ui.honeycomb.io/team/datasets/dataset/triggers/honeycomb",
  "status": "TRIGGERED",
  "summary": "Triggered: trig on dataset",
  "description": "Currently greater than threshold value (2) for key1:jsm (value 5)",
  "operator": "greater than",
  "threshold": 2,
  "result_url": "",
  "result_groups": [
    {
      "Group": { "key1": "jsm" },
      "Result": 5
    },
    {
      "Group": { "key1": "works" },
      "Result": 1
    },
    {
      "Group": { "key1": "like charm" },
      "Result": 1
    }
  ],
  "result_groups_triggered": [
    {
      "Group": { "key1": "jsm" },
      "Result": 5
    }
  ]
}

Operations