Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 3 Current »

Netdata troubleshoots slowdowns and anomalies in your infrastructure with thousands of metrics, interactive visualizations, and insightful health alarms.

What does the integration offer?

With the Netdata Integration, Compass acts as a dispatcher for these alerts, 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.

Compass has a specific API for Netdata Integration, Netdata sends alerts to Compass and Compass handles the automatic creation of alerts.

How does the integration work?

  • Netdata troubleshoot slowdowns and anomalies in your infrastructure and creates alarms from this. When an alert is created in Netdata, an alert is also created in Compass automatically through the integration.

  • When values are back to normal, the alerts are cleared in Netdata. When an alert is cleared in Netdata, an alert is also closed in Compass.

Set up the integration

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

  • Add a Netdata integration in Compass

  • Configure the integration in Netdata

Add a Netdata integration

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

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

To configure the integration of Netdata with Compass, complete the following steps:

  1. In Netdata, update the notification variable in health_alarm_notify.conf with the following commands:
    # cd /etc/netdata
    # ./edit-config health_alarm_notify.conf

  2. Declare OG_API_KEY with the value of the API key copied previously from Compass.

  3. Start Netdata.

  • No labels