Integrate with SignalFx

What does the integration offer?

SignalFx detectors monitor signals and send alerts when they cross defined thresholds. With the SignalFx Integration, Compass acts as a dispatcher for these alerts, 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.

Compass has a specific API for SignalFx Integration, SignalFx sends alerts to Compass and Compass handles the automatic creation of alerts.

How does the integration work?

SignalFx detectors monitor signals and send alerts when they cross defined thresholds. When an alert is created in SignalFx, an alert is also created in Compass automatically through the integration. When values are back to normal, SignalFx detectors resolve the alert. When an alert is resolved in SignalFx, an alert is also closed in Compass.

Set up the integration

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

Add a SignalFx integration in Compass
Configure the integration in SignalFx

Add a SignalFx 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 SignalFx 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 “SignalFx”.
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 API URL.
You will use this URL while configuring the integration in SignalFx 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 SignalFx

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

In SignalFx, open the Organization Overview page.
Select a metric you want to create alerts for and then the bell icon in the upper-right corner.
Select New Detector From Chart.
Enter a value for Detector Name and select Create Alert Rule.
On the Alert screen, enter values for alert signal, condition, settings, and message.
In Alert Recipient, select Add Recipient and select Webhook.
Select Custom.
Paste the API URL previously copied from Compass into URL.
Select Activate Alert Rule.
Select SAVE.

Sample payloads sent from SignalFx

The Sources field of the following snippet is a string representation of a JSON object the content of which can differ; hence, the whole Sources object is added to the available draggable (dynamic) fields so that the custom fields can be extracted as needed. For example, to add the dsname field of the Sources object to alerts, use {{sources.dsname}}.

Create alert payload

(in JSON format)

{
    "severity": "Critical",
    "sources": "{\"AWSUniqueId\":\"i-274xxxx1_us-west-2_97xxxxxxxx\",\"dsname\":\"value\",\"host\":\"ip-172.us-west-2.compute.internal\",\"plugin\":\"signalfx-metadata\",\"plugin_instance\":\"utilization\",\"sf_metric\":\"memory.utilization\"}",
    "rule": "Create Compass Alert",
    "alertTimestamp": 1463567930000,
    "eventType": "_SF_PLOT_KEY_Ciu5eDlAgAc_9_3",
    "incidentId": "CiYI3ipAgnA",
    "detector": "Memory Used % Detector",
    "detectorUrl": "https://app.signalfx.com/#/detector/Ciu5eDlAgAc/edit",
    "currentValue": "4.07361626150254",
    "status": "too high"
}

Close alert payload