mirror of
https://github.com/netdata/netdata.git
synced 2025-04-13 01:08:11 +00:00
grammar pass on alerts and notifications dir (#17729)
This commit is contained in:
parent
bde40f3ec6
commit
0c8277f8d9
4 changed files with 123 additions and 122 deletions
docs/alerts-and-notifications
creating-alerts-with-netdata-alerts-configuration-manager.md
notifications/centralized-cloud-notifications
|
@ -1,45 +1,44 @@
|
||||||
# Creating Alerts with Netdata Alerts Configuration Manager
|
# 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](https://www.netdata.cloud/pricing/).
|
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](https://www.netdata.cloud/pricing/).
|
||||||
|
|
||||||
## Using the Alerts Configuration Manager
|
## Using the Alerts Configuration Manager
|
||||||
|
|
||||||
1. Navigate to the **Metrics** tab and select the chart you want to configure for alerts.
|
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.
|
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.
|
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**.
|
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](/src/health/REFERENCE.md#edit-health-configuration-files).
|
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](/src/health/REFERENCE.md#edit-health-configuration-files).
|
||||||
6. To activate the new alert, run the command `<path to netdata install>/usr/sbin/netdatacli reload-health`.
|
6. To activate the new Alert, run the command `<path to netdata install>/usr/sbin/netdatacli reload-health`.
|
||||||
|
|
||||||
## Alerts Configuration Manager Sections
|
## Alerts Configuration Manager Sections
|
||||||
|
|
||||||
### Alert Detection Method
|
### Alert Detection Method
|
||||||
|
|
||||||
An alert is triggered whenever a metric crosses a threshold:
|
An Alert is triggered whenever a metric crosses a threshold:
|
||||||
|
|
||||||
- **Standard Threshold**: Triggered when a metric crosses a predefined value.
|
- **Standard Threshold**: Triggered when a metric crosses a predefined value.
|
||||||
- **Metric Variance**: Triggered based on the variance of the metric.
|
- **Metric Variance**: Triggered based on the variance of the metric.
|
||||||
- **Anomaly Rate**: Triggered based on the anomaly rate of the metric.
|
- **Anomaly Rate**: Triggered based on the anomaly rate of the metric.
|
||||||
|
|
||||||
### Metrics Lookup, Filtering and Formula Section
|
### Metrics Lookup, Filtering, and Formula Section
|
||||||
|
|
||||||
You can read more about the different options in the [Alerts reference documentation](/src/health/REFERENCE.md)
|
You can read more about the different options in the [Alerts reference documentation](/src/health/REFERENCE.md).
|
||||||
|
|
||||||
- **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`.
|
- **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.
|
- **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.
|
- **Formula / Calculation**: The **show advanced** checkbox allows defining a formula for the metric value, which is then used to set Alert thresholds.
|
||||||
|
|
||||||
### Alerting Conditions
|
### 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.
|
- **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.
|
- **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.
|
- **Check Interval**: Define how frequently the health check should run.
|
||||||
- **Delay Notifications**: Manage notification delays for alert escalations or de-escalations.
|
- **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.
|
- **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.
|
- **Custom Exec Script**: Define custom scripts to execute when an Alert triggers.
|
||||||
|
|
||||||
### Alert Name, Description and Summary Section
|
### Alert Name, Description, and Summary Section
|
||||||
|
|
||||||
- **Alert Template Name**: Provide a unique name for the alert.
|
- **Alert Template Name**: Provide a unique name for the Alert.
|
||||||
- **Alert Template Description**: Offer a brief explanation of what the alert monitors.
|
- **Alert Template Description**: Offer a brief explanation of what the Alert
|
||||||
- **Alert Summary**: Create a custom title for alert notifications, which can be integrated with centralized notification systems available [here](https://learn.netdata.cloud/docs/alerts-&-notifications/notifications/centralized-cloud-notifications).
|
|
||||||
|
|
|
@ -1,24 +1,26 @@
|
||||||
# Centralized Cloud Notifications Reference
|
# Centralized Cloud Notifications Reference
|
||||||
|
|
||||||
Netdata Cloud sends alert notifications for nodes in warning, critical, or unreachable states, ensuring alerts are managed centrally and efficiently.
|
Netdata Cloud sends Alert notifications for nodes in warning, critical, or unreachable states, ensuring Alerts are managed centrally and efficiently.
|
||||||
|
|
||||||
## Benefits of Centralized Notifications
|
## Benefits of Centralized Notifications
|
||||||
|
|
||||||
- Consolidate health status views across all infrastructure in one place.
|
- Consolidate health status views across all infrastructure in one place.
|
||||||
- Set up and [manage your alert notifications easily](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md).
|
- Set up and [manage your Alert notifications easily](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md).
|
||||||
- Expedite troubleshooting with tools like [Metric Correlations](/docs/metric-correlations.md) and the [Anomaly Advisor](/docs/dashboards-and-charts/anomaly-advisor-tab.md).
|
- Expedite troubleshooting with tools like [Metric Correlations](/docs/metric-correlations.md) and the [Anomaly Advisor](/docs/dashboards-and-charts/anomaly-advisor-tab.md).
|
||||||
|
|
||||||
To avoid notification overload, **flood protection** is triggered when a node frequently disconnects or sends excessive alerts, highlighting potential issues.
|
|
||||||
|
|
||||||
Admins must [enable alert notifications](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md#manage-space-notification-settings) for their Space(s). All users can then customize their notification preferences through their [account menu](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md#manage-user-notification-settings).
|
|
||||||
|
|
||||||
> **Note**
|
> **Note**
|
||||||
>
|
>
|
||||||
> Centralized alerts in Netdata Cloud are separate from the [Netdata Agent](/docs/alerts-and-notifications/notifications/README.md) notifications. Alerts must be [configured individually](/src/health/REFERENCE.md) on each node.
|
> To avoid notification overload, **flood protection** is triggered when a node frequently disconnects or sends excessive Alerts, highlighting potential issues.
|
||||||
|
|
||||||
|
Administrators must [enable Alert notifications](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md#manage-space-notification-settings) for their Space(s). All users can then customize their notification preferences through their [account menu](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md#manage-user-notification-settings).
|
||||||
|
|
||||||
|
> **Note**
|
||||||
|
>
|
||||||
|
> Centralized Alerts in Netdata Cloud are separate from the [Netdata Agent](/docs/alerts-and-notifications/notifications/README.md) notifications. Agent Alerts must be [configured individually](/src/health/REFERENCE.md) on each node.
|
||||||
|
|
||||||
## Alert Notifications
|
## Alert Notifications
|
||||||
|
|
||||||
Notifications can be sent via email or through third-party services like PagerDuty or Slack. Admins manage notification settings for the entire Space, while individual users can personalize settings in their profile.
|
Notifications can be sent via email or through third-party services like PagerDuty or Slack. Administrators can manage notification settings for the entire Space, while individual users can personalize settings in their profile.
|
||||||
|
|
||||||
### Service Level
|
### Service Level
|
||||||
|
|
||||||
|
@ -28,7 +30,7 @@ Notifications are sent to user-specific destinations, such as email, which are m
|
||||||
|
|
||||||
#### System
|
#### System
|
||||||
|
|
||||||
These notifications go to general targets like a Slack channel, with admins setting rules for notification targets based on workspace or alert level.
|
These notifications go to general targets like a Slack channel, with administrators setting rules for notification targets based on workspace or Alert level.
|
||||||
|
|
||||||
### Service Classification
|
### Service Classification
|
||||||
|
|
||||||
|
@ -42,11 +44,11 @@ Exclusive to [paid plans](/docs/netdata-cloud/netdata-subscription-plans.md), in
|
||||||
|
|
||||||
## Alert Notification Silencing Rules
|
## Alert Notification Silencing Rules
|
||||||
|
|
||||||
Netdata Cloud offers a silencing rule engine to mute alert notifications based on specific conditions related to nodes or alert types. Learn how to manage these settings [here](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md).
|
Netdata Cloud offers a silencing rule engine to mute Alert notifications based on specific conditions related to nodes or Alert types. Learn how to manage these settings [here](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md).
|
||||||
|
|
||||||
## Flood Protection
|
## Flood Protection
|
||||||
|
|
||||||
If a node repeatedly changes state or fires alerts, flood protection limits notifications to prevent overload. You can still access node details through Netdata Cloud or directly via the local Agent dashboard.
|
If a node repeatedly changes state or raises Alerts, flood protection limits notifications to prevent overload. You can still access node details through Netdata Cloud or directly via the local Agent dashboard.
|
||||||
|
|
||||||
## Anatomy of an Email Alert Notification
|
## Anatomy of an Email Alert Notification
|
||||||
|
|
||||||
|
@ -55,13 +57,13 @@ Email notifications provide comprehensive details:
|
||||||
- The Space's name
|
- The Space's name
|
||||||
- The node's name
|
- The node's name
|
||||||
- Alert status: critical, warning, cleared
|
- Alert status: critical, warning, cleared
|
||||||
- Previous alert status
|
- Previous Alert status
|
||||||
- Time at which the alert triggered
|
- Time at which the Alert triggered
|
||||||
- Chart context that triggered the alert
|
- Chart context that triggered the Alert
|
||||||
- Name and information about the triggered alert
|
- Name and information about the triggered Alert
|
||||||
- Alert value
|
- Alert value
|
||||||
- Total number of warning and critical alerts on that node
|
- Total number of warning and critical Alerts on that node
|
||||||
- Threshold for triggering the given alert state
|
- Threshold for triggering the given Alert state
|
||||||
- Calculation or database lookups that Netdata uses to compute the value
|
- Calculation or database lookups that Netdata uses to compute the value
|
||||||
- Source of the alert, including which file you can edit to configure this alert on an individual node
|
- Source of the Alert, including which file you can edit to configure this Alert on an individual node
|
||||||
- Direct link to the node’s chart in Cloud dashboards.
|
- Direct link to the node’s chart in Cloud dashboards.
|
||||||
|
|
|
@ -1,59 +1,60 @@
|
||||||
# Manage alert notification silencing rules
|
# Manage Alert Notification Silencing Rules
|
||||||
|
|
||||||
From the Cloud interface, you can manage your space's alert notification silencing rules settings as well as allow users to define their personal ones.
|
From the Cloud interface, you can manage your space's Alert notification silencing rules settings as well as allow users to define their personal ones.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
To manage **space's alert notification silencing rule settings**, you will need the following:
|
To manage **space's Alert notification silencing rule settings**, you will need the following:
|
||||||
|
|
||||||
- A Netdata Cloud account
|
- A Netdata Cloud account
|
||||||
- Access to the space as an **administrator** or **manager** (**troubleshooters** can only view space rules)
|
- Access to the space as an **administrator** or **manager** (**troubleshooters** can only view space rules)
|
||||||
|
|
||||||
|
To manage your **personal Alert notification silencing rule settings**, you will need the following:
|
||||||
To manage your **personal alert notification silencing rule settings**, you will need the following:
|
|
||||||
|
|
||||||
- A Netdata Cloud account
|
- A Netdata Cloud account
|
||||||
- Access to the space with any roles except **billing**
|
- Access to the space with any role except **billing**
|
||||||
|
|
||||||
### Steps
|
### Steps
|
||||||
|
|
||||||
1. Click on the **Space settings** cog (located above your profile icon)
|
1. Click on the **Space settings** cog (located above your profile icon).
|
||||||
1. Click on the **Alert & Notification** tab on the left hand-side
|
2. Click on the **Alert & Notification** tab on the left-hand side.
|
||||||
1. Click on the **Notification Silencing Rules** tab
|
3. Click on the **Notification Silencing Rules** tab.
|
||||||
1. You will be presented with a table of the configured alert notification silencing rules for:
|
4. You will be presented with a table of the configured Alert notification silencing rules for:
|
||||||
* the space (if aren't an **observer**)
|
|
||||||
* yourself
|
- The space (if you aren't an **observer**)
|
||||||
|
- Yourself
|
||||||
You will be able to:
|
|
||||||
1. **Add a new** alert notification silencing rule configuration.
|
You will be able to:
|
||||||
- Choose if it applies to **All users** or **Myself** (All users is only available for **administrators** and **managers**)
|
|
||||||
- You need to provide a name for the configuration so you can easily refer to it
|
1. **Add a new** Alert notification silencing rule configuration.
|
||||||
- Define criteria for Nodes: To which Rooms will this apply? What Nodes? Does it apply to host labels key-value pairs?
|
- Choose if it applies to **All users** or **Myself** (All users is only available for **administrators** and **managers**).
|
||||||
- Define criteria for Alerts: Which alert name is being targeted? What alert context? Will it apply to a specific alert role?
|
- You need to provide a name for the configuration so you can easily refer to it.
|
||||||
|
- Define criteria for Nodes, to which Rooms will the rule apply, on what Nodes and whether or not it applies to host labels key-value pairs.
|
||||||
|
- Define criteria for Alerts, such as Alert name is being targeted and on what Alert context. You can also specify if it will apply to a specific Alert role.
|
||||||
- Define when it will be applied:
|
- Define when it will be applied:
|
||||||
- Immediately, from now till until it is turned off or until a specific duration (start and end date automatically set)
|
- Immediately, from now until it is turned off or until a specific duration (start and end date automatically set).
|
||||||
- Scheduled, you specify the start and end time for when the rule becomes active and then inactive (time is set according to your browser local timezone)
|
- Scheduled, you can specify the start and end time for when the rule becomes active and then inactive (time is set according to your browser's local timezone).
|
||||||
Note: You are only able to add a rule if your space is on a [paid plan](https://github.com/netdata/netdata/edit/master/docs/netdata-cloud/netdata-subscription-plans.md).
|
Note: You are only able to add a rule if your space is on a [paid plan](/docs/netdata-cloud/netdata-subscription-plans.md).
|
||||||
1. **Edit an existing** alert notification silencing rule configurations. You will be able to change:
|
2. **Edit an existing** Alert notification silencing rule configuration. You will be able to change:
|
||||||
- The name provided for it
|
- The name provided for it
|
||||||
- Who it applies to
|
- Who it applies to
|
||||||
- Selection criteria for Nodes and Alert
|
- Selection criteria for Nodes and Alerts
|
||||||
- When it will be applied
|
- When it will be applied
|
||||||
1. **Enable/Disable** a given alert notification silencing rule configuration.
|
3. **Enable/Disable** a given Alert notification silencing rule configuration.
|
||||||
- Use the toggle to enable or disable
|
- Use the toggle to enable or disable
|
||||||
1. **Delete an existing** alert notification silencing rule.
|
4. **Delete an existing** Alert notification silencing rule.
|
||||||
- Use the trash icon to delete your configuration
|
- Use the trash icon to delete your configuration
|
||||||
|
|
||||||
## Silencing rules examples
|
## Silencing Rules Examples
|
||||||
|
|
||||||
| Rule name | War Rooms | Nodes | Host Label | Alert name | Alert context | Alert instance | Alert role | Description |
|
| Rule name | War Rooms | Nodes | Host Label | Alert name | Alert context | Alert instance | Alert role | Description |
|
||||||
| :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :--|
|
|:---------------------------------|:-------------------|:---------|:-------------------------|:-------------------------------------------------|:--------------|:-------------------------|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| Space silencing | All Rooms | * | * | * | * | * | This rule silences the entire space, targets all nodes and for all users. E.g. infrastructure wide maintenance window. |
|
| Space silencing | All Rooms | * | * | * | * | * | * | This rule silences the entire space, targets all nodes, and for all users. E.g. infrastructure-wide maintenance window. |
|
||||||
| DB Servers Rooms | PostgreSQL Servers | * | * | * | * | * | * | This rules silences the nodes in the room named PostgreSQL Servers, for example it doesn't silence the `All Nodes` room. E.g. My team with membership to this room doesn't want to receive notifications for these nodes. |
|
| DB Servers Rooms | PostgreSQL Servers | * | * | * | * | * | * | This rule silences the nodes in the room named PostgreSQL Servers, for example, it doesn't silence the `All Nodes` room. E.g. My team with membership to this room doesn't want to receive notifications for these nodes. |
|
||||||
| Node child1 | All Rooms | `child1` | * | * | * | * | * | This rule silences all alert state transitions for node `child1` on all rooms and for all users. E.g. node could be going under maintenance. |
|
| Node child1 | All Rooms | `child1` | * | * | * | * | * | This rule silences all Alert state transitions for node `child1` in all rooms and for all users. E.g. node could be going under maintenance. |
|
||||||
| Production nodes | All Rooms | * | `environment:production` | * | * | * | * | This rule silences all alert state transitions for nodes with the host label key-value pair `environment:production`. E.g. Maintenance window on nodes with specific host labels. |
|
| Production nodes | All Rooms | * | `environment:production` | * | * | * | * | This rule silences all Alert state transitions for nodes with the host label key-value pair `environment:production`. E.g. Maintenance window on nodes with specific host labels. |
|
||||||
| Third party maintenance | All Rooms | * | * | `httpcheck_posthog_netdata_cloud.request_status` | * | * | * | This rule silences this specific alert since third party partner will be undergoing maintenance. |
|
| Third party maintenance | All Rooms | * | * | `httpcheck_posthog_netdata_cloud.request_status` | * | * | * | This rule silences this specific Alert since the third-party partner will be undergoing maintenance. |
|
||||||
| Intended stress usage on CPU | All Rooms | * | * | * | `system.cpu` | * | * | This rule silences specific alerts across all nodes and their CPU cores. |
|
| Intended stress usage on CPU | All Rooms | * | * | * | `system.cpu` | * | * | This rule silences specific Alerts across all nodes and their CPU cores. |
|
||||||
| Silence role webmaster | All Rooms | * | * | * | * | * | `webmaster` | This rule silences all alerts configured with the role `webmaster`. |
|
| Silence role webmaster | All Rooms | * | * | * | * | * | `webmaster` | This rule silences all Alerts configured with the role `webmaster`. |
|
||||||
| Silence alert on node | All Rooms | `child1` | * | `httpcheck_posthog_netdata_cloud.request_status` | * | * | * | This rule silences the specific alert on the `child1` node. |
|
| Silence Alert on node | All Rooms | `child1` | * | `httpcheck_posthog_netdata_cloud.request_status` | * | * | * | This rule silences the specific Alert on the `child1` node. |
|
||||||
| Disk Space alerts on mount point | All Rooms | * | * | `disk_space_usage` | `disk.space` | `disk_space_opt_baddisk` | * | This rule silences the specific alert instance on all nodes `/opt/baddisk`. |
|
| Disk Space Alerts on mount point | All Rooms | * | * | `disk_space_usage` | `disk.space` | `disk_space_opt_baddisk` | * | This rule silences the specific Alert instance on all nodes `/opt/baddisk`. |
|
||||||
|
|
|
@ -1,73 +1,72 @@
|
||||||
# Manage notification methods
|
# Manage Notification Methods
|
||||||
|
|
||||||
From the Cloud interface, you can manage your space's notification settings as well as allow users to personalize their notifications setting
|
From the Cloud interface, you can manage your Space's notification settings as well as allow users to personalize their notification settings.
|
||||||
|
|
||||||
## Manage space notification settings
|
## Manage Space Notification Settings
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
To manage space notification settings, you will need the following:
|
To manage Space notification settings, you will need the following:
|
||||||
|
|
||||||
- A Netdata Cloud account
|
- A Netdata Cloud account
|
||||||
- Access to the space as an **administrator**
|
- Access to the Space as an **administrator**
|
||||||
|
|
||||||
### Available actions per notification methods based on service level
|
### Available Actions per Notification Method Based on Service Level
|
||||||
|
|
||||||
| **Action** | **Personal service level** | **System service level** |
|
| **Action** | **Personal Service Level** | **System Service Level** |
|
||||||
| :- | :-: | :-: |
|
|:------------------------------------------------|:--------------------------:|:------------------------:|
|
||||||
| Enable / Disable | X | X |
|
| Enable / Disable | X | X |
|
||||||
| Edit | | X | |
|
| Edit | | X |
|
||||||
| Delete | X | X |
|
| Delete | X | X |
|
||||||
| Add multiple configurations for same method | | X |
|
| Add multiple configurations for the same method | | X |
|
||||||
|
|
||||||
Notes:
|
> **Notes**
|
||||||
* For Netadata provided ones you can't delete the existing notification method configuration.
|
>
|
||||||
* Enable, Edit and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-classification))
|
> - For Netdata provided ones, you can't delete the existing notification method configuration.
|
||||||
|
> - Enable, Edit, and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-classification)).
|
||||||
|
|
||||||
### Steps
|
### Steps
|
||||||
|
|
||||||
1. Click on the **Space settings** cog (located above your profile icon)
|
1. Click on the **Space settings** cog (located above your profile icon).
|
||||||
1. Click on the **Alerts & Notification** tab on the left hand-side
|
2. Click on the **Alerts & Notifications** tab on the left-hand side.
|
||||||
1. Click on the **Notification Methods** tab
|
3. Click on the **Notification Methods** tab.
|
||||||
1. You will be presented with a table of the configured notification methods for the space. You will be able to:
|
4. You will be presented with a table of the configured notification methods for the Space. You will be able to:
|
||||||
1. **Add a new** notification method configuration.
|
1. **Add a new** notification method configuration.
|
||||||
- Choose the service from the list of the available ones, you'll may see a list of unavailable options if your plan doesn't allow some of them (you will see on the
|
- Choose the service from the list of available ones. The available options will depend on your subscription plan.
|
||||||
card the plan level that allows a specific service)
|
- You can optionally provide a name for the configuration so you can easily refer to it.
|
||||||
- You can optionally provide a name for the configuration so you can easily refer to what it
|
- You can define the filtering criteria, regarding which Rooms the method will apply, and what notifications you want to receive (All Alerts and unreachable, All Alerts, Critical only).
|
||||||
- Define filtering criteria. To which Rooms will this apply? What notifications I want to receive? (All Alerts and unreachable, All Alerts, Critical only)
|
- Depending on the service, different inputs will be present. Please note that there are mandatory and optional inputs.
|
||||||
- Depending on the service different inputs will be present, please note that there are mandatory and optional inputs
|
- If you have doubts on how to configure the service, you can find a link at the top of the modal that takes you to the specific documentation page to help you.
|
||||||
- If you doubts on how to configure the service you can find a link at the top of the modal that takes you to the specific documentation page to help you
|
2. **Edit an existing** notification method configuration. Personal level ones can't be edited here, see [Manage User Notification Settings](#manage-user-notification-settings). You will be able to change:
|
||||||
1. **Edit an existing** notification method configuration. Personal level ones can't be edited here, see [Manage user notification settings](#manage-user-notification-settings). You will be able to change:
|
|
||||||
- The name provided for it
|
- The name provided for it
|
||||||
- Filtering criteria
|
- Filtering criteria
|
||||||
- Service specific inputs
|
- Service-specific inputs
|
||||||
1. **Enable/Disable** a given notification method configuration.
|
3. **Enable/Disable** a given notification method configuration.
|
||||||
- Use the toggle to enable or disable the notification method configuration
|
- Use the toggle to enable or disable the notification method configuration.
|
||||||
1. **Delete an existing** notification method configuration. Netdata provided ones can't be deleted, e.g. Email
|
4. **Delete an existing** notification method configuration. Netdata provided ones can't be deleted, e.g., Email.
|
||||||
- Use the trash icon to delete your configuration
|
- Use the trash icon to delete your configuration.
|
||||||
|
|
||||||
## Manage user notification settings
|
## Manage User Notification Settings
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
To manage user specific notification settings, you will need the following:
|
To manage user-specific notification settings, you will need the following:
|
||||||
|
|
||||||
- A Cloud account
|
- A Cloud account
|
||||||
- Have access to, at least, a space
|
- Access to, at least, a Space
|
||||||
|
|
||||||
Note: If an administrator has disabled a Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification method this will override any user specific setting.
|
Note: If an administrator has disabled a Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification method, this will override any user-specific setting.
|
||||||
|
|
||||||
### Steps
|
### Steps
|
||||||
|
|
||||||
1. Click on the **User notification settings** shortcut on top of the help button
|
1. Click on the **User notification settings** shortcut on top of the help button.
|
||||||
1. You are presented with:
|
2. You are presented with:
|
||||||
- The Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification methods you can manage
|
- The Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification methods you can manage.
|
||||||
- The list spaces and rooms inside those where you have access to
|
- The list of Spaces and Rooms inside those where you have access to.
|
||||||
- If you're an administrator, Manager or Troubleshooter you'll also see the Rooms from a space you don't have access to on **All Rooms** tab and you can activate notifications for them by joining the room
|
- If you're an Administrator, Manager, or Troubleshooter, you'll also see the Rooms from a Space you don't have access to on the **All Rooms** tab, and you can activate notifications for them by joining the Room.
|
||||||
1. On this modal you will be able to:
|
3. On this modal you will be able to:
|
||||||
1. **Enable/Disable** the notification method for you, this applies accross all spaces and rooms
|
1. **Enable/Disable** the notification method for you; this applies across all Spaces and Rooms.
|
||||||
- Use the toggle enable or disable the notification method
|
- Use the toggle to enable or disable the notification method.
|
||||||
1. **Define what notifications you want** to per space/room: All Alerts and unreachable, All Alerts, Critical only or No notifications
|
2. **Define what notifications you want** per Space/room: All Alerts and unreachable, All Alerts, Critical only, or No notifications.
|
||||||
1. **Activate notifications** for a room you aren't a member of
|
3. **Activate notifications** for a Room you aren't a member of.
|
||||||
- From the **All Rooms** tab click on the Join button for the room(s) you want
|
- From the **All Rooms** tab, click on the Join button for the Room(s) you want.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue