Skip to content

Commit

Permalink
docs: format, typos, and some simplifications in docs/ (netdata#19112)
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyam8 authored Nov 30, 2024
1 parent 4038a7d commit d9f7159
Show file tree
Hide file tree
Showing 58 changed files with 487 additions and 526 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ You can read more about the different options in the [Alerts reference documenta
### 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.
- **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.
- **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

Expand Down
4 changes: 2 additions & 2 deletions docs/alerts-and-notifications/notifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ This section includes the documentation of the integrations for both of Netdata'

<!-- following links are virtual links to a generated page, should not lead somewhere upon click from GitHub -->

- Netdata Cloud provides centralized alert notifications, utilizing the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](/docs/alerts-&-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.
- Netdata Cloud provides centralized alert notifications, using the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.

- The Netdata Agent offers a [wider range of notification options](/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the Agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.
- The Netdata Agent offers a [wider range of notification options](/docs/alerts-and-notifications/notifications/agent-dispatched-notifications) directly from the Agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ From the Cloud interface, you can manage your space's Alert notification silenci
To manage **space's Alert notification silencing rule settings**, you will need the following:

- A Netdata Cloud account
- Access to the space as an **administrator** or **manager** (**troubleshooters** can only view space rules)
- Access to 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:

- A Netdata Cloud account
- Access to the space with any role except **billing**
- Access to Space with any role except **billing**

### Steps

Expand All @@ -21,33 +21,33 @@ To manage your **personal Alert notification silencing rule settings**, you will
3. Click on the **Notification Silencing Rules** tab.
4. You will be presented with a table of the configured Alert notification silencing rules for:

- The space (if you 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.
- 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.
- 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:
- Immediately, from now until it is turned off or until a specific duration (start and end date automatically set).
- 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](/docs/netdata-cloud/view-plan-and-billing.md).
2. **Edit an existing** Alert notification silencing rule configuration. You will be able to change:
- The name provided for it
- Who it applies to
- Selection criteria for Nodes and Alerts
- When it will be applied
3. **Enable/Disable** a given Alert notification silencing rule configuration.
- Use the toggle to enable or disable
4. **Delete an existing** Alert notification silencing rule.
- Use the trash icon to delete your configuration
1. **Add a new** Alert notification silencing rule configuration.
- 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 refer to it.
- Define criteria for Nodes, to which Rooms will the rule apply, on what Nodes and whether it applies to host labels key-value pairs.
- Define criteria for Alerts, such as Alert name is being targeted and in what Alert context. You can also specify if it applies to a specific Alert role.
- Define when it is applied:
- Immediately, from now until it is turned off or until a specific duration (start and end date automatically set).
- 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](/docs/netdata-cloud/view-plan-and-billing.md).
2. **Edit an existing** Alert notification silencing rule configuration. You will be able to change:
- The name provided for it
- Who it applies to
- Selection criteria for Nodes and Alerts
- When it will be applied
3. **Enable/Disable** a given Alert notification silencing rule configuration.
- Use the toggle to enable or disable
4. **Delete an existing** Alert notification silencing rule.
- Use the trash icon to delete your configuration

## Silencing Rules Examples

| Rule name | Rooms | Nodes | Host Label | Alert name | Alert context | Alert instance | Alert role | Description |
| Rule name | 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. |
| 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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ From the Cloud interface, you can manage your Space's notification settings as w
To manage Space notification settings, you will need the following:

- A Netdata Cloud account
- Access to the Space as an **administrator**
- Access to Space as an **administrator**

### Available Actions per Notification Method Based on Service Level

Expand All @@ -31,20 +31,20 @@ To manage Space notification settings, you will need the following:
2. Click on the **Alerts & Notifications** tab on the left-hand side.
3. Click on the **Notification Methods** tab.
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.
- Choose the service from the list of available ones. The available options will depend on your subscription plan.
- You can optionally provide a name for the configuration so you can easily refer to 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).
- 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.
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:
- The name provided for it
- Filtering criteria
- Service-specific inputs
3. **Enable/Disable** a given notification method configuration.
- Use the toggle to enable or disable the notification method configuration.
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.
1. **Add a new** notification method configuration.
- Choose the service from the list of available ones. The available options will depend on your subscription plan.
- You can optionally provide a name for the configuration so you can refer to 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).
- 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.
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:
- The name provided for it
- Filtering criteria
- Service-specific inputs
3. **Enable/Disable** a given notification method configuration.
- Use the toggle to enable or disable the notification method configuration.
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.

## Manage User Notification Settings

Expand All @@ -61,11 +61,11 @@ Note: If an administrator has disabled a Personal [service level](/docs/alerts-a

1. Click on the **User notification settings** shortcut on top of the help button.
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 list of Spaces and Rooms inside those where you have access to.
- 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 of Spaces and Rooms inside those where you have access to.
3. On this modal you will be able to:
1. **Enable/Disable** the notification method for you; this applies across all Spaces and Rooms.
- Use the toggle to enable or disable the notification method.
2. **Define what notifications you want** per Space/Room: All Alerts and unreachable, All Alerts, Critical only, or No notifications.
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.
1. **Enable/Disable** the notification method for you; this applies across all Spaces and Rooms.
- Use the toggle to enable or disable the notification method.
2. **Define what notifications you want** per Space/Room: All Alerts and unreachable, All Alerts, Critical only, or No notifications.
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.
4 changes: 2 additions & 2 deletions docs/category-overview-pages/working-with-logs.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Working with Logs

This section talks about ways Netdata collects and visualizes logs.
This section talks about the ways Netdata collects and visualizes logs.

The [systemd journal plugin](/src/collectors/systemd-journal.plugin/) is the core Netdata component for reading systemd journal logs.
The [systemd journal plugin](/src/collectors/systemd-journal.plugin) is the core Netdata component for reading systemd journal logs.

For structured logs, Netdata provides tools like [log2journal](/src/collectors/log2journal/README.md) and [systemd-cat-native](/src/libnetdata/log/systemd-cat-native.md) to convert them into compatible systemd journal entries.

Expand Down
4 changes: 2 additions & 2 deletions docs/dashboards-and-charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ When you access the Netdata dashboard through the Cloud, you'll always have the
By default, the Agent dashboard shows the latest version (matching Netdata Cloud). However, there are a few exceptions:

- Without internet access, the Agent can't download the newest dashboards. In this case, it will automatically use the bundled version.
- Users have defined, e.g. through URL bookmark, that they want to see the previous version of the dashboard (accessible `http://NODE:19999/v1`, replacing `NODE` with the IP address or hostname of your Agent).
- Users have defined, e.g., through URL bookmark that they want to see the previous version of the dashboard (accessible `http://NODE:19999/v1`, replacing `NODE` with the IP address or hostname of your Agent).

## Main sections

Expand Down Expand Up @@ -37,4 +37,4 @@ You can access the dashboard at <https://app.netdata.cloud/> and [sign-in with a

To view your Netdata dashboard, open a web browser and enter the address `http://NODE:19999` - replace `NODE` with your Agent's IP address or hostname. If the Agent is on the same machine, use `http://localhost:19999`.

Documentation for previous Agent dashboard can still be found [here](/src/web/gui/README.md).
Documentation for the previous Agent dashboard can still be found [here](/src/web/gui/README.md).
Loading

0 comments on commit d9f7159

Please sign in to comment.