fix(docs): unresolved file references (#11903)
Ilya Mashchenko committed
Dec 20, 2021 at 16:21 UTC
78c2af15478ea47e436ed58f0db827e5f37ba26d
35 files changed
+69
-69
backends/WALKTHROUGH.md
+2
-2
@@ -62,7 +62,7 @@ command to run (/bin/bash) and then chooses the base container images (centos:la
62
sitting inside the shell of the container.
63
64
After we have entered the shell we can install Netdata. This process could not be easier. If you take a look at [this
65
-link](../packaging/installer/README.md), the Netdata devs give us several one-liners to install Netdata. I have not had
65
+link](/packaging/installer/README.md), the Netdata devs give us several one-liners to install Netdata. I have not had
66
any issues with these one liners and their bootstrapping scripts so far (If you guys run into anything do share). Run
67
the following command in your container.
68
@@ -214,7 +214,7 @@ the `chart` dimension. If you’d like you can combine the ‘chart’ and ‘in
214
Let’s give this a try: `netdata_system_cpu_percentage_average{chart="system.cpu", instance="netdata:19999"}`
215
216
This is the basics of using Prometheus to query Netdata. I’d advise everyone at this point to read [this
217
-page](../backends/prometheus/#using-netdata-with-prometheus). The key point here is that Netdata can export metrics from
217
+page](/backends/prometheus/README.md#using-netdata-with-prometheus). The key point here is that Netdata can export metrics from
218
its internal DB or can send metrics “as-collected” by specifying the ‘source=as-collected’ url parameter like so.
219
<http://localhost:19999/api/v1/allmetrics?format=prometheus&help=yes&types=yes&source=as-collected> If you choose to use
220
this method you will need to use Prometheus's set of functions here: <https://prometheus.io/docs/querying/functions/> to
claim/README.md
+7
-7
@@ -70,7 +70,7 @@ When coming from [Nodes view page](https://learn.netdata.cloud/docs/cloud/visua
70
71
### Connect an agent running in Linux
72
73
-If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
73
+If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
74
75
```
76
bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
@@ -80,7 +80,7 @@ the node in your Space after 60 seconds, see the [troubleshooting information](#
80
81
Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](#connect-an-agent-without-root-privileges) section.
82
83
-For more details on what are the extra parameters `claim-token`, `claim-rooms` and `claim-url` please refer to [Connect node to Netdata Cloud during installation](/packaging/installer/methods/kickstart#connect-node-to-netdata-cloud-during-installation).
83
+For more details on what are the extra parameters `claim-token`, `claim-rooms` and `claim-url` please refer to [Connect node to Netdata Cloud during installation](/packaging/installer/methods/kickstart.md#connect-node-to-netdata-cloud-during-installation).
84
85
### Connect an agent without root privileges
86
@@ -224,7 +224,7 @@ you don't see the node in your Space after 60 seconds, see the [troubleshooting
224
225
### Connect an agent running in macOS
226
227
-To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/methods/macos#install-netdata-with-kickstart) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
227
+To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/methods/macos.md#install-netdata-with-our-automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
228
229
```bash
230
bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
@@ -234,7 +234,7 @@ the node in your Space after 60 seconds, see the [troubleshooting information](#
234
235
### Connect a Kubernetes cluster's parent Netdata pod
236
237
-Read our [Kubernetes installation](/packaging/installer/methods/kubernetes.md#connect-a-kubernetes-clusters-parent-pod)
237
+Read our [Kubernetes installation](/packaging/installer/methods/kubernetes.md#connect-your-kubernetes-cluster-to-netdata-cloud)
238
for details on connecting a parent Netdata pod.
239
240
### Connect through a proxy
@@ -263,7 +263,7 @@ For example, a HTTP proxy setting may look like the following:
263
proxy = http://proxy.example.com:1080 # With a URL
264
```
265
266
-You can now move on to connecting. When you connect with the [kickstart](/packaging/installer/#automatic-one-line-installation-script) script, add the `--claim-proxy=` parameter and
266
+You can now move on to connecting. When you connect with the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) script, add the `--claim-proxy=` parameter and
267
append the same proxy setting you added to `netdata.conf`.
268
269
```bash
@@ -458,7 +458,7 @@ using the [ACLK](/aclk/README.md).
458
459
### kickstart script
460
461
-The best way to install Netdata and connect your nodes to Netdata Cloud is with our automatic one-line installation script, [kickstart](/packaging/installer/#automatic-one-line-installation-script). This script will install the Netdata Agent, in case it isn't already installed, and connect your node to Netdata Cloud.
461
+The best way to install Netdata and connect your nodes to Netdata Cloud is with our automatic one-line installation script, [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script). This script will install the Netdata Agent, in case it isn't already installed, and connect your node to Netdata Cloud.
462
463
This works with:
464
* all Linux distributions, see [Netdata distribution support matrix](https://learn.netdata.cloud/docs/agent/packaging/distributions)
@@ -516,7 +516,7 @@ netdatacli reload-claiming-state
516
517
This reloads the Agent connection state from disk.
518
519
-Our recommendation is to trigger the connection process using the [kickstart](/packaging/installer/#automatic-one-line-installation-script) whenever possible.
519
+Our recommendation is to trigger the connection process using the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) whenever possible.
520
521
### Netdata Agent command line
522
collectors/COLLECTORS.md
+5
-5
@@ -129,7 +129,7 @@ configure any of these collectors according to your setup and infrastructure.
129
metrics.
130
- [Redis (Go)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/redis/): Monitor status from any
131
number of database instances by reading the server's response to the `INFO ALL` command.
132
-- [Redis (Python)](/collectors/python.d.plugin/redis/): Monitor database status by reading the server's response to
132
+- [Redis (Python)](/collectors/python.d.plugin/redis/README.md): Monitor database status by reading the server's response to
133
the `INFO` command.
134
- [RethinkDB](/collectors/python.d.plugin/rethinkdbs/README.md): Collect database server and cluster statistics.
135
- [Riak KV](/collectors/python.d.plugin/riakkv/README.md): Collect database stats from the `/stats` endpoint.
@@ -169,14 +169,14 @@ configure any of these collectors according to your setup and infrastructure.
169
plugins metrics from an endpoint provided by `in_monitor plugin`.
170
- [Logstash](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/logstash/): Monitor JVM threads,
171
memory usage, garbage collection statistics, and more.
172
-- [OpenVPN status logs](/collectors/python.d.plugin/ovpn_status_log/): Parse server log files and provide summary
172
+- [OpenVPN status logs](/collectors/python.d.plugin/ovpn_status_log/README.md): Parse server log files and provide summary
173
(client, traffic) metrics.
174
- [Squid web server logs](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/squidlog/): Tail Squid
175
access logs to return the volume of requests, types of requests, bandwidth, and much more.
176
- [Web server logs (Go version for Apache,
177
NGINX)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/): Tail access logs and provide
178
very detailed web server performance statistics. This module is able to parse 200k+ rows in less than half a second.
179
-- [Web server logs (Python version for Apache, NGINX, Squid)](/collectors/python.d.plugin/web_log/): Tail access log
179
+- [Web server logs (Python version for Apache, NGINX, Squid)](/collectors/python.d.plugin/web_log/README.md): Tail access log
180
file and collect web server/caching proxy metrics.
181
182
### Messaging
@@ -217,7 +217,7 @@ configure any of these collectors according to your setup and infrastructure.
217
server authentication and accounting statistics from the `status server`.
218
- [Freeradius (Python)](/collectors/python.d.plugin/freeradius/README.md): Collect server authentication and
219
accounting statistics from the `status server` using the `radclient` tool.
220
-- [Libreswan](/collectors/charts.d.plugin/libreswan/): Collect bytes-in, bytes-out, and uptime metrics.
220
+- [Libreswan](/collectors/charts.d.plugin/libreswan/README.md): Collect bytes-in, bytes-out, and uptime metrics.
221
- [Icecast](/collectors/python.d.plugin/icecast/README.md): Monitor the number of listeners for active sources.
222
- [ISC BIND](/collectors/node.d.plugin/named/README.md): Collect nameserver summary performance statistics via a web
223
interface (`statistics-channels` feature).
@@ -267,7 +267,7 @@ configure any of these collectors according to your setup and infrastructure.
267
blockchain indexes, memory usage, network usage, and transactions of wallet instances.
268
- [Energi Core (Python)](/collectors/python.d.plugin/energid/README.md): Monitor blockchain, memory, network, and
269
unspent transactions statistics.
270
-- [Fronius Symo](/collectors/node.d.plugin/fronius/): Collect power, consumption, autonomy, energy, and inverter
270
+- [Fronius Symo](/collectors/node.d.plugin/fronius/README.md): Collect power, consumption, autonomy, energy, and inverter
271
statistics.
272
- [UPS/PDU](/collectors/charts.d.plugin/nut/README.md): Read the status of UPS/PDU devices using the `upsc` tool.
273
- [SMA Sunny WebBox](/collectors/node.d.plugin/sma_webbox/README.md): Collect power statistics.
collectors/QUICKSTART.md
+1
-1
@@ -23,7 +23,7 @@ Netdata has _pre-installed_ collectors for hundreds of popular applications and
23
anything to collect metrics from many popular services, like Nginx web servers, MySQL/MariaDB databases, and much more.
24
25
To find whether Netdata has a pre-installed collector for your favorite app/service, check out our [collector support
26
-list](COLLECTORS.md). The only exception is the [third-party collectors](COLLECTORS.md#third-party-plugins), which
26
+list](COLLECTORS.md). The only exception is the [third-party collectors](COLLECTORS.md#third-party-collectors), which
27
you do need to install yourself. However, this quickstart guide will focus on pre-installed collectors.
28
29
When you find a collector you're interested in, take note of its orchestrator. These are in the headings above each
collectors/REFERENCE.md
+3
-3
@@ -116,7 +116,7 @@ This section features a list of Netdata's plugins, with a boolean setting to ena
116
By default, most plugins are enabled, so you don't need to enable them explicitly to use their collectors. To enable or
117
disable any specific plugin, remove the comment (`#`) and change the boolean setting to `yes` or `no`.
118
119
-All **external plugins** are managed by [plugins.d](plugins.d/), which provides additional management options.
119
+All **external plugins** are managed by [plugins.d](plugins.d/README.md), which provides additional management options.
120
121
## Internal plugins
122
@@ -178,10 +178,10 @@ through this, is to examine what other similar plugins do.
178
179
## External Plugins
180
181
-**External plugins** use the API and are managed by [plugins.d](plugins.d/).
181
+**External plugins** use the API and are managed by [plugins.d](plugins.d/README.md).
182
183
## Write a custom collector
184
185
-You can add custom collectors by following the [external plugins documentation](../collectors/plugins.d/).
185
+You can add custom collectors by following the [external plugins documentation](/collectors/plugins.d/README.md).
186
187
[]()
collectors/python.d.plugin/example/README.md
+1
-1
@@ -6,6 +6,6 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/pytho
6
# Example
7
8
An example python data collection module.
9
-You can use this example to help you [write a new Python module](../#how-to-write-a-new-module).
9
+You can use this example to help you [write a new Python module](/collectors/python.d.plugin/README.md#how-to-write-a-new-module).
10
11
[](<>)
collectors/python.d.plugin/web_log/README.md
+1
-1
@@ -31,7 +31,7 @@ If Netdata is installed on a system running a web server, it will detect it and
31
32
*[**netdata**](https://my-netdata.io/) charts based on metrics collected by querying the `nginx` API (i.e. `/stub_status`).*
33
34
-> [**netdata**](https://my-netdata.io/) supports `apache`, `nginx`, `lighttpd` and `tomcat`. To obtain real-time information from a web server API, the web server needs to expose it. For directions on configuring your web server, check the config files for each web server. There is a directory with a config file for each web server under [`/etc/netdata/python.d/`](../).
34
+> [**netdata**](https://my-netdata.io/) supports `apache`, `nginx`, `lighttpd` and `tomcat`. To obtain real-time information from a web server API, the web server needs to expose it. For directions on configuring your web server, check the config files for each web server. There is a directory with a config file for each web server under `/etc/netdata/python.d/`.
35
36
## Configuration
37
database/engine/README.md
+3
-3
@@ -44,7 +44,7 @@ section for details.
44
45
The `dbengine multihost disk space` option determines the amount of disk space in **MiB** that is dedicated to storing
46
Netdata metric values and all related metadata describing them. You can use the [**database engine
47
-calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
47
+calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
48
to correctly set `dbengine multihost disk space` based on your metrics retention policy. The calculator gives an
49
accurate estimate based on how many child nodes you have, how many metrics your Agent collects, and more.
50
@@ -62,7 +62,7 @@ Netdata metric values per legacy database engine instance (see [details on the l
62
63
When using the multihost database engine, all parent and child nodes share the same `page cache size` and `dbengine
64
multihost disk space` in a single dbengine instance. The [**database engine
65
-calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
65
+calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
66
helps you properly set `page cache size` and `dbengine multihost disk space` on your parent node to allocate enough
67
resources based on your metrics retention policy and how many child nodes you have.
68
@@ -112,7 +112,7 @@ An important observation is that RAM usage depends on both the `page cache size`
112
options.
113
114
You can use our [database engine
115
-calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
115
+calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
116
to validate the memory requirements for your particular system(s) and configuration (**out-of-date**).
117
118
### Disk space requirements
docs/anonymous-statistics.md
+1
-1
@@ -91,7 +91,7 @@ update. You can also export the environment variable `DO_NOT_TRACK` with a non-z
91
92
When using Docker, **set your `DO_NOT_TRACK` environment variable to `1`.** You can set this variable with the following
93
command: `export DO_NOT_TRACK=1`. When creating a container using Netdata's [Docker
94
-image](/packaging/docker/README.md#run-the-agent-with-the-docker-command) for the first time, this variable will disable
94
+image](/packaging/docker/README.md#create-a-new-netdata-agent-container) for the first time, this variable will disable
95
the anonymous statistics script inside of the container.
96
97
Each of these opt-out processes does the following:
docs/collect/application-metrics.md
+1
-1
@@ -29,7 +29,7 @@ Our most popular application collectors:
29
rows in less than half a second.
30
- [MySQL](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql/): Collect database global,
31
replication, and per-user statistics.
32
-- [Redis](/collectors/python.d.plugin/redis/): Monitor database status by reading the server's response to the `INFO`
32
+- [Redis](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/redis): Monitor database status by reading the server's response to the `INFO`
33
command.
34
- [Apache](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/apache/): Collect Apache web
35
server performance metrics via the `server-status?auto` endpoint.
docs/collect/system-metrics.md
+1
-1
@@ -30,7 +30,7 @@ eBPF collector to analyze how and when a process accesses files, when it makes s
30
creating zombie processes, and more.
31
32
While the above plugins and associated collectors are the most important for system metrics, there are many others. You
33
-can find all system collectors in our [supported collectors list](/collectors/COLLECTORS.md#system-metrics).
33
+can find all system collectors in our [supported collectors list](/collectors/COLLECTORS.md#system-collectors).
34
35
## Collect Windows system metrics
36
docs/configure/common-changes.md
+1
-1
@@ -31,7 +31,7 @@ section](/daemon/config/README.md#global-section-options) of `netdata.conf`.
31
```
32
33
Read our doc on [increasing long-term metrics storage](/docs/store/change-metrics-storage.md) for details, including a
34
-[calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
34
+[calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
35
to help you determine the exact settings for your desired retention period.
36
37
### Reduce the data collection frequency
docs/configure/secure-nodes.md
+1
-1
@@ -11,7 +11,7 @@ internet at large, anyone can access the dashboard and your node's metrics at `h
11
so that the local dashboard was immediately accessible to users, and so that we don't dictate how professionals set up
12
and secure their infrastructures.
13
14
-Despite this design decision, your [data](/docs/netdata-security.md#your-data-are-safe-with-netdata) and your
14
+Despite this design decision, your [data](/docs/netdata-security.md#your-data-is-safe-with-netdata) and your
15
[systems](/docs/netdata-security.md#your-systems-are-safe-with-netdata) are safe with Netdata. Netdata is read-only,
16
cannot do anything other than present metrics, and runs without special/`sudo` privileges. Also, the local dashboard
17
only exposes chart metadata and metric values, not raw data.
docs/contributing/contributing-documentation.md
+2
-2
@@ -18,7 +18,7 @@ The Netdata team aggregates and publishes all documentation at [learn.netdata.cl
18
## Before you get started
19
20
Anyone interested in contributing to documentation should first read the [Netdata style
21
-guide](/docs/contributing/style-guide.md) and the [Netdata Community Code of Conduct](/CODE_OF_CONDUCT.md).
21
+guide](/docs/contributing/style-guide.md) and the [Netdata Community Code of Conduct](https://learn.netdata.cloud/contribute/code-of-conduct).
22
23
Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read the [Mastering
24
Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on creating
@@ -92,7 +92,7 @@ request based on the changes you made in the new branch of your fork.
92
93
## Making a pull request
94
95
-Pull requests (PRs) should be concise and informative. See our [PR guidelines](/CONTRIBUTING.md#pr-guidelines) for
95
+Pull requests (PRs) should be concise and informative. See our [PR guidelines](https://learn.netdata.cloud/contribute/handbook#pr-guidelines) for
96
specifics.
97
98
- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50
docs/contributing/style-guide.md
+1
-1
@@ -421,7 +421,7 @@ In Markdown, use the standard image syntax, `![]()`, and place the alt text betw
421
using our logo:
422
423
```markdown
424
-
424
+
425
```
426
427
Reference in-product text, code samples, and terminal output with actual text content, not screen captures or other
docs/dashboard/customize.mdx
+1
-1
@@ -25,7 +25,7 @@ Here are a few popular settings:
25
### Change chart legend position
26
27
Find this setting under the **Visual** tab. By default, Netdata places the [legend of
28
-dimensions](/docs/dashboard/dimensions-contexts-families.mdx#dimensions) _below_ charts. Click this toggle to
28
+dimensions](/docs/dashboard/dimensions-contexts-families.mdx#dimension) _below_ charts. Click this toggle to
29
move the legend to the _right_ of charts.
30
31
### Change theme
docs/dashboard/dimensions-contexts-families.mdx
+1
-1
@@ -26,7 +26,7 @@ utilization is represented as a percentage, disk I/O as `MiB/s`, and available R
26
Beneath every chart (or on the right-side if you configure the dashboard) is a legend of dimensions. When there are
27
multiple dimensions, you'll see a different entry in the legend for each dimension.
28
29
-The **Apps CPU Time** chart (with the [context](#contexts) `apps.cpu`), which visualizes CPU utilization of
29
+The **Apps CPU Time** chart (with the [context](#context) `apps.cpu`), which visualizes CPU utilization of
30
different types of processes/services/applications on your node, always provides a vibrant example of a chart with
31
multiple dimensions.
32
docs/export/external-databases.md
+1
-1
@@ -51,7 +51,7 @@ documentation and the [enabling a connector](/docs/export/enable-connector.md) d
51
- **KairosDB**: [Graphite](/exporting/graphite/README.md), [OpenTSDB](/exporting/opentsdb/README.md)
52
- **M3DB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
53
- **MetricFire**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
54
-- **MongoDB**: [MongoDB](/exporting/mongodb/)
54
+- **MongoDB**: [MongoDB](/exporting/mongodb/README.md)
55
- **New Relic**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
56
- **OpenTSDB**: [OpenTSDB](/exporting/opentsdb/README.md), [Prometheus remote
57
write](/exporting/prometheus/remote_write/README.md)
docs/getting-started.md
+6
-6
@@ -28,7 +28,7 @@ dashboard](https://user-images.githubusercontent.com/1153921/80825153-abaec600-8
28
29
**What's next?**:
30
31
-- Read more about the [standard Netdata dashboard](/web/gui/).
31
+- Read more about the [standard Netdata dashboard](/web/gui/README.md).
32
- Learn all the specifics of [using charts](/web/README.md#using-charts) or the differences between [charts,
33
context, and families](/web/README.md#charts-contexts-families).
34
@@ -51,9 +51,9 @@ Once you save your changes, [restart Netdata](#start-stop-and-restart-netdata) t
51
52
- [Change how long Netdata stores metrics](#change-how-long-netdata-stores-metrics) by changing the `page cache size`
53
and `dbengine disk space` settings in `netdata.conf`.
54
-- Move Netdata's dashboard to a [different port](/web/server/) or enable TLS/HTTPS
54
+- Move Netdata's dashboard to a [different port](/web/server/README.md) or enable TLS/HTTPS
55
encryption.
56
-- See all the `netdata.conf` options in our [daemon configuration documentation](/daemon/config/).
56
+- See all the `netdata.conf` options in our [daemon configuration documentation](/daemon/config/README.md).
57
- Run your own [registry](/registry/README.md#run-your-own-registry).
58
59
## Change how long Netdata stores metrics
@@ -86,7 +86,7 @@ Netdata](#start-stop-and-restart-netdata).
86
87
However, auto-detection only works if you installed the source using its standard installation procedure. If Netdata
88
isn't collecting metrics after a restart, your source probably isn't configured correctly. Look at the [external plugin
89
-documentation](/collectors/plugins.d/) to find the appropriate module for your source. Those pages will contain
89
+documentation](/collectors/plugins.d/README.md) to find the appropriate module for your source. Those pages will contain
90
more information about how to configure your source for auto-detection.
91
92
Some modules, like `chrony`, are disabled by default and must be enabled manually for auto-detection to work.
@@ -186,7 +186,7 @@ Find the `SEND_EMAIL="YES"` line and change it to `SEND_EMAIL="NO"`.
186
- Follow the [health quickstart](/health/QUICKSTART.md) to locate and edit existing health entities, and then
187
create your own.
188
- See all the alarm options via the [health configuration reference](/health/REFERENCE.md).
189
-- Add a new notification method, like [Slack](/health/notifications/slack/).
189
+- Add a new notification method, like [Slack](/health/notifications/slack/README.md).
190
191
## Monitor multiple systems with Netdata Cloud
192
@@ -230,7 +230,7 @@ Take a look at some more advanced features and configurations:
230
- Enable long-term archiving of Netdata metrics via [exporting engine](/exporting/README.md) to time-series databases.
231
- Improve security by putting Netdata behind an [Nginx proxy with SSL](/docs/Running-behind-nginx.md).
232
233
-Or, learn more about how you can contribute to [Netdata core](/CONTRIBUTING.md) or our
233
+Or, learn more about how you can contribute to [Netdata core](/README.md#contribute) or our
234
[documentation](/docs/contributing/contributing-documentation.md)!
235
236
[](<>)
docs/guides/longer-metrics-storage.md
+1
-1
@@ -57,7 +57,7 @@ compressed metrics. The default settings retain about two day's worth of metrics
57
every second.
58
59
[**See our database engine
60
-calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
60
+calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
61
to help you correctly set `dbengine multihost disk space` based on your needs. The calculator gives an accurate estimate
62
based on how many child nodes you have, how many metrics your Agent collects, and more.
63
docs/guides/monitor/pi-hole-raspberry-pi.md
+1
-1
@@ -137,7 +137,7 @@ more than 256.
137
```
138
139
Use our [database sizing
140
-calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
140
+calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
141
and [guide on storing historical metrics](/docs/guides/longer-metrics-storage.md) to help you determine the right
142
setting for your Raspberry Pi.
143
docs/guides/monitor/stop-notifications-alarms.md
+1
-1
@@ -80,7 +80,7 @@ You can add `to: silent` to any alarm you'd rather not bother you with notificat
80
You should now know the fundamentals behind silencing any individual alarm in Netdata.
81
82
To learn about _all_ of Netdata's health configuration possibilities, visit the [health reference
83
-guide](/health/REFERENCE.md), or check out other [tutorials on health monitoring](/health/README.md#tutorials).
83
+guide](/health/REFERENCE.md), or check out other [tutorials on health monitoring](/health/README.md#guides).
84
85
Or, take better control over how you get notified about alarms via the [notification
86
system](/health/notifications/README.md).
docs/guides/step-by-step/step-05.md
+1
-1
@@ -224,7 +224,7 @@ Health alarms, while great on their own, are pretty useless without some way of
224
That's why Netdata comes with a notification system that supports more than a dozen services, such as email, Slack,
225
Discord, PagerDuty, Twilio, Amazon SNS, and much more.
226
227
-To see all the supported systems, visit our [notifications documentation](/health/notifications/).
227
+To see all the supported systems, visit our [notifications documentation](/health/notifications/README.md).
228
229
We'll cover email and Slack notifications here, but with this knowledge you should be able to enable any other type of
230
notifications instead of or in addition to these.
docs/guides/step-by-step/step-99.md
+1
-1
@@ -44,7 +44,7 @@ If that feels like too much possibility to you, why not one of these options:
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.
47
+ [contributions doc](/README.md#contribute) for ideas of how you can pitch in.
48
49
We can't wait to see what you monitor next! Bon voyage! ⛵
50
docs/metrics-storage-management/enable-streaming.mdx
+2
-2
@@ -76,7 +76,7 @@ method](/docs/configure/start-stop-restart.md) for your system.
76
77
While encrypting the connection between your parent and child nodes is recommended for security, it's not required to
78
get started. If you're not interested in encryption, skip ahead to [view streamed
79
-metrics](#view-streamed-metrics-in-netdata-s-dashboard).
79
+metrics](#view-streamed-metrics-in-netdatas-dashboard).
80
81
In this example, we'll use self-signed certificates.
82
@@ -135,7 +135,7 @@ Now that you have a basic streaming setup with replication, you may want to twea
135
child database, disable the child dashboard, or enable SSL on the streaming connection between the parent and child.
136
137
See the [streaming reference
138
-doc](/docs/metrics-storage-management/reference-streaming.mdx#supported-streaming-configurations) for details about
138
+doc](/docs/metrics-storage-management/reference-streaming.mdx#examples) for details about
139
other possible configurations.
140
141
When using Netdata's default TSDB (`dbengine`), the parent node maintains separate, parallel databases for itself and
docs/monitor/configure-alarms.md
+1
-1
@@ -117,7 +117,7 @@ Let's look into each of the lines to see how they create a working health entity
117
- `every`: How often to perform the `lookup` calculation to decide whether or not to trigger this alarm.
118
- `warn`/`crit`: The value at which Netdata should trigger a warning or critical alarm. This example uses simple
119
syntax, but most pre-configured health entities use
120
- [hysteresis](/health/REFERENCE.md#special-usage-of-the-conditional-operator) to avoid superfluous notifications.
120
+ [hysteresis](/health/REFERENCE.md#special-use-of-the-conditional-operator) to avoid superfluous notifications.
121
- `info`: A description of the alarm, which will appear in the dashboard and notifications.
122
123
In human-readable format:
docs/monitor/enable-notifications.md
+1
-1
@@ -94,7 +94,7 @@ want to see alarm notifications from Netdata. Click the green **Add to Slack** b
94
95
On the following page, you'll receive a **Webhook URL**. That's what you'll need to configure Netdata, so keep it handy.
96
97
-Navigate to your [Netdata config directory](/docs/configure/nodes.md#netdata-config-directory) and use `edit-config` to
97
+Navigate to your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) and use `edit-config` to
98
open the `health_alarm_notify.conf` file:
99
100
```bash
docs/quickstart/infrastructure.md
+1
-1
@@ -91,7 +91,7 @@ single-node dashboards in Netdata Cloud to drill down on specific issues, scrub
91
historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
92
93
Read about the process in the [infrastructure
94
-overview](/docs/visualize/overview-infrastructure.md#single-node-dashboards) doc, then learn about [interacting with
94
+overview](/docs/visualize/overview-infrastructure.md#drill-down-with-single-node-dashboards) doc, then learn about [interacting with
95
dashboards and charts](/docs/visualize/interact-dashboards-charts.md) to get the most from all of Netdata's real-time
96
metrics.
97
exporting/WALKTHROUGH.md
+1
-1
@@ -216,7 +216,7 @@ the `chart` dimension. If you'd like you can combine the `chart` and `instance`
216
Let's give this a try: `netdata_system_cpu_percentage_average{chart="system.cpu", instance="netdata:19999"}`
217
218
This is the basics of using Prometheus to query Netdata. I'd advise everyone at this point to read [this
219
-page](/exporting/prometheus/#using-netdata-with-prometheus). The key point here is that Netdata can export metrics from
219
+page](/exporting/prometheus/README.md#using-netdata-with-prometheus). The key point here is that Netdata can export metrics from
220
its internal DB or can send metrics _as-collected_ by specifying the `source=as-collected` URL parameter like so.
221
<http://localhost:19999/api/v1/allmetrics?format=prometheus&help=yes&types=yes&source=as-collected> If you choose to use
222
this method you will need to use Prometheus's set of functions here: <https://prometheus.io/docs/querying/functions/> to
health/REFERENCE.md
+8
-8
@@ -52,7 +52,7 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation
52
- The `every` line is **required** if not using `lookup`.
53
- Each entity **must** have at least one of the following lines: `lookup`, `calc`, `warn`, or `crit`.
54
- A few lines use space-separated lists to define how the entity behaves. You can use `*` as a wildcard or prefix with
55
- `!` for a negative match. Order is important, too! See our [simple patterns docs](../libnetdata/simple_pattern/) for
55
+ `!` for a negative match. Order is important, too! See our [simple patterns docs](/libnetdata/simple_pattern/README.md) for
56
more examples.
57
- Lines terminated by a `\` are spliced together with the next line. The backslash is removed and the following line is
58
joined with the current one. No space is inserted, so you may split a line anywhere, even in the middle of a word.
@@ -275,7 +275,7 @@ template: disk_svctm_alarm
275
The `families` line, used only alongside templates, filters which families within the context this alarm should apply
276
to. The value is a space-separated list.
277
278
-The value is a space-separate list of simple patterns. See our [simple patterns docs](../libnetdata/simple_pattern/) for
278
+The value is a space-separate list of simple patterns. See our [simple patterns docs](/libnetdata/simple_pattern/README.md) for
279
some examples.
280
281
For example, you can create a template on the `disk.io` context, but filter it to only the `sda` and `sdb` families:
@@ -294,7 +294,7 @@ The format is:
294
lookup: METHOD AFTER [at BEFORE] [every DURATION] [OPTIONS] [of DIMENSIONS] [foreach DIMENSIONS]
295
```
296
297
-Everything is the same with [badges](../web/api/badges/). In short:
297
+Everything is the same with [badges](/web/api/badges/README.md). In short:
298
299
- `METHOD` is one of `average`, `min`, `max`, `sum`, `incremental-sum`.
300
This is required.
@@ -531,11 +531,11 @@ that will be applied to all hosts installed in the last decade with the followin
531
host labels: installed = 201*
532
```
533
534
-See our [simple patterns docs](../libnetdata/simple_pattern/) for more examples.
534
+See our [simple patterns docs](/libnetdata/simple_pattern/README.md) for more examples.
535
536
## Expressions
537
538
-Netdata has an internal [infix expression parser](../libnetdata/eval). This parses expressions and creates an internal
538
+Netdata has an internal [infix expression parser](/libnetdata/eval). This parses expressions and creates an internal
539
structure that allows fast execution of them.
540
541
These operators are supported `+`, `-`, `*`, `/`, `<`, `<=`, `<>`, `!=`, `>`, `>=`, `&&`, `||`, `!`, `AND`, `OR`, `NOT`.
@@ -602,15 +602,15 @@ You can find all the variables that can be used for a given chart, using
602
Agent dashboard. For example, [variables for the `system.cpu` chart of the
603
registry](https://registry.my-netdata.io/api/v1/alarm_variables?chart=system.cpu).
604
605
-> If you don't know how to find the CHART_NAME, you can read about it [here](../web/README.md#charts).
605
+> If you don't know how to find the CHART_NAME, you can read about it [here](/web/README.md#charts).
606
607
Netdata supports 3 internal indexes for variables that will be used in health monitoring.
608
609
<details markdown="1"><summary>The variables below can be used in both chart alarms and context templates.</summary>
610
611
Although the `alarm_variables` link shows you variables for a particular chart, the same variables can also be used in
612
-templates for charts belonging to a given [context](../web/README.md#contexts). The reason is that all charts of a given
613
-context are essentially identical, with the only difference being the [family](../web/README.md#families) that
612
+templates for charts belonging to a given [context](/web/README.md#contexts). The reason is that all charts of a given
613
+context are essentially identical, with the only difference being the [family](/web/README.md#families) that
614
identifies a particular hardware or software instance. Charts and templates do not apply to specific families anyway,
615
unless if you explicitly limit an alarm with the [alarm line `families`](#alarm-line-families).
616
packaging/installer/README.md
+2
-2
@@ -194,8 +194,8 @@ man-in-the-middle attacks.
194
### CentOS 6 and CentOS 8
195
196
To install the Agent on certain CentOS and RHEL systems, you must enable non-default repositories, such as EPEL or
197
-PowerTools, to gather hard dependencies. See the [CentOS 6](/packaging/installer/methods/manual.md#centos-rehel-6-x) and
198
-[CentOS 8](/packaging/installer/methods/manual.md#centos-rehel-8-x) sections for more information.
197
+PowerTools, to gather hard dependencies. See the [CentOS 6](/packaging/installer/methods/manual.md#centos--rhel-6x) and
198
+[CentOS 8](/packaging/installer/methods/manual.md#centos--rhel-8x) sections for more information.
199
200
### Access to file is not permitted
201
packaging/installer/methods/cloud-providers.md
+1
-1
@@ -29,7 +29,7 @@ we recommend either the [`kickstart.sh` automatic installation script](kickstart
29
packages](packages.md).
30
31
To see the full list of approved methods for each operating system/version we support, see our [distribution
32
-matrix](../../DISTRIBUTIONS.md). That table will guide you to the various supported methods for your cloud instance.
32
+matrix](/packaging/DISTRIBUTIONS.md). That table will guide you to the various supported methods for your cloud instance.
33
34
If you have issues with Netdata after installation, look to the sections below to find the issue you're experiencing,
35
followed by the solution for your provider.
packaging/installer/methods/kickstart.md
+1
-1
@@ -88,7 +88,7 @@ For example:
88
bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
89
```
90
91
-Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](#connect-an-agent-without-root-privileges) section.
91
+Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](/claim/README.md#connect-an-agent-without-root-privileges) section.
92
93
## Verify script integrity
94
packaging/installer/methods/macos.md
+3
-3
@@ -6,11 +6,11 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal
6
# Install Netdata on macOS
7
8
Netdata works on macOS, albeit with some limitations. The number of charts displaying system metrics is limited, but you
9
-can use any of Netdata's [external plugins](../../../collectors/plugins.d/README.md) to monitor any services you might
9
+can use any of Netdata's [external plugins](/collectors/plugins.d/README.md) to monitor any services you might
10
have installed on your macOS system. You could also use a macOS system as the parent node in a [streaming
11
configuration](/streaming/README.md).
12
13
-We recommend you to **[install Netdata with the our automatic one-line installation script](#install-netdata-with-the-automatic-one-line-installation-script)**,
13
+We recommend you to **[install Netdata with the our automatic one-line installation script](#install-netdata-with-our-automatic-one-line-installation-script)**,
14
15
16
As an alternative you also have community-created and -maintained [**Homebrew
@@ -23,7 +23,7 @@ Being community-created and -maintained we don't guarantee that the features mad
23
24
## Install Netdata with our automatic one-line installation script
25
26
-To install Netdata using our automatic [kickstart](/packaging/installer/#automatic-one-line-installation-script) script you will just need to run:
26
+To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) script you will just need to run:
27
28
```bash
29
bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
web/README.md
+3
-3
@@ -17,14 +17,14 @@ There are two primary ways to view Netdata's dashboards:
17
1. The [local Agent dashboard](/web/gui/README.md) that comes pre-configured with every Netdata installation. You can
18
see it at `http://NODE:19999`, replacing `NODE` with `localhost`, the hostname of your node, or its IP address. You
19
can customize the contents and colors of the standard dashboard [using
20
- JavaScript](/web/gui/README.md#customizing-the-standard-dashboard).
20
+ JavaScript](/web/gui/README.md#customizing-the-local-dashboard).
21
22
2. The [`dashboard.js` JavaScript library](#dashboardjs), which helps you
23
- [customize the standard dashboards](/web/gui/README.md#customizing-the-standard-dashboard)
23
+ [customize the standard dashboards](/web/gui/README.md#customizing-the-local-dashboard)
24
using JavaScript, or create entirely new [custom dashboards](/web/gui/custom/README.md) or
25
[Atlassian Confluence dashboards](/web/gui/confluence/README.md).
26
27
-You can also view all the data Netdata collects through the [REST API v1](/web/api/).
27
+You can also view all the data Netdata collects through the [REST API v1](/web/api/README.md#netdata-rest-api).
28
29
No matter where you use Netdata's charts, you'll want to know how to [use](#using-charts) them. You'll also want to
30
understand how Netdata defines [charts](#charts), [dimensions](#dimensions), [families](#families), and