Integrate Opsgenie with Compose

What does Opsgenie offer Compose users?

Compose sends alerts via email and using webhook. Either method is used to forward Compose alerts to Opsgenie. How to create alerts via email in Opsgenie is described in the email integration document. This document describes how to integrate Compose and Opsgenie using Opsgenie’s Compose Integration.

Opsgenie provides a specific API for Compose Integration to create alerts directly in Opsgenie data centers.

Functionality of the integration

When Compose triggers an alert, an alert is created in Opsgenie automatically through the integration.

Add Compose Integration in Opsgenie

If you're using Opsgenie's Free or Essentials plan or if you’re using Opsgenie with Jira Service Management's Standard plan, you can add this integration from your team dashboard only. The Integrations page under Settings is not available in your plan.

Go to Teams and select your team.
Select Integrations on the left navigation and then select Add integration.

Adding the integration from your team dashboard will make your team the owner of the integration. This means Opsgenie will assign the alerts received through this integration to your team only. Follow the rest of the steps in this section to set up the integration.

Go to Settings > Integrations. Search for Compose and select Add.
Specify who is notified of Compose alerts using the Responders field. Auto-complete suggestions are provided as you type.
Copy the integration URL which includes Opsgenie endpoint as well as the API key.
Select Save Integration.

Configuration in Compose

From the Compose control panel, open Account->Notifications page.
From this page, select Webhook as the type of the notification.
Under Webhook Alerts, populate Webhook Url field with the integration URL copied when saving the integration.
Click Save alert settings.

5. Alert properties are configured from Compose Integration / Advanced Settings page.
6. Now manage your Compose database alerts at Opsgenie and leverage its full alerting functionality.

Sample payload sent from Compose

JSON

{
  "alert_type_causes": "Some common causes are: * Network connectivity interuption * Server Failure * High load on primary",
  "alert_type_description": "A stepdown alert is raised when the primary member in a replica set is unavailable and a secondary is promoted to primary.",
  "alert_type_resolution": "There is generally nothing to do to resolve this type of alert. This is the expected behavior, but you should make sure that your app is configured to handle this type of failure by using a replica set in your connection info and using safe writes. Most drivers will recover automatically from this. If not an app restart might be required.",
  "databases[]": "db1,db2",
  "message": "There was a stepdown c235.candidate.17.mongolayer.com:10235 -> c235.candidate.16.mongolayer.com:10235",
  "severity": "1",
  "source": "candidate.16.mongolayer.com:10235",
  "title": "stepdown alert on candidate.16.mongolayer.com:10235",
  "trigger_value": "The value that was triggered causing the alert. This only applies to alerts with limits.",
  "type": "stepdown"
}

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