• Products
  • Get started
  • Documentation
  • Resources

Integrate with Consul

The feature described in this article is currently rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

Consul Logo

What does the integration offer?

Use Jira Service Management's Consul integration to sends Consul alerts to Jira Service Management API with detailed information. Jira Service Management acts as a dispatcher for Consul alerts, determines the right people to notify based on on-call schedules-– notifies via email, text messages (SMS), phone calls and iPhone & Android push notifications, and escalates alerts until the alert is acknowledged or closed.

How does the integration work?

When Consul triggers an alert, an alert is created in Jira Service Management automatically through the integration.

Set up the integration

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

  • Add a Consul integration in Jira Service Management

  • Configure the integration in Consul

Add a Consul integration

If you're using the Free or Standard plan in Jira Service Management, you can only add this integration from your team’s operations page. To access the feature through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be on Premium or Enterprise plan.

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 Consul 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 “Consul”.

  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 API key.
    You will use this key while configuring the integration in Consul later.

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

Configure the integration in Consul

To configure the integration of Consul with Jira Service Management, complete the following steps:

1. Install Consul-Alerts on your Consul server. Find out how to install Consul-Alerts.

2. Ensure that Consul-Alerts is running.

3. Configure the Jira Service Management API key:
curl -X PUT -d 'API_KEY' http://localhost:8500/v1/kv/consul-alerts/config/notifiers/opsgenie/api-key

The Consul agent's IP and port may vary.

4. Optional: Set the entity field value to show up in Jira Service Management alert details. The default is 'Cluster-Alert'.
curl -X PUT -d 'Consul' http://localhost:8500/v1/kv/consul-alerts/config/notifiers/opsgenie/cluster-name

5. Enable Jira Service Management notifications in Consul-Alerts:
curl -X PUT -d 'true' http://localhost:8500/v1/kv/consul-alerts/config/notifiers/opsgenie/enabled

When a Consul healthcheck becomes critical, a Jira Service Management alert is automatically created. When the Consul healthcheck passes again, the Jira Service Management alert is automatically closed.

This is an API-based integration, so dynamic (draggable) properties such as custom priority, payload, URL, and headers aren't available.

 

Additional Help