Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 3 Next »

  • Opsgenie in text

What does the integration offer?

Circonus users leverage Compass to aggregate and manage alerts not only from Circonus but also from other sources. Compass enables users to maintain their own notifications information and preferences, eliminates the burden of keeping this information current and accurate in multiple disparate tools.

This integration provides Circonus users with full alert lifecycle management capabilities. Use Compass to not only receive notifications for critical problems detected by Circonus but also acknowledge alerts, take or assign ownership of the alerts, comment on them, etc. rapidly no matter when and where the alerts are received. Compass keeps track of all alert activity seamlessly: when the alert is created, who is notified when and how, whether and when recipients see the alert, acknowledged it, who executes which action, etc. Compass also automatically closes alerts when the host/service comes back up.

A short text message (SMS) is typically used to notify users often fails to convey sufficient information to enable the recipients to assess the problem and determine the right course of action. Compass alerts are not limited to couple hundred characters of text, and include many fields, tags, and capability for attached information. Recipients not only see the alert message, but all the supporting information, to figure out what to do next. Attach any information that is relevant to the alert and make it available to the recipients either via the API or the web UI.

How does the integration work?

  • When Circonus triggers an alert, an alert is created in Compass automatically through the integration.

  • When the alert condition is no longer valid, Circonus makes another HTTP POST request to Compass and Compass closes the alert automatically.

  • When the alert is acknowledged/unacknowledged by Compass, alert is acknowledged/unacknowledged automatically in Circonus as well (optional).

Set up the integration

Circonus is a bidirectional integration. Setting it up involves the following steps:

  • Add a Circonus integration in Compass

  • Configure the integration in Circonus

Add a Circonus integration

Bidirectional integrations aren’t supported in the Standard plan. All the other integrations are supported at a team level in Standard.

If you're using the Standard plan in Compass, 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 Circonus integration in Compass, complete the following steps:

  1. Go to your team’s operations page.

  2. On the left navigation panel, select Integrations and then Add integration.

  3. Run a search and select “Circonus”.

  4. On the next screen, enter a name for the integration.

  5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

  6. Select Continue.
    The integration is saved at this point.

  7. Expand the Steps to configure the integration section and copy the webhook URL.
    You will use this URL while configuring the integration in Circonus later.

  8. Select Turn on integration.
    The rules you create for the integration will work only if you turn on the integration.

Customize the integration

The Circonus integration uses sensible configuration defaults to make the integration as easy as possible. However, you can customize the integration:

  • Define different rules to notify different people for different alerts

  • Modify alert content using Circonus webhook payload

The following variables from Circonus alert webhook payload are available when defining filters and when setting the alert fields values:

  • Alert Type

  • Account Name

  • Severity

  • Metric Name

  • Check Name

  • Host

  • Agent

  • Alert Value

  • Alert Time

  • Clear Value

  • Clear Time

  • Alert Url

  • Metric Notes

Create multiple rules with filters using the variables from Circonus webhook payload. For each rule, alert fields are able to have different values, hence different people to be notified.

Acknowledge/Unacknowledge alerts in Circonus via Compass

The Circonus integration provides outgoing actions, too. If chosen, Compass can acknowledge/unacknowledge alerts in Circonus. Select Send alert Updates Back to Circonus. Available actions are visible. Then choose the actions to send back to Circonus.

Configure a webhook in Circonus

To configure the integration of Circonus with Compass, complete the following steps:

  1. Go to **Menu next to Circonus logo.

  2. Click Contact Groups.

  3. Click NEW CONTACT GROUP +.

  4. Enter a name for the contact group.

  5. From Use Third Party drop-down menu, select Opsgenie.

  6. Paste the API URL previously copied into Opsgenie API URL.

  7. Select Save.

  8. Copy the URL from Webhook URL and paste it into Circonus Webhook URL in the integration configuration page.

  9. Create a ruleset that triggers an alert and add the new contact group to that.

Sample payload sent from Circonus to Compass

JSON

{
  "check_name": "54.214.23.46 http",
  "metric_link": null,
  "check_id": 81313,
  "alert_value": "212.0",
  "check_bundle_id": 60426,
  "alert_url": "https://circonus.com/account/opsgenie/fault-detection?alert_id=7438967",
  "host": "54.214.23.46",
  "metric_notes": "METRIC NOT",
  "alert_time": "Fri, 24 Jan 2014 18:17:37",
  "clear_time": "Fri, 24 Jan 2014 18:23:36",
  "metric_name": "duration",
  "clear_value": "220.0",
  "agent": "Ashburn, VA, US",
  "severity": "2",
  "alert_id": "7438967",
  "account_name": "opsgenie"
}

Compass parses the payload as follows:

JSON

{
  "check_name": "54.214.23.46 http",
  "alert_value": "212.0",
  "alert_url": "https://circonus.com/account/opsgenie/fault-detection?alert_id=7438967",
  "host": "54.214.23.46",
  "metric_notes": "METRIC NOT",
  "alert_time": "Fri, 24 Jan 2014 18:17:37",
  "clear_time": "Fri, 24 Jan 2014 18:23:36",
  "metric_name": "duration",
  "clear_value": "220.0",
  "agent": "Ashburn, VA, US",
  "severity": "2",
  "alert_id": "7438967",
  "account_name": "opsgenie"
}

Sample payload sent from Compass to Circonus

Sample payload for Acknowledge action

JSON

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452224764002246,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"fili@ifountain.com",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"fili@ifountain.com",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":"",
        "alert_id":64657364
    },
    "action":"Acknowledge",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

Sample payload for Unacknowledge action

JSON

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452224764002246,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"fili@ifountain.com",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"fili@ifountain.com",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":"",
        "alert_id":64657364
    },
    "action":"UnAcknowledge",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

 

  • No labels