What does the integration offer?
Use Compass's Consul integration to sends Consul alerts to Compass API with detailed information. Compass acts as a dispatcher for Consul alerts, determines the right people to notify based on on-call schedules using email, text messages (SMS), phone calls, and iPhone and 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 Compass 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 Compass
Configure the integration in Consul
Add a Consul integration
| Info |
|---|
Bidirectional integrations aren’t supported in the Standard plan. All the other integrations are supported at a team level in Standard. If you're using the Standard plan in Compass, 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 Consul integration in Compass, complete the following steps:
Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Consul”.
On the next screen, enter aname for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.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.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 Compass, complete the following steps:
Install Consul-Alerts on your Consul server. Find out how to install Consul-Alerts.
Ensure that Consul-Alerts is running.
Configure the Compass API key:
curl -X PUT -d 'API_KEY' http://localhost:8500/v1/kv/consul-alerts/config/notifiers/opsgenie/api-key
| Info |
|---|
The Consul agent's IP and port may vary. |
Optional: Set the entity field value to show up in Compass alert details. The default is 'Cluster-Alert'.
curl -X PUT -d 'Consul' http://localhost:8500/v1/kv/consul-alerts/config/notifiers/opsgenie/cluster-name
Enable Compass 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 Compass alert is automatically created. When the Consul healthcheck passes again, the Compass alert is automatically closed.
| Note |
|---|
This is an API-based integration, so dynamic (draggable) properties such as custom priority, payload, URL, and headers aren't available. |