0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-14 01:29:11 +00:00
netdata_netdata/docs/cloud/alerts-configuration-manager.md
Fotis Voutsas ea98d9a9e7
Update Netdata subscription plans documentation ()
* update the plans doc to reflect plans available

* update role base access model

* view plan n billing updates

* change wording

* admin wording

* update centralized cloud alerts reference doc

* remove misleading plan indication

* check links, and format files and tables

* Update plans.md

* Apply suggestions from code review

* simplify language in edited docs, make them simpler to grasp

* edits from product

* Update alerts-configuration-manager.md

* Apply suggestions from code review

Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>

---------

Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud>
Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>
2024-05-02 11:52:31 +01:00

3.5 KiB

Creating Alerts with Netdata Alerts Configuration Manager

The Netdata Alerts Configuration Manager enables subscribers to easily set up alerts directly from the Netdata Dashboard. More details on subscriptions can be found here.

Using the Alerts Configuration Manager

  1. Navigate to the Metrics tab and select the chart you want to configure for alerts.
  2. Click the Alert icon in the top right corner of the chart.
  3. The Alert Configuration Manager will open, showing the default thresholds. Modify these thresholds as needed, the alert definition on the right will update automatically.
  4. For additional settings, toggle Show advanced.
  5. After configuring the alert, copy the generated alert definition from the code box. Paste this into an existing or new custom health configuration file located at <path to netdata install>/etc/netdata/health.d/ on a Parent Agent or a Standalone Child Agent. The guide to edit health configuration files is available here.
  6. To activate the new alert, run the command <path to netdata install>/usr/sbin/netdatacli reload-health.

Alerts Configuration Manager Sections

Alert Detection Method

An alert is triggered whenever a metric crosses a threshold:

  • Standard Threshold: Triggered when a metric crosses a predefined value.
  • Metric Variance: Triggered based on the variance of the metric.
  • Anomaly Rate: Triggered based on the anomaly rate of the metric.

Metrics Lookup, Filtering and Formula Section

You can read more about the different options in the Alerts reference documentation

  • Metrics Lookup: Adjust the database lookup parameters directly in the UI, including method (avg, sum, min, max, etc.), computation style, dimensions, duration, and options like absolute or percentage.
  • Alert Filtering: The show advanced checkbox allows filtering of alert health checks for specific infrastructure components. Options include selecting hosts, nodes, instances, chart labels, and operating systems.
  • Formula / Calculation: The show advanced checkbox allows defining a formula for the metric value, which is then used to set alert thresholds.

Alerting Conditions

  • Thresholds: Set thresholds for warning and critical alert states, specifying whether the alert should trigger above or below these thresholds. Advanced settings allow for custom formulas.
    • Recovery Thresholds: Set thresholds for downgrading the alert from critical to warning or from warning to clear.
  • Check Interval: Define how frequently the health check should run.
  • Delay Notifications: Manage notification delays for alert escalations or de-escalations.
  • Agent Specific Options: Options exclusive to the Netdata Agent, like repeat notification frequencies and notification recipients.
    • Custom Exec Script: Define custom scripts to execute when an alert triggers.

Alert Name, Description and Summary Section

  • Alert Template Name: Provide a unique name for the alert.
  • Alert Template Description: Offer a brief explanation of what the alert monitors.
  • Alert Summary: Create a custom title for alert notifications, which can be integrated with centralized notification systems available here.