Skip to content

Commit fecbb89

Browse files
authored
Move/refactor docs to accomodate new Guides section on Learn (netdata#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
1 parent 78ca668 commit fecbb89

38 files changed

+169
-188
lines changed

collectors/QUICKSTART.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,18 @@ and `python.d`.
3535
> If there is a collector written in both Go and Python, it's better to choose the Go-based version, as we will
3636
> eventually deprecate most Python-based collectors.
3737
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.
4041

4142
## Configure your application or service for monitoring
4243

4344
Every collector's documentation comes with instructions on how to configure your app/service to make it available to
4445
Netdata's collector. Our [collector support list](COLLECTORS.md) contains links to each collector's documentation page
4546
so you can learn more.
4647

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
4850
installation must have the `stub_status` module configured correctly, in addition to an active `stub_status/` page, for
4951
Netdata to monitor it. You can confirm whether you have the module enabled with the following command:
5052

@@ -82,13 +84,14 @@ Despite Netdata's auto-detection capabilities, it's important to know how to edi
8284

8385
You should always edit configuration files with the `edit-config` script that comes with every installation of Netdata.
8486
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
8688
collector's configuration file.
8789

8890
How do you find that path to the collector's configuration file? Look under the **Configuration** heading in the
8991
collector's documentation. Each file contains a short code block with the relevant command.
9092

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`.
9295

9396
```bash
9497
cd /etc/netdata # Replace this path with your Netdata config directory
@@ -115,7 +118,7 @@ entry in the menu and new interactive charts!
115118
Collector not working? Learn about collector troubleshooting in our [collector
116119
reference](REFERENCE.md#troubleshoot-a-collector).
117120

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
119122
popular collectors.
120123

121124
Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our

collectors/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ guide](/collectors/QUICKSTART.md).
3030

3131
[Collectors configuration reference](/collectors/REFERENCE.md)
3232

33-
## Tutorials
33+
## Guides
3434

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)
3636

37-
[Monitor CockroadchDB metrics with Netdata](/docs/tutorials/monitor-cockroachdb.md)
37+
[Monitor CockroadchDB metrics with Netdata](/docs/guides/monitor-cockroachdb.md)
3838

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)
4040

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)
4242

4343
## Related features
4444

docs/Performance.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,8 @@ following settings in the `[global]` section of `netdata.conf`:
196196
# dbengine disk space = 256
197197
```
198198

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.
201201

202202
### 6. Disable gzip compression of responses
203203

docs/configuration-guide.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ it there.
6363
#### Increase the long-term metrics retention period
6464

6565
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
6868
engine](/database/engine/README.md#memory-requirements).
6969

7070
#### Reduce the data collection frequency
@@ -198,7 +198,7 @@ Beginning with 1.20, Netdata accepts user-defined **host labels**. These labels
198198
labels]`.
199199

200200
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).
202202

203203
To define a label inside this section, some rules needs to be followed, or Netdata will reject the label. The following
204204
restrictions are applied for label names:

docs/contributing/style-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ of the Agent repository (`/`). Links should also always end with the filename of
330330
Avoid relative links or traversing up directories using `../`.
331331

332332
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`.
334334

335335
### References to UI elements
336336

docs/export/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ be applied to other connectors as well.
2525
> If you are migrating from the deprecated backends system, this quickstart will also help you update your configuration
2626
> to the new format. For the most part, the configurations are identical, but there are two exceptions. First,
2727
> `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.
2929
3030
Open the `exporting.conf` file with `edit-config`.
3131

@@ -94,8 +94,8 @@ collected, you should start seeing data in your external database after only a f
9494

9595
- [Exporting reference guide](/exporting/README.md)
9696
- [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)
9898
- [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)
100100

101101
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fexporting%2FREADME.md&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

docs/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Agent can collect thousands of metrics in real-time and use its database for
1515
configuration, but there are some valuable things to know to get the most out of Netdata based on your needs.
1616

1717
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.
1919

2020
> If you haven't installed Netdata yet, visit the [installation instructions](/packaging/installer/README.md) for
2121
> 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
6767
You can tweak this custom _database engine_ to store a much larger dataset than your system's available RAM,
6868
particularly if you allow Netdata to use slightly more RAM and disk space than the default configuration.
6969

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
7171
and use our [database engine calculator](https://learn.netdata.cloud/docs/agent/database/calculator) to figure
7272
out the exact settings you'll need to store historical metrics right in the Agent's database.
7373

docs/tutorials/collect-apache-nginx-web-logs.md renamed to docs/guides/collect-apache-nginx-web-logs.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<!--
2-
---
32
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
64
-->
75

86
# 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
2220
ever. In one test on a system with SSD storage, the collector consistently parsed the logs for 200,000 requests in
2321
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/).
2422

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/).
2725

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
2927
constantly write to into real-time insights into your infrastructure.
3028

3129
## Set up your web servers
@@ -128,7 +126,7 @@ web server's access log and begin showing real-time charts!
128126
### Custom log formats and fields
129127

130128
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.
132130

133131
We do have [extensive
134132
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.
160158
Don't forget to give GitHub user [Wing924](https://github.com/Wing924) a big 👍 for his hard work in starting up the Go
161159
refactoring effort.
162160

163-
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Ftutorials%2Fweb-log-collector&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
161+
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fguides%2Fcollect-apache-nginx-web-logs&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

docs/tutorials/collect-unbound-metrics.md renamed to docs/guides/collect-unbound-metrics.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
<!--
2-
---
32
title: "Monitor Unbound DNS servers with Netdata"
43
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
75
-->
86

97
# Monitor Unbound DNS servers with Netdata
@@ -16,7 +14,7 @@ Unbound runs on FreeBSD, OpenBSD, NetBSD, macOS, Linux, and Windows, and support
1614
queries and answers are all encrypted with TLS. In theory, that should reduce the risk of eavesdropping or
1715
man-in-the-middle attacks when communicating to DNS servers.
1816

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
2018
configuration.
2119

2220
## Set up your Unbound installation
@@ -137,4 +135,4 @@ for improvement or refinement based on real-world use cases. Feel free to [file
137135
issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&template=bug_report.md) with your
138136
thoughts.
139137

140-
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Ftutorials%2Funbound-metrics&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
138+
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fguides%2Funbound-metrics&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

docs/tutorials/longer-metrics-storage.md renamed to docs/guides/longer-metrics-storage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
title: "Change how long Netdata stores metrics"
33
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
55
-->
66

77
# 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
1313
more. With the right settings, Netdata is quite capable of efficiently storing hours or days worth of historical,
1414
per-second metrics without having to rely on an [exporting engine](/exporting/README.md).
1515

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
1717
engine](#using-the-database-engine)**, but you can stick with or switch to the round-robin database if you prefer.
1818

1919
Let's get started.
@@ -155,4 +155,4 @@ charts](/web/README.md#using-charts).
155155
And if you'd now like to reduce Netdata's resource usage, view our [performance guide](/docs/Performance.md) for
156156
our best practices on optimization.
157157

158-
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Ftutorials%2Flonger-metrics-storage&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
158+
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fguides%2Flonger-metrics-storage&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

docs/tutorials/monitor-cockroachdb.md renamed to docs/guides/monitor-cockroachdb.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<!--
2-
---
32
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
64
-->
75

86
# Monitor CockroachDB metrics with Netdata
@@ -134,3 +132,5 @@ Also, be sure to check out these useful resources:
134132
docs](https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint)
135133
- [Monitor CockroachDB with
136134
Prometheus](https://www.cockroachlabs.com/docs/stable/monitor-cockroachdb-with-prometheus.html)
135+
136+
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fguides%2Fmonitor-cockroachdb&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

docs/tutorials/monitor-hadoop-cluster.md renamed to docs/guides/monitor-hadoop-cluster.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<!--
2-
---
32
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
64
-->
75

86
# Monitor a Hadoop cluster with Netdata
@@ -17,16 +15,16 @@ implementations.
1715

1816
Netdata comes with built-in and pre-configured support for monitoring both HDFS and Zookeeper.
1917

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
2119
the [official Hadoop
2220
instructions](http://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/SingleCluster.html) or an
2321
alternative, like the guide available from
2422
[DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-install-hadoop-in-stand-alone-mode-on-ubuntu-18-04).
2523

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:
2725

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)
3028

3129
## Set up your HDFS and Zookeeper installations
3230

@@ -203,4 +201,4 @@ issue](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage&
203201
file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/zookeeper.conf) to understand how to configure
204202
global options or per-job options, timeouts, TLS certificates, and more.
205203

206-
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Ftutorials%2Fmonitor-hadoop-cluster&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
204+
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fguides%2Fmonitor-hadoop-cluster&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

0 commit comments

Comments
 (0)