diff options
author | Joel Hans <joel@netdata.cloud> | 2020-04-14 10:26:13 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-04-14 10:26:13 -0700 |
commit | e99692f145f710930723081d2e5bbf8868be2080 (patch) | |
tree | 468157463f0f133d927019e6826a9559dd989b9b /docs | |
parent | 59916b01b83026d6e6caf59f4efb67b7d428b70d (diff) |
Docs: Standardize links between documentation (#8638)
* Trying out some absolute-ish links
* Try one out on installer
* Testing logic
* Trying out some more links
* Fixing links
* Fix links in python collectors
* Changed a bunch more links
* Fix build errors
* Another push of links
* Fix build error and add more links
* Complete first pass
* Fix final broken links
* Fix links to files
* Fix for Netlify
* Two more fixes
Diffstat (limited to 'docs')
32 files changed, 526 insertions, 291 deletions
diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md index 9935daa890..d607111b3f 100644 --- a/docs/Add-more-charts-to-netdata.md +++ b/docs/Add-more-charts-to-netdata.md @@ -7,10 +7,10 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-ch # Add more charts to Netdata -This file has been deprecated. Please see our [collectors docs](../collectors/README.md) or the collectors [quickstart -guide](../collectors/QUICKSTART.md) for more information. +This file has been deprecated. Please see our [collectors docs](/collectors/README.md) or the collectors [quickstart +guide](/collectors/QUICKSTART.md) for more information. ## Available data collection modules -See the [list of supported collectors](../collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics +See the [list of supported collectors](/collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics from. diff --git a/docs/Performance.md b/docs/Performance.md index 9daf54ebfd..ff416111b3 100644 --- a/docs/Performance.md +++ b/docs/Performance.md @@ -32,15 +32,15 @@ For most server systems, with a few hundred charts and a few thousand dimensions To prove Netdata scalability, check issue [#1323](https://github.com/netdata/netdata/issues/1323#issuecomment-265501668) where Netdata collects 95.000 metrics per second, with 12% CPU utilization of a single core! -In embedded systems, if the Netdata daemon is using a lot of CPU without any web clients accessing it, you should lower the data collection frequency. To set the data collection frequency, edit `/etc/netdata/netdata.conf` and set `update_every` to a higher number (this is the frequency in seconds data are collected for all charts: higher number of seconds = lower frequency, the default is 1 for per second data collection). You can also set this frequency per module or chart. Check the [daemon configuration](../daemon/config) for plugins and charts. For specific modules, the configuration needs to be changed in: +In embedded systems, if the Netdata daemon is using a lot of CPU without any web clients accessing it, you should lower the data collection frequency. To set the data collection frequency, edit `/etc/netdata/netdata.conf` and set `update_every` to a higher number (this is the frequency in seconds data are collected for all charts: higher number of seconds = lower frequency, the default is 1 for per second data collection). You can also set this frequency per module or chart. Check the [daemon configuration](/daemon/config/README.md) for plugins and charts. For specific modules, the configuration needs to be changed in: -- `python.d.conf` for [python](../collectors/python.d.plugin/#pythondplugin) -- `node.d.conf` for [nodejs](../collectors/node.d.plugin/#nodedplugin) -- `charts.d.conf` for [bash](../collectors/charts.d.plugin/#chartsdplugin) +- `python.d.conf` for [python](/collectors/python.d.plugin/README.md) +- `node.d.conf` for [nodejs](/collectors/node.d.plugin/README.md) +- `charts.d.conf` for [bash](/collectors/charts.d.plugin/README.md) ## Plugins -If a plugin is using a lot of CPU, you should lower its update frequency, or if you wrote it, re-factor it to be more CPU efficient. Check [External Plugins](../collectors/plugins.d/) for more details on writing plugins. +If a plugin is using a lot of CPU, you should lower its update frequency, or if you wrote it, re-factor it to be more CPU efficient. Check [External Plugins](/collectors/plugins.d/README.md) for more details on writing plugins. ## CPU consumption when web clients are accessing dashboards @@ -55,7 +55,7 @@ To lower the CPU utilization of Netdata when clients are accessing the dashboard ## Monitoring a heavily-loaded system While running, Netdata does not depend much on disk I/O aside from writing to log files and the [database -engine](../database/engine/README.md) "spilling" historical metrics to disk when it uses all its available RAM. +engine](/database/engine/README.md) "spilling" historical metrics to disk when it uses all its available RAM. Under a heavy system load, plugins that need disk may stop and show gaps during heavy system load, but the Netdata daemon itself should be able to work and collect values from `/proc` and `/sys` and serve web clients accessing it. @@ -159,7 +159,7 @@ In this section you can select which modules of the `proc` plugin you need. All ... ``` -Refer to the [proc.plugins documentation](../collectors/proc.plugin/) for the list and description of all the proc plugin modules. +Refer to the [proc.plugins documentation](/collectors/proc.plugin/README.md) for the list and description of all the proc plugin modules. ### 3. Lower internal plugin update frequency @@ -196,7 +196,7 @@ following settings in the `[global]` section of `netdata.conf`: # dbengine disk space = 256 ``` -See the [database engine documentation](../database/engine/README.md) or our [tutorial on metrics +See the [database engine documentation](/database/engine/README.md) or our [tutorial on metrics retention](tutorials/longer-metrics-storage.md) for more details on lowering the database engine's memory requirements. ### 6. Disable gzip compression of responses diff --git a/docs/Running-behind-apache.md b/docs/Running-behind-apache.md index b6e9743b2d..930c220fda 100644 --- a/docs/Running-behind-apache.md +++ b/docs/Running-behind-apache.md @@ -354,7 +354,7 @@ If your apache server is not on localhost, you can set: *note: Netdata v1.9+ support `allow connections from`* -`allow connections from` accepts [Netdata simple patterns](../libnetdata/simple_pattern/) to match against the connection IP address. +`allow connections from` accepts [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to match against the connection IP address. ## prevent the double access.log diff --git a/docs/Running-behind-nginx.md b/docs/Running-behind-nginx.md index 6e1083ac20..edd58ad9ec 100644 --- a/docs/Running-behind-nginx.md +++ b/docs/Running-behind-nginx.md @@ -165,7 +165,9 @@ Using the above, you access Netdata on the backend servers, like this: ### Encrypt the communication between Nginx and Netdata -In case Netdata's web server has been [configured to use TLS](../web/server/#enabling-tls-support), it is necessary to specify inside the Nginx configuration that the final destination is using TLS. To do this, please, append the following parameters in your `nginx.conf` +In case Netdata's web server has been [configured to use TLS](/web/server/README.md#enabling-tls-support), it is +necessary to specify inside the Nginx configuration that the final destination is using TLS. To do this, please, append +the following parameters in your `nginx.conf` ```conf proxy_set_header X-Forwarded-Proto https; @@ -238,7 +240,8 @@ If your Nginx server is not on localhost, you can set: *note: Netdata v1.9+ support `allow connections from`* -`allow connections from` accepts [Netdata simple patterns](../libnetdata/simple_pattern/) to match against the connection IP address. +`allow connections from` accepts [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to match against the +connection IP address. ## Prevent the double access.log diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md index bb859b4da7..49a6f92043 100644 --- a/docs/anonymous-statistics.md +++ b/docs/anonymous-statistics.md @@ -84,13 +84,13 @@ installation, including manual, offline, and macOS installations. Create the fil .opt-out-from-anonymous-statistics` from your Netdata configuration directory. **Pass the option `--disable-telemetry` to any of the installer scripts in the [installation -docs](../packaging/installer/README.md).** You can append this option during the initial installation or a manual +docs](/packaging/installer/README.md).** You can append this option during the initial installation or a manual update. You can also export the environment variable `DO_NOT_TRACK` with a non-zero or non-empty value (e.g: `export DO_NOT_TRACK=1`). When using Docker, **set your `DO_NOT_TRACK` environment variable to `1`.** You can set this variable with the following command: `export DO_NOT_TRACK=1`. When creating a container using Netdata's [Docker -image](../packaging/docker/README.md#run-netdata-with-the-docker-command) for the first time, this variable will disable +image](/packaging/docker/README.md#run-netdata-with-the-docker-command) for the first time, this variable will disable the anonymous statistics script inside of the container. Each of these opt-out processes does the following: diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md index 7ea5cc0205..c30175f04c 100644 --- a/docs/configuration-guide.md +++ b/docs/configuration-guide.md @@ -15,7 +15,7 @@ Depending on your installation method, Netdata will have been installed either d Under that directory you will see the following: -- `netdata.conf` is [the main configuration file](../daemon/config/README.md#daemon-configuration) +- `netdata.conf` is [the main configuration file](/daemon/config/README.md#daemon-configuration) - `edit-config` is an sh script that you can use to easily and safely edit the configuration. Just run it to see its usage. - Other directories, initially empty, where your custom configurations for alarms and collector plugins/modules will @@ -23,21 +23,21 @@ Under that directory you will see the following: - `orig` is a symbolic link to the directory `/usr/lib/netdata/conf.d`, which contains the stock configurations for everything not included in `netdata.conf`: - `health_alarm_notify.conf` is where you configure how and to who Netdata will send [alarm - notifications](../health/notifications/README.md#netdata-alarm-notifications). + notifications](/health/notifications/README.md#netdata-alarm-notifications). - `health.d` is the directory that contains the alarm triggers for [health - monitoring](../health/README.md#health-monitoring). It contains one .conf file per collector. - - The [modular plugin orchestrators](../collectors/plugins.d/README.md#external-plugins-overview) have: + monitoring](/health/README.md#health-monitoring). It contains one .conf file per collector. + - The [modular plugin orchestrators](/collectors/plugins.d/README.md#external-plugins-overview) have: - One config file each, mainly to turn their modules on and off: `python.d.conf` for - [python](../collectors/python.d.plugin/README.md#pythondplugin), `node.d.conf` for - [nodejs](../collectors/node.d.plugin/README.md#nodedplugin) and `charts.d.conf` for - [bash](../collectors/charts.d.plugin/README.md#chartsdplugin) modules. + [python](/collectors/python.d.plugin/README.md#pythondplugin), `node.d.conf` for + [nodejs](/collectors/node.d.plugin/README.md#nodedplugin) and `charts.d.conf` for + [bash](/collectors/charts.d.plugin/README.md#chartsdplugin) modules. - One directory each, where the module-specific configuration files can be found. - `stream.conf` is where you configure [streaming and - replication](../streaming/README.md#streaming-and-replication) + replication](/streaming/README.md#streaming-and-replication) - `stats.d` is a directory under which you can add .conf files to add [synthetic - charts](../collectors/statsd.plugin/README.md#synthetic-statsd-charts). + charts](/collectors/statsd.plugin/README.md#synthetic-statsd-charts). - Individual collector plugin config files, such as `fping.conf` for the [fping - plugin](../collectors/fping.plugin/) and `apps_groups.conf` for the [apps plugin](../collectors/apps.plugin/) + plugin](/collectors/fping.plugin/) and `apps_groups.conf` for the [apps plugin](/collectors/apps.plugin/) So there are many configuration files to control every aspect of Netdata's behavior. It can be overwhelming at first, but you won't have to deal with any of them, unless you have specific things you need to change. The following HOWTO @@ -47,7 +47,7 @@ will guide you on how to customize your Netdata, based on what you want to do. ### Persist my configuration -In <http://localhost:19999/netdata.conf>, you will see the following two parameters: +In `http://localhost:19999/netdata.conf`, you will see the following two parameters: ```bash # config directory = /etc/netdata @@ -63,28 +63,28 @@ it there. #### Increase the long-term metrics retention period Increase the values for the `page cache size` and `dbengine disk space` settings in the [`[global]` -section](../daemon/config/README.md#global-section-options) of `netdata.conf`. Read our tutorial on [increasing -long-term metrics storage](tutorials/longer-metrics-storage.md) and the [memory requirements for the database -engine](../database/engine/README.md#memory-requirements). +section](/daemon/config/README.md#global-section-options) of `netdata.conf`. Read our tutorial on [increasing +long-term metrics storage](/docs/tutorials/longer-metrics-storage.md) and the [memory requirements for the database +engine](/database/engine/README.md#memory-requirements). #### Reduce the data collection frequency -Increase `update every` in [netdata.conf \[global\]](../daemon/config/README.md#global-section-options). This is another +Increase `update every` in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options). This is another way to increase your metrics retention period, but at a lower resolution than the default 1s. #### Modify how a chart is displayed In `netdata.conf` under `# Per chart configuration` you will find several [\[CHART_NAME\] -sections](../daemon/config/README.md#per-chart-configuration), where you can control all aspects of a specific chart. +sections](/daemon/config/README.md#per-chart-configuration), where you can control all aspects of a specific chart. #### Disable a collector -Entire plugins can be turned off from the [netdata.conf \[plugins\]](../daemon/config/README.md#plugins-section-options) +Entire plugins can be turned off from the [netdata.conf \[plugins\]](/daemon/config/README.md#plugins-section-options) section. To disable specific modules of a plugin orchestrator, you need to edit one of the following: -- `python.d.conf` for [python](../collectors/python.d.plugin/README.md) -- `node.d.conf` for [nodejs](../collectors/node.d.plugin/README.md) -- `charts.d.conf` for [bash](../collectors/charts.d.plugin/README.md) +- `python.d.conf` for [python](/collectors/python.d.plugin/README.md) +- `node.d.conf` for [nodejs](/collectors/node.d.plugin/README.md) +- `charts.d.conf` for [bash](/collectors/charts.d.plugin/README.md) #### Show charts with zero metrics @@ -101,16 +101,16 @@ internal Netdata plugins. You can add a new alarm definition either by editing an existing stock alarm config file under `health.d` (e.g. `/etc/netdata/edit-config health.d/load.conf`), or by adding a new `.conf` file under `/etc/netdata/health.d`. The -documentation on how to define an alarm is in [health monitoring](../health/README.md). It is +documentation on how to define an alarm is in [health monitoring](/health/README.md). It is suggested to look at some of the stock alarm definitions, so you can ensure you understand how the various options work. #### Turn off all alarms and notifications -Just set `enabled = no` in the [netdata.conf \[health\]](../daemon/config/README.md#health-section-options) section +Just set `enabled = no` in the [netdata.conf \[health\]](/daemon/config/README.md#health-section-options) section #### Modify or disable a specific alarm -The `health.d` directory that contains the alarm triggers for [health monitoring](../health/README.md). It has +The `health.d` directory that contains the alarm triggers for [health monitoring](/health/README.md). It has one .conf file per collector. You can easily find the .conf file you will need to modify, by looking for the "source" line on the table that appears on the right side of an alarm on the Netdata gui. @@ -121,12 +121,12 @@ to run `/etc/netdata/edit-config health.d/cpu.conf` and look for alarm at line 4 As stated at the top of the .conf file, **you can disable an alarm notification by setting the 'to' line to: silent**. To modify how the alarm gets triggered, we suggest that you go through the guide on [health -monitoring](../health/README.md#health-monitoring). +monitoring](/health/README.md#health-monitoring). #### Receive notifications using my preferred method You only need to configure `health_alarm_notify.conf`. To learn how to do it, read first [alarm -notifications](../health/notifications/README.md#netdata-alarm-notifications) and then open the submenu `Supported +notifications](/health/notifications/README.md#netdata-alarm-notifications) and then open the submenu `Supported Notifications` under `Alarm notifications` in the documentation to find the specific page on your preferred notification method. @@ -134,39 +134,39 @@ method. #### Change the Netdata web server access lists -You have several options under the [netdata.conf \[web\]](../web/server/README.md#access-lists) section. +You have several options under the [netdata.conf \[web\]](/web/server/README.md#access-lists) section. #### Stop sending info to registry.my-netdata.io You will need to configure the `[registry]` section in `netdata.conf`. First read the [registry -documentation](../registry/). In it, are instructions on how to [run your own -registry](../registry/README.md#run-your-own-registry). +documentation](/registry/). In it, are instructions on how to [run your own +registry](/registry/README.md#run-your-own-registry). #### Change the IP address/port Netdata listens to The settings are under the `[web]` section. Look at the [web server -documentation](../web/server/README.md#binding-netdata-to-multiple-ports) for more info. +documentation](/web/server/README.md#binding-netdata-to-multiple-ports) for more info. ### System resource usage #### Reduce the resources Netdata uses -The page on [Netdata performance](Performance.md) has an excellent guide on how to reduce the Netdata cpu/disk/RAM -utilization to levels suitable even for the weakest [IoT devices](netdata-for-IoT.md). +The page on [Netdata performance](/docs/Performance.md) has an excellent guide on how to reduce the Netdata cpu/disk/RAM +utilization to levels suitable even for the weakest [IoT devices](/docs/netdata-for-IoT.md). #### Change when Netdata saves metrics to disk -[netdata.conf \[global\]](../daemon/config/README.md#global-section-options): `memory mode` +[netdata.conf \[global\]](/daemon/config/README.md#global-section-options): `memory mode` #### Prevent Netdata from getting immediately killed when my server runs out of memory -You can change the Netdata [OOM score](../daemon/README.md#oom-score) in `[global]`. +You can change the Netdata [OOM score](/daemon/README.md#oom-score) in `[global]`. ### Other #### Move Netdata directories -The various directory paths are in [netdata.conf \[global\]](../daemon/config/README.md#global-section-options). +The various directory paths are in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options). ## How Netdata configuration works @@ -190,7 +190,7 @@ wrote there, is not used. Unix prefers regular expressions. But they are just too hard, too cryptic to use, write and understand. -So, Netdata supports [simple patterns](../libnetdata/simple_pattern/). +So, Netdata supports [simple patterns](/libnetdata/simple_pattern/README.md). ## Netdata labels @@ -198,7 +198,7 @@ Beginning with 1.20, Netdata accepts user-defined **host labels**. These labels labels]`. Read more about how these labels work and why they're an effective way to organize complex infrasturctures in our -tutorial: [Use host labels to organize systems, metrics, and alarms](tutorials/using-host-labels.md). +tutorial: [Use host labels to organize systems, metrics, and alarms](/docs/tutorials/using-host-labels.md). To define a label inside this section, some rules needs to be followed, or Netdata will reject the label. The following restrictions are applied for label names: diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md index faff4eeb2d..9347bccabc 100644 --- a/docs/contributing/contributing-documentation.md +++ b/docs/contributing/contributing-documentation.md @@ -12,8 +12,8 @@ We welcome contributions to Netdata's already extensive documentation, which we repository](https://github.com/netdata/netdata) on GitHub. Like all contributing to all other aspects of Netdata, we ask that anyone who wants to help with documentation read and -abide by the [Contributor Convenant Code of Conduct](https://docs.netdata.cloud/code_of_conduct/) and follow the -instructions outlined in our [Contributing document](../../CONTRIBUTING.md). +abide by the [Contributor Convenant Code of Conduct](/CODE_OF_CONDUCT.md) and follow the +instructions outlined in our [Contributing document](/CONTRIBUTING.md). We also ask you to read our [documentation style guide](style-guide.md), which, while not complete, will give you some guidance on how we write and organize our documentation. @@ -116,8 +116,7 @@ folder and either name it `README.md` for generic documentation, or with another At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have a direct relationship to a specific component of Netdata. It's where we house our [getting started -guide](../../docs/getting-started.md), guides on [running Netdata behind Nginx](../../docs/Running-behind-nginx.md), and -more. +guide](/docs/getting-started.md), guides on [running Netdata behind Nginx](/docs/Running-behind-nginx.md), and more. If the documentation you're working on doesn't have a direct relaionship to a component of Netdata, it can be placed in this `docs/` folder. diff --git a/docs/generator/checklinks.sh b/docs/generator/checklinks.sh index fea613e46a..77a950e210 100755 --- a/docs/generator/checklinks.sh +++ b/docs/generator/checklinks.sh @@ -112,6 +112,33 @@ ck_netdata_relative () { dbg " - # (#somelink)" testinternal "$f" "$f" "$rlnk" ;; + /* ) + # Handle links in Markdown files that begin with `/`. + dbg " - # (/path/filename.md) -> htmldoc (/path/filename/)" + # For links that end in `.md`. + if [[ $rlnk =~ ^(.*)/(.*).md$ ]] ; then + testf "$f" ".$rlnk" + + if [ "${BASH_REMATCH[2]}" = "README" ] ; then + s="${BASH_REMATCH[1]}/" + else + s="${BASH_REMATCH[1]}/${BASH_REMATCH[2]}/" + fi + fi + # For links that end in `.md#...`. + if [[ $lnk =~ ^(.*)/(.*).md#(.*)$ ]] ; then + TRGT=".${BASH_REMATCH[1]}/${BASH_REMATCH[2]}.md" + LNK="#${BASH_REMATCH[3]}" + testf "$f" "$TRGT" + testinternal "$f" "$TRGT" "$LNK" + + if [ "${BASH_REMATCH[2]}" = "README" ] ; then + s="${BASH_REMATCH[1]}/#${BASH_REMATCH[3]}" + else + s="${BASH_REMATCH[1]}/${BASH_REMATCH[2]}/#${BASH_REMATCH[3]}" + fi + fi + ;; */ ) dbg " - # (path/)" TRGT="$fpath/${rlnk}README.md" diff --git a/docs/getting-started.md b/docs/getting-started.md index c86416a929..ca0f27422c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,7 +1,7 @@ <!-- --- title: "Getting started guide" -date: 2020-03-11 +date: 2020-04-06 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/getting-started.md --- --> @@ -15,10 +15,10 @@ Netdata can collect thousands of metrics in real-time and use its database for l configuration, but there are some valuable things to know to get the most out of Netdata based on your needs. We'll skip right into some technical details, so if you're brand-new to monitoring the health and performance of systems -and applications, our [**step-by-step tutorial**](step-by-step/step-00.md) might be a better fit. +and applications, our [**step-by-step tutorial**](/docs/step-by-step/step-00.md) might be a better fit. -> If you haven't installed Netdata yet, visit the [installation instructions](../packaging/installer) for details, -> including our one-liner script, which automatically installs Netdata on almost all Linux distributions. +> If you haven't installed Netdata yet, visit the [installation instructions](/packaging/installer/README.md) for +> details, including our one-liner script, which automatically installs Netdata on almost all Linux distributions. ## Access the dashboard @@ -33,9 +33,9 @@ dashboard](https://user-images.githubusercontent.com/1153921/63463901-fcb9c800-c **What's next?**: -- Read more about the [standard Netdata dashboard](../web/gui/). -- Learn all the specifics of [using charts](../web/README.md#using-charts) or the differences between [charts, - context, and families](../web/README.md#charts-contexts-families). +- Read more about the [standard Netdata dashboard](/web/gui/). +- Learn all the specifics of [using charts](/web/README.md#using-charts) or the differences between [charts, + context, and families](/web/README.md#charts-contexts-families). ## Configuration basics @@ -56,10 +56,10 @@ Once you save your changes, [restart Netdata](#start-stop-and-restart-netdata) t - [Change how long Netdata stores metrics](#change-how-long-netdata-stores-metrics) by changing the `page cache size` and `dbengine disk space` settings in `netdata.conf`. -- Move Netdata's dashboard to a [different port](https://docs.netdata.cloud/web/server/) or enable TLS/HTTPS +- Move Netdata's dashboard to a [different port](/web/server/) or enable TLS/HTTPS encryption. -- See all the `netdata.conf` options in our [daemon configuration documentation](../daemon/config/). -- Run your own [registry](../registry/README.md#run-your-own-registry). +- See all the `netdata.conf` options in our [daemon configuration documentation](/daemon/config/). +- Run your own [registry](/registry/README.md#run-your-own-registry). ## Change how long Netdata stores metrics @@ -70,13 +70,14 @@ configuration keeps RAM usage low while allowing for long-term, on-disk metrics You can tweak this custom _database engine_ to store a much larger dataset than your system's available RAM, particularly if you allow Netdata to use slightly more RAM and disk space than the default configuration. -Read our tutorial, [**Changing how long Netdata stores metrics**](../docs/tutorials/longer-metrics-storage.md), to learn +Read our tutorial, [**Changing how long Netdata stores metrics**](/docs/tutorials/longer-metrics-storage.md), to learn more. **What's next?**: -- Learn more about the [memory requirements for the database engine](../database/engine/README.md#memory-requirements) - to understand how much RAM/disk space you should commit to storing historical metrics. +- Learn more about the [memory requirements for the database + engine](/database/engine/README.md#memory-requirements) to understand how much RAM/disk space you should commit + to storing historical metrics. ## Collect data from more sources @@ -89,8 +90,8 @@ Netdata](#start-stop-and-restart-netdata). However, auto-detection only works if you installed the source using its standard installation procedure. If Netdata isn't collecting metrics after a restart, your source probably isn't configured correctly. Look at the [external plugin -documentation](../collectors/plugins.d/) to find the appropriate module for your source. Those pages will contain more -information about how to configure your source for auto-detection. +documentation](/collectors/plugins.d/) to find the appropriate module for your source. Those pages will contain +more information about how to configure your source for auto-detection. Some modules, like `chrony`, are disabled by default and must be enabled manually for auto-detection to work. @@ -156,12 +157,12 @@ changes based on your particular Nginx setup. **What's next?**: -- Look at the [full list of data collection modules](../collectors/COLLECTORS.md) +- Look at the [full list of data collection modules](/collectors/COLLECTORS.md) to configure your sources for auto-detection and monitoring. -- Improve the [performance](Performance.md) of Netdata on low-memory systems. +- Improve the [performance](/docs/Performance.md) of Netdata on low-memory systems. - Configure `systemd` to expose [systemd services - utilization](../collectors/cgroups.plugin/README.md#monitoring-systemd-services) metrics automatically. -- [Reconfigure individual charts](../daemon/config/README.md#per-chart-configuration) in `netdata.conf`. + utilization](/collectors/cgroups.plugin/README.md#monitoring-systemd-services) metrics automatically. +- [Reconfigure individual charts](/daemon/config/README.md#per-chart-configuration) in `netdata.conf`. ## Health monitoring and alarms @@ -186,19 +187,19 @@ Find the `SEND_EMAIL="YES"` line and change it to `SEND_EMAIL="NO"`. **What's next?**: -- Follow the [health quickstart](../health/QUICKSTART.md) to locate and edit existing health entities, and then create - your own. -- See all the alarm options via the [health configuration reference](../health/REFERENCE |