Move/refactor docs to accomodate new Guides section on Learn (#9266)
* Move directories and change verbiage to guide * Move health guides * Quick fix to collectors quickstart * Fix broken links * Remove health/tutorials dir * Fix links in collectors quickstart * Fix links to go.d pages
Joel Hans committed
Jun 4, 2020 at 09:05 UTC
fecbb89d0c33e2bbe84aa14c0b3204cb60134218
38 files changed
+169
-188
collectors/QUICKSTART.md
+9
-6
@@ -35,8 +35,9 @@ and `python.d`.
35
> If there is a collector written in both Go and Python, it's better to choose the Go-based version, as we will
36
> eventually deprecate most Python-based collectors.
37
38
-From here on out, this quickstart guide will use the [Nginx collector](go.d.plugin/modules/nginx/README.md) as an
39
-example to showcase the process of configuring and enabling one of Netdata's pre-installed collectors.
38
+From here on out, this quickstart guide will use the [Nginx
39
+collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) as an example to showcase the
40
+process of configuring and enabling one of Netdata's pre-installed collectors.
41
42
## Configure your application or service for monitoring
43
@@ -44,7 +45,8 @@ Every collector's documentation comes with instructions on how to configure your
45
Netdata's collector. Our [collector support list](COLLECTORS.md) contains links to each collector's documentation page
46
so you can learn more.
47
47
-For example, the [Nginx collector documentation](go.d.plugin/modules/nginx/README.md) states that your Nginx
48
+For example, the [Nginx collector
49
+documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) states that your Nginx
50
installation must have the `stub_status` module configured correctly, in addition to an active `stub_status/` page, for
51
Netdata to monitor it. You can confirm whether you have the module enabled with the following command:
52
@@ -82,13 +84,14 @@ Despite Netdata's auto-detection capabilities, it's important to know how to edi
84
85
You should always edit configuration files with the `edit-config` script that comes with every installation of Netdata.
86
To edit a collector configuration file, navigate to your [Netdata configuration
85
-directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file). Launch `edit-config` with the path to the
87
+directory](/docs/guides/step-by-step/step-04.md#find-your-netdataconf-file). Launch `edit-config` with the path to the
88
collector's configuration file.
89
90
How do you find that path to the collector's configuration file? Look under the **Configuration** heading in the
91
collector's documentation. Each file contains a short code block with the relevant command.
92
91
-For example, the [Nginx collector](go.d.plugin/modules/nginx/README.md) has its configuration file at `go.d/nginx.conf`.
93
+For example, the [Nginx collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) has its
94
+configuration file at `go.d/nginx.conf`.
95
96
```bash
97
cd /etc/netdata # Replace this path with your Netdata config directory
@@ -115,7 +118,7 @@ entry in the menu and new interactive charts!
118
Collector not working? Learn about collector troubleshooting in our [collector
119
reference](REFERENCE.md#troubleshoot-a-collector).
120
118
-View our [collectors tutorials](/collectors/README.md#tutorials) to get specific instructions on enabling new and
121
+View our [collectors guides](/collectors/README.md#guides) to get specific instructions on enabling new and
122
popular collectors.
123
124
Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our
collectors/README.md
+5
-5
@@ -30,15 +30,15 @@ guide](/collectors/QUICKSTART.md).
30
31
[Collectors configuration reference](/collectors/REFERENCE.md)
32
33
-## Tutorials
33
+## Guides
34
35
-[Monitor Nginx or Apache web server log files with Netdata](/docs/tutorials/collect-apache-nginx-web-logs.md)
35
+[Monitor Nginx or Apache web server log files with Netdata](/docs/guides/collect-apache-nginx-web-logs.md)
36
37
-[Monitor CockroadchDB metrics with Netdata](/docs/tutorials/monitor-cockroachdb.md)
37
+[Monitor CockroadchDB metrics with Netdata](/docs/guides/monitor-cockroachdb.md)
38
39
-[Monitor Unbound DNS servers with Netdata](/docs/tutorials/collect-unbound-metrics.md)
39
+[Monitor Unbound DNS servers with Netdata](/docs/guides/collect-unbound-metrics.md)
40
41
-[Monitor a Hadoop cluster with Netdata](/docs/tutorials/monitor-hadoop-cluster.md)
41
+[Monitor a Hadoop cluster with Netdata](/docs/guides/monitor-hadoop-cluster.md)
42
43
## Related features
44
docs/Performance.md
+2
-2
@@ -196,8 +196,8 @@ following settings in the `[global]` section of `netdata.conf`:
196
# dbengine disk space = 256
197
```
198
199
-See the [database engine documentation](/database/engine/README.md) or our [tutorial on metrics
200
-retention](tutorials/longer-metrics-storage.md) for more details on lowering the database engine's memory requirements.
199
+See the [database engine documentation](/database/engine/README.md) or our [guide on metrics
200
+retention](/docs/guides/longer-metrics-storage.md) for more details on lowering the database engine's memory requirements.
201
202
### 6. Disable gzip compression of responses
203
docs/configuration-guide.md
+3
-3
@@ -63,8 +63,8 @@ it there.
63
#### Increase the long-term metrics retention period
64
65
Increase the values for the `page cache size` and `dbengine disk space` settings in the [`[global]`
66
-section](/daemon/config/README.md#global-section-options) of `netdata.conf`. Read our tutorial on [increasing
67
-long-term metrics storage](/docs/tutorials/longer-metrics-storage.md) and the [memory requirements for the database
66
+section](/daemon/config/README.md#global-section-options) of `netdata.conf`. Read our guide on [increasing
67
+long-term metrics storage](/docs/guides/longer-metrics-storage.md) and the [memory requirements for the database
68
engine](/database/engine/README.md#memory-requirements).
69
70
#### Reduce the data collection frequency
@@ -198,7 +198,7 @@ Beginning with 1.20, Netdata accepts user-defined **host labels**. These labels
198
labels]`.
199
200
Read more about how these labels work and why they're an effective way to organize complex infrasturctures in our
201
-tutorial: [Use host labels to organize systems, metrics, and alarms](/docs/tutorials/using-host-labels.md).
201
+guide: [Use host labels to organize systems, metrics, and alarms](/docs/guides/using-host-labels.md).
202
203
To define a label inside this section, some rules needs to be followed, or Netdata will reject the label. The following
204
restrictions are applied for label names:
docs/contributing/style-guide.md
+1
-1
@@ -330,7 +330,7 @@ of the Agent repository (`/`). Links should also always end with the filename of
330
Avoid relative links or traversing up directories using `../`.
331
332
For example, if you want to link to our installation guide, you should link to `/packaging/installer/README.md`. To
333
-reference the guide for increasing metrics storage, use `/docs/tutorials/longer-metrics-storage.md`.
333
+reference the guide for increasing metrics storage, use `/docs/guides/longer-metrics-storage.md`.
334
335
### References to UI elements
336
docs/export/README.md
+3
-3
@@ -25,7 +25,7 @@ be applied to other connectors as well.
25
> If you are migrating from the deprecated backends system, this quickstart will also help you update your configuration
26
> to the new format. For the most part, the configurations are identical, but there are two exceptions. First,
27
> `exporting.conf` uses a new `[<type>:<name>]` format for defining connector instances. Second, the `host tags` setting
28
-> is deprecated. Instead, use [host labels](/docs/tutorials/using-host-labels.md) to tag exported metrics.
28
+> is deprecated. Instead, use [host labels](/docs/guides/using-host-labels.md) to tag exported metrics.
29
30
Open the `exporting.conf` file with `edit-config`.
31
@@ -94,8 +94,8 @@ collected, you should start seeing data in your external database after only a f
94
95
- [Exporting reference guide](/exporting/README.md)
96
- [Backends (deprecated)](/backends/README.md)
97
-- [Use host labels to organize systems, metrics, and alarms](/docs/tutorials/using-host-labels.md)
97
+- [Use host labels to organize systems, metrics, and alarms](/docs/guides/using-host-labels.md)
98
- [Database engine](/database/engine/README.md)
99
-- [Change how long Netdata stores metrics (long-term storage)](/docs/tutorials/longer-metrics-storage.md)
99
+- [Change how long Netdata stores metrics (long-term storage)](/docs/guides/longer-metrics-storage.md)
100
101
[](<>)
docs/getting-started.md
+2
-2
@@ -15,7 +15,7 @@ The Agent can collect thousands of metrics in real-time and use its database for
15
configuration, but there are some valuable things to know to get the most out of Netdata based on your needs.
16
17
We'll skip right into some technical details, so if you're brand-new to monitoring the health and performance of systems
18
-and applications, our [**step-by-step tutorial**](/docs/step-by-step/step-00.md) might be a better fit.
18
+and applications, our [**step-by-step guide**](/docs/guides/step-by-step/step-00.md) might be a better fit.
19
20
> If you haven't installed Netdata yet, visit the [installation instructions](/packaging/installer/README.md) for
21
> details, including our one-liner script, which automatically installs Netdata on almost all Linux distributions.
@@ -67,7 +67,7 @@ configuration keeps RAM usage low while allowing for long-term, on-disk metrics
67
You can tweak this custom _database engine_ to store a much larger dataset than your system's available RAM,
68
particularly if you allow Netdata to use slightly more RAM and disk space than the default configuration.
69
70
-Read our guide on [changing how long Netdata stores metrics](/docs/tutorials/longer-metrics-storage.md) to learn more
70
+Read our guide on [changing how long Netdata stores metrics](/docs/guides/longer-metrics-storage.md) to learn more
71
and use our [database engine calculator](https://learn.netdata.cloud/docs/agent/database/calculator) to figure
72
out the exact settings you'll need to store historical metrics right in the Agent's database.
73
docs/guides/collect-apache-nginx-web-logs.md
renamed
+6
-8
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Monitor Nginx or Apache web server log files with Netdata"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/collect-apache-nginx-web-logs.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-apache-nginx-web-logs.md
4
-->
5
6
# Monitor Nginx or Apache web server log files with Netdata
@@ -22,10 +20,10 @@ You can now use the [LTSV log format](http://ltsv.org/), track TLS and cipher us
20
ever. In one test on a system with SSD storage, the collector consistently parsed the logs for 200,000 requests in
21
200ms, using ~30% of a single core. To learn more about these improvements, see our [v1.19 release post](https://blog.netdata.cloud/posts/release-1.19/).
22
25
-The [go.d plugin](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/) is currently compatible with
26
-[Nginx](https://nginx.org/en/) and [Apache](https://httpd.apache.org/).
23
+The [go.d plugin](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/) is currently compatible
24
+with [Nginx](https://nginx.org/en/) and [Apache](https://httpd.apache.org/).
25
28
-This tutorial will walk you through using the new Go-based web log collector to turn the logs these web servers
26
+This guide will walk you through using the new Go-based web log collector to turn the logs these web servers
27
constantly write to into real-time insights into your infrastructure.
28
29
## Set up your web servers
@@ -128,7 +126,7 @@ web server's access log and begin showing real-time charts!
126
### Custom log formats and fields
127
128
The web log collector is capable of parsing custom Nginx and Apache log formats and presenting them as charts, but we'll
131
-leave that topic for a separate tutorial.
129
+leave that topic for a separate guide.
130
131
We do have [extensive
132
documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/#custom-log-format) on how
@@ -160,4 +158,4 @@ into powerful real-time tools for keeping your servers happy.
158
Don't forget to give GitHub user [Wing924](https://github.com/Wing924) a big 👍 for his hard work in starting up the Go
159
refactoring effort.
160
163
-[](<>)
161
+[](<>)
docs/guides/collect-unbound-metrics.md
renamed
+3
-5
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Monitor Unbound DNS servers with Netdata"
3
date: 2020-03-31
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/collect-unbound-metrics.md
6
----
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-unbound-metrics.md
5
-->
6
7
# Monitor Unbound DNS servers with Netdata
@@ -16,7 +14,7 @@ Unbound runs on FreeBSD, OpenBSD, NetBSD, macOS, Linux, and Windows, and support
14
queries and answers are all encrypted with TLS. In theory, that should reduce the risk of eavesdropping or
15
man-in-the-middle attacks when communicating to DNS servers.
16
19
-This tutorial will show you how to collect dozens of essential metrics from your Unbound servers with minimal
17
+This guide will show you how to collect dozens of essential metrics from your Unbound servers with minimal
18
configuration.
19
20
## Set up your Unbound installation
@@ -137,4 +135,4 @@ for improvement or refinement based on real-world use cases. Feel free to [file
135
issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) with your
136
thoughts.
137
140
-[](<>)
138
+[](<>)
docs/guides/longer-metrics-storage.md
renamed
+3
-3
@@ -1,7 +1,7 @@
1
<!--
2
title: "Change how long Netdata stores metrics"
3
description: "With a single configuration change, the Netdata Agent can store days, weeks, or months of metrics at its famous per-second granularity."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/longer-metrics-storage.md
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/longer-metrics-storage.md
5
-->
6
7
# Change how long Netdata stores metrics
@@ -13,7 +13,7 @@ Many people think Netdata can only store about an hour's worth of real-time metr
13
more. With the right settings, Netdata is quite capable of efficiently storing hours or days worth of historical,
14
per-second metrics without having to rely on an [exporting engine](/exporting/README.md).
15
16
-This tutorial gives two options for configuring Netdata to store more metrics. **We recommend the default [database
16
+This guide gives two options for configuring Netdata to store more metrics. **We recommend the default [database
17
engine](#using-the-database-engine)**, but you can stick with or switch to the round-robin database if you prefer.
18
19
Let's get started.
@@ -155,4 +155,4 @@ charts](/web/README.md#using-charts).
155
And if you'd now like to reduce Netdata's resource usage, view our [performance guide](/docs/Performance.md) for
156
our best practices on optimization.
157
158
-[](<>)
158
+[](<>)
docs/guides/monitor-cockroachdb.md
renamed
+3
-3
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Monitor CockroachDB metrics with Netdata"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/monitor-cockroachdb.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-cockroachdb.md
4
-->
5
6
# Monitor CockroachDB metrics with Netdata
@@ -134,3 +132,5 @@ Also, be sure to check out these useful resources:
132
docs](https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint)
133
- [Monitor CockroachDB with
134
Prometheus](https://www.cockroachlabs.com/docs/stable/monitor-cockroachdb-with-prometheus.html)
135
+
136
+[](<>)
docs/guides/monitor-hadoop-cluster.md
renamed
+6
-8
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Monitor a Hadoop cluster with Netdata"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/monitor-hadoop-cluster.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-hadoop-cluster.md
4
-->
5
6
# Monitor a Hadoop cluster with Netdata
@@ -17,16 +15,16 @@ implementations.
15
16
Netdata comes with built-in and pre-configured support for monitoring both HDFS and Zookeeper.
17
20
-This tutorial assumes you have a Hadoop cluster, with HDFS and Zookeeper, running already. If you don't, please follow
18
+This guide assumes you have a Hadoop cluster, with HDFS and Zookeeper, running already. If you don't, please follow
19
the [official Hadoop
20
instructions](http://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/SingleCluster.html) or an
21
alternative, like the guide available from
22
[DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-install-hadoop-in-stand-alone-mode-on-ubuntu-18-04).
23
26
-For more specifics on the collection modules used in this tutorial, read the respective pages in our documentation:
24
+For more specifics on the collection modules used in this guide, read the respective pages in our documentation:
25
28
-- [HDFS](/collectors/go.d.plugin/modules/hdfs/README.md)
29
-- [Zookeeper](/collectors/go.d.plugin/modules/zookeeper/README.md)
26
+- [HDFS](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/hdfs)
27
+- [Zookeeper](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/zookeeper)
28
29
## Set up your HDFS and Zookeeper installations
30
@@ -203,4 +201,4 @@ issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&
201
file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/zookeeper.conf) to understand how to configure
202
global options or per-job options, timeouts, TLS certificates, and more.
203
206
-[](<>)
204
+[](<>)
docs/guides/monitor/dimension-templates.md
renamed
+11
-11
@@ -1,7 +1,7 @@
1
<!--
2
---
3
title: "Use dimension templates to create dynamic alarms"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/tutorials/dimension-templates.md
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/monitor/health/dimension-templates.md
5
---
6
-->
7
@@ -11,22 +11,22 @@ Your ability to monitor the health of your systems and applications relies on yo
11
the best set of alarms for your particular needs.
12
13
In v1.18 of Netdata, we introduced **dimension templates** for alarms, which simplifies the process of writing [alarm
14
-entities](../REFERENCE.md#health-entity-reference) for charts with many dimensions.
14
+entities](/health/REFERENCE.md#health-entity-reference) for charts with many dimensions.
15
16
Dimension templates can condense many individual entities into one—no more copy-pasting one entity and changing the
17
`alarm`/`template` and `lookup` lines for each dimension you'd like to monitor.
18
19
They are, however, an advanced health monitoring feature. For more basic instructions on creating your first alarm,
20
-check out our [health monitoring documentation](../README.md), which also includes
21
-[examples](../REFERENCE.md#example-alarms).
20
+check out our [health monitoring documentation](/health/README.md), which also includes
21
+[examples](/health/REFERENCE.md#example-alarms).
22
23
## The fundamentals of `foreach`
24
25
Our dimension templates update creates a new `foreach` parameter to the existing [`lookup`
26
-line](../REFERENCE.md#alarm-line-lookup). This is where the magic happens.
26
+line](/health/REFERENCE.md#alarm-line-lookup). This is where the magic happens.
27
28
You use the `foreach` parameter to specify which dimensions you want to monitor with this single alarm. You can separate
29
-them with a comma (`,`) or a pipe (`|`). You can also use a [Netdata simple pattern](../../libnetdata/simple_pattern/README.md)
29
+them with a comma (`,`) or a pipe (`|`). You can also use a [Netdata simple pattern](/libnetdata/simple_pattern/README.md)
30
to create many alarms with a regex-like syntax.
31
32
The `foreach` parameter _has_ to be the last parameter in your `lookup` line, and if you have both `of` and `foreach` in
@@ -97,7 +97,7 @@ Let's look at some other examples of how `foreach` works so you can best apply i
97
In the last example, we used `foreach system,user,nice` to create three distinct alarms using dimension templates. But
98
what if you want to quickly create alarms for _all_ the dimensions of a given chart?
99
100
-Use a [simple pattern](../../libnetdata/simple_pattern/README.md)! One example of a simple pattern is a single wildcard
100
+Use a [simple pattern](/libnetdata/simple_pattern/README.md)! One example of a simple pattern is a single wildcard
101
(`*`).
102
103
Instead of monitoring system CPU usage, let's monitor per-application CPU usage using the `apps.cpu` chart. Passing a
@@ -116,11 +116,11 @@ This entity will now create alarms for every dimension in the `apps.cpu` chart.
116
10 or more dimensions, using the wildcard ensures you catch every CPU-hogging process.
117
118
To learn more about how to use simple patterns with dimension templates, see our [simple patterns
119
-documentation](../../libnetdata/simple_pattern/README.md).
119
+documentation](/libnetdata/simple_pattern/README.md).
120
121
## Using `foreach` with alarm templates
122
123
-Dimension templates also work with [alarm templates](../REFERENCE.md#alarm-line-alarm-or-template). Alarm
123
+Dimension templates also work with [alarm templates](/health/REFERENCE.md#alarm-line-alarm-or-template). Alarm
124
templates help you create alarms for all the charts with a given context—for example, all the cores of your system's
125
CPU.
126
@@ -173,6 +173,6 @@ alarms that will help you better monitor the health of your systems.
173
Or, at the very least, simplify your configuration files.
174
175
For information about other advanced features in Netdata's health monitoring toolkit, check out our [health
176
-documentation](../../health/). And if you have some cool alarms you built using dimension templates,
176
+documentation](/health/README.md). And if you have some cool alarms you built using dimension templates,
177
178
-[](<>)
178
+[](<>)
docs/guides/monitor/stop-notifications-alarms.md
renamed
+9
-9
@@ -1,7 +1,7 @@
1
<!--
2
---
3
title: "Stop notifications for individual alarms"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/tutorials/stop-notifications-alarms.md
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/stop-notifications-alarms.md
5
---
6
-->
7
@@ -15,7 +15,7 @@ relevant if you run Netdata on your laptop or a small virtual server. If they're
15
to real issues with health and performance.
16
17
Silencing individual alarms is an excellent solution for situations where you're not interested in seeing a specific
18
-alarm but don't want to disable a [notification system](../notifications/README.md) entirely.
18
+alarm but don't want to disable a [notification system](/health/notifications/README.md) entirely.
19
20
## Find the alarm configuration file
21
@@ -36,7 +36,7 @@ In the `source` row, you see that this chart is getting its configuration from
36
the file you need to edit if you want to silence this alarm.
37
38
For more information about editing or referencing health configuration files on your system, see the [health
39
-quickstart](../QUICKSTART.md#edit-health-configuration-files).
39
+quickstart](/health/QUICKSTART.md#edit-health-configuration-files).
40
41
## Edit the file to enable silencing
42
@@ -82,13 +82,13 @@ You can add `to: silence` to any alarm you'd rather not bother you with notifica
82
You should now know the fundamentals behind silencing any individual alarm in Netdata.
83
84
To learn about _all_ of Netdata's health configuration possibilities, visit the [health reference
85
-guide](../REFERENCE.md), or check out other [tutorials on health monitoring](../README.md#tutorials).
85
+guide](/health/REFERENCE.md), or check out other [tutorials on health monitoring](/health/README.md#tutorials).
86
87
Or, take better control over how you get notified about alarms via the [notification
88
-system](../notifications/README.md).
88
+system](/health/notifications/README.md).
89
90
-You can also use Netdata's [Health Management API](../../web/api/health/README.md#health-management-api) to control
91
-health checks and notifications while Netdata runs. With this API, you can disable health checks during a maintenance
92
-window or backup process, for example.
90
+You can also use Netdata's [Health Management API](/web/api/health/README.md#health-management-api) to control health
91
+checks and notifications while Netdata runs. With this API, you can disable health checks during a maintenance window or
92
+backup process, for example.
93
94
-[](<>)
94
+[](<>)
docs/guides/step-by-step/step-00.md
renamed
+10
-10
@@ -1,32 +1,30 @@
1
<!--
2
----
3
-title: "The step-by-step Netdata tutorial"
2
+title: "The step-by-step Netdata guide"
3
date: 2020-03-31
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-00.md
6
----
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-00.md
5
-->
6
9
-# The step-by-step Netdata tutorial
7
+# The step-by-step Netdata guide
8
9
Welcome to Netdata! We're glad you're interested in our health monitoring and performance troubleshooting system.
10
11
Because Netdata is entirely open-source software, you can use it free of charge, whether you want to monitor one or ten
12
thousand systems! All our code is hosted on [GitHub](https://github.com/netdata/netdata).
13
16
-This tutorial is designed to help you understand what Netdata is, what it's capable of, and how it'll help you make
14
+This guide is designed to help you understand what Netdata is, what it's capable of, and how it'll help you make
15
faster and more informed decisions about the health and performance of your systems and applications. If you're
16
completely new to Netdata, or have never tried health monitoring/performance troubleshooting systems before, this
19
-tutorial is perfect for you.
17
+guide is perfect for you.
18
19
If you have monitoring experience, or would rather get straight into configuring Netdata to your needs, you can jump
20
straight into code and configurations with our [getting started guide](/docs/getting-started.md).
21
24
-> This tutorial contains instructions for Netdata installed on a Linux system. Many of the instructions will work on
22
+> This guide contains instructions for Netdata installed on a Linux system. Many of the instructions will work on
23
> other supported operating systems, like FreeBSD and macOS, but we can't make any guarantees.
24
25
## Where to go if you need help
26
29
-No matter where you are in this Netdata tutorial, if you need help, head over to our [GitHub
27
+No matter where you are in this Netdata guide, if you need help, head over to our [GitHub
28
repository](https://github.com/netdata/netdata/). That's where we collect questions from users, help fix their bugs, and
29
point people toward documentation that explains what they're having trouble with.
30
@@ -34,7 +32,7 @@ Click on the **issues** tab to see all the conversations we're having with Netda
32
previously-written advice for your specific problem, and if you don't see any results, hit the **New issue** button to
33
send us a question.
34
37
-Or, if that's too complicated, feel free to send this tutorial's author [an email](mailto:joel@netdata.cloud).
35
+Or, if that's too complicated, feel free to send this guide's author [an email](mailto:joel@netdata.cloud).
36
37
## Before we get started
38
@@ -113,3 +111,5 @@ MongoDB, TimescaleDB, and others.
111
[Step 10. Set up a proxy](step-10.md)
112
113
Run Netdata behind an Nginx proxy to improve performance, and enable TLS/HTTPS for better security.
114
+
115
+[](<>)
docs/guides/step-by-step/step-01.md
renamed
+4
-4
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Step 1. Netdata's building blocks"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-01.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-01.md
4
-->
5
6
# Step 1. Netdata's building blocks
@@ -40,7 +38,7 @@ Let's get started!
38
## Netdata's core features
39
40
Netdata has only been around for a few years, but it's a complex piece of software. Here are just some of the features
43
-we'll cover throughout this tutorial.
41
+we'll cover throughout this guide.
42
43
- A sophisticated **dashboard**, which we'll cover in [step 2](step-02.md). The real-time, highly-granular dashboard,
44
with hundreds of charts, is your main source of information about the health and performance of your systems/
@@ -154,3 +152,5 @@ We think it's imperative you understand why we built Netdata the way we did. But
152
get right into that dashboard you've heard so much about.
153
154
[Next: Get to know Netdata's dashboard →](step-02.md)
155
+
156
+[](<>)
docs/guides/step-by-step/step-02.md
renamed
+6
-6
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Step 2. Get to know Netdata's dashboard"
3
date: 2020-05-04
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-02.md
6
----
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-02.md
5
-->
6
7
# Step 2. Get to know Netdata's dashboard
@@ -39,7 +37,7 @@ of your Agent. If you're unsure, try `http://localhost:19999` first. Hit **Enter
37
39
42
-> From here on out in this tutorial, we'll refer to the address you use to view your dashboard as `NODE`. Be sure to
40
+> From here on out in this guide, we'll refer to the address you use to view your dashboard as `NODE`. Be sure to
41
> replace it with either `localhost`, the IP address, or the hostname of your system.
42
43
## Explore available charts using menus
@@ -189,13 +187,13 @@ often Netdata should be calculating these metrics to see if the alarm should rem
187
The `execute` field tells Netdata how to notify you about this alarm, and the `source` field lets you know where you can
188
find the configuration file, if you'd like to edit its configuration.
189
192
-We'll cover alarm configuration in more detail later in the tutorial, so don't worry about it too much for now! Right
190
+We'll cover alarm configuration in more detail later in the guide, so don't worry about it too much for now! Right
191
now, it's most important that you understand how to see alarms, and parse their details, if and when they appear on your
192
system.
193
194
## What's next?
195
198
-In this step of the Netdata tutorial, you learned how to:
196
+In this step of the Netdata guide, you learned how to:
197
198
- Visit the dashboard
199
- Explore available charts (using the right-side menu)
@@ -206,3 +204,5 @@ In this step of the Netdata tutorial, you learned how to:
204
Next, you'll learn how to monitor multiple nodes through the dashboard.
205
206
[Next: Monitor more than one system with Netdata →](step-03.md)
207
+
208
+[](<>)
docs/guides/step-by-step/step-03.md
renamed
+4
-4
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Step 3. Monitor more than one system with Netdata"
3
date: 2020-05-01
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-03.md
6
----
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-03.md
5
-->
6
7
# Step 3. Monitor more than one system with Netdata
@@ -52,7 +50,7 @@ Or, if you're feeling confident, dive right in.
50
51
<p><a href="https://app.netdata.cloud" className="button button--lg">Sign in to Cloud</a></p>
52
55
-When you finish that guide, circle back to this step in the tutorial to learn how to use the Visited Nodes feature on
53
+When you finish that guide, circle back to this step in the guide to learn how to use the Visited Nodes feature on
54
top of Cloud's centralized web interface.
55
56
## Navigate between dashboards with Visited Nodes
@@ -89,3 +87,5 @@ Visited nodes, it's time to learn more about how you can configure Netdata to yo
87
customize your Netdata experience to your exact infrastructure and the information you need.
88
89
[Next: The basics of configuring Netdata →](step-04.md)
90
+
91
+[](<>)
docs/guides/step-by-step/step-04.md
renamed
+9
-9
@@ -1,14 +1,12 @@
1
<!--
2
----
2
title: "Step 4. The basics of configuring Netdata"
3
date: 2020-03-31
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-04.md
6
----
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-04.md
5
-->
6
7
# Step 4. The basics of configuring Netdata
8
11
-Welcome to the fourth step of the Netdata tutorial.
9
+Welcome to the fourth step of the Netdata guide.
10
11
Since the beginning, we've covered the building blocks of Netdata, dashboard basics, and how you can monitor many
12
individual systems using many distributed Netdata agents.
@@ -47,7 +45,7 @@ In the system represented by the screenshot, the line reads: `config directory =
45
> For more details on where your Netdata config directory is, take a look at our [installation
46
> instructions](/packaging/installer/README.md).
47
50
-For the rest of this tutorial, we'll assume you're editing files or running scripts from _within_ your **Netdata
48
+For the rest of this guide, we'll assume you're editing files or running scripts from _within_ your **Netdata
49
configuration directory**.
50
51
## Use edit-config to open `netdata.conf`
@@ -98,7 +96,7 @@ section and give it the value of `1`.
96
```
97
98
Restart Netdata with `service restart netdata` or the [appropriate
101
-alternative](../getting-started.md#start-stop-and-restart-netdata) for your system.
99
+alternative](/docs/getting-started.md#start-stop-and-restart-netdata) for your system.
100
101
Now, open up your browser and navigate to `http://HOST:19999/netdata.conf`. You'll see that Netdata has recognized
102
that our fake option isn't valid and added a notice that Netdata will ignore it.
@@ -126,8 +124,8 @@ Once you're done, restart Netdata and refresh the dashboard. Say hello to your r
124
netdata.conf](https://user-images.githubusercontent.com/1153921/80994808-1c065300-8df2-11ea-81af-d28dc3ba27c8.gif)
125
126
Netdata has dozens upon dozens of options you can change. To see them all, read our [daemon
129
-configuration](/daemon/config/README.md), or hop into our popular tutorial on [increasing long-term metrics
130
-storage](/docs/tutorials/longer-metrics-storage.md).
127
+configuration](/daemon/config/README.md), or hop into our popular guide on [increasing long-term metrics
128
+storage](/docs/guides/longer-metrics-storage.md).
129
130
## What's next?
131
@@ -135,10 +133,12 @@ At this point, you should be comfortable with getting to your Netdata directory,
133
seeing your changes reflected in the dashboard.
134
135
Netdata has many more configuration files that you might want to change, but we'll cover those in the following steps of
138
-this tutorial.
136
+this guide.
137
138
In the next step, we're going to cover one of Netdata's core functions: monitoring the health of your systems via alarms
139
and notifications. You'll learn how to disable alarms, create new ones, and push notifications to the system of your
140
choosing.
141
142
[Next: Health monitoring alarms and notifications →](step-05.md)
143
+
144
+[](<>)
docs/guides/step-by-step/step-05.md
renamed
+4
-4
@@ -1,13 +1,11 @@
1
<!--
2
----
2
title: "Step 5. Health monitoring alarms and notifications"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-05.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-05.md
4
-->
5
6
# Step 5. Health monitoring alarms and notifications
7
10
-In the fifth step of the Netdata tutorial, we're introducing you to one of our core features: **health monitoring**.
8
+In the fifth step of the Netdata guide, we're introducing you to one of our core features: **health monitoring**.
9
10
To accurately monitor the health of your systems and applications, you need to know _immediately_ when there's something
11
strange going on. Netdata's alarm and notification systems are essential to keeping you informed.
@@ -345,3 +343,5 @@ Next up, we're going to cover how Netdata collects its metrics, and how you can
343
from hundreds of services with almost no configuration on your part. Onward!
344
345
[Next: Collect metrics from more services and apps →](step-06.md)
346
+
347
+[](<>)
docs/guides/step-by-step/step-06.md
renamed
+4
-4
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Step 6. Collect metrics from more services and apps"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-06.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/guides/docs/step-by-step/step-06.md
4
-->
5
6
# Step 6. Collect metrics from more services and apps
@@ -39,7 +37,7 @@ are organized and manged by plugins. **Internal** plugins collect system metrics
37
non-system metrics, and **orchestrator** plugins group individal collectors together based on the programming language
38
they were built in.
39
42
-These modules are primarily written in [Go](/collectors/go.d.plugin/README.md) (`go.d`) and
40
+These modules are primarily written in [Go](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/) (`go.d`) and
41
[Python](/collectors/python.d.plugin/README.md), although some use [Bash](/collectors/charts.d.plugin/README.md)
42
(`charts.d`) or [Node.js](/collectors/node.d.plugin/README.md) (`node.d`).
43
@@ -120,3 +118,5 @@ Now that you've learned the fundamentals behind configuring data sources for aut
118
the dashboard to learn more about some of its more advanced features.
119
120
[Next: Netdata's dashboard in depth →](step-07.md)
121
+
122
+[](<>)
docs/guides/step-by-step/step-07.md
renamed
+5
-5
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Step 7. Netdata's dashboard in depth"
3
date: 2020-05-04
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-07.md
6
----
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-07.md
5
-->
6
7
# Step 7. Netdata's dashboard in depth
@@ -11,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-ste
9
Welcome to the seventh step of the Netdata guide!
10
11
This step of the guide aims to get you more familiar with the features of the dashboard not previously mentioned in
14
-[step 2](/docs/step-by-step/step-02.md).
12
+[step 2](/docs/guides/step-by-step/step-02.md).
13
14
## What you'll learn in this step
15
@@ -103,7 +101,7 @@ restore your real-time dashboard for your machine.
101
102
## What's next?
103
106
-In this step of the Netdata tutorial, you learned how to:
104
+In this step of the Netdata guide, you learned how to:
105
106
- Change the dashboard's settings
107
- Check if there's an update to Netdata
@@ -112,3 +110,5 @@ In this step of the Netdata tutorial, you learned how to:
110
Next, you'll learn how to build your first custom dashboard!
111
112
[Next: Build your first custom dashboard →](step-08.md)
113
+
114
+[](<>)
docs/guides/step-by-step/step-08.md
renamed
+7
-7
@@ -1,13 +1,11 @@
1
<!--
2
----
2
title: "Step 8. Build your first custom dashboard"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-08.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-08.md
4
-->
5
6
# Step 8. Build your first custom dashboard
7
10
-In previous steps of the tutorial, you have learned how several sections of the Netdata dashboard worked.
8
+In previous steps of the guide, you have learned how several sections of the Netdata dashboard worked.
9
10
This step will show you how to set up a custom dashboard to fit your unique needs. If nothing else, Netdata is really,
11
really flexible. 🤸
@@ -147,8 +145,8 @@ charts on a single page.
145
### The chart unique ID (required)
146
147
You need to specify the unique ID of a chart to show it on your custom dashboard. If you forgot how to find the unique
150
-ID, head back over to [step 2](/docs/step-by-step/step-02.md#understand-charts-dimensions-families-and-contexts) for a
151
-re-introduction.
148
+ID, head back over to [step 2](/docs/guides/step-by-step/step-02.md#understand-charts-dimensions-families-and-contexts)
149
+for a re-introduction.
150
151
You can then put this unique ID into a `<div>` element with the `data-netdata` attribute. Put this in the `<body>` of
152
your custom dashboard file beneath the helpful comment.
@@ -392,4 +390,6 @@ from multiple Netdata agents, and choose which dimensions a given chart shows.
390
391
Next, you'll learn how to store long-term historical metrics in Netdata!
392
395
-[Next: Long-term metrics storage →](/docs/step-by-step/step-09.md)
393
+[Next: Long-term metrics storage →](/docs/guides/step-by-step/step-09.md)
394
+
395
+[](<>)
docs/guides/step-by-step/step-09.md
renamed
+8
-8
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Step 9. Long-term metrics storage"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-09.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-09.md
4
-->
5
6
# Step 9. Long-term metrics storage
@@ -33,7 +31,7 @@ Let's get started!
31
## Tweak the database engine's settings
32
33
If you're using Netdata v1.18.0 or higher, and you haven't changed your `memory mode` settings before following this
36
-tutorial, your Netdata agent is already using the database engine.
34
+guide, your Netdata agent is already using the database engine.
35
36
Let's look at your `netdata.conf` file again. Under the `[global]` section, you'll find three connected options.
37
@@ -78,8 +76,8 @@ You can archive all the metrics collected by Netdata to **external databases**.
76
include Graphite, OpenTSDB, Prometheus, AWS Kinesis Data Streams, Google Cloud Pub/Sub, MongoDB, and the list is always
77
growing.
78
81
-As we said in [step 1](/docs/step-by-step/step-01.md), we have only complimentary systems, not competitors! We're happy
82
-to support these archiving methods and are always working to improve them.
79
+As we said in [step 1](/docs/guides/step-by-step/step-01.md), we have only complimentary systems, not competitors! We're
80
+happy to support these archiving methods and are always working to improve them.
81
82
A lot of Netdata users archive their metrics to one of these databases for long-term storage or further analysis. Since
83
Netdata collects so many metrics every second, they can quickly overload small devices or even big servers that are
@@ -157,7 +155,9 @@ documentation](/exporting/README.md).
155
You're getting close to the end! In this step, you learned how to make the most of the database engine, or archive
156
metrics to MongoDB for long-term storage.
157
160
-In the last step of this step-by-step tutorial, we'll put our sysadmin hat on and use Nginx to proxy traffic to and from
158
+In the last step of this step-by-step guide, we'll put our sysadmin hat on and use Nginx to proxy traffic to and from
159
our Netdata dashboard.
160
163
-[Next: Set up a proxy →](step-10.md)
161
+[Next: Set up a proxy →](/docs/guides/step-by-step/step-10.md)
162
+
163
+[](<>)
docs/guides/step-by-step/step-10.md
renamed
+9
-9
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Step 10. Set up a proxy"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-10.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-10.md
4
-->
5
6
# Step 10. Set up a proxy
@@ -10,15 +8,15 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-ste
8
You're almost through! At this point, you should be pretty familiar with now Netdata works and how to configure it to
9
your liking.
10
13
-In this step of the tutorial, we're going to add a proxy in front of Netdata. We're doing this for both improved
11
+In this step of the guide, we're going to add a proxy in front of Netdata. We're doing this for both improved
12
performance and security, so we highly recommend following these steps. Doubly so if you installed Netdata on a
13
publicly-accessible remote server.
14
15
> ❗ If you installed Netdata on the machine you're currently using (e.g. on `localhost`), and have been accessing
18
-> Netdata at `http://localhost:19999`, you can skip this step of the tutorial. In most cases, there is no benefit to
16
+> Netdata at `http://localhost:19999`, you can skip this step of the guide. In most cases, there is no benefit to
17
> setting up a proxy for a service running locally.
18
21
-> ❗❗ This tutorial requires more advanced administration skills than previous parts. If you're still working on your
19
+> ❗❗ This guide requires more advanced administration skills than previous parts. If you're still working on your
20
> Linux administration skills, and would rather get back to Netdata, you might want to [skip this
21
> step](step-99.md) for now and return to it later.
22
@@ -41,7 +39,7 @@ large enters your system through the proxy, which then routes it to the service.
39
A proxy is often used to enable encrypted HTTPS connections with your browser, but they're also useful for load
40
balancing, performance, and password-protection.
41
44
-We'll use [Nginx](https://nginx.org/en/) for this step of the tutorial, but you can also use
42
+We'll use [Nginx](https://nginx.org/en/) for this step of the guide, but you can also use
43
[Caddy](https://caddyserver.com/) as a simple proxy if you prefer.
44
45
## Required before you start
@@ -54,7 +52,7 @@ You need three things to run a proxy using Nginx:
52
53
### Nginx and Certbot
54
57
-This step of the tutorial assumes you can install Nginx on your system. Here are the easiest methods to do so on Debian,
55
+This step of the guide assumes you can install Nginx on your system. Here are the easiest methods to do so on Debian,
56
Ubuntu, Fedora, and CentOS systems.
57
58
```bash
@@ -223,8 +221,10 @@ If you want to configure your Nginx proxy further, check out the following:
221
- [High-performance Netdata](/docs/high-performance-netdata.md)
222
- [Enabling TLS on Netdata's dashboard](/web/server/README.md#enabling-tls-support)
223
226
-And... you're _almost_ done with the Netdata tutorial.
224
+And... you're _almost_ done with the Netdata guide.
225
226
For some celebratory emoji and a clap on the back, head on over to our final step.
227
228
[Next: The end. →](step-99.md)
229
+
230
+[](<>)
docs/guides/step-by-step/step-99.md
renamed
+7
-7
@@ -1,21 +1,19 @@
1
<!--
2
----
2
title: "Step ∞. You're finished!"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-99.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-99.md
4
-->
5
6
# Step ∞. You're finished!
7
8
Congratulations. 🎉
9
12
-You've completed the step-by-step Netdata tutorial. That means you're well on your way to becoming an expert in using
10
+You've completed the step-by-step Netdata guide. That means you're well on your way to becoming an expert in using
11
our toolkit for health monitoring and performance troubleshooting.
12
13
But, perhaps more importantly, also that much closer to being an expert in the _fundamental skills behind health
14
monitoring and performance troubleshooting_, which you can take with you to any job or project.
15
18
-And that is the entire point of this tutorial, and Netdata's [documentation](https://learn.netdata.cloud) as a
16
+And that is the entire point of this guide, and Netdata's [documentation](https://learn.netdata.cloud) as a
17
whole—give you every resource possible to help you build faster, more resilient systems, services, and applications.
18
19
Along the way, you learned how to:
@@ -35,7 +33,7 @@ Seems like a lot, right? Well, we hope it felt manageable and, yes, even _fun_.
33
34
## What's next?
35
38
-Now that you're at the end of our step-by-step Netdata tutorial, the next steps are entirely up to you. In fact, you're
36
+Now that you're at the end of our step-by-step Netdata guide, the next steps are entirely up to you. In fact, you're
37
just at the beginning of your journey into health monitoring and performance troubleshooting.
38
39
Our documentation exists to put every Netdata resource in front of you as easily and coherently as we possibly can.
@@ -43,9 +41,11 @@ Click around, search, and find new mountains to climb.
41
42
If that feels like too much possibility to you, why not one of these options:
43
46
-- Share your experience with Netdata and this tutorial. Be sure to [@mention](https://twitter.com/linuxnetdata) us on
44
+- Share your experience with Netdata and this guide. Be sure to [@mention](https://twitter.com/linuxnetdata) us on
45
Twitter!
46
- Contribute to what we do. Browse our [open issues](https://github.com/netdata/netdata/issues) and check out out
47
[contributions doc](/CONTRIBUTING.md) for ideas of how you can pitch in.
48
49
We can't wait to see what you monitor next! Bon voyage! ⛵
50
+
51
+[](<>)
docs/guides/using-host-labels.md
renamed
+3
-3
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Use host labels to organize systems, metrics, and alarms"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/using-host-labels.md
5
----
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/using-host-labels.md
4
-->
5
6
# Use host labels to organize systems, metrics, and alarms
@@ -208,3 +206,5 @@ queries _do_ showcase this information. As always, we recommend you secure Netda
206
If you have issues or questions around using host labels, don't hesitate to [file an
207
issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) on GitHub. We're
208
excited to make host labels even more valuable to our users, which we can only do with your input.
209
+
210
+[](<>)
exporting/README.md
+1
-1
@@ -23,7 +23,7 @@ same time. You can have different update intervals and filters configured for ev
23
The exporting engine has its own configuration file `exporting.conf`. Configuration is almost similar to
24
[backends](/backends/README.md#configuration). The most important difference is that type of a connector should be
25
specified in a section name before a colon and an instance name after the colon. Also, you can't use `host tags`
26
-anymore. Set your labels using the [`[host labels]`](/docs/tutorials/using-host-labels.md) section in `netdata.conf`.
26
+anymore. Set your labels using the [`[host labels]`](/docs/guides/using-host-labels.md) section in `netdata.conf`.
27
28
Since Netdata collects thousands of metrics per server per second, which would easily congest any database server when
29
several Netdata servers are sending data to it, Netdata allows sending metrics at a lower frequency, by resampling them.
health/QUICKSTART.md
+2
-2
@@ -37,7 +37,7 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et
37
> You may need to use `sudo` or another method of elevating your privileges: `sudo ./edit-config health.d/cpu.conf`.
38
>
39
> You can also use the `$EDITOR` environment variable to use your preferred terminal editor with `edit-config`. See
40
-> [this page](/docs/step-by-step/step-04.md#use-edit-config-to-open-netdataconf) for details.
40
+> [this page](/docs/guides/step-by-step/step-04.md#use-edit-config-to-open-netdataconf) for details.
41
42
Each health configuration file contains one or more health entities, which always begin with an `alarm:` or `template:`
43
line. You can edit these entities based on your needs. To make any changes live, be sure to [reload your health
@@ -140,7 +140,7 @@ killall -USR2 netdata
140
141
To learn about all of Netdata's health configuration options, view the [reference guide](/health/REFERENCE.md).
142
143
-Or, get guided insights into specific health configurations with our [health tutorials](/health/README.md#tutorials).
143
+Or, get guided insights into specific health configurations with our [health guides](/health/README.md#guides).
144
145
Finally, move on to Netdata's [notification system](/health/notifications/README.md) to learn more about how Netdata can
146
let you know when the health of your systems or apps goes awry.
health/README.md
+6
-22
@@ -17,35 +17,19 @@ operates like a health watchdog for your services and applications.
17
You can even run statistical algorithms against the metrics you've collected to power complex lookups. Your imagination,
18
and the needs of your infrastructure, are your only limits.
19
20
-**Take the next steps with health monitoring:**
20
+[Quickstart](/health/QUICKSTART.md)
21
22
-<DocsSteps>
22
+[Configuration reference](/health/REFERENCE.md)
23
24
-[<FiPlay /> Quickstart](/health/QUICKSTART.md)
25
-
26
-[<FiCode /> Configuration reference](/health/REFERENCE.md)
27
-
28
-[<FiBook /> Tutorials](#tutorials)
29
-
30
-</DocsSteps>
31
-
32
-## Tutorials
24
+## Guides
25
26
Every infrastructure is different, so we're not interested in mandating how you should configure Netdata's health
35
-monitoring features. Instead, these tutorials should give you the details you need to tweak alarms to your heart's
27
+monitoring features. Instead, these guides should give you the details you need to tweak alarms to your heart's
28
content.
29
38
-<DocsTutorials>
39
-<div>
40
-
41
-### Health entities
42
-
43
-[Stopping notifications for individual alarms](/health/tutorials/stop-notifications-alarms.md)
44
-
45
-[Use dimension templates to create dynamic alarms](/health/tutorials/dimension-templates.md)
30
+[Stopping notifications for individual alarms](/docs/guides/monitor/stop-notifications-alarms.md)
31
47
-</div>
48
-</DocsTutorials>
32
+[Use dimension templates to create dynamic alarms](/docs/guides/monitor/dimension-templates.md)
33
34
## Related features
35
health/REFERENCE.md
+1
-1
@@ -383,7 +383,7 @@ good idea to tell Netdata to not clear the notification, by using the `no-clear-
383
384
#### Alarm line `host labels`
385
386
-Defines the list of labels present on a host. See our [host labels tutorial](/docs/tutorials/using-host-labels.md) for
386
+Defines the list of labels present on a host. See our [host labels guide](/docs/guides/using-host-labels.md) for
387
an explanation of host labels and how to implement them.
388
389
For example, let's suppose that `netdata.conf` is configured with the following labels:
packaging/installer/README.md
+2
-2
@@ -49,8 +49,8 @@ page](/packaging/installer/methods/kickstart.md).
49
Scroll down for details about [automatic updates](#automatic-updates) or [nightly vs. stable
50
releases](#nightly-vs-stable-releases).
51
52
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
53
-for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
52
+When you finish installing Netdata, be sure to visit our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for
53
+a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
54
55
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
56
guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/kickstart-64.md
+2
-2
@@ -83,8 +83,8 @@ If the script is valid, this command will return `OK, VALID`.
83
84
## What's next?
85
86
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md) for a
87
-fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
86
+When you finish installing Netdata, be sure to visit our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for
87
+a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
88
89
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
90
guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/kickstart.md
+2
-2
@@ -65,8 +65,8 @@ If the script is valid, this command will return `OK, VALID`.
65
66
## What's next?
67
68
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
69
-for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
68
+When you finish installing Netdata, be sure to visit our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for
69
+a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
70
71
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
72
guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/macos.md
+2
-2
@@ -79,8 +79,8 @@ sudo ./netdata-installer.sh --install /usr/local
79
80
## What's next?
81
82
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
83
-for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
82
+When you finish installing Netdata, be sure to visit our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for
83
+a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
84
85
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
86
guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/manual.md
+2
-2
@@ -216,8 +216,8 @@ In most cases, you can do this by running `CC=gcc ./netdata-installer.sh`.
216
217
## What's next?
218
219
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
220
-for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
219
+When you finish installing Netdata, be sure to visit our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for
220
+a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
221
222
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
223
guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/offline.md
+1
-1
@@ -80,4 +80,4 @@ Now that Netdata is installed, be sure to visit our [getting started guide](/doc
80
quick overview of configuring Netdata, enabling plugins, and controlling Netdata's daemon.
81
82
Or, get the full guided tour of Netdata's capabilities with our [step-by-step
83
-tutorial](/docs/step-by-step/step-00.md)!
83
+guide](/docs/guides/step-by-step/step-00.md)!
packaging/installer/methods/packages.md
+2
-2
@@ -50,8 +50,8 @@ If you are using such a setup, there are a couple of ways you can work around th
50
51
## What's next?
52
53
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
54
-for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
53
+When you finish installing Netdata, be sure to visit our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for
54
+a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
55
56
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
57
guide](/docs/getting-started.md) for a quick overview.