Integrate with SignalFx (Legacy)

This article highlights a new alerting feature that's natively available in Jira Service Management which is gradually rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

What does the integration offer?

SignalFx detectors monitor signals and send alerts when they cross defined thresholds. With the SignalFx Integration, Jira Service Management acts as a dispatcher for these alerts, determines the right people to notify based on on-call schedules– notifies them using email, text messages (SMS), phone calls, and iPhone & Android push notifications, and escalates alerts until they are acknowledged or closed.

Jira Service Management has a specific API for SignalFx Integration, SignalFx sends alerts to Jira Service Management and Jira Service Management 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 Jira Service Management 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 Jira Service Management.

Set up the integration

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

Add a SignalFx integration in Jira Service Management
Configure the integration in SignalFx

Add a SignalFx integration

Bidirectional integrations aren’t supported in Free and Standard plans. All the other integrations are supported at a team level in Free and Standard; however, for their outgoing part to work, you need to upgrade to a higher plan. To add any integration at a site level through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be either on Premium or Enterprise.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management only assigns the alerts received through this integration to your team.

To add a SignalFx integration in Jira Service Management, 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 “SignalFx”.

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

5. For the integration variant, select “SignalFx Legacy”.

Select “SignalFx” if you want to use the built-in notification service. Find out how to integrate with SignalFx.

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

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

8. 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.

9. 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 Jira Service Management into URL.
Select Activate Alert Rule.
Select SAVE.

Sample payloads sent from SignalFx to Jira Service Management

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 Jira Service Management 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

(in JSON format)

{
    "severity": "Critical",
    "sources": "{\"AWSUniqueId\":\"i-2xxx1_us-west-2_974xxxxxxx\",\"dsname\":\"value\",\"host\":\"ip-172-x.us-west-2.compute.internal\",\"plugin\":\"signalfx-metadata\",\"plugin_instance\":\"utilization\",\"sf_metric\":\"memory.utilization\"}",
    "rule": "Create Jira Service Management Alert",
    "alertTimestamp": 1463568222190,
    "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": "ok"
}

Was this helpful?

It wasn't accurate

It wasn't clear

It wasn't relevant

Still need help?

The Atlassian Community is here for you.

Ask the Community