/
Integrate with Prometheus

Integrate with Prometheus

Owned by Shivi Sivasubramanian
Last updated: Aug 06, 2024 by Meghali Deb Roy (Deactivated)
2 min read

What does the integration offer?

Use Compass’s Prometheus Integration to forward Prometheus alerts to Compass. Compass 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 the alert is acknowledged or closed.

How does the integration work?

When an alert is created in Prometheus, an alert is created in Compass automatically through the integration.

Set up the integration

Prometheus is an API integration. Setting it up involves the following steps:

  • Add a Prometheus integration in Compass

  • Configure the integration in Prometheus

Add a Prometheus 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 Prometheus integration in Compass, 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 “Prometheus”.

  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 Prometheus 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 Prometheus

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

  1. Download Alertmanager.

  2. Configure Alertmanager. Find out how to configure Alertmanager.

  3. Paste the API Key copied previously into the api_key: field of the script.

  4. Enter values for Details, Teams, and Tags if needed.

  5. Run Alertmanager.

 Read more about the integration.