Reorg learn 0226 (#14610)
* Reorg getting started * Streaming * Remove blanks * Fix up to cloud alerts
Chris Akritidis committed
Feb 26, 2023 at 09:38 UTC
20745bf78ba1504591711b0780517f405158503a
34 files changed
+335
-771
daemon/README.md
+9
-102
@@ -1,101 +1,10 @@
1
-<!--
2
-title: "Netdata daemon"
3
-date: "2020-04-29"
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/daemon/README.md"
5
-sidebar_label: "Netdata daemon"
6
-learn_status: "Published"
7
-learn_rel_path: "Operations"
8
--->
9
-
1
# Netdata daemon
2
12
-## Starting netdata
13
-
14
-- You can start Netdata by executing it with `/usr/sbin/netdata` (the installer will also start it).
15
-
16
-- You can stop Netdata by killing it with `killall netdata`. You can stop and start Netdata at any point. When
17
- exiting, the [database engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md) saves metrics to `/var/cache/netdata/dbengine/` so that
18
- it can continue when started again.
19
-
20
-Access to the web site, for all graphs, is by default on port `19999`, so go to:
21
-
22
-```sh
23
-http://127.0.0.1:19999/
24
-```
25
-
26
-You can get the running config file at any time, by accessing `http://127.0.0.1:19999/netdata.conf`.
27
-
28
-### Starting Netdata at boot
29
-
30
-In the `system` directory you can find scripts and configurations for the
31
-various distros.
32
-
33
-#### systemd
34
-
35
-The installer already installs `netdata.service` if it detects a systemd system.
36
-
37
-To install `netdata.service` by hand, run:
38
-
39
-```sh
40
-# stop Netdata
41
-killall netdata
42
-
43
-# copy netdata.service to systemd
44
-cp system/netdata.service /etc/systemd/system/
45
-
46
-# let systemd know there is a new service
47
-systemctl daemon-reload
48
-
49
-# enable Netdata at boot
50
-systemctl enable netdata
51
-
52
-# start Netdata
53
-systemctl start netdata
54
-```
55
-
56
-#### init.d
57
-
58
-In the system directory you can find `netdata-lsb`. Copy it to the proper place according to your distribution
59
-documentation. For Ubuntu, this can be done via running the following commands as root.
60
-
61
-```sh
62
-# copy the Netdata startup file to /etc/init.d
63
-cp system/netdata-lsb /etc/init.d/netdata
64
-
65
-# make sure it is executable
66
-chmod +x /etc/init.d/netdata
67
-
68
-# enable it
69
-update-rc.d netdata defaults
70
-```
71
-
72
-#### openrc (gentoo)
73
-
74
-In the `system` directory you can find `netdata-openrc`. Copy it to the proper
75
-place according to your distribution documentation.
76
-
77
-#### CentOS / Red Hat Enterprise Linux
3
+The Netdata daemon is practically a synonym for the Netdata Agent, as it controls its
4
+entire operation. We support various methods to
5
+[start, stop, or restart the daemon](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
6
79
-For older versions of RHEL/CentOS that don't have systemd, an init script is included in the system directory. This can
80
-be installed by running the following commands as root.
81
-
82
-```sh
83
-# copy the Netdata startup file to /etc/init.d
84
-cp system/netdata-init-d /etc/init.d/netdata
85
-
86
-# make sure it is executable
87
-chmod +x /etc/init.d/netdata
88
-
89
-# enable it
90
-chkconfig --add netdata
91
-```
92
-
93
-_There have been some recent work on the init script, see PR
94
-<https://github.com/netdata/netdata/pull/403>_
95
-
96
-#### other systems
97
-
98
-You can start Netdata by running it from `/etc/rc.local` or equivalent.
7
+This document provides some basic information on the command line options, log files, and how to debug and troubleshoot
8
9
## Command line options
10
@@ -302,7 +211,7 @@ You can use the following:
211
212
For more information see `man sched`.
213
305
-### scheduling priority for `rr` and `fifo`
214
+### Scheduling priority for `rr` and `fifo`
215
216
Once the policy is set to one of `rr` or `fifo`, the following will appear:
217
@@ -323,7 +232,7 @@ When the policy is set to `other`, `nice`, or `batch`, the following will appear
232
process nice level = 19
233
```
234
326
-## scheduling settings and systemd
235
+## Scheduling settings and systemd
236
237
Netdata will not be able to set its scheduling policy and priority to more important values when it is started as the
238
`netdata` user (systemd case).
@@ -471,7 +380,7 @@ will contain the messages.
380
> Do not forget to disable tracing (`debug flags = 0`) when you are done tracing. The file `debug.log` can grow too
381
> fast.
382
474
-### compiling Netdata with debugging
383
+### Compiling Netdata with debugging
384
385
To compile Netdata with debugging, use this:
386
@@ -486,7 +395,7 @@ CFLAGS="-O1 -ggdb -DNETDATA_INTERNAL_CHECKS=1" ./netdata-installer.sh
395
The above will compile and install Netdata with debugging info embedded. You can now use `debug flags` to set the
396
section(s) you need to trace.
397
489
-### debugging crashes
398
+### Debugging crashes
399
400
We have made the most to make Netdata crash free. If however, Netdata crashes on your system, it would be very helpful
401
to provide stack traces of the crash. Without them, is will be almost impossible to find the issue (the code base is
@@ -514,7 +423,7 @@ Run the following command and post the output on a github issue.
423
gdb $(which netdata) /path/to/core/dump
424
```
425
517
-### you can reproduce a Netdata crash on your system
426
+### You can reproduce a Netdata crash on your system
427
428
> you need to have Netdata compiled with debugging info for this to work (check above)
429
@@ -526,5 +435,3 @@ valgrind $(which netdata) -D
435
436
Netdata will start and it will be a lot slower. Now reproduce the crash and `valgrind` will dump on your console the
437
stack trace. Open a new github issue and post the output.
529
-
530
-
database/README.md
+3
-3
@@ -42,13 +42,13 @@ The default mode `[db].mode = dbengine` has been designed to scale for longer re
42
for parent Agents in the _Parent - Child_ setups
43
44
The other available database modes are designed to minimize resource utilization and should only be considered on
45
-[Parent - Child](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md) setups at the children side and only when the
45
+[Parent - Child](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md) setups at the children side and only when the
46
resource constraints are very strict.
47
48
So,
49
50
- On a single node setup, use `[db].mode = dbengine`.
51
-- On a [Parent - Child](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md) setup, use `[db].mode = dbengine` on the
51
+- On a [Parent - Child](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md) setup, use `[db].mode = dbengine` on the
52
parent to increase retention, a more resource efficient mode like, `dbengine` with light retention settings, and
53
`save`, `ram` or `none` modes for the children to minimize resource utilization.
54
@@ -68,7 +68,7 @@ Metrics retention is controlled only by the disk space allocated to storing metr
68
CPU required by the agent to query longer timeframes.
69
70
Since Netdata Agents usually run on the edge, on production systems, Netdata Agent **parents** should be considered.
71
-When having a [**parent - child**](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md) setup, the child (the
71
+When having a [**parent - child**](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md) setup, the child (the
72
Netdata Agent running on a production system) delegates all of its functions, including longer metrics retention and
73
querying, to the parent node that can dedicate more resources to this task. A single Netdata Agent parent can centralize
74
multiple children Netdata Agents (dozens, hundreds, or even thousands depending on its available resources).
docs/Running-behind-apache.md
+4
-15
@@ -1,13 +1,4 @@
1
-<!--
2
-title: "Netdata via apache's mod_proxy"
3
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md"
4
-sidebar_label: "Netdata via apache's mod_proxy"
5
-learn_status: "Published"
6
-learn_topic_type: "Tasks"
7
-learn_rel_path: "Configuration/Secure your nodes"
8
--->
9
-
10
-# Netdata via apache's mod_proxy
1
+# Netdata via Apache's mod_proxy
2
3
Below you can find instructions for configuring an apache server to:
4
@@ -38,13 +29,11 @@ Also, enable the rewrite module:
29
```sh
30
sudo a2enmod rewrite
31
```
41
-
42
-
32
## Netdata on an existing virtual host
33
34
On any **existing** and already **working** apache virtual host, you can redirect requests for URL `/netdata/` to one or more Netdata servers.
35
47
-### proxy one Netdata, running on the same server apache runs
36
+### Proxy one Netdata, running on the same server apache runs
37
38
Add the following on top of any existing virtual host. It will allow you to access Netdata as `http://virtual.host/netdata/`.
39
@@ -74,7 +63,7 @@ Add the following on top of any existing virtual host. It will allow you to acce
63
</VirtualHost>
64
```
65
77
-### proxy multiple Netdata running on multiple servers
66
+### Proxy multiple Netdata running on multiple servers
67
68
Add the following on top of any existing virtual host. It will allow you to access multiple Netdata as `http://virtual.host/netdata/HOSTNAME/`, where `HOSTNAME` is the hostname of any other Netdata server you have (to access the `localhost` Netdata, use `http://virtual.host/netdata/localhost/`).
69
@@ -355,7 +344,7 @@ If your apache server is not on localhost, you can set:
344
345
`allow connections from` accepts [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to match against the connection IP address.
346
358
-## prevent the double access.log
347
+## Prevent the double access.log
348
349
apache logs accesses and Netdata logs them too. You can prevent Netdata from generating its access log, by setting this in `/etc/netdata/netdata.conf`:
350
docs/category-overview-pages/deployment-strategies.md
+4
-4
@@ -1,4 +1,4 @@
1
-# Netdata Deployment Strategies
1
+# Deployment strategies
2
3
Netdata can be used to monitor all kinds of infrastructure, from stand-alone tiny IoT devices to complex hybrid setups
4
combining on-premise and cloud infrastructure, mixing bare-metal servers, virtual machines and containers.
@@ -7,13 +7,13 @@ There are 3 components to structure your Netdata ecosystem:
7
8
1. **Netdata Agents**
9
To monitor the physical or virtual nodes of your infrastructure, including all applications and containers running on them.
10
-
10
+
11
Netdata Agents are Open-Source, licensed under GPL v3+.
12
13
2. **Netdata Parents**
14
To create data centralization points within your infrastructure, to offload Netdata Agents functions from your production
15
systems, to provide high-availability of your data, increased data retention and isolation of your nodes.
16
-
16
+
17
Netdata Parents are implemented using the Netdata Agent software. Any Netdata Agent can be an Agent for a node and a Parent
18
for other Agents, at the same time.
19
@@ -41,7 +41,7 @@ We suggest to do the following configuration changes for production deployments:
41
2. Offload Netdata Agents running on production systems, using Netdata Parents to take over most of their functions
42
To free system resources for the production applications running on them and to isolate production systems from the rest
43
of the world, while at the same time providing increased data retention, data high availability and security.
44
-
44
+
45
See [streaming and replication](https://github.com/netdata/netdata/blob/master/streaming/README.md)
46
47
3. Use Netdata Cloud to access the dashboards
docs/category-overview-pages/installation-overview.md
+1
-8
@@ -1,11 +1,4 @@
1
-<!--
2
-title: "Installation"
3
-sidebar_label: "Installation"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/installation-overview.md"
5
-learn_status: "Published"
6
-learn_rel_path: "Installation"
7
-sidebar_position: 5
8
--->
1
+# Installation
2
3
In this category you can find instructions on all the possible ways you can install Netdata on the
4
[supported platforms](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md).
docs/cloud/alerts-notifications/add-discord-notification.md
+5
-20
@@ -1,17 +1,8 @@
1
-<!--
2
-title: "Add Discord notification configuration"
3
-sidebar_label: "Add Discord notification configuration"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md"
5
-sidebar_position: "1"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
9
-learn_docs_purpose: "Instructions on how to add notification configuration for Discord"
10
--->
1
+# Add Discord notification configuration
2
3
From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord.
4
14
-#### Prerequisites
5
+## Prerequisites
6
7
To enable Discord notifications you need:
8
@@ -19,7 +10,7 @@ To enable Discord notifications you need:
10
- Access to the space as an **administrator**
11
- Have a Discord server able to receive webhook integrations. For mode details check [how to configure this on Discord](#settings-on-discord)
12
22
-#### Steps
13
+## Steps
14
15
1. Click on the **Space settings** cog (located above your profile icon)
16
1. Click on the **Notification** tab
@@ -35,9 +26,9 @@ To enable Discord notifications you need:
26
- Webhook URL - URL provided on Discord for the channel you want to receive your notifications. For more details check [how to configure this on Discord](#settings-on-discord)
27
- Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
28
38
-#### Settings on Discord
29
+## Settings on Discord
30
40
-#### Enable webhook integrations on Discord server
31
+## Enable webhook integrations on Discord server
32
33
To enable the webhook integrations on Discord you need:
34
1. Go to *Integrations** under your **Server Settings
@@ -51,9 +42,3 @@ To enable the webhook integrations on Discord you need:
42
43
44
For more details please read this article from Discord: [Intro to Webhooks](https://support.discord.com/hc/en-us/articles/228383668).
54
-
55
-#### Related topics
56
-
57
-- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
58
-- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
59
-- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
\ No newline at end of file
docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md
+5
-22
@@ -1,17 +1,8 @@
1
-<!--
2
-title: "Add PagerDuty notification configuration"
3
-sidebar_label: "Add PagerDuty notification configuration"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md"
5
-sidebar_position: "1"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
9
-learn_docs_purpose: "Instructions on how to add notification configuration for PagerDuty"
10
--->
1
+# Add PagerDuty notification configuration
2
3
From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on PagerDuty.
4
14
-#### Prerequisites
5
+## Prerequisites
6
7
To add PagerDuty notification configurations you need
8
@@ -20,7 +11,7 @@ To add PagerDuty notification configurations you need
11
- Space needs to be on **Business** plan or higher
12
- Have a PagerDuty service to receive events, for mode details check [how to configure this on PagerDuty](#settings-on-pagerduty)
13
23
-#### Steps
14
+## Steps
15
16
1. Click on the **Space settings** cog (located above your profile icon)
17
1. Click on the **Notification** tab
@@ -34,9 +25,9 @@ To add PagerDuty notification configurations you need
25
1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
26
- Integration Key - is a 32 character key provided by PagerDuty to receive events on your service. For more details check [how to configure this on PagerDuty](#settings-on-pagerduty)
27
37
-#### Settings on PagerDuty
28
+## Settings on PagerDuty
29
39
-#### Enable webhook integrations on PagerDuty
30
+## Enable webhook integrations on PagerDuty
31
32
To enable the webhook integrations on PagerDuty you need:
33
1. Create a service to receive events from your services directory page:
@@ -49,12 +40,4 @@ To enable the webhook integrations on PagerDuty you need:
40
41
1. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI:
42
52
-
43
54
-
55
-
56
-#### Related topics
57
-
58
-- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
59
-- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
60
-- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
\ No newline at end of file
docs/cloud/alerts-notifications/add-slack-notification-configuration.md
+4
-20
@@ -1,17 +1,8 @@
1
-<!--
2
-title: "Add Slack notification configuration"
3
-sidebar_label: "Add Slack notification configuration"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md"
5
-sidebar_position: "1"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
9
-learn_docs_purpose: "Instructions on how to add notification configuration for Slack"
10
--->
1
+# Add Slack notification configuration
2
3
From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on Slack.
4
14
-#### Prerequisites
5
+## Prerequisites
6
7
To add discord notification configurations you need
8
@@ -20,7 +11,7 @@ To add discord notification configurations you need
11
- Space needs to be on **Business** plan or higher
12
- Have a Slack app on your workspace to receive the webhooks, for mode details check [how to configure this on Slack](#settings-on-slack)
13
23
-#### Steps
14
+## Steps
15
16
1. Click on the **Space settings** cog (located above your profile icon)
17
1. Click on the **Notification** tab
@@ -34,7 +25,7 @@ To add discord notification configurations you need
25
1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
26
- Webhook URL - URL provided on Slack for the channel you want to receive your notifications. For more details check [how to configure this on Slack](#settings-on-slack)
27
37
-#### Settings on Slack
28
+## Settings on Slack
29
30
To enable the webhook integrations on Slack you need:
31
1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details
@@ -54,10 +45,3 @@ To enable the webhook integrations on Slack you need:
45
46
47
For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
57
-
58
-
59
-#### Related topics
60
-
61
-- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
62
-- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
63
-- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
\ No newline at end of file
docs/cloud/alerts-notifications/add-webhook-notification-configuration.md
+7
-22
@@ -1,17 +1,8 @@
1
-<!--
2
-title: "Add webhook notification configuration"
3
-sidebar_label: "Add webhook notification configuration"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md"
5
-sidebar_position: "1"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
9
-learn_docs_purpose: "Instructions on how to add notification configuration for webhook"
10
--->
1
+# Add webhook notification configuration
2
3
From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on a webhook using a predefined schema.
4
14
-#### Prerequisites
5
+## Prerequisites
6
7
To add discord notification configurations you need
8
@@ -20,7 +11,7 @@ To add discord notification configurations you need
11
- Space needs to be on **Pro** plan or higher
12
- Have an app that allows you to receive webhooks following a predefined schema, for mode details check [how to create the webhook service](#webhook-service)
13
23
-#### Steps
14
+## Steps
15
16
1. Click on the **Space settings** cog (located above your profile icon)
17
1. Click on the **Notification** tab
@@ -39,11 +30,11 @@ To add discord notification configurations you need
30
- Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.
31
- Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.
32
42
-#### Webhook service
33
+## Webhook service
34
35
A webhook integration allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL. In this document, we'll go over the steps to set up a generic webhook integration, including adding headers, and implementing different types of authorization mechanisms.
36
46
-##### Netdata webhook integration
37
+### Netdata webhook integration
38
39
A webhook integration is a way for one service to notify another service about events that occur within it. This is done by sending an HTTP POST request to a specified URL (known as the "webhook URL") when an event occurs.
40
@@ -68,7 +59,7 @@ The notification content sent to the destination service will be a JSON object h
59
| warning_count | integer | Number of warning alerts currently existing on the same node. |
60
| alarm_url | string | Netdata Cloud URL for this alarm. |
61
71
-##### Extra headers
62
+### Extra headers
63
64
When setting up a webhook integration, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL.
65
@@ -78,7 +69,7 @@ By default, the following headers will be sent in the HTTP request
69
|:-------------------------------:|-----------------------------|
70
| Content-Type | application/json |
71
81
-##### Authorization mechanism
72
+### Authorization mechanism
73
74
Netdata webhook integration supports 3 different authorization mechanisms:
75
@@ -97,9 +88,3 @@ In basic authorization, the client sends a request with an Authorization header
88
3. Bearer
89
90
In bearer token authorization, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service.
100
-
101
-#### Related topics
102
-
103
-- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
104
-- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
105
-- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
docs/cloud/alerts-notifications/manage-notification-methods.md
+8
-24
@@ -1,25 +1,17 @@
1
-<!--
2
-title: "Manage notification methods"
3
-sidebar_label: "Manage notification methods"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md"
5
-learn_status: "Published"
6
-learn_topic_type: "Tasks"
7
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
8
-learn_docs_purpose: "Instructions on how to manage notification methods"
9
--->
1
+# Manage notification methods
2
3
From the Cloud interface, you can manage your space's notification settings as well as allow users to personalize their notifications setting
4
13
-### Manage space notification settings
5
+## Manage space notification settings
6
15
-#### Prerequisites
7
+### Prerequisites
8
9
To manage space notification settings, you will need the following:
10
11
- A Netdata Cloud account
12
- Access to the space as an **administrator**
13
22
-#### Available actions per notification methods based on service level
14
+### Available actions per notification methods based on service level
15
16
| **Action** | **Personal service level** | **System service level** |
17
| :- | :-: | :-: |
@@ -32,7 +24,7 @@ Notes:
24
* For Netadata provided ones you can't delete the existing notification method configuration.
25
* Enable, Edit and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-classification))
26
35
-#### Steps
27
+### Steps
28
29
1. Click on the **Space settings** cog (located above your profile icon)
30
1. Click on the **Notification** tab
@@ -53,9 +45,9 @@ Notes:
45
1. **Delete an existing** notification method configuartion. Netdata provided ones can't be deleted, e.g. Email
46
- Use the trash icon to delete your configuration
47
56
-### Manage user notification settings
48
+## Manage user notification settings
49
58
-#### Prerequisites
50
+### Prerequisites
51
52
To manage user specific notification settings, you will need the following:
53
@@ -64,7 +56,7 @@ To manage user specific notification settings, you will need the following:
56
57
Note: If an administrator has disabled a Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-level) notification method this will override any user specific setting.
58
67
-#### Steps
59
+### Steps
60
61
1. Click on the **User notification settings** shortcut on top of the help button
62
1. You are presented with:
@@ -78,11 +70,3 @@ Note: If an administrator has disabled a Personal [service level](https://github
70
1. **Activate notifications** for a room you aren't a member of
71
- From the **All Rooms** tab click on the Join button for the room(s) you want
72
81
-#### Related topics
82
-
83
-- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
84
-- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
85
-- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
86
-- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification.md)
87
-- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
88
-- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
docs/cloud/alerts-notifications/notifications.md
+2
-33
@@ -1,11 +1,4 @@
1
-<!--
2
-title: "Cloud alert notifications"
3
-description: "Configure Netdata Cloud to send notifications to your team whenever any node on your infrastructure triggers an alert threshold."
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md"
5
-sidebar_label: "Cloud alert notifications"
6
-learn_status: "Published"
7
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
8
--->
1
+# Cloud alert notifications
2
3
import Callout from '@site/src/components/Callout'
4
@@ -14,7 +7,7 @@ unreachable state. By enabling notifications, you ensure no alert, on any node i
7
you or your team.
8
9
Having this information centralized helps you:
17
-* Have a clear view of the health across your infrastructure, [seeing all a alerts in one place](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.md)
10
+* Have a clear view of the health across your infrastructure, seeing all alerts in one place.
11
* Easily [setup your alert notification process](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md):
12
methods to use and where to use them, filtering rules, etc.
13
* Quickly troubleshoot using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
@@ -126,27 +119,3 @@ within Cloud's embedded dashboards.
119
Here's an example email notification for the `ram_available` chart, which is in a critical state:
120
121
129
-
130
-## What's next?
131
-
132
-Netdata Cloud's alarm notifications feature leverages the alarms configuration on each node in your infrastructure. If
133
-you'd like to tweak any of these alarms, or even add new ones based on your needs, read our [Health
134
-configuration documentation](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
135
-
136
-You can also [view active alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.md) in Netdata Cloud for an instant
137
-visualization of the health of your infrastructure.
138
-
139
-### Related Topics
140
-
141
-#### **Related Concepts**
142
-- [Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
143
-- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
144
-- [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.md)
145
-
146
-#### Related Tasks
147
-- [View Active alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.md)
148
-- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
149
-- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
150
-- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification.md)
151
-- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
152
-- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
docs/cloud/alerts-notifications/smartboard.md
deleted
-46
@@ -1,46 +0,0 @@
1
-<!--
2
-title: "Alerts smartboard"
3
-description: ""
4
-type: "reference"
5
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.md"
6
-sidebar_label: "Alerts smartboard"
7
-learn_status: "Published"
8
-learn_topic_type: "Tasks"
9
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
10
--->
11
-
12
-The Alerts view gives you a high level of availability and performance information for every node you're
13
-monitoring with Netdata Cloud. We expect it to become the "home base" for many Netdata Cloud users who want to instantly
14
-understand what's going on with their infrastructure and exactly where issues might be.
15
-
16
-The Alerts view is available entirely for free to all users and for any number of nodes.
17
-
18
-## Alerts table and filtering
19
-
20
-The Alerts view shows all active alerts in your War Room, including the alert's name, the most recent value, a
21
-timestamp of when it became active, and the relevant node.
22
-
23
-You can use the checkboxes in the filter pane on the right side of the screen to filter the alerts displayed in the
24
-table
25
-by Status, Class, Type & Componenet, Role, Operating System, or Node.
26
-
27
-Click on any of the alert names to see the alert.
28
-
29
-## View active alerts
30
-
31
-In the `Active` subtab, you can see exactly how many **critical** and **warning** alerts are active across your nodes.
32
-
33
-## View configured alerts
34
-
35
-You can view all the configured alerts on all the agents that belong to a War Room in the `Alert Configurations` subtab.
36
-From within the Alerts view, you can click the `Alert Configurations` subtab to see a high level view of the states of
37
-the alerts on the nodes within this War Room and drill down to the node level where each alert is configured with their
38
-latest status.
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
docs/cloud/alerts-notifications/view-active-alerts.md
deleted
-49
@@ -1,49 +0,0 @@
1
-# View active alerts
2
-
3
-Netdata Cloud receives information about active alerts on individual nodes in your infrastructure and updates the
4
-interface based on those status changes.
5
-
6
-Netdata Cloud doesn't produce alerts itself but rather receives and aggregates alerts from each node in your
7
-infrastructure based on their configuration. Every node comes with hundreds of pre-configured alerts that have been
8
-tested by Netdata's community of DevOps engineers and SREs, but you may want to customize existing alerts or create new
9
-ones entirely.
10
-
11
-Read our documentation on [health alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to
12
-learn how to tweak existing alerts or create new
13
-health entities based on the specific needs of your infrastructure. By taking charge of alert configuration, you'll
14
-ensure Netdata Cloud always delivers the most relevant alerts about the well-being of your nodes.
15
-
16
-## View all active alerts
17
-
18
-The [Alerts Smartboard](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.md)
19
-provides a high-level interface for viewing the number of critical or warning alerts and where they are in your
20
-infrastructure.
21
-
22
-
23
-
24
-Click on the **Alerts** tab in any War Room to open the Smartboard. Alternatively, click on any of the alert badges in
25
-the [Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) to jump to the Alerts
26
-Smartboard.
27
-
28
-From here, filter active alerts using the **critical** or **warning** boxes, or hover over a box in
29
-the [nodes map](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.md#nodes-map)
30
-to see a
31
-popup node-specific alert information.
32
-
33
-## View alerts in context with charts
34
-
35
-If you click on any of the alerts, either in a nodes map popup or the alerts table, Netdata Cloud navigates you to the
36
-single-node dashboard and scrolls to the relevant chart. Netdata Cloud also draws a highlight and the value at the
37
-moment your node triggered this alert.
38
-
39
-
40
-
41
-You can
42
-then [highlight this area](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#highlight)
43
-with `Alt/⌘ + mouse selection` to highlight the alerted timeframe while you explore other charts for root cause
44
-analysis.
45
-
46
-Or, select the area and
47
-run [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to
48
-filter the single-node
49
-dashboard to only those charts most likely to be connected to the alert.
docs/cloud/data-privacy.md
+1
-9
@@ -1,12 +1,4 @@
1
-<!--
2
-title: "Data privacy in the Netdata Cloud"
3
-description: "Keeping your data safe and secure is our priority.Netdata never stores your personal information in the Netdata Cloud."
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/data-privacy.md"
5
-sidebar_label: "Data privacy in the Netdata Cloud"
6
-learn_status: "Published"
7
-learn_topic_type: "Concepts"
8
-learn_rel_path: "Concepts"
9
--->
1
+# Data privacy in Netdata Cloud
2
3
[Data privacy](https://netdata.cloud/privacy/) is very important to us. We firmly believe that your data belongs to
4
you. This is why **we don't store any metric data in Netdata Cloud**.
docs/cloud/manage/invite-your-team.md
+1
-11
@@ -1,14 +1,4 @@
1
-<!--
2
-title: "Invite your team"
3
-description: >-
4
- "Invite your entire SRE, DevOPs, or ITOps team to Netdata Cloud to give everyone insights into your
5
- infrastructure from a single pane of glass."
6
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md"
7
-sidebar_label: "Invite your team"
8
-learn_status: "Published"
9
-learn_topic_type: "Tasks"
10
-learn_rel_path: "Operations"
11
--->
1
+# Invite your team
2
3
Invite new users to your Space by clicking on **Invite Users** in
4
the [Space](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md) management area.
docs/cloud/manage/role-based-access.md
+14
-23
@@ -1,17 +1,8 @@
1
-<!--
2
-title: "Role-Based Access model"
3
-sidebar_label: "Role-Based Access model"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md"
5
-sidebar_position: "1"
6
-learn_status: "Published"
7
-learn_topic_type: "Concepts"
8
-learn_rel_path: "Concepts"
9
-learn_docs_purpose: "Explanation of Netdata roles and permissions linked to them"
10
--->
1
+# Role-Based Access model"
2
3
Netdata Cloud's role-based-access mechanism allows you to control what functionalities in the app users can access. Each user can be assigned only one role, which fully specifies all the capabilities they are afforded.
4
14
-#### What roles are available?
5
+## What roles are available?
6
7
With the advent of the paid plans we revamped the roles to cover needs expressed by Netdata users, like providing more limited access to their customers, or
8
being able to join any room. We also aligned the offered roles to the target audience of each plan. The end result is the following:
@@ -25,15 +16,15 @@ being able to join any room. We also aligned the offered roles to the target aud
16
| **Billing**<p>This role is for users that need to manage billing options and see invoices, with no further access to the system.</p> | - | - | :heavy_check_mark: | - |
17
| **Member** ⚠️ Legacy role<p>This role allows users to manage War Rooms and invite fellow Member teammates.</p><p>These users cannot see all War Rooms in the Space but can see all Nodes since they are always on the _All Nodes_ room.</p>| - | - | - | :heavy_check_mark: |
18
28
-#### What happens to the previous Member role?
19
+## What happens to the previous Member role?
20
21
We will maintain a Early Bird plan for existing users, which will continue to provide access to the Member role.
22
32
-#### Which functionalities are available for each role?
23
+## Which functionalities are available for each role?
24
25
In more detail, you can find on the following tables which functionalities are available for each role on each domain.
26
36
-##### Space Management
27
+### Space Management
28
29
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
30
| :-- | :--: | :--: | :--: | :--: | :--: | :--: |
@@ -43,7 +34,7 @@ In more detail, you can find on the following tables which functionalities are a
34
| Change name | :heavy_check_mark: | - | - | - | - | - |
35
| Change description | :heavy_check_mark: | - | - | - | - | - |
36
46
-##### Node Management
37
+### Node Management
38
39
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
40
| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
@@ -51,7 +42,7 @@ In more detail, you can find on the following tables which functionalities are a
42
| Connect Node to Space | :heavy_check_mark: | - | - | - | - | - | - |
43
| Delete Node from Space | :heavy_check_mark: | - | - | - | - | - | - |
44
54
-##### User Management
45
+### User Management
46
47
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
48
| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
@@ -69,7 +60,7 @@ In more detail, you can find on the following tables which functionalities are a
60
| Invite existing user to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | User already invited to the Space |
61
| Remove user from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
62
72
-##### Room Management
63
+### Room Management
64
65
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
66
| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
@@ -83,7 +74,7 @@ In more detail, you can find on the following tables which functionalities are a
74
| Add existing Nodes to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | Node already connected to the Space |
75
| Remove Nodes from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
76
86
-##### Notifications Management
77
+### Notifications Management
78
79
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
80
| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
@@ -97,7 +88,7 @@ In more detail, you can find on the following tables which functionalities are a
88
Notes:
89
* Enable, Edit and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-classification))
90
100
-##### Dashboards
91
+### Dashboards
92
93
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
94
| :-- | :--: | :--: | :--: | :--: | :--: | :--: |
@@ -108,7 +99,7 @@ Notes:
99
| Delete any dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
100
| Delete own dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
101
111
-##### Functions
102
+### Functions
103
104
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
105
| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
@@ -117,14 +108,14 @@ Notes:
108
| Run read-only function in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
109
| Run sensitive function in Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | There isn't any function on this category yet, so subject to change. |
110
120
-##### Events feed
111
+### Events feed
112
113
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
114
| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
115
| See Alert or Topology events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
116
| See Auditing events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | These are coming soon, not currently available |
117
127
-##### Billing
118
+### Billing
119
120
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
121
| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
@@ -134,7 +125,7 @@ Notes:
125
| Manage payment methods | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
126
| Update billing email | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
127
137
-##### Other permissions
128
+### Other permissions
129
130
| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
131
| :-- | :--: | :--: | :--: | :--: | :--: | :--: |
docs/cloud/manage/sign-in.md
+1
-14
@@ -1,12 +1,4 @@
1
-<!--
2
-title: "Sign in with email, Google, or GitHub"
3
-description: "Learn how signing in to Cloud works via one of our three authentication methods, plus some tips if you're having trouble signing in."
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.md"
5
-sidebar_label: "Sign in with email, Google, or GitHub"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations"
9
--->
1
+# Sign in with email, Google, or GitHub
2
3
You can [sign in to Netdata](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_first_section) through one of three methods: email, Google, or GitHub. Email uses a
4
time-sensitive link that authenticates your browser, and Google/GitHub both use OAuth to associate your email address
@@ -81,8 +73,3 @@ with `user2@example.com`, Netdata Cloud creates a new account and begins the onb
73
74
It is not currently possible to link an account created with `user@example.com` to a Google account associated with
75
`user2@example.com`.
84
-
85
-## What's next?
86
-
87
-If you haven't already onboarded to Netdata Cloud and connected your first nodes, visit
88
-the [Get Started section of our documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
docs/cloud/manage/themes.md
+1
-9
@@ -1,12 +1,4 @@
1
-<!--
2
-title: "Choose your Netdata Cloud theme"
3
-description: "Switch between Light and Dark themes in Netdata Cloud to match your personal visualization preferences."
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/themes.md"
5
-sidebar_label: "Choose your Netdata Cloud theme"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations"
9
--->
1
+# Choose your Netdata Cloud theme
2
3
The Dark theme is the default for all new Netdata Cloud accounts.
4
docs/cloud/manage/view-plan-billing.md
+1
-10
@@ -1,13 +1,4 @@
1
-<!--
2
-title: "View Plan & Billing"
3
-sidebar_label: "View Plan & Billing"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/view-plan-billing.md"
5
-sidebar_position: "1"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations"
9
-learn_docs_purpose: "How to check details on your space plan and billing"
10
--->
1
+# View Plan & Billing
2
3
From the Cloud interface, you can view and manage your space's plan and billing settings, and see the space's usage in terms of running nodes.
4
To view and manage some specific settings, related to billing options and invoices, you'll be redirected to our billing provider Customer Portal.
docs/cloud/spaces.md
+1
-11
@@ -1,14 +1,4 @@
1
-<!--
2
-title: "Spaces"
3
-description: >-
4
- "Organize your infrastructure monitoring on Netdata Cloud by creating Spaces, then groupingyour
5
- Agent-monitored nodes."
6
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md"
7
-sidebar_label: "Spaces"
8
-learn_status: "Published"
9
-learn_topic_type: "Tasks"
10
-learn_rel_path: "Operations"
11
--->
1
+# Spaces
2
3
A Space is a high-level container. It's a collaboration space where you can organize team members, access levels and the
4
nodes you want to monitor.
docs/cloud/visualize/overview.md
+3
-3
@@ -1,4 +1,4 @@
1
-# Home, Overview and Single Node view
1
+# Home, overview and single node views
2
3
## Home
4
@@ -7,7 +7,7 @@ The Home tab provides a predefined dashboard of relevant information about entit
7
This tab will automatically present summarized information in an easily digestible display. You can see information about your
8
nodes, data collection and retention stats, alerts, users and dashboards.
9
10
-## Overview and Single Node view
10
+## Overview and single node view
11
12
The Overview tab is another great way to monitor infrastructure using Netdata Cloud. While the interface might look
13
similar to local dashboards served by an Agent Overview uses **composite charts**.
@@ -19,7 +19,7 @@ you can see your infrastructure from a single pane of glass, discover trends or
19
The Single Node view dashboard is exactly the same as the Overview, but with a hard-coded filter to only show
20
a single node.
21
22
-### Chart Navigation Menu
22
+### Chart navigation Menu
23
24
Netdata Cloud uses a similar menu to local Agent dashboards, with sections
25
and sub-menus aggregated from every contributing node. For example, even if only two nodes actively collect from and
docs/cloud/war-rooms.md
+1
-11
@@ -1,14 +1,4 @@
1
-<!--
2
-title: "War Rooms"
3
-description: >-
4
- "Netdata Cloud uses War Rooms to group related nodes and create insightful compositedashboards based on
5
- their aggregate health and performance."
6
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md"
7
-sidebar_label: "War Rooms"
8
-learn_status: "Published"
9
-learn_topic_type: "Tasks"
10
-learn_rel_path: "Operations"
11
--->
1
+# War rooms
2
3
War Rooms organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and
4
visualizations.
docs/configure/start-stop-restart.md
+77
-14
@@ -1,20 +1,10 @@
1
-<!--
2
-title: "Start, stop, or restart the Netdata Agent"
3
-description: "Manage the Netdata Agent daemon, load configuration changes, and troubleshoot stuck processes on systemd and non-systemd nodes."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/configure/start-stop-restart.md"
5
-sidebar_label: "Start, stop, or restart the Netdata Agent"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations"
9
--->
10
-
1
# Start, stop, or restart the Netdata Agent
2
13
-When you install the Netdata Agent, the [daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md) is configured to start at boot and stop and
14
-restart/shutdown.
3
+When you install the Netdata Agent, the [daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md) is
4
+configured to start at boot and stop and restart/shutdown.
5
16
-You will most often need to _restart_ the Agent to load new or editing configuration files. [Health
17
-configuration](#reload-health-configuration) files are the only exception, as they can be reloaded without restarting
6
+You will most often need to _restart_ the Agent to load new or editing configuration files.
7
+[Health configuration](#reload-health-configuration) files are the only exception, as they can be reloaded without restarting
8
the entire Agent.
9
10
Stopping or restarting the Netdata Agent will cause gaps in stored metrics until the `netdata` process initiates
@@ -81,3 +71,76 @@ ps aux| grep netdata
71
72
The output of `ps aux` should show no `netdata` or associated processes running. You can now start the Netdata Agent
73
again with `service netdata start`, or the appropriate method for your system.
74
+
75
+## Starting Netdata at boot
76
+
77
+In the `system` directory you can find scripts and configurations for the
78
+various distros.
79
+
80
+### systemd
81
+
82
+The installer already installs `netdata.service` if it detects a systemd system.
83
+
84
+To install `netdata.service` by hand, run:
85
+
86
+```sh
87
+# stop Netdata
88
+killall netdata
89
+
90
+# copy netdata.service to systemd
91
+cp system/netdata.service /etc/systemd/system/
92
+
93
+# let systemd know there is a new service
94
+systemctl daemon-reload
95
+
96
+# enable Netdata at boot
97
+systemctl enable netdata
98
+
99
+# start Netdata
100
+systemctl start netdata
101
+```
102
+
103
+### init.d
104
+
105
+In the system directory you can find `netdata-lsb`. Copy it to the proper place according to your distribution
106
+documentation. For Ubuntu, this can be done via running the following commands as root.
107
+
108
+```sh
109
+# copy the Netdata startup file to /etc/init.d
110
+cp system/netdata-lsb /etc/init.d/netdata
111
+
112
+# make sure it is executable
113
+chmod +x /etc/init.d/netdata
114
+
115
+# enable it
116
+update-rc.d netdata defaults
117
+```
118
+
119
+### openrc (gentoo)
120
+
121
+In the `system` directory you can find `netdata-openrc`. Copy it to the proper
122
+place according to your distribution documentation.
123
+
124
+### CentOS / Red Hat Enterprise Linux
125
+
126
+For older versions of RHEL/CentOS that don't have systemd, an init script is included in the system directory. This can
127
+be installed by running the following commands as root.
128
+
129
+```sh
130
+# copy the Netdata startup file to /etc/init.d
131
+cp system/netdata-init-d /etc/init.d/netdata
132
+
133
+# make sure it is executable
134
+chmod +x /etc/init.d/netdata
135
+
136
+# enable it
137
+chkconfig --add netdata
138
+```
139
+
140
+_There have been some recent work on the init script, see PR
141
+<https://github.com/netdata/netdata/pull/403>_
142
+
143
+### other systems
144
+
145
+You can start Netdata by running it from `/etc/rc.local` or equivalent.
146
+
docs/dashboard/visualization-date-and-time-controls.md
+27
-62
@@ -1,18 +1,28 @@
1
-<!--
2
-title: "Visualization date and time controls"
3
-description: "Netdata's dashboard features powerful date visualization controls that include a time control (play, pause, force play), a timezone selector and a rich date and timeframe selector, with useful defaults and rich customization, to help you narrow your focus when troubleshooting issues or anomalies."
4
-type: "how-to"
5
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/visualization-date-and-time-controls.md"
6
-sidebar_label: "Visualization date and time controls"
7
-learn_status: "Published"
8
-learn_topic_type: "Concepts"
9
-learn_rel_path: "Concepts"
10
--->
11
-
1
# Visualization date and time controls
2
3
+## Time controls
4
+
5
+The time control provides you the following options: **Play**, **Pause** and **Force Play**.
6
+* **Play** - the content of the page will be automatically refreshed while this is in the foreground
7
+* **Pause** - the content of the page isn't refreshed due to a manual request to pause it or, for example, when your investigating data on a
8
+chart (cursor is on top of a chart)
9
+* **Force Play** - the content of the page will be automatically refreshed even if this is in the background
10
+
11
+With this, we aim to bring more clarity and allow you to distinguish if the content you are looking at is live or historical and also allow you
12
+ to always refresh the content of the page when the tabs are in the background.
13
+
14
+Main use cases for **Force Play**:
15
+* You use a terminal or deployment tools to do changes in your infra and want to see immediately, Netdata is in the background, displaying the impact
16
+of these changes
17
+* You want to have Netdata on the background, example displayed on a TV, to constantly see metrics through dashboards or to watch the alert
18
+status
19
+
20
+
21
+
22
## Date and time selector
23
24
+The date and time selector allows you to change the visible timeframe and change the timezone used in the interface.
25
+
26
### Pick timeframes to visualize
27
28
While [panning through time and zooming in/out](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) from charts it is helpful when
@@ -56,40 +66,7 @@ minutes, hours, days, or months. Enter a number and choose the appropriate unit
66
Use the calendar to select multiple days. Click on a date to begin the timeframe selection, then an ending date. The
67
timeframe begins at noon on the beginning and end dates. Click **Apply** to see your selected multi-day timeframe.
68
59
-## Time controls
60
-
61
-The time control provides you the following options: **Play**, **Pause** and **Force Play**.
62
-* **Play** - the content of the page will be automatically refreshed while this is in the foreground
63
-* **Pause** - the content of the page isn't refreshed due to a manual request to pause it or, for example, when your investigating data on a
64
-chart (cursor is on top of a chart)
65
-* **Force Play** - the content of the page will be automatically refreshed even if this is in the background
66
-
67
-With this, we aim to bring more clarity and allow you to distinguish if the content you are looking at is live or historical and also allow you
68
- to always refresh the content of the page when the tabs are in the background.
69
-
70
-Main use cases for **Force Play**:
71
-* You use a terminal or deployment tools to do changes in your infra and want to see immediately, Netdata is in the background, displaying the impact
72
-of these changes
73
-* You want to have Netdata on the background, example displayed on a TV, to constantly see metrics through dashboards or to watch the alert
74
-status
75
-
76
-
78
-
79
-## Timezone selector
80
-
81
-With the timezone selector, you have the ability to change the timezone on Netdata Cloud. More often than not teams are
82
-distributed in different timezones and they need to collaborate.
83
-
84
-Our goal is to make it easier for you and your teams to troubleshoot based on your timezone preference and communicate easily
85
-with varying timezones and timeframes without the need to be concerned about their specificity.
86
-
87
-<img width="437" alt="Untitled1" src="https://user-images.githubusercontent.com/43294513/216628390-c3bd1cd2-349d-4523-b8d3-c7e68395f670.png"/>
88
-
89
-When you change the timezone all the date and time fields will be updated to be displayed according to the specified timezone, this goes from
90
-charts to alerts information and across the Netdata Cloud.
91
-
92
-## Caveats and considerations
69
+#### Caveats and considerations
70
71
**Longer timeframes will decrease metrics granularity**. At the default timeframe, based on your browser viewport, each
72
"tick" on charts represents one second. If you select a timeframe of 6 hours, each tick represents the _average_ value
@@ -100,26 +77,14 @@ time-series database (TSDB) to store as many metrics as it can within a specific
77
storage is 256 MiB, which should be enough for 1-3 days of historical metrics. If you navigate back to a timeframe
78
beyond stored historical metrics, you'll see this message:
79
103
-
80
+
81
82
At any time, [configure the internal TSDB's storage capacity](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) to expand your
83
depth of historical metrics.
84
109
-## What's next?
110
-
111
-One useful next step after selecting a timeframe is [exporting the
112
-metrics](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md) into a snapshot file, which can then be shared and imported
113
-into any other Netdata dashboard.
114
-
115
-There are also many ways to [customize](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md) the standard dashboard experience, from changing
116
-the theme to editing the text that accompanies every section of charts.
85
+### Timezone selector
86
118
-## Further reading & related information
87
+The default timezone used in all date and time fields in Netdata Cloud comes from your browser. To change it, open the
88
+date and time selector and use the control displayed here:
89
120
-- Dashboard
121
- - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md)
122
- - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
123
- - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md)
124
- - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md)
125
- - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md)
90
+<img alt="Untitled1" src="https://user-images.githubusercontent.com/43294513/216628390-c3bd1cd2-349d-4523-b8d3-c7e68395f670.png"/>
docs/metrics-storage-management/enable-streaming.md
+78
-44
@@ -1,28 +1,75 @@
1
-<!--
2
-title: "Enable streaming between nodes"
3
-description: >-
4
- "With metrics streaming enabled, you can not only replicate metrics data
5
- into a second database, but also view dashboards and trigger alarm notifications
6
- for multiple nodes in parallel."
7
-type: "how-to"
8
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md"
9
-sidebar_label: "Enable streaming between nodes"
10
-learn_status: "Published"
11
-learn_topic_type: "Tasks"
12
-learn_rel_path: "Configuration"
13
--->
14
-
15
-# Enable streaming between nodes
1
+# How metrics streaming works
2
+
3
+Each node running Netdata can stream the metrics it collects, in real time, to another node. Streaming allows you to
4
+replicate metrics data across multiple nodes, or centralize all your metrics data into a single time-series database
5
+(TSDB).
6
+
7
+When one node streams metrics to another, the node receiving metrics can visualize them on the dashboard, run health checks to
8
+[trigger alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) and
9
+[send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md), and
10
+[export](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) all metrics to an external TSDB. When Netdata streams metrics to another
11
+Netdata, the receiving one is able to perform everything a Netdata instance is capable of.
12
+
13
+Streaming lets you decide exactly how you want to store and maintain metrics data. While we believe Netdata's
14
+[distributed architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) is
15
+ideal for speed and scale, streaming provides centralization options and high data availability.
16
+
17
+This document will get you started quickly with streaming. More advanced concepts and suggested production deployments
18
+can be found in the [streaming and replication reference](https://github.com/netdata/netdata/blob/master/streaming/README.md).
19
+
20
+## Streaming basics
21
+
22
+There are three types of nodes in Netdata's streaming ecosystem.
23
+
24
+- **Parent**: A node, running Netdata, that receives streamed metric data.
25
+- **Child**: A node, running Netdata, that streams metric data to one or more parent.
26
+- **Proxy**: A node, running Netdata, that receives metric data from a child and "forwards" them on to a
27
+ separate parent node.
28
+
29
+Netdata uses API keys, which are just random GUIDs, to authorize the communication between child and parent nodes. We
30
+recommend using `uuidgen` for generating API keys, which can then be used across any number of streaming connections.
31
+Or, you can generate unique API keys for each parent-child relationship.
32
+
33
+Once the parent node authorizes the child's API key, the child can start streaming metrics.
34
+
35
+It's important to note that the streaming connection uses TCP, UDP, or Unix sockets, _not HTTP_. To proxy streaming
36
+metrics, you need to use a proxy that tunnels [OSI layer 4-7
37
+traffic](https://en.wikipedia.org/wiki/OSI_model#Layer_4:_Transport_Layer) without interfering with it, such as
38
+[SOCKS](https://en.wikipedia.org/wiki/SOCKS) or Nginx's
39
+[TCP/UDP load balancing](https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/).
40
+
41
+## Supported streaming configurations
42
+
43
+Netdata supports any combination of parent, child, and proxy nodes that you can imagine. Any node can act as both a
44
+parent, child, or proxy at the same time, sending or receiving streaming metrics from any number of other nodes.
45
+
46
+Here are a few example streaming configurations:
47
+
48
+- **Headless collector**:
49
+ - Child `A`, _without_ a database or web dashboard, streams metrics to parent `B`.
50
+ - `A` metrics are only available via the local Agent dashboard for `B`.
51
+ - `B` generates alarms for `A`.
52
+- **Replication**:
53
+ - Child `A`, _with_ a database and web dashboard, streams metrics to parent `B`.
54
+ - `A` metrics are available on both local Agent dashboards, and can be stored with the same or different metrics
55
+ retention policies.
56
+ - Both `A` and `B` generate alarms.
57
+- **Proxy**:
58
+ - Child `A`, _with or without_ a database, sends metrics to proxy `C`, also _with or without_ a database. `C` sends
59
+ metrics to parent `B`.
60
+ - Any node with a database can generate alarms.
61
+
62
+## Enable streaming between nodes
63
64
The simplest streaming configuration is **replication**, in which a child node streams its metrics in real time to a
65
parent node, and both nodes retain metrics in their own databases.
66
67
To configure replication, you need two nodes, each running Netdata. First you'll first enable streaming on your parent
68
node, then enable streaming on your child node. When you're finished, you'll be able to see the child node's metrics in
22
-the parent node's dashboard, quickly switch between the two dashboards, and be able to serve [alarm
23
-notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) from either or both nodes.
69
+the parent node's dashboard, quickly switch between the two dashboards, and be able to serve
70
+[alarm notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) from either or both nodes.
71
25
-## Enable streaming on the parent node
72
+### Enable streaming on the parent node
73
74
First, log onto the node that will act as the parent.
75
@@ -58,7 +105,7 @@ simplified version of the configuration, minus the commented lines, looks like t
105
Save the file and close it, then restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
106
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
107
61
-## Enable streaming on the child node
108
+### Enable streaming on the child node
109
110
Connect to your child node with SSH.
111
@@ -79,7 +126,7 @@ looks like the following:
126
Save the file and close it, then restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
127
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
128
82
-## Enable TLS/SSL on streaming (optional)
129
+### Enable TLS/SSL on streaming (optional)
130
131
While encrypting the connection between your parent and child nodes is recommended for security, it's not required to
132
get started. If you're not interested in encryption, skip ahead to [view streamed
@@ -119,7 +166,16 @@ self-signed certificates.
166
Restart both the parent and child nodes with `sudo systemctl restart netdata`, or the [appropriate
167
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to stream encrypted metrics using TLS/SSL.
168
122
-## View streamed metrics in Netdata's dashboard
169
+### View streamed metrics in Netdata Cloud
170
+
171
+In Netdata Cloud you should now be able to see a new parent showing up in the Home tab under "Nodes by data replication".
172
+The replication factor for the child node has now increased to 2, meaning that its data is now highly available.
173
+
174
+You don't need to do anything else, as the cloud will automatically prefer to fetch data about the child from the parent
175
+and switch to querying the child only when the parent is unavailable, or for some reason doesn't have the requested
176
+data (e.g. the connection between parent and the child is broken).
177
+
178
+### View streamed metrics in Netdata's dashboard
179
180
At this point, the child node is streaming its metrics in real time to its parent. Open the local Agent dashboard for
181
the parent by navigating to `http://PARENT-NODE:19999` in your browser, replacing `PARENT-NODE` with its IP address or
@@ -130,29 +186,7 @@ This dashboard shows parent metrics. To see child metrics, open the left-hand si
186
in the top panel. Both nodes appear under the **Replicated Nodes** menu. Click on either of the links to switch between
187
separate parent and child dashboards.
188
133
-
189
+
190
191
The child dashboard is also available directly at `http://PARENT-NODE:19999/host/CHILD-HOSTNAME`, which in this example
192
is `http://203.0.113.0:19999/host/netdata-child`.
138
-
139
-## What's next?
140
-
141
-Now that you have a basic streaming setup with replication, you may want to tweak the configuration to eliminate the
142
-child database, disable the child dashboard, or enable SSL on the streaming connection between the parent and child.
143
-
144
-See the [streaming reference
145
-doc](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.md#examples) for details about
146
-other possible configurations.
147
-
148
-When using Netdata's default TSDB (`dbengine`), the parent node maintains separate, parallel databases for itself and
149
-every child node streaming to it. Each instance is sized identically based on the `dbengine multihost disk space`
150
-setting in `netdata.conf`. See our doc on [changing metrics retention](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) for
151
-details.
152
-
153
-### Related information & further reading
154
-
155
-- Streaming
156
- - [How Netdata streams metrics](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md)
157
- - **[Enable streaming between nodes](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md)**
158
- - [Streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.md)
docs/metrics-storage-management/how-streaming-works.md
deleted
-85
@@ -1,85 +0,0 @@
1
-# How metrics streaming works
2
-
3
-Each node running Netdata can stream the metrics it collects, in real time, to another node. Streaming allows you to
4
-replicate metrics data across multiple nodes, or centralize all your metrics data into a single time-series database
5
-(TSDB).
6
-
7
-When one node streams metrics to another, the node receiving metrics can visualize them on the dashboard, run health checks to
8
-[trigger alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) and
9
-[send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md), and
10
-[export](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) all metrics to an external TSDB. When Netdata streams metrics to another
11
-Netdata, the receiving one is able to perform everything a Netdata instance is capable of.
12
-
13
-Streaming lets you decide exactly how you want to store and maintain metrics data. While we believe Netdata's
14
-[distributed architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) is
15
-ideal for speed and scale, streaming provides centralization options and high data availability.
16
-
17
-## Streaming basics
18
-
19
-There are three types of nodes in Netdata's streaming ecosystem.
20
-
21
-- **Parent**: A node, running Netdata, that receives streamed metric data.
22
-- **Child**: A node, running Netdata, that streams metric data to one or more parent.
23
-- **Proxy**: A node, running Netdata, that receives metric data from a child and "forwards" them on to a
24
- separate parent node.
25
-
26
-Netdata uses API keys, which are just random GUIDs, to authorize the communication between child and parent nodes. We
27
-recommend using `uuidgen` for generating API keys, which can then be used across any number of streaming connections.
28
-Or, you can generate unique API keys for each parent-child relationship.
29
-
30
-Once the parent node authorizes the child's API key, the child can start streaming metrics.
31
-
32
-It's important to note that the streaming connection uses TCP, UDP, or Unix sockets, _not HTTP_. To proxy streaming
33
-metrics, you need to use a proxy that tunnels [OSI layer 4-7
34
-traffic](https://en.wikipedia.org/wiki/OSI_model#Layer_4:_Transport_Layer) without interfering with it, such as
35
-[SOCKS](https://en.wikipedia.org/wiki/SOCKS) or Nginx's [TCP/UDP load
36
-balancing](https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/).
37
-
38
-## Supported streaming configurations
39
-
40
-Netdata supports any combination of parent, child, and proxy nodes that you can imagine. Any node can act as both a
41
-parent, child, or proxy at the same time, sending or receiving streaming metrics from any number of other nodes.
42
-
43
-Here are a few example streaming configurations:
44
-
45
-- **Headless collector**:
46
- - Child `A`, _without_ a database or web dashboard, streams metrics to parent `B`.
47
- - `A` metrics are only available via the local Agent dashboard for `B`.
48
- - `B` generates alarms for `A`.
49
-- **Replication**:
50
- - Child `A`, _with_ a database and web dashboard, streams metrics to parent `B`.
51
- - `A` metrics are available on both local Agent dashboards, and can be stored with the same or different metrics
52
- retention policies.
53
- - Both `A` and `B` generate alarms.
54
-- **Proxy**:
55
- - Child `A`, _with or without_ a database, sends metrics to proxy `C`, also _with or without_ a database. `C` sends
56
- metrics to parent `B`.
57
- - Any node with a database can generate alarms.
58
-
59
-## Viewing streamed metrics
60
-
61
-Parent nodes feature a **Replicated Nodes** section in the left-hand panel, which opens with the hamburger icon
62
-
63
-in the top navigation. The parent node, plus any child nodes, appear here. Click on any of the hostnames to switch
64
-between parent and child dashboards, all served by the parent's [web server](https://github.com/netdata/netdata/blob/master/web/server/README.md).
65
-
66
-
68
-
69
-Each child dashboard is also available directly at the following URL pattern:
70
-`http://PARENT-NODE:19999/host/CHILD-HOSTNAME`.
71
-
72
-## What's next?
73
-
74
-Now that you understand the fundamentals of streaming metrics between nodes, go ahead and [enable
75
-streaming](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md) using a simple `parent-child` relationship. For all
76
-the details, see the [streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.md) doc.
77
-
78
-Take your streaming setup even further by [exporting metrics](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) to an external TSDB.
79
-
80
-### Related information & further reading
81
-
82
-- Streaming
83
- - **[How Netdata streams metrics](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md)**
84
- - [Enable streaming between nodes](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md)
85
- - [Streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.md)
docs/metrics-storage-management/reference-streaming.md
+1
-1
@@ -11,7 +11,7 @@ learn_rel_path: "Configuration"
11
# Streaming reference
12
13
Each node running Netdata can stream the metrics it collects, in real time, to another node. To learn more, read about
14
-[how streaming works](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md).
14
+[how streaming works](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md).
15
16
For a quickstart guide for enabling a simple `parent-child` streaming relationship, see our [stream metrics between
17
nodes](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md) doc. All other configuration options and scenarios are
docs/monitor/view-active-alarms.md
+3
-13
@@ -1,21 +1,11 @@
1
-<!--
2
-title: "View active health alarms"
3
-description: "View active alarms and their rich data to discover and resolve anomalies and performance issues across your infrastructure."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/monitor/view-active-alarms.md"
5
-sidebar_label: "View active health alarms"
6
-learn_status: "Published"
7
-learn_topic_type: "Concepts"
8
-learn_rel_path: "Operations/Alerts"
9
--->
10
-
11
-# View active health alarms
1
+# View active alerts
2
3
Every Netdata Agent comes with hundreds of pre-installed health alarms designed to notify you when an anomaly or
14
-performance issue affects your node or the applications it runs.
4
+performance issue affects your node or the applications it runs.
5
6
## Netdata Cloud
7
18
-A War Room's [alarms indicator](https://learn.netdata.cloud/docs/cloud/war-rooms#indicators) displays the number of
8
+A War Room's [indicator](https://learn.netdata.cloud/docs/cloud/war-rooms#indicators) displays the number of
9
active `critical` (red) and `warning` (yellow) alerts for the nodes in this War Room. Click on either the critical or
10
warning badges to open a pre-filtered modal displaying only those types of [active
11
alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.md).
health/README.md
+3
-3
@@ -18,6 +18,6 @@ community-configured alarms for every app/service [the Agent collects metrics fr
18
silence anything you're not interested in. You can even power complex lookups by running statistical algorithms against
19
your metrics.
20
21
-Ready to take the next steps with health monitoring?
22
-
23
-[Configuration reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md)
21
+You can [use various alert notification methods](https://github.com/netdata/netdata/edit/master/docs/monitor/enable-notifications.md),
22
+[customize alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), and
23
+[disable/silence](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#disable-or-silence-alerts) alerts.
health/REFERENCE.md
+62
-31
@@ -37,6 +37,8 @@ You can configure the Agent's health watchdog service by editing files in two lo
37
Navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) and
38
use `edit-config` to make changes to any of these files.
39
40
+### Edit individual alerts
41
+
42
For example, to edit the `cpu.conf` health configuration file, run:
43
44
```bash
@@ -69,17 +71,53 @@ to the values of your choosing. For example:
71
crit: $this > (($status == $CRITICAL) ? (75) : (85))
72
```
73
72
-Save the file and [reload Netdata's health configuration](#reload-health-configuration) to make your changes live.
74
+Save the file and [reload Netdata's health configuration](#reload-health-configuration) to apply your changes.
75
+
76
+## Disable or silence alerts
77
+
78
+Alerts and notifications can be disabled permanently via configuration changes, or temporarily, via the
79
+[health management API](https://github.com/netdata/netdata/blob/master/web/api/health/README.md). The
80
+available options are described below.
81
+
82
+### Disable all alerts
83
+
84
+In the `netdata.conf` `[health]` section, set `enabled` to `no`, and restart the agent.
85
+
86
+### Disable some alerts
87
+
88
+In the `netdata.conf` `[health]` section, set `enabled alerms` to a
89
+[simple pattern](https://github.com/netdata/netdata/edit/master/libnetdata/simple_pattern/README.md) that
90
+excludes one or more alerts. e.g. `enabled alarms = !oom_kill *` will load all alarms except `oom_kill`.
91
+
92
+You can also [edit the file where the alert is defined](#edit-individual-alerts), comment out its definition,
93
+and [reload Netdata's health configuration](#reload-health-configuration).
94
74
-### Silence an individual alarm
95
+### Silence an individual alert
96
76
-Instead of disabling an alarm altogether, or even disabling _all_ alarms, you can silence individual alarms by changing
77
-one line in a given health entity. To silence any single alarm, change the `to:` line in its entity to `silent`.
97
+You can stop receiving notification for an individual alert by [changing](#edit-individual-alerts) the `to:` line to `silent`.
98
99
```yaml
100
to: silent
101
```
102
103
+This action requires that you [reload Netdata's health configuration](#reload-health-configuration).
104
+
105
+### Temporarily disable alerts at runtime
106
+
107
+When you need to frequently disable all or some alerts from triggering during certain times (for instance
108
+when running backups) you can use the
109
+[health management API](https://github.com/netdata/netdata/blob/master/web/api/health/README.md).
110
+The API allows you to issue commands to control the health engine's behavior without changing configuration,
111
+or restarting the agent.
112
+
113
+### Temporarily silence notifications at runtime
114
+
115
+If you want health checks to keep running and alerts to keep getting triggered, but notifications to be
116
+suppressed temporarily, you can use the
117
+[health management API](https://github.com/netdata/netdata/blob/master/web/api/health/README.md).
118
+The API allows you to issue commands to control the health engine's behavior without changing configuration,
119
+or restarting the agent.
120
+
121
## Write a new health entity
122
123
While tuning existing alarms may work in some cases, you may need to write entirely new health entities based on how
@@ -1124,33 +1162,6 @@ template: ml_5min_node
1162
1163
The `lookup` line will use the `anomaly_rate` dimension of the `anomaly_detection.anomaly_rate` ML chart to calculate the average [node level anomaly rate](https://learn.netdata.cloud/docs/agent/ml#node-anomaly-rate) over the last 5 minues.
1164
1127
-## Troubleshooting
1128
-
1129
-You can compile Netdata with [debugging](https://github.com/netdata/netdata/blob/master/daemon/README.md#debugging) and then set in `netdata.conf`:
1130
-
1131
-```yaml
1132
-[global]
1133
- debug flags = 0x0000000000800000
1134
-```
1135
-
1136
-Then check your `/var/log/netdata/debug.log`. It will show you how it works. Important: this will generate a lot of
1137
-output in debug.log.
1138
-
1139
-You can find the context of charts by looking up the chart in either `http://NODE:19999/netdata.conf` or
1140
-`http://NODE:19999/api/v1/charts`, replacing `NODE` with the IP address or hostname for your Agent dashboard.
1141
-
1142
-You can find how Netdata interpreted the expressions by examining the alarm at
1143
-`http://NODE:19999/api/v1/alarms?all`. For each expression, Netdata will return the expression as given in its
1144
-config file, and the same expression with additional parentheses added to indicate the evaluation flow of the
1145
-expression.
1146
-
1147
-## Disabling health checks or silencing notifications at runtime
1148
-
1149
-It's currently not possible to schedule notifications from within the alarm template. For those scenarios where you need
1150
-to temporary disable notifications (for instance when running backups triggers a disk alert) you can disable or silence
1151
-notifications are runtime. The health checks can be controlled at runtime via the
1152
-[health management API](https://github.com/netdata/netdata/blob/master/web/api/health/README.md).
1153
-
1165
## Use dimension templates to create dynamic alarms
1166
1167
In v1.18 of Netdata, we introduced **dimension templates** for alarms, which simplifies the process of
@@ -1311,3 +1322,23 @@ And how just a few of those dimension template-generated alarms look like in the
1322
1323
All in all, this single entity creates 36 individual alarms. Much easier than writing 36 separate entities in your
1324
health configuration files!
1325
+
1326
+## Troubleshooting
1327
+
1328
+You can compile Netdata with [debugging](https://github.com/netdata/netdata/blob/master/daemon/README.md#debugging) and then set in `netdata.conf`:
1329
+
1330
+```yaml
1331
+[global]
1332
+ debug flags = 0x0000000000800000
1333
+```
1334
+
1335
+Then check your `/var/log/netdata/debug.log`. It will show you how it works. Important: this will generate a lot of
1336
+output in debug.log.
1337
+
1338
+You can find the context of charts by looking up the chart in either `http://NODE:19999/netdata.conf` or
1339
+`http://NODE:19999/api/v1/charts`, replacing `NODE` with the IP address or hostname for your Agent dashboard.
1340
+
1341
+You can find how Netdata interpreted the expressions by examining the alarm at
1342
+`http://NODE:19999/api/v1/alarms?all`. For each expression, Netdata will return the expression as given in its
1343
+config file, and the same expression with additional parentheses added to indicate the evaluation flow of the
1344
+expression.
packaging/installer/REINSTALL.md
+1
-11
@@ -1,14 +1,4 @@
1
-<!--
2
-title: "Reinstall the Netdata Agent"
3
-description: "Troubleshooting installation issues or force an update of the Netdata Agent by reinstalling it using the same method you used during installation."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/REINSTALL.md"
5
-sidebar_label: "Reinstall the Netdata Agent"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
9
--->
10
-
11
-# Reinstall the Netdata Agent
1
+# Reinstall Netdata
2
3
In certain situations, such as needing to enable a feature or troubleshoot an issue, you may need to reinstall the
4
Netdata Agent on your node.
packaging/installer/UPDATE.md
+1
-11
@@ -1,14 +1,4 @@
1
-<!--
2
-title: "Update the Netdata Agent"
3
-description: "If you opted out of automatic updates, you need to update your Netdata Agent to the latest nightly or stable version."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/UPDATE.md"
5
-sidebar_label: "Update the Netdata Agent"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
9
--->
10
-
11
-# Update the Netdata Agent
1
+# Update Netdata
2
3
By default, the Netdata Agent automatically updates with the latest nightly or stable version depending on which
4
you installed. If you opted out of automatic updates, you need to update your Netdata Agent to the latest nightly
packaging/maintainers/README.md
+1
-10
@@ -1,13 +1,4 @@
1
-<!--
2
-title: "Package Maintainers"
3
-date: 2020-03-31
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/maintainers/README.md
5
-sidebar_label: "Package Maintainers"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Package maintainers"
8
--->
9
-
10
-# Package Maintainers
1
+# Package maintainers
2
3
This page tracks the package maintainers for Netdata, for various operating systems and versions.
4
streaming/README.md
+5
-17
@@ -1,13 +1,4 @@
1
-<!--
2
-title: "Streaming and replication"
3
-description: "Replicate and mirror Netdata's metrics through real-time streaming from child to parent nodes. Then combine, correlate, and export."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/streaming/README.md
5
-sidebar_label: "Streaming and replication"
6
-learn_status: "Published"
7
-learn_rel_path: "Configuration"
8
--->
9
-
10
-# Streaming and replication
1
+# Streaming and replication reference
2
3
Each Netdata node is able to replicate/mirror its database to another Netdata node, by streaming the collected
4
metrics in real-time. This is quite different to
@@ -22,8 +13,10 @@ When one Netdata node streams metrics another, the receiving instance can use th
13
- Run health checks that trigger alarms and send alarm notifications
14
- Export metrics to an external time-series database
15
25
-
26
-
16
+This document contains advanced streaming options and suggested deployment options for production.
17
+If you haven't already done so, we suggest you first go through the
18
+[quick introduction to streaming](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md)
19
+, for your first, basic parent child setup.
20
21
## Supported configurations
22
@@ -128,10 +121,6 @@ Once the communication is authorized, the sending Netdata node can push metrics
121
122
The following sections describe how you can configure sending and receiving Netdata nodes.
123
131
-
132
-
133
-
134
-
124
##### Options for the sending node
125
126
This is the section for the sending Netdata node. On the receiving node, `[stream].enabled` can be `no`.
@@ -207,7 +196,6 @@ that use `*` as wildcard (any number of times) and a `!` prefix for a negative m
196
So: `allow from = !10.1.2.3 10.*` will allow all IPs in `10.*` except `10.1.2.3`. The order is
197
important: left to right, the first positive or negative match is used.
198
210
-
199
##### Tracing
200
201
When a child is trying to push metrics to a parent or proxy, it logs entries like these: