Set up Compass
Learn how to set up Compass and integrate it with Atlassian products and applications.
Integrate Compass with Opsgenie
Opsgenie is a modern incident management platform that ensures critical incidents are never missed, and actions are taken by the right people in the shortest possible time. Opsgenie receives alerts from your monitoring systems and custom applications and categorizes each alert based on importance and timing.
On-call schedules ensure the right people are notified through multiple communication channels including voice calls, email, SMS, and push messages on mobile devices. If an alert is not acknowledged, Opsgenie automatically escalates it, ensuring the incident gets the needed attention.
Compass currently supports Opsgenie as a tool to:
display on-call information
visualize incident events on the activity feed
provide metrics around incidents
Integrate Compass with Opsgenie
To integrate Compass with Opsgenie, you must first install the Opsgenie app in Compass. Then, you must create, or use an existing, Opsgenie API key to connect Compass to the Opsgenie account to finish setup.
Make sure the API key has read, create and update, and configuration access permissions enabled.
When you integrate an app with Compass, other Compass users can view events and metrics data sent from the app to Compass, even if they don't have access to that data in the underlying app. For example, when you integrate Bitbucket with Compass, someone who doesn't have access to a repository can see the events and metrics related to that repository in Compass. The same applies to data sent from this app to Compass.
Before you begin
Ensure that you’re an owner of the Opsgenie account you want to connect to or work with your account owner to install this Opsgenie app.
Ensure that you’re an admin on your Compass instance.
Ensure your Opsgenie account is on the Essentials plan or higher. Some APIs and features the Opsgenie app for Compass uses are incompatible with free tier accounts.
Perform the integration
Integrate Compass with Opsgenie:
Select Apps from the top navigation bar in Compass.
Select Install on the Opsgenie app card. This installs the Opsgenie app in Compass.
Select Configure on the Opsgenie app card.
Authorize the Opsgenie app to access Compass on your behalf if you haven't previously done so.
Enter the API key from Opsgenie. Make sure the API key has read, create and update, and configuration access permissions enabled.
Select Connect account.
Add on-call information from Opsgenie to a component
With the Opsgenie app Compass you can associate an Opsgenie schedule with a Compass component to show on-call information directly in Compass. You can find all your Opsgenie schedules under the "Who is on-call" menu in Opsgenie.
In Compass, navigate to a component you want to connect to your Opsgenie on-call information. On the component’s overview page, you’ll see the on-call section on the right side of the component’s details.
Select + Add on-call schedule
Search for a schedule in Opsgenie by name, or paste a link to your Opsgenie schedule. You can find all your Opsgenie schedules under the "Who is on-call" menu in Opsgenie.
Optionally, enter link text to be displayed as the card’s title (Instead of ‘Opsgenie’ as the card title).
Select Add.
Your on-call information is displayed and updated from Opsgenie. If for some reason you encounter an error after adding an Opsgenie schedule, make sure you entered the right type of link (e.g. https://yourcompany.app.opsgenie.com/settings/schedule/detail/1e819432-18d0-4963-128c-c1d6a8d015ec).
Remove on-call information from Opsgenie from a component
In Compass, navigate to a component you want to remove your Opsgenie on-call information from. On the component’s details page, you’ll see the on-call section on the right side of the component’s details.
Select the icon next to the on-call link information you want to remove.
Select Remove in the dialogue that opens to confirm.
The on-call information no longer appears in the on-call card.
Add incident information from Opsgenie to a component
With the Opsgenie app Compass you can associate an Opsgenie service with a Compass component to see incident events on the activity feed and calculate incident-related metrics. To associate an Opsgenie service with a Compass component and see incident information:
In Compass, navigate to a component.
In the Other links section of the component's details, select + Add any other relevant links
Paste a link to your Opsgenie service. You can find all your Opsgenie services under the "Services" menu in Opsgenie.
Optionally, enter link text to be displayed as the link title (instead of the URL).
Select Add.
Incidents on the associated Opsgenie service will now be shown on the activity feed and metrics related to those incidents will be updated tracked and updated automatically by Compass.
Incidents from Opsgenie are not sent in realtime. There could be a delay of up to 10 minutes before incident events are ingested by Compass from Opsgenie.
If you don't see metrics updating it could be that you have not had any incidents recently (hooray!). Make sure you also added the correct Opsgenie service link in the "Other links" section of the component.
View incident events from Opsgenie
In Compass, navigate to a component you want to view incident events for.
Select Activity on the left side of the component's details.
See recent incidents on the Timeline or List views of the activity feed for the component or dependencies.
See metrics about incident events from Opsgenie
In Compass, navigate to a component you want to view incident events for.
View the metrics section of the component's details.
Supported metrics:
Metric | Description | How it's calculated |
|---|---|---|
Incident Count | The number of incidents opened in the last 28 days. | Incident events from associated Opsgenie service. |
MTTR | MTTR (mean time to resolve) is the average time it takes to fully resolve a failure, as measured from when an incident occurs (making the component dysfunctional) to when the component becomes fully functional again, measured over the last 10 incidents. | Incident events from associated Opsgenie service. |
Read more about Compass metrics
If you do not see metrics updating it could be that you have not had any incidents recently (hooray!). Make sure you also added the correct Opsgenie service link to the component.
Remove incident information from Opsgenie from a component
In Compass, navigate to a component you want to remove your Opsgenie incident information from. On the component’s details page, find the link to the Opsgenie service in the Other links section.
Select the icon next to the Opsgenie service link you want to remove.
Select Remove in the dialogue that opens to confirm.
Incident events will no longer show on the activity feed and incident related metrics will be removed from the component.
Disconnect the Opsgenie account connected with Compass
Disconnecting your Opsgenie account means on-call and incident information will no longer be displayed for your components.
Before you begin
Ensure that you’re a product admin on your Compass instance.
Disconnect the Opsgenie account
To disconnect a Opsgenie account from Compass:
In Compass, from the top navigation bar, select Apps.
Select Configure on the Opsgenie app card.
Select Disconnect. The Opsgenie account is disconnected from Compass and the page refreshes to its initial state with no account connected.
Uninstall the Opsgenie app from Compass
If you no longer want to use the Opsgenie app from Compass you can uninstall it.
Before you begin
Ensure that you’re a product admin on your Compass instance.
Uninstall the Opsgenie app
To uninstall the Opsgenie app from Compass:
In Compass, from the top navigation bar, select Apps.
Select Configure on the Opsgenie app card.
Select Uninstall on the Opsgenie app card. The Opsgenie app uninstalls from Compass.
Was this helpful?
Still need help?
The Atlassian Community is here for you.