Fix broken links in our documentation (#14565)
* fix broken link in ml/README.md * fix broken link across all files * fix broken link across all files * fix broken links and remove what's next sections * fix broken links and remove what's next section * Remove related links sections with broken links that link to removed files * fix broken links
Fotis Voutsas committed
Feb 20, 2023 at 16:52 UTC
ff14cf0df6e7d29c6f0a0ee152f20d5ef7608fa5
28 files changed
+46
-135
aclk/README.md
+1
-2
@@ -28,8 +28,7 @@ this is not an option in your case always verify the current domain resolution (
28
29
:::
30
31
-For a guide to connecting a node using the ACLK, plus additional troubleshooting and reference information, read our [get
32
-started with Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.md) guide or the full [connect to Cloud
31
+For a guide to connecting a node using the ACLK, plus additional troubleshooting and reference information, read our [connect to Cloud
32
documentation](https://github.com/netdata/netdata/blob/master/claim/README.md).
33
34
## Data privacy
collectors/COLLECTORS.md
+11
-9
@@ -52,7 +52,10 @@ If you don't see the app/service you'd like to monitor in this list:
52
53
## Available Collectors
54
55
-- [Service and application collectors](#service-and-application-collectors)
55
+- [Supported collectors list](#supported-collectors-list)
56
+ - [Add your application to Netdata](#add-your-application-to-netdata)
57
+ - [Available Collectors](#available-collectors)
58
+ - [Service and application collectors](#service-and-application-collectors)
59
- [Generic](#generic)
60
- [APM (application performance monitoring)](#apm-application-performance-monitoring)
61
- [Containers and VMs](#containers-and-vms)
@@ -68,7 +71,7 @@ If you don't see the app/service you'd like to monitor in this list:
71
- [Search](#search)
72
- [Storage](#storage)
73
- [Web](#web)
71
-- [System collectors](#system-collectors)
74
+ - [System collectors](#system-collectors)
75
- [Applications](#applications)
76
- [Disks and filesystems](#disks-and-filesystems)
77
- [eBPF](#ebpf)
@@ -79,10 +82,10 @@ If you don't see the app/service you'd like to monitor in this list:
82
- [Processes](#processes)
83
- [Resources](#resources)
84
- [Users](#users)
82
-- [Netdata collectors](#netdata-collectors)
83
-- [Orchestrators](#orchestrators)
84
-- [Third-party collectors](#third-party-collectors)
85
-- [Etc](#etc)
85
+ - [Netdata collectors](#netdata-collectors)
86
+ - [Orchestrators](#orchestrators)
87
+ - [Third-party collectors](#third-party-collectors)
88
+ - [Etc](#etc)
89
90
## Service and application collectors
91
@@ -218,8 +221,7 @@ configure any of these collectors according to your setup and infrastructure.
221
server log files and provide summary (client, traffic) metrics.
222
- [Squid web server logs](https://github.com/netdata/go.d.plugin/blob/master/modules/squidlog/README.md): Tail Squid
223
access logs to return the volume of requests, types of requests, bandwidth, and much more.
221
-- [Web server logs (Go version for Apache,
222
- NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md/): Tail access logs and provide
224
+- [Web server logs (Go version for Apache, NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md): Tail access logs and provide
225
very detailed web server performance statistics. This module is able to parse 200k+ rows in less than half a second.
226
- [Web server logs (Apache, NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md): Tail
227
access log
@@ -398,7 +400,7 @@ The Netdata Agent can collect these system- and hardware-level metrics using a v
400
of targets (service-checks) using the XML
401
stats interface.
402
- [WMI (Windows Management Instrumentation)
401
- exporter](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md): Collect CPU, memory,
403
+ exporter](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md): Collect CPU, memory,
404
network, disk, OS, system, and log-in metrics scraping `wmi_exporter`.
405
406
### Disks and filesystems
docs/category-overview-pages/integrations-overview.md
+1
-1
@@ -23,7 +23,7 @@ either centrally, via the
23
24
We designed Netdata with interoperability in mind. The Agent collects thousands of metrics every second, and then what
25
you do with them is up to you. You can
26
-[store metrics in the database engine](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md),
26
+[store metrics in the database engine](https://github.com/netdata/netdata/blob/master/database/README.md),
27
or send them to another time series database for long-term storage or further analysis using
28
Netdata's [exporting engine](https://github.com/netdata/netdata/edit/master/exporting/README.md).
29
docs/cloud/alerts-notifications/notifications.md
+3
-3
@@ -34,7 +34,7 @@ Centralized alert notifications from Netdata Cloud is a independent process from
34
Netdata](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md). You can enable one or the other, or both, based on your needs. However,
35
the alerts you see in Netdata Cloud are based on those streamed from your Netdata-monitoring nodes. If you want to tweak
36
or add new alert that you see in Netdata Cloud, and receive via centralized alert notifications, you must
37
-[configure](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) each node's alert watchdog.
37
+[configure](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) each node's alert watchdog.
38
39
</Callout>
40
@@ -130,8 +130,8 @@ Here's an example email notification for the `ram_available` chart, which is in
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
-quickstart](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
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.
docs/cloud/alerts-notifications/view-active-alerts.md
+1
-1
@@ -19,7 +19,7 @@ infrastructure based on their configuration. Every node comes with hundreds of p
19
tested by Netdata's community of DevOps engineers and SREs, but you may want to customize existing alerts or create new
20
ones entirely.
21
22
-Read our doc on [health alerts](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to
22
+Read our documentation on [health alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to
23
learn how to tweak existing alerts or create new
24
health entities based on the specific needs of your infrastructure. By taking charge of alert configuration, you'll
25
ensure Netdata Cloud always delivers the most relevant alerts about the well-being of your nodes.
docs/cloud/manage/plans.md
+1
-1
@@ -18,7 +18,7 @@ To not disrupt current users space's access rights we will be keeping their curr
18
keep using the legacy **Member** role with the exact same permissions as it has currently.
19
20
If you move from the **Early Bird** plan to a paid plan, you will not be able to return to the **Early Bird** plan again. The **Community** free plan will always be available to you, but it does not allow
21
-you to invite or change users using the Member role. See more details on our [roles and plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md#what-roles-are-available) documentation.
21
+you to invite or change users using the Member role. See more details on our [roles and plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md#what-roles-are-available) documentation.
22
23
:::
24
docs/cloud/manage/role-based-access.md
+1
-1
@@ -1,7 +1,7 @@
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-model.md"
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"
docs/cloud/visualize/nodes.md
+1
-2
@@ -42,8 +42,7 @@ If you want to add more metrics to your War Rooms and they don't show up when yo
42
need to configure those nodes to collect from additional data sources. See our [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md)
43
to learn how to use dozens of pre-installed collectors that can instantly collect from your favorite services and applications.
44
45
-If you want to see up to 30 days of historical metrics in Cloud (and more on individual node dashboards), read our guide
46
-on [long-term storage of historical metrics](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md). Also, see our
45
+If you want to see up to 30 days of historical metrics in Cloud (and more on individual node dashboards), read about [changing how long Netdata stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md). Also, see our
46
[calculator](/docs/store/change-metrics-storage#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
47
for finding the disk and RAM you need to store metrics for a certain period of time.
48
docs/configure/common-changes.md
+2
-2
@@ -93,7 +93,7 @@ sudo ./edit-config health.d/example-alarm.conf
93
94
Or, append your new alarm to an existing file by editing a relevant existing file in the `health.d/` directory.
95
96
-Read more about [configuring alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to
96
+Read more about [configuring alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to
97
get started, and see
98
the [health monitoring reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) for a full listing
99
of options available in health entities.
@@ -229,7 +229,7 @@ You can also take what you've learned about node configuration to tweak the Agen
229
230
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module) or tweak
231
their behavior.
232
-- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
232
+- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) or
233
create new ones.
234
- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive
235
updates about the health of your
docs/configure/nodes.md
+3
-3
@@ -24,7 +24,7 @@ anomaly, or change in infrastructure affects how their Agents should perform.
24
## The Netdata config directory
25
26
On most Linux systems, using our [recommended one-line
27
-installation](https://github.com/netdata/netdata/blob/master/docs/get-started.md#install-on-linux-with-one-line-installer), the **Netdata config
27
+installation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer), the **Netdata config
28
directory** is `/etc/netdata/`. The config directory contains several configuration files with the `.conf` extension, a
29
few directories, and a shell script named `edit-config`.
30
@@ -52,7 +52,7 @@ exist.
52
- `apps_groups.conf` is a configuration file for changing how applications/processes are grouped when viewing the
53
**Application** charts from [`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) or
54
[`ebpf.plugin`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
55
-- `health.d/` is a directory that contains [health configuration files](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
55
+- `health.d/` is a directory that contains [health configuration files](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
56
- `health_alarm_notify.conf` enables and configures [alarm notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
57
- `statsd.d/` is a directory for configuring Netdata's [statsd collector](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md).
58
- `stream.conf` configures [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) between separate nodes running the Agent.
@@ -161,7 +161,7 @@ and `edit-config`. We put together a few security best practices based on how yo
161
You can also take what you've learned about node configuration to enable or enhance features:
162
163
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) or tweak their behavior.
164
-- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or create new ones.
164
+- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) or create new ones.
165
- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive updates about the health of your
166
infrastructure.
167
- Change [the long-term metrics retention period](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) using the database engine.
docs/configure/start-stop-restart.md
-19
@@ -81,22 +81,3 @@ ps aux| grep netdata
81
82
The output of `ps aux` should show no `netdata` or associated processes running. You can now start the Netdata Agent
83
again with `service netdata start`, or the appropriate method for your system.
84
-
85
-## What's next?
86
-
87
-Learn more about [securing the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md).
88
-
89
-You can also use the restart/reload methods described above to enable new features:
90
-
91
-- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) or tweak their behavior.
92
-- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or create new ones.
93
-- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive updates about the health of your
94
- infrastructure.
95
-- Change [the long-term metrics retention period](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) using the database engine.
96
-
97
-### Related reference documentation
98
-
99
-- [Netdata Agent · Daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md)
100
-- [Netdata Agent · Netdata CLI](https://github.com/netdata/netdata/blob/master/cli/README.md)
101
-
102
-[](<>)
docs/dashboard/dimensions-contexts-families.md
+2
-2
@@ -18,7 +18,7 @@ they have a lot of underlying complexity. To meaningfully organize charts out of
18
your nodes, Netdata uses the concepts of **dimensions**, **contexts**, and **families**.
19
20
Understanding how these work will help you more easily navigate the dashboard, [write new
21
-alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or play around with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
21
+alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or play around with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
22
23
For a refresher on the anatomy of a chart, see [dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md).
24
@@ -56,7 +56,7 @@ whereas anything after the `.` is specified either by the chart's developer or b
56
57
By default, a chart's type affects where it fits in the menu, while its family creates submenus.
58
59
-Netdata also relies on contexts for [alarm configuration](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) (the [`on`
59
+Netdata also relies on contexts for [alarm configuration](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) (the [`on`
60
line](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-on)).
61
62
## Family
docs/dashboard/how-dashboard-works.md
+1
-20
@@ -95,24 +95,5 @@ active alarm, and the **Log** tab shows a historical record of exactly when alar
95
log](https://user-images.githubusercontent.com/1153921/80842482-8c289500-8bb6-11ea-9791-600cfdbe82ce.gif)
96
97
Learn more about [viewing active alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md), [configuring
98
-alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or [enabling a new notification
98
+alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or [enabling a new notification
99
method](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
100
-
101
-## What's next?
102
-
103
-Learn more about [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md) to quickly pan through time, zoom, and
104
-show/hide dimensions to best understand the state of your node in any timeframe. A complete understanding of [chart
105
-dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md) will also help with how Netdata
106
-organizes its dashboard and operates [alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
107
-
108
-### Further reading & related information
109
-
110
-- Dashboard
111
- - **[How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md)**
112
- - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
113
- - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md)
114
- - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md)
115
- - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md)
116
- - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md)
117
-- [HTTP API](https://github.com/netdata/netdata/blob/master/web/api/README.md)
118
-- [Custom dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md)
docs/export/external-databases.md
-16
@@ -75,19 +75,3 @@ documentation and the [enabling a connector](https://github.com/netdata/netdata/
75
Can't find your preferred external time-series database? Ask our [community](https://community.netdata.cloud/) for
76
solutions, or file an [issue on
77
GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
78
-
79
-## What's next?
80
-
81
-We recommend you read our document on [enabling a connector](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md) to learn about the
82
-process and discover important configuration options. If you would rather skip ahead, click on any of the above links to
83
-connectors for their reference documentation, which outline any prerequisites to install for that connector, along with
84
-connector-specific configuration options.
85
-
86
-Read about one possible use case for exporting metrics in our guide: [_Export and visualize Netdata metrics in
87
-Graphite_](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md).
88
-
89
-### Related reference documentation
90
-
91
-- [Exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md)
92
-
93
-
docs/guides/configure/performance.md
+1
-17
@@ -107,7 +107,7 @@ update_every: 10
107
## Disable unneeded plugins or collectors
108
109
If you know that you don't need an [entire plugin or a specific
110
-collector](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), you can disable any of them.
110
+collector](https://github.com/netdata/netdata/blob/master/collectors/README.md#collector-architecture-and-terminology), you can disable any of them.
111
Keep in mind that if a plugin/collector has nothing to do, it simply shuts down and does not consume system resources.
112
You will only improve the Agent's performance by disabling plugins/collectors that are actively collecting metrics.
113
@@ -229,19 +229,3 @@ On the child nodes you should add to `netdata.conf` the following:
229
[health]
230
enabled = no
231
```
232
-
233
-## What's next?
234
-
235
-We hope this guide helped you better understand how to optimize the performance of the Netdata Agent.
236
-
237
-Now that your Agent is running smoothly, we recommend you [secure your nodes](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) if you haven't
238
-already.
239
-
240
-Next, dive into some of Netdata's more complex features, such as configuring its health watchdog or exporting metrics to
241
-an external time-series database.
242
-
243
-- [Interact with dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md)
244
-- [Configure health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md)
245
-- [Export metrics to external time-series databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md)
246
-
247
-[](<>)
docs/guides/monitor-cockroachdb.md
+1
-1
@@ -115,4 +115,4 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et
115
./edit-config health.d/cockroachdb.conf # You may need to use `sudo` for write privileges
116
```
117
118
-For more information about editing the defaults or writing new alarm entities, see our documentation on [configuring health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
118
+For more information about editing the defaults or writing new alarm entities, see our documentation on [configuring health alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
docs/guides/monitor/lamp-stack.md
+1
-1
@@ -211,7 +211,7 @@ shows any alarms currently triggered, while the **All** tab displays a list of _
211
213
214
-[Tweak alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) based on your infrastructure monitoring needs, and to see these alarms
214
+[Tweak alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) based on your infrastructure monitoring needs, and to see these alarms
215
in other places, like your inbox or a Slack channel, [enable a notification
216
method](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
217
docs/guides/monitor/pi-hole-raspberry-pi.md
+3
-4
@@ -101,8 +101,7 @@ part of your system might affect another.
101
103
104
-If you're completely new to Netdata, look at our [step-by-step guide](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-00.md) for a
105
-walkthrough of all its features. For a more expedited tour, see the [get started documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
104
+If you're completely new to Netdata, look at the [Introduction](https://github.com/netdata/netdata/blob/master/docs/getting-started/introduction.md) section for a walkthrough of all its features. For a more expedited tour, see the [get started documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
105
106
### Enable temperature sensor monitoring
107
@@ -140,7 +139,7 @@ more than 256.
139
140
Use our [database sizing
141
calculator](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
143
-and [guide on storing historical metrics](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md) to help you determine the right
142
+and the [Database configuration documentation](https://github.com/netdata/netdata/blob/master/database/README.md) to help you determine the right
143
setting for your Raspberry Pi.
144
145
## What's next?
@@ -153,7 +152,7 @@ Most importantly, you can always install additional services and instantly colle
152
153
- [Optimize performance](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md) using tweaks developed for IoT devices.
154
- [Stream Raspberry Pi metrics](https://github.com/netdata/netdata/blob/master/streaming/README.md) to a parent host for easy access or longer-term storage.
156
-- [Tweak alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) for either Pi-hole or the health of your Raspberry Pi.
155
+- [Tweak alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) for either Pi-hole or the health of your Raspberry Pi.
156
- [Export metrics to external databases](https://github.com/netdata/netdata/blob/master/exporting/README.md) with the exporting engine.
157
158
Or, head over to [our guides](https://learn.netdata.cloud/guides/) for even more experiments and insights into
docs/monitor/enable-notifications.md
+1
-2
@@ -12,8 +12,7 @@ learn_rel_path: "Integrations/Notify"
12
Netdata offers two ways to receive alert notifications on external platforms. These methods work independently _or_ in
13
parallel, which means you can enable both at the same time to send alert notifications to any number of endpoints.
14
15
-Both methods use a node's health alerts to generate the content of alert notifications. Read the doc on [configuring
16
-alerts](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to change the preconfigured thresholds or to create tailored alerts for your
15
+Both methods use a node's health alerts to generate the content of alert notifications. Read our documentation on [configuring alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to change the preconfigured thresholds or to create tailored alerts for your
16
infrastructure.
17
18
Netdata Cloud offers [centralized alert notifications](#netdata-cloud) via email, which leverages the health status
docs/monitor/view-active-alarms.md
+2
-3
@@ -65,12 +65,11 @@ With the three icons beneath that and the **role** designation, you can:
65
3. Copy the code to embed the badge onto another web page using an `<embed>` element.
66
67
The table on the right-hand side displays information about the health entity that triggered the alarm, which you can
68
-use as a reference to [configure alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
68
+use as a reference to [configure alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
69
70
## What's next?
71
72
-With the information that appears on Netdata Cloud and the local dashboard about active alarms, you can [configure
73
-alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to match your infrastructure's needs or your team's goals.
72
+With the information that appears on Netdata Cloud and the local dashboard about active alarms, you can [configure alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to match your infrastructure's needs or your team's goals.
73
74
If you're happy with the pre-configured alarms, skip ahead to [enable
75
notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to use Netdata Cloud's centralized alarm notifications and/or
docs/visualize/create-dashboards.md
+1
-1
@@ -66,7 +66,7 @@ faster.
66
67
While it's useful to see real-time metrics on flexible dashboards, you need ways to know precisely when an anomaly
68
strikes. Every Netdata Agent comes with a health watchdog that
69
-uses [alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) and
69
+uses [alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) and
70
[notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to notify you of
71
issues seconds after they strike.
72
docs/visualize/interact-dashboards-charts.md
+1
-2
@@ -120,8 +120,7 @@ Netdata Cloud users can [build new dashboards](https://github.com/netdata/netdat
120
aggregating relevant metrics from any number of nodes onto a single interface, you can respond faster to anomalies,
121
perform more targeted troubleshooting, or keep tabs on a bird's eye view of your infrastructure.
122
123
-If you're finished with dashboards for now, skip to Netdata's health watchdog for information on [creating or
124
-configuring](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) alarms, and [send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md)
123
+If you're finished with dashboards for now, skip to Netdata's health watchdog for information on [creating or configuring](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) alarms, and [send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md)
124
to get informed when something goes wrong in your infrastructure.
125
126
### Related reference documentation
exporting/README.md
+1
-1
@@ -44,7 +44,7 @@ connector to enable and configure for your database of choice.
44
- [**Graphite**](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md): A plaintext interface. Metrics are sent to the database server as
45
`prefix.hostname.chart.dimension`. `prefix` is configured below, `hostname` is the hostname of the machine (can
46
also be configured). Learn more in our guide to [export and visualize Netdata metrics in
47
- Graphite](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md).
47
+ Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md).
48
- [**JSON** document databases](https://github.com/netdata/netdata/blob/master/exporting/json/README.md)
49
- [**OpenTSDB**](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md): Use a plaintext or HTTP interfaces. Metrics are sent to
50
OpenTSDB as `prefix.chart.dimension` with tag `host=hostname`.
health/README.md
-17
@@ -21,20 +21,3 @@ your metrics.
21
Ready to take the next steps with health monitoring?
22
23
[Configuration reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md)
24
-
25
-## Guides
26
-
27
-Every infrastructure is different, so we're not interested in mandating how you should configure Netdata's health
28
-monitoring features. Instead, these guides should give you the details you need to tweak alarms to your heart's
29
-content.
30
-
31
-[Stopping notifications for individual alarms](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/stop-notifications-alarms.md)
32
-
33
-[Use dimension templates to create dynamic alarms](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/dimension-templates.md)
34
-
35
-## Related features
36
-
37
-**[Notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md)**: Get notified about ongoing alarms from your Agents via your
38
-favorite platform(s), such as Slack, Discord, PagerDuty, email, and much more.
39
-
40
-
health/notifications/pagerduty/README.md
+1
-1
@@ -63,5 +63,5 @@ sudo su -s /bin/bash netdata
63
Aside from the three values set in `health_alarm_notify.conf`, there is no further configuration required to send alert
64
notifications to PagerDuty.
65
66
-To configure individual alarms, read our [alert configuration](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) doc or
66
+To configure individual alarms, read our [alert configuration](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) doc or
67
the [health entity reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) doc.
ml/README.md
+3
-1
@@ -114,7 +114,9 @@ To enable or disable anomaly detection:
114
2. In the `[ml]` section, set `enabled = yes` to enable or `enabled = no` to disable.
115
3. Restart netdata (typically `sudo systemctl restart netdata`).
116
117
-**Note**: If you would like to learn more about configuring Netdata please see [the configuration guide](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-04.md).
117
+> 📑 Note
118
+>
119
+> If you would like to learn more about configuring Netdata please see the [Configuration section](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) of our documentation.
120
121
Below is a list of all the available configuration params and their default values.
122
packaging/installer/README.md
+1
-1
@@ -63,7 +63,7 @@ or read about its requirements to configure your endpoint to publish metrics in
63
#### Alarms & notifications
64
65
Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source
66
-community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
66
+community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) or
67
[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.
68
69
#### Make your deployment production ready
packaging/installer/methods/cloud-providers.md
+1
-1
@@ -19,7 +19,7 @@ aims to document some of those steps for popular cloud providers.
19
20
> This document is a work-in-progress! If you find new issues specific to a cloud provider, or would like to help
21
> clarify the correct workaround, please [create an
22
-> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request.md)
22
+> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request)
23
> with your process and instructions on using the provider's interface to complete the workaround.
24
25
- [Install Netdata on cloud providers](#install-netdata-on-cloud-providers)