From e99692f145f710930723081d2e5bbf8868be2080 Mon Sep 17 00:00:00 2001 From: Joel Hans Date: Tue, 14 Apr 2020 10:26:13 -0700 Subject: 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 --- collectors/COLLECTORS.md | 6 ++-- collectors/QUICKSTART.md | 7 +++-- collectors/README.md | 33 ++++++++++---------- collectors/REFERENCE.md | 8 ++--- collectors/apps.plugin/README.md | 22 ++++++-------- collectors/cgroups.plugin/README.md | 2 +- collectors/charts.d.plugin/README.md | 10 +++---- collectors/charts.d.plugin/ap/README.md | 2 +- collectors/charts.d.plugin/apcupsd/README.md | 2 +- collectors/charts.d.plugin/libreswan/README.md | 2 +- collectors/charts.d.plugin/nut/README.md | 2 +- collectors/charts.d.plugin/opensips/README.md | 2 +- collectors/charts.d.plugin/sensors/README.md | 4 +-- collectors/diskspace.plugin/README.md | 2 +- collectors/ebpf_process.plugin/README.md | 12 ++++---- collectors/fping.plugin/README.md | 2 +- collectors/ioping.plugin/README.md | 2 +- collectors/node.d.plugin/README.md | 7 ++--- collectors/plugins.d/README.md | 35 ++++++++++++---------- collectors/proc.plugin/README.md | 2 +- collectors/python.d.plugin/README.md | 6 ++-- collectors/python.d.plugin/adaptec_raid/README.md | 2 +- collectors/python.d.plugin/am2320/README.md | 2 +- collectors/python.d.plugin/apache/README.md | 2 +- collectors/python.d.plugin/beanstalk/README.md | 2 +- collectors/python.d.plugin/bind_rndc/README.md | 2 +- collectors/python.d.plugin/boinc/README.md | 2 +- collectors/python.d.plugin/ceph/README.md | 2 +- collectors/python.d.plugin/chrony/README.md | 2 +- collectors/python.d.plugin/couchdb/README.md | 2 +- .../python.d.plugin/dns_query_time/README.md | 2 +- collectors/python.d.plugin/dnsdist/README.md | 2 +- collectors/python.d.plugin/dockerd/README.md | 2 +- collectors/python.d.plugin/dovecot/README.md | 2 +- collectors/python.d.plugin/elasticsearch/README.md | 2 +- collectors/python.d.plugin/energid/README.md | 2 +- collectors/python.d.plugin/fail2ban/README.md | 2 +- collectors/python.d.plugin/freeradius/README.md | 2 +- collectors/python.d.plugin/gearman/README.md | 2 +- collectors/python.d.plugin/go_expvar/README.md | 20 ++++++------- collectors/python.d.plugin/haproxy/README.md | 2 +- collectors/python.d.plugin/hddtemp/README.md | 2 +- collectors/python.d.plugin/hpssa/README.md | 2 +- collectors/python.d.plugin/httpcheck/README.md | 2 +- collectors/python.d.plugin/icecast/README.md | 2 +- collectors/python.d.plugin/ipfs/README.md | 2 +- collectors/python.d.plugin/isc_dhcpd/README.md | 2 +- collectors/python.d.plugin/litespeed/README.md | 2 +- collectors/python.d.plugin/logind/README.md | 2 +- collectors/python.d.plugin/megacli/README.md | 2 +- collectors/python.d.plugin/memcached/README.md | 2 +- collectors/python.d.plugin/mongodb/README.md | 2 +- collectors/python.d.plugin/monit/README.md | 2 +- collectors/python.d.plugin/mysql/README.md | 2 +- collectors/python.d.plugin/nginx/README.md | 2 +- collectors/python.d.plugin/nginx_plus/README.md | 2 +- collectors/python.d.plugin/ntpd/README.md | 2 +- collectors/python.d.plugin/nvidia_smi/README.md | 2 +- collectors/python.d.plugin/openldap/README.md | 2 +- collectors/python.d.plugin/oracledb/README.md | 2 +- .../python.d.plugin/ovpn_status_log/README.md | 2 +- collectors/python.d.plugin/phpfpm/README.md | 2 +- collectors/python.d.plugin/portcheck/README.md | 2 +- collectors/python.d.plugin/postgres/README.md | 4 +-- collectors/python.d.plugin/powerdns/README.md | 2 +- collectors/python.d.plugin/proxysql/README.md | 2 +- collectors/python.d.plugin/puppet/README.md | 2 +- collectors/python.d.plugin/rabbitmq/README.md | 2 +- collectors/python.d.plugin/redis/README.md | 2 +- collectors/python.d.plugin/rethinkdbs/README.md | 2 +- collectors/python.d.plugin/retroshare/README.md | 2 +- collectors/python.d.plugin/riakkv/README.md | 2 +- collectors/python.d.plugin/samba/README.md | 2 +- collectors/python.d.plugin/sensors/README.md | 2 +- collectors/python.d.plugin/smartd_log/README.md | 2 +- collectors/python.d.plugin/spigotmc/README.md | 2 +- collectors/python.d.plugin/springboot/README.md | 6 ++-- collectors/python.d.plugin/squid/README.md | 2 +- collectors/python.d.plugin/tomcat/README.md | 2 +- collectors/python.d.plugin/tor/README.md | 2 +- collectors/python.d.plugin/traefik/README.md | 2 +- collectors/python.d.plugin/uwsgi/README.md | 2 +- collectors/python.d.plugin/varnish/README.md | 2 +- collectors/python.d.plugin/w1sensor/README.md | 2 +- collectors/python.d.plugin/web_log/README.md | 10 +++---- collectors/tc.plugin/README.md | 6 ++-- 86 files changed, 168 insertions(+), 168 deletions(-) (limited to 'collectors') diff --git a/collectors/COLLECTORS.md b/collectors/COLLECTORS.md index e62d9f9d00..510286c573 100644 --- a/collectors/COLLECTORS.md +++ b/collectors/COLLECTORS.md @@ -12,9 +12,9 @@ Netdata uses collectors to help you gather metrics from your favorite applicatio real-time, interactive charts. The following list includes collectors for both internal system metrics, and external apps/services metrics. -Read more about collectors and how to enable them in our [collectors documentation](README.md), or use the [collector -quickstart](QUICKSTART.md) to figure out how to collect metrics from your favorite app/service with auto-detection and -minimal configuration. +Read more about collectors and how to enable them in our [collectors documentation](/collectors/README.md), or use the +[collector quickstart](/collectors/QUICKSTART.md) to figure out how to collect metrics from your favorite app/service +with auto-detection and minimal configuration. If you don't see the app/service you'd like to monitor here, check out our [GitHub issues](https://github.com/netdata/netdata/issues). Use the search bar to look for previous discussions about that diff --git a/collectors/QUICKSTART.md b/collectors/QUICKSTART.md index 2935eed240..6a13023296 100644 --- a/collectors/QUICKSTART.md +++ b/collectors/QUICKSTART.md @@ -115,8 +115,9 @@ entry in the menu and new interactive charts! Collector not working? Learn about collector troubleshooting in our [collector reference](REFERENCE.md#troubleshoot-a-collector). -View our [collectors tutorials](README.md#tutorials) to get specific instructions on enabling new and popular -collectors. +View our [collectors tutorials](/collectors/README.md#tutorials) to get specific instructions on enabling new and +popular collectors. Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our -[internal plugin API](REFERENCE.md#internal-plugins-api) or our [external plugin docs](plugins.d/README.md). +[internal plugin API](/collectors/REFERENCE.md#internal-plugins-api) or our [external plugin +docs](/collectors/plugins.d/README.md). diff --git a/collectors/README.md b/collectors/README.md index df8b8ed349..d1079b25d4 100644 --- a/collectors/README.md +++ b/collectors/README.md @@ -9,45 +9,46 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/READM Netdata can collect metrics from hundreds of different sources, be they internal data created by the system itself, or external data created by services or applications. To see _all_ of the sources Netdata collects from, view our [list of -supported collectors](COLLECTORS.md), and then view our [quickstart guide](QUICKSTART.md) to get up-and-running. +supported collectors](/collectors/COLLECTORS.md), and then view our [quickstart guide](/collectors/QUICKSTART.md) to get +up-and-running. There are two essential points to understand about how collecting metrics works in Netdata: - All collectors are **installed by default** with every installation of Netdata. You do not need to install collectors manually to collect metrics from new sources. -- Upon startup, Netdata will **auto-detect** any application or service that has a [collector](COLLECTORS.md), as long - as both the collector and the app/service are configured correctly. +- Upon startup, Netdata will **auto-detect** any application or service that has a + [collector](/collectors/COLLECTORS.md), as long as both the collector and the app/service are configured correctly. Most users will want to enable a new Netdata collector for their app/service. For those details, see our [quickstart -guide](QUICKSTART.md). +guide](/collectors/QUICKSTART.md). ## Take your next steps with collectors -[Collectors quickstart](QUICKSTART.md) +[Collectors quickstart](/collectors/QUICKSTART.md) -[Supported collectors list](COLLECTORS.md) +[Supported collectors list](/collectors/COLLECTORS.md) -[Collectors configuration reference](REFERENCE.md) +[Collectors configuration reference](/collectors/REFERENCE.md) ## Tutorials -[Monitor Nginx or Apache web server log files with Netdata](../docs/tutorials/collect-apache-nginx-web-logs.md) +[Monitor Nginx or Apache web server log files with Netdata](/docs/tutorials/collect-apache-nginx-web-logs.md) -[Monitor CockroadchDB metrics with Netdata](../docs/tutorials/monitor-cockroachdb.md) +[Monitor CockroadchDB metrics with Netdata](/docs/tutorials/monitor-cockroachdb.md) -[Monitor Unbound DNS servers with Netdata](../docs/tutorials/collect-unbound-metrics.md) +[Monitor Unbound DNS servers with Netdata](/docs/tutorials/collect-unbound-metrics.md) -[Monitor a Hadoop cluster with Netdata](../docs/tutorials/monitor-hadoop-cluster.md) +[Monitor a Hadoop cluster with Netdata](/docs/tutorials/monitor-hadoop-cluster.md) ## Related features -**[Dashboards](../web/README.md)**: Vizualize your newly-collect metrics in real-time using Netdata's [built-in -dashboard](../web/gui/README.md). +**[Dashboards](/web/README.md)**: Vizualize your newly-collect metrics in real-time using Netdata's [built-in +dashboard](/web/gui/README.md). -**[Backends](../backends/README.md)**: Extend our built-in [database engine](), which supports long-term metrics -storage, by archiving metrics to like Graphite, Prometheus, MongoDB, TimescaleDB, and more. +**[Backends](/backends/README.md)**: Extend our built-in [database engine](/database/engine/README.md), which supports +long-term metrics storage, by archiving metrics to like Graphite, Prometheus, MongoDB, TimescaleDB, and more. -**[Exporting](../exporting/README.md)**: An experimental refactoring of our backends system with a modular system and +**[Exporting](/exporting/README.md)**: An experimental refactoring of our backends system with a modular system and support for exporting metrics to multiple systems simultaneously. [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/collectors/REFERENCE.md b/collectors/REFERENCE.md index 3cd52736e9..9498a0d2b5 100644 --- a/collectors/REFERENCE.md +++ b/collectors/REFERENCE.md @@ -35,8 +35,8 @@ independent processes in a variety of programming languages based on their purpo MySQL database, among many others. For most users, enabling individual collectors for the application/service you're interested in is far more important -than knowing which plugin it uses. See our [collectors list](COLLECTORS.md) to see whether your favorite app/service has -a collector, and then read the [collectors quickstart](QUICKSTART.md) and the documentation for that specific collector +than knowing which plugin it uses. See our [collectors list](/collectors/COLLECTORS.md) to see whether your favorite app/service has +a collector, and then read the [collectors quickstart](/collectors/QUICKSTART.md) and the documentation for that specific collector to figure out how to enable it. There are three types of plugins: @@ -48,7 +48,7 @@ There are three types of plugins: independent processes. They communicate with the daemon via pipes. - **Plugin orchestrators**, which are external plugins that instead support a number of **modules**. Modules are a type of collector. We have a few plugin orchestrators available for those who want to develop their own collectors, - but focus most of our efforts on the [Go plugin](go.d.plugin/README.md). + but focus most of our efforts on the [Go plugin](/collectors/go.d.plugin/README.md). ## Enable, configure, and disable modules @@ -59,7 +59,7 @@ However, there are cases that auto-detection fails. Usually, the reason is that allow Netdata to connect. In most of the cases, allowing the user `netdata` from `localhost` to connect and collect metrics, will automatically enable data collection for the application in question (it will require a Netdata restart). -View our [collectors quickstart](QUICKSTART.md) for explict details on enabling and configuring collector modules. +View our [collectors quickstart](/collectors/QUICKSTART.md) for explict details on enabling and configuring collector modules. ## Troubleshoot a collector diff --git a/collectors/apps.plugin/README.md b/collectors/apps.plugin/README.md index d9daf84148..b85a6da766 100644 --- a/collectors/apps.plugin/README.md +++ b/collectors/apps.plugin/README.md @@ -14,7 +14,7 @@ for every process found running. Since Netdata needs to present this information in charts and track them through time, instead of presenting a `top` like list, `apps.plugin` uses a pre-defined list of **process groups** -to which it assigns all running processes. This list is [customizable](apps_groups.conf) and Netdata +to which it assigns all running processes. This list is customizable via `apps_groups.conf`, and Netdata ships with a good default for most cases (to edit it on your system run `/etc/netdata/edit-config apps_groups.conf`). So, `apps.plugin` builds a process tree (much like `ps fax` does in Linux), and groups @@ -22,7 +22,7 @@ processes together (evaluating both child and parent processes) so that the resu a predefined set of members (of course, only process groups found running are reported). > If you find that `apps.plugin` categorizes standard applications as `other`, we would be -> glad to accept pull requests improving the [defaults](apps_groups.conf) shipped with Netdata. +> glad to accept pull requests improving the defaults shipped with Netdata in `apps_groups.conf`. Unlike traditional process monitoring tools (like `top`), `apps.plugin` is able to account the resource utilization of exit processes. Their utilization is accounted at their currently running parents. @@ -67,7 +67,7 @@ Each of these sections provides the same number of charts: The above are reported: -- For **Applications** per [target configured](apps_groups.conf). +- For **Applications** per target configured. - For **Users** per username or UID (when the username is not available). - For **User Groups** per groupname or GID (when groupname is not available). @@ -97,8 +97,7 @@ its CPU resources will be cut in half, and data collection will be once every 2 ## Configuration -The configuration file is `/etc/netdata/apps_groups.conf` (the default is [here](apps_groups.conf)). -To edit it on your system run `/etc/netdata/edit-config apps_groups.conf`. +The configuration file is `/etc/netdata/apps_groups.conf`. To edit it on your system, run `/etc/netdata/edit-config apps_groups.conf`. The configuration file works accepts multiple lines, each having this format: @@ -224,7 +223,7 @@ Examples below for process group `sql`: - Open Pipes ![image](https://registry.my-netdata.io/api/v1/badge.svg?chart=apps.pipes&dimensions=sql&value_color=green=0%7Cred) - Open Sockets ![image](https://registry.my-netdata.io/api/v1/badge.svg?chart=apps.sockets&dimensions=sql&value_color=green%3E=3%7Cred) -For more information about badges check [Generating Badges](../../web/api/badges) +For more information about badges check [Generating Badges](/web/api/badges/README.md) ## Comparison with console tools @@ -358,9 +357,7 @@ So, the `ssh` session is using 95% CPU time. Why `ssh`? -`apps.plugin` groups all processes based on its configuration file -[`/etc/netdata/apps_groups.conf`](apps_groups.conf) -(to edit it on your system run `/etc/netdata/edit-config apps_groups.conf`). +`apps.plugin` groups all processes based on its configuration file. The default configuration has nothing for `bash`, but it has for `sshd`, so Netdata accumulates all ssh sessions to a dimension on the charts, called `ssh`. This includes all the processes in the process tree of `sshd`, **including the exited children**. @@ -375,10 +372,9 @@ the process tree of `sshd`, **including the exited children**. Netdata reads `/proc//stat` for all processes, once per second and extracts `utime` and `stime` (user and system cpu utilization), much like all the console tools do. -But it [also extracts `cutime` and `cstime`](https://github.com/netdata/netdata/blob/62596cc6b906b1564657510ca9135c08f6d4cdda/src/apps_plugin.c#L636-L642) -that account the user and system time of the exit children of each process. By keeping a map in -memory of the whole process tree, it is capable of assigning the right time to every process, -taking into account all its exited children. +But it also extracts `cutime` and `cstime` that account the user and system time of the exit children of each process. +By keeping a map in memory of the whole process tree, it is capable of assigning the right time to every process, taking +into account all its exited children. It is tricky, since a process may be running for 1 hour and once it exits, its parent should not receive the whole 1 hour of cpu time in just 1 second - you have to subtract the cpu time that has diff --git a/collectors/cgroups.plugin/README.md b/collectors/cgroups.plugin/README.md index 5da605a970..a2dc876490 100644 --- a/collectors/cgroups.plugin/README.md +++ b/collectors/cgroups.plugin/README.md @@ -105,7 +105,7 @@ For this mapping Netdata provides 2 configuration options: The whole point for the additional pattern list, is to limit the number of times the script will be called. Without this pattern list, the script might be called thousands of times, depending on the number of cgroups available in the system. -The above pattern list is matched against the path of the cgroup. For matched cgroups, Netdata calls the script [cgroup-name.sh](cgroup-name.sh.in) to get its name. This script queries `docker`, or applies heuristics to find give a name for the cgroup. +The above pattern list is matched against the path of the cgroup. For matched cgroups, Netdata calls the script [cgroup-name.sh](https://raw.githubusercontent.com/netdata/netdata/master/collectors/cgroups.plugin/cgroup-name.sh.in) to get its name. This script queries `docker`, or applies heuristics to find give a name for the cgroup. ### charts with zero metrics diff --git a/collectors/charts.d.plugin/README.md b/collectors/charts.d.plugin/README.md index b6b52b2161..0067f25f0c 100644 --- a/collectors/charts.d.plugin/README.md +++ b/collectors/charts.d.plugin/README.md @@ -62,11 +62,11 @@ For a module called `X`, the following criteria must be met: the collector cannot be used). - `X_create()` - creates the Netdata charts, following the standard Netdata plugin guides as described in - **[External Plugins](../plugins.d/)** (commands `CHART` and `DIMENSION`). + **[External Plugins](/collectors/plugins.d/README.md)** (commands `CHART` and `DIMENSION`). The return value does matter: 0 = OK, 1 = FAILED. - `X_update()` - collects the values for the defined charts, following the standard Netdata plugin guides - as described in **[External Plugins](../plugins.d/)** (commands `BEGIN`, `SET`, `END`). + as described in **[External Plugins](/collectors/plugins.d/README.md)** (commands `BEGIN`, `SET`, `END`). The return value also matters: 0 = OK, 1 = FAILED. 5. The following global variables are available to be set: @@ -74,7 +74,7 @@ For a module called `X`, the following criteria must be met: The module script may use more functions or variables. But all of them must begin with `X_`. -The standard Netdata plugin variables are also available (check **[External Plugins](../plugins.d/)**). +The standard Netdata plugin variables are also available (check **[External Plugins](/collectors/plugins.d/README.md)**). ### X_check() @@ -88,7 +88,7 @@ connect to a local mysql database to find out if it can read the values it needs ### X_create() The purpose of the BASH function `X_create()` is to create the charts and dimensions using the standard Netdata -plugin guides (**[External Plugins](../plugins.d/)**). +plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**). `X_create()` will be called just once and only after `X_check()` was successful. You can however call it yourself when there is need for it (for example to add a new dimension to an existing chart). @@ -98,7 +98,7 @@ A non-zero return value will disable the collector. ### X_update() `X_update()` will be called repeatedly every `X_update_every` seconds, to collect new values and send them to Netdata, -following the Netdata plugin guides (**[External Plugins](../plugins.d/)**). +following the Netdata plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**). The function will be called with one parameter: microseconds since the last time it was run. This value should be appended to the `BEGIN` statement of every chart updated by the collector script. diff --git a/collectors/charts.d.plugin/ap/README.md b/collectors/charts.d.plugin/ap/README.md index 06e9abb0e6..f6e32a3a66 100644 --- a/collectors/charts.d.plugin/ap/README.md +++ b/collectors/charts.d.plugin/ap/README.md @@ -84,7 +84,7 @@ Station 40:b8:37:5a:ed:5e (on wlan0) ## Configuration Edit the `charts.d/ap.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/charts.d.plugin/apcupsd/README.md b/collectors/charts.d.plugin/apcupsd/README.md index 510e5fba7d..8a796c3f46 100644 --- a/collectors/charts.d.plugin/apcupsd/README.md +++ b/collectors/charts.d.plugin/apcupsd/README.md @@ -12,7 +12,7 @@ Monitors different APC UPS models and retrieves status information using `apcacc ## Configuration Edit the `charts.d/apcupsd.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/charts.d.plugin/libreswan/README.md b/collectors/charts.d.plugin/libreswan/README.md index bfc62431fe..61a8c78e14 100644 --- a/collectors/charts.d.plugin/libreswan/README.md +++ b/collectors/charts.d.plugin/libreswan/README.md @@ -23,7 +23,7 @@ The following charts are created, **per tunnel**: ## Configuration Edit the `charts.d/libreswan.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/charts.d.plugin/nut/README.md b/collectors/charts.d.plugin/nut/README.md index b477404d1f..255088fa77 100644 --- a/collectors/charts.d.plugin/nut/README.md +++ b/collectors/charts.d.plugin/nut/README.md @@ -52,7 +52,7 @@ The following charts will be created: ## Configuration Edit the `charts.d/nut.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/charts.d.plugin/opensips/README.md b/collectors/charts.d.plugin/opensips/README.md index 6ce04709aa..ae87456851 100644 --- a/collectors/charts.d.plugin/opensips/README.md +++ b/collectors/charts.d.plugin/opensips/README.md @@ -10,7 +10,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/chart ## Configuration Edit the `charts.d/opensips.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/charts.d.plugin/sensors/README.md b/collectors/charts.d.plugin/sensors/README.md index 777cf2f3df..d2b56d31e3 100644 --- a/collectors/charts.d.plugin/sensors/README.md +++ b/collectors/charts.d.plugin/sensors/README.md @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/chart # Linux machine sensors monitoring with Netdata > THIS MODULE IS OBSOLETE. -> USE [THE PYTHON ONE](../../python.d.plugin/sensors) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT +> USE [THE PYTHON ONE](/collectors/python.d.plugin/sensors) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT > > Unlike the python one, this module can collect temperature on RPi. @@ -34,7 +34,7 @@ One chart for every sensor chip found and each of the above will be created. ## Configuration Edit the `charts.d/sensors.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/diskspace.plugin/README.md b/collectors/diskspace.plugin/README.md index 1737e83762..351b9ed19e 100644 --- a/collectors/diskspace.plugin/README.md +++ b/collectors/diskspace.plugin/README.md @@ -39,6 +39,6 @@ Charts can be enabled/disabled for every mount separately: # inodes usage = auto ``` -> for disks performance monitoring, see the `proc` plugin, [here](../proc.plugin/#monitoring-disks) +> for disks performance monitoring, see the `proc` plugin, [here](/collectors/proc.plugin/README.md#monitoring-disks) [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fdiskspace.plugin%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/collectors/ebpf_process.plugin/README.md b/collectors/ebpf_process.plugin/README.md index b563ff193b..a77a42d003 100644 --- a/collectors/ebpf_process.plugin/README.md +++ b/collectors/ebpf_process.plugin/README.md @@ -71,9 +71,9 @@ commands. You can also configure your system's `/etc/fstab` configuration to mou eBPF collection is only enabled if you install Netdata with the `--enable-ebpf` option. -If you installed via the [one-line installation script](../../packaging/installer/README.md), [64-bit -binary](../../packaging/installer/methods/kickstart-64.md), or [manually](../../packaging/installer/methods/manual.md), -you can append the `--enable-ebpf` option when you reinstall. +If you installed via the [one-line installation script](/packaging/installer/README.md), [64-bit +binary](/packaging/installer/methods/kickstart-64.md), or [manually](/packaging/installer/methods/manual.md), you can +append the `--enable-ebpf` option when you reinstall. For example, if you used the one-line installation script, you can reinstall Netdata with the following: @@ -214,6 +214,6 @@ Because eBPF monitoring is complex, we are evaluating the performance of this ne conditions, across various system loads, and when monitoring complex applications. Our [initial testing](https://github.com/netdata/netdata/issues/8195) shows the performance of the eBPF collector is -nearly identical to our [apps.plugin collector](../apps.plugin/), despite collecting and displaying much more -sophisticated metrics. You can now use the eBPF to gather deeper insights without affecting the performance of your -complex applications at any load. +nearly identical to our [apps.plugin collector](/collectors/apps.plugin/README.md), despite collecting and displaying +much more sophisticated metrics. You can now use the eBPF to gather deeper insights without affecting the performance of +your complex applications at any load. diff --git a/collectors/fping.plugin/README.md b/collectors/fping.plugin/README.md index f150fa0d3a..ad12faaca1 100644 --- a/collectors/fping.plugin/README.md +++ b/collectors/fping.plugin/README.md @@ -44,7 +44,7 @@ fping_opts="-R -b 56 -i 1 -r 0 -t 5000" ## alarms Netdata will automatically attach a few alarms for each host. -Check the [latest versions of the fping alarms](../../health/health.d/fping.conf) +Check the [latest versions of the fping alarms](https://raw.githubusercontent.com/netdata/netdata/master/health/health.d/fping.conf) ## Additional Tips diff --git a/collectors/ioping.plugin/README.md b/collectors/ioping.plugin/README.md index 137c72933b..a48511c005 100644 --- a/collectors/ioping.plugin/README.md +++ b/collectors/ioping.plugin/README.md @@ -44,7 +44,7 @@ ioping_opts="-T 1000000 -R" ## alarms Netdata will automatically attach a few alarms for each host. -Check the [latest versions of the ioping alarms](../../health/health.d/ioping.conf) +Check the [latest versions of the ioping alarms](https://raw.githubusercontent.com/netdata/netdata/master/health/health.d/ioping.conf) ## Multiple ioping Plugins With Different Settings diff --git a/collectors/node.d.plugin/README.md b/collectors/node.d.plugin/README.md index 1e6d19c4ee..f4416553e5 100644 --- a/collectors/node.d.plugin/README.md +++ b/collectors/node.d.plugin/README.md @@ -40,19 +40,18 @@ collectors in node.js. It also manages all its data collectors (placed in `/usr/ instance of node, thus lowering the memory footprint of data collection. Of course, there can be independent plugins written in node.js (placed in `/usr/libexec/netdata/plugins`). -These will have to be developed using the guidelines of **[External Plugins](../plugins.d/)**. +These will have to be developed using the guidelines of **[External Plugins](/collectors/plugins.d/README.md)**. To run `node.js` plugins you need to have `node` installed in your system. In some older systems, the package named `node` is not node.js. It is a terminal emulation program called `ax25-node`. In this case the node.js package may be referred as `nodejs`. Once you install `nodejs`, we suggest to link `/usr/bin/nodejs` to `/usr/bin/node`, so that typing `node` in your terminal, opens node.js. -For more information check the **\[[Installation]]** guide. ## configuring `node.d.plugin` `node.d.plugin` can work even without any configuration. Its default configuration file is -[/etc/netdata/node.d.conf](node.d.conf) (to edit it on your system run `/etc/netdata/edit-config node.d.conf`). +`node.d.conf`. To edit it on your system, run `/etc/netdata/edit-config node.d.conf`. ## configuring `node.d.plugin` modules @@ -234,6 +233,6 @@ The `service` object defines a set of functions to allow you send information to --- _FIXME: document an operational node.d.plugin data collector - the best example is the -[snmp collector](snmp/snmp.node.js)_ +[snmp collector](https://raw.githubusercontent.com/netdata/netdata/master/collectors/node.d.plugin/snmp/snmp.node.js)_ [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fnode.d.plugin%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/collectors/plugins.d/README.md b/collectors/plugins.d/README.md index ff680595a8..3ce463e228 100644 --- a/collectors/plugins.d/README.md +++ b/collectors/plugins.d/README.md @@ -14,18 +14,18 @@ from external processes, thus allowing Netdata to use **external plugins**. |plugin|language|O/S|description| |:----:|:------:|:-:|:----------| -|[apps.plugin](../apps.plugin/)|`C`|linux, freebsd|monitors the whole process tree on Linux and FreeBSD and breaks down system resource usage by **process**, **user** and **user group**.| -|[charts.d.plugin](../charts.d.plugin/)|`BASH`|all|a **plugin orchestrator** for data collection modules written in `BASH` v4+.| -|[cups.plugin](../cups.plugin/)|`C`|all|monitors **CUPS**| -|[fping.plugin](../fping.plugin/)|`C`|all|measures network latency, jitter and packet loss between the monitored node and any number of remote network end points.| -|[ioping.plugin](../ioping.plugin/)|`C`|all|measures disk latency.| -|[freeipmi.plugin](../freeipmi.plugin/)|`C`|linux|collects metrics from enterprise hardware sensors, on Linux servers.| -|[nfacct.plugin](../nfacct.plugin/)|`C`|linux|collects netfilter firewall, connection tracker and accounting metrics using `libmnl` and `libnetfilter_acct`.| -|[xenstat.plugin](../xenstat.plugin/)|`C`|linux|collects XenServer and XCP-ng metrics using `lxenstat`.| -|[perf.plugin](../perf.plugin/)|`C`|linux|collects CPU performance metrics using performance monitoring units (PMU).| -|[node.d.plugin](../node.d.plugin/)|`node.js`|all|a **plugin orchestrator** for data collection modules written in `node.js`.| -|[python.d.plugin](../python.d.plugin/)|`python`|all|a **plugin orchestrator** for data collection modules written in `python` v2 or v3 (both are supported).| -|[slabinfo.plugin](../slabinfo.plugin/)|`C`|linux|collects kernel internal cache objects (SLAB) metrics.| +|[apps.plugin](/collectors/apps.plugin/README.md)|`C`|linux, freebsd|monitors the whole process tree on Linux and FreeBSD and breaks down system resource usage by **process**, **user** and **user group**.| +|[charts.d.plugin](/collectors/charts.d.plugin/README.md)|`BASH`|all|a **plugin orchestrator** for data collection modules written in `BASH` v4+.| +|[cups.plugin](/collectors/cups.plugin/README.md)|`C`|all|monitors **CUPS**| +|[fping.plugin](/collectors/fping.plugin/README.md)|`C`|all|measures network latency, jitter and packet loss between the monitored node and any number of remote network end points.| +|[ioping.plugin](/collectors/ioping.plugin/README.md)|`C`|all|measures disk latency.| +|[freeipmi.plugin](/collectors/freeipmi.plugin/README.md)|`C`|linux|collects metrics from enterprise hardware sensors, on Linux servers.| +|[nfacct.plugin](/collectors/nfacct.plugin/README.md)|`C`|linux|collects netfilter firewall, connection tracker and accounting metrics using `libmnl` and `libnetfilter_acct`.| +|[xenstat.plugin](/collectors/xenstat.plugin/README.md)|`C`|linux|collects XenServer and XCP-ng metrics using `lxenstat`.| +|[perf.plugin](/collectors/perf.plugin/README.md)|`C`|linux|collects CPU performance metrics using performance monitoring units (PMU).| +|[node.d.plugin](/collectors/node.d.plugin/README.md)|`node.js`|all|a **plugin orchestrator** for data collection modules written in `node.js`.| +|[python.d.plugin](/collectors/python.d.plugin/README.md)|`python`|all|a **plugin orchestrator** for data collection modules written in `python` v2 or v3 (both are supported).| +|[slabinfo.plugin](/collectors/slabinfo.plugin/README.md)|`C`|linux|collects kernel internal cache objects (SLAB) metrics.| Plugin orchestrators may also be described as **modular plugins**. They are modular since they accept custom made modules to be included. Writing modules for these plugins is easier than accessing the native Netdata API directly. You will find modules already available for each orchestrator under the directory of the particular modular plugin (e.g. under python.d.plugin for the python orchestrator). Each of these modular plugins has each own methods for defining modules. Please check the examples and their documentation. @@ -64,7 +64,7 @@ Plugins can create any number of charts with any number of dimensions each. Each Netdata will supply the environment variables `NETDATA_USER_CONFIG_DIR` (for user supplied) and `NETDATA_STOCK_CONFIG_DIR` (for Netdata supplied) configuration files to identify the directory where configuration files are stored. It is up to the plugin to read the configuration it needs. -The `netdata.conf` section [plugins] section contains a list of all the plugins found at the system where Netdata runs, with a boolean setting to enable them or not. +The `netdata.conf` section `[plugins]` section contains a list of all the plugins found at the system where Netdata runs, with a boolean setting to enable them or not. Example: @@ -385,15 +385,18 @@ or do not output the line at all. ## Modular Plugins -1. **python**, use `python.d.plugin`, there are many examples in the [python.d directory](../python.d.plugin/) +1. **python**, use `python.d.plugin`, there are many examples in the [python.d + directory](/collectors/python.d.plugin/README.md) python is ideal for Netdata plugins. It is a simple, yet powerful way to collect data, it has a very small memory footprint, although it is not the most CPU efficient way to do it. -2. **node.js**, use `node.d.plugin`, there are a few examples in the [node.d directory](../node.d.plugin/) +2. **node.js**, use `node.d.plugin`, there are a few examples in the [node.d + directory](/collectors/node.d.plugin/README.md) node.js is the fastest scripting language for collecting data. If your plugin needs to do a lot of work, compute values, etc, node.js is probably the best choice before moving to compiled code. Keep in mind though that node.js is not memory efficient; it will probably need more RAM compared to python. -3. **BASH**, use `charts.d.plugin`, there are many examples in the [charts.d directory](../charts.d.plugin/) +3. **BASH**, use `charts.d.plugin`, there are many examples in the [charts.d + directory](/collectors/charts.d.plugin/README.md) BASH is the simplest scripting language for collecting values. It is the less efficient though in terms of CPU resources. You can use it to collect data quickly, but extensive use of it might use a lot of system resources. diff --git a/collectors/proc.plugin/README.md b/collectors/proc.plugin/README.md index 36c8c86035..3038c2de14 100644 --- a/collectors/proc.plugin/README.md +++ b/collectors/proc.plugin/README.md @@ -307,7 +307,7 @@ By default Netdata will enable monitoring metrics only when they are not zero. I There are several alarms defined in `health.d/net.conf`. -The tricky ones are `inbound packets dropped` and `inbound packets dropped ratio`. They have quite a strict policy so that they warn users about possible issues. These alarms can be annoying for some network configurations. It is especially true for some bonding configurations if an interface is a slave or a bonding interface itself. If it is expected to have a certain number of drops on an interface for a certain network configuration, a separate alarm with different triggering thresholds can be created or the existing one can be disabled for this specific interface. It can be done with the help of the [families](../../health/REFERENCE.md#alarm-line-families) line in the alarm configuration. For example, if you want to disable the `inbound packets dropped` alarm for `eth0`, set `families: !eth0 *` in the alarm definition for `template: inbound_packets_dropped`. +The tricky ones are `inbound packets dropped` and `inbound packets dropped ratio`. They have quite a strict policy so that they warn users about possible issues. These alarms can be annoying for some network configurations. It is especially true for some bonding configurations if an interface is a slave or a bonding interface itself. If it is expected to have a certain number of drops on an interface for a certain network configuration, a separate alarm with different triggering thresholds can be created or the existing one can be disabled for this specific interface. It can be done with the help of the [families](/health/REFERENCE.md#alarm-line-families) line in the alarm configuration. For example, if you want to disable the `inbound packets dropped` alarm for `eth0`, set `families: !eth0 *` in the alarm definition for `template: inbound_packets_dropped`. #### configuration diff --git a/collectors/python.d.plugin/README.md b/collectors/python.d.plugin/README.md index e5e007ca60..46e9bdd3c2 100644 --- a/collectors/python.d.plugin/README.md +++ b/collectors/python.d.plugin/README.md @@ -81,7 +81,8 @@ Writing new python module is simple. You just need to remember to include 5 majo If you plan to submit the module in a PR, make sure and go through the [PR checklist for new modules](#pull-request-checklist-for-python-plugins) beforehand to make sure you have updated all the files you need to. -For a quick start, you can look at the [example plugin](example/example.chart.py). +For a quick start, you can look at the [example +plugin](https://raw.githubusercontent.com/netdata/netdata/master/collectors/python.d.plugin/example/example.chart.py). ### Global variables `ORDER` and `CHART` @@ -204,7 +205,8 @@ For additional security it uses python `subprocess.Popen` (without `shell=True` _Examples: `apache`, `nginx`, `tomcat`_ -_Multiple Endpoints (urls) Examples: [`rabbitmq`](rabbitmq/README.md) (simpler) , [`elasticsearch`](elasticsearch/README.md) (threaded)_ +_Multiple Endpoints (urls) Examples: [`rabbitmq`](/collectors/python.d.plugin/rabbitmq/README.md) (simpler) , +[`elasticsearch`](/collectors/python.d.plugin/elasticsearch/README.md) (threaded)_ _Variables from config file_: `url`, `user`, `pass`. diff --git a/collectors/python.d.plugin/adaptec_raid/README.md b/collectors/python.d.plugin/adaptec_raid/README.md index 5c5370a981..75778c1aa9 100644 --- a/collectors/python.d.plugin/adaptec_raid/README.md +++ b/collectors/python.d.plugin/adaptec_raid/README.md @@ -45,7 +45,7 @@ adaptec_raid: yes ``` Edit the `python.d/adaptec_raid.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/am2320/README.md b/collectors/python.d.plugin/am2320/README.md index 4d724277e7..94f083e294 100644 --- a/collectors/python.d.plugin/am2320/README.md +++ b/collectors/python.d.plugin/am2320/README.md @@ -22,7 +22,7 @@ It produces the following charts: ## Configuration Edit the `python.d/am2320.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/apache/README.md b/collectors/python.d.plugin/apache/README.md index e431034e28..724356e8ec 100644 --- a/collectors/python.d.plugin/apache/README.md +++ b/collectors/python.d.plugin/apache/README.md @@ -53,7 +53,7 @@ It produces the following charts: ## Configuration Edit the `python.d/apache.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/beanstalk/README.md b/collectors/python.d.plugin/beanstalk/README.md index 977e9c7d3c..e3e2bf50b1 100644 --- a/collectors/python.d.plugin/beanstalk/README.md +++ b/collectors/python.d.plugin/beanstalk/README.md @@ -113,7 +113,7 @@ Provides server and tube-level statistics. ## Configuration Edit the `python.d/beanstalk.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/bind_rndc/README.md b/collectors/python.d.plugin/bind_rndc/README.md index 2509b5eca6..aa5bf19293 100644 --- a/collectors/python.d.plugin/bind_rndc/README.md +++ b/collectors/python.d.plugin/bind_rndc/README.md @@ -59,7 +59,7 @@ It produces: ## Configuration Edit the `python.d/bind_rndc.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/boinc/README.md b/collectors/python.d.plugin/boinc/README.md index 62b98eb6b1..68b0e313d0 100644 --- a/collectors/python.d.plugin/boinc/README.md +++ b/collectors/python.d.plugin/boinc/README.md @@ -14,7 +14,7 @@ It provides charts tracking the total number of tasks and active tasks, as well ## Configuration Edit the `python.d/boinc.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/ceph/README.md b/collectors/python.d.plugin/ceph/README.md index 3369b37d14..b886a12751 100644 --- a/collectors/python.d.plugin/ceph/README.md +++ b/collectors/python.d.plugin/ceph/README.md @@ -29,7 +29,7 @@ Monitors the ceph cluster usage and consumption data of a server, and produces: ## Configuration Edit the `python.d/ceph.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/chrony/README.md b/collectors/python.d.plugin/chrony/README.md index d9ce213625..63d6e4cf87 100644 --- a/collectors/python.d.plugin/chrony/README.md +++ b/collectors/python.d.plugin/chrony/README.md @@ -24,7 +24,7 @@ Verify that user Netdata can execute `chronyc tracking`. If necessary, update `/ ## Configuration Edit the `python.d/chrony.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different diff --git a/collectors/python.d.plugin/couchdb/README.md b/collectors/python.d.plugin/couchdb/README.md index d4b0925cef..58e8bc8e8a 100644 --- a/collectors/python.d.plugin/couchdb/README.md +++ b/collectors/python.d.plugin/couchdb/README.md @@ -21,7 +21,7 @@ Monitors vital statistics of a local Apache CouchDB 2.x server, including: ## Configuration Edit the `python.d/couchdb.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/dns_query_time/README.md b/collectors/python.d.plugin/dns_query_time/README.md index 8831e0f14c..c1e4c23d8e 100644 --- a/collectors/python.d.plugin/dns_query_time/README.md +++ b/collectors/python.d.plugin/dns_query_time/README.md @@ -18,7 +18,7 @@ It produces one aggregate chart or one chart per DNS server, showing the query t ## Configuration Edit the `python.d/dns_query_time.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different diff --git a/collectors/python.d.plugin/dnsdist/README.md b/collectors/python.d.plugin/dnsdist/README.md index ecee36004e..90b95590d7 100644 --- a/collectors/python.d.plugin/dnsdist/README.md +++ b/collectors/python.d.plugin/dnsdist/README.md @@ -53,7 +53,7 @@ Collects load-balancer performance and health metrics, and draws the following c ## Configuration Edit the `python.d/dnsdist.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different diff --git a/collectors/python.d.plugin/dockerd/README.md b/collectors/python.d.plugin/dockerd/README.md index 11c1f1b7f0..e33d7ebb1a 100644 --- a/collectors/python.d.plugin/dockerd/README.md +++ b/collectors/python.d.plugin/dockerd/README.md @@ -30,7 +30,7 @@ Following charts are drawn: ## Configuration Edit the `python.d/dockerd.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different diff --git a/collectors/python.d.plugin/dovecot/README.md b/collectors/python.d.plugin/dovecot/README.md index e23d8bb786..0858617e25 100644 --- a/collectors/python.d.plugin/dovecot/README.md +++ b/collectors/python.d.plugin/dovecot/README.md @@ -79,7 +79,7 @@ Module gives information with following charts: ## Configuration Edit the `python.d/dovecot.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different diff --git a/collectors/python.d.plugin/elasticsearch/README.md b/collectors/python.d.plugin/elasticsearch/README.md index 1e8c8bea88..12b69a1347 100644 --- a/collectors/python.d.plugin/elasticsearch/README.md +++ b/collectors/python.d.plugin/elasticsearch/README.md @@ -68,7 +68,7 @@ It produces: ## Configuration Edit the `python.d/elasticsearch.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different diff --git a/collectors/python.d.plugin/energid/README.md b/collectors/python.d.plugin/energid/README.md index 5241658e08..ea271f3bac 100644 --- a/collectors/python.d.plugin/energid/README.md +++ b/collectors/python.d.plugin/energid/README.md @@ -50,7 +50,7 @@ long daemon startup. ## Configuration Edit the `python.d/energid.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different diff --git a/collectors/python.d.plugin/fail2ban/README.md b/collectors/python.d.plugin/fail2ban/README.md index 52fabc4d3c..b2a0f6411d 100644 --- a/collectors/python.d.plugin/fail2ban/README.md +++ b/collectors/python.d.plugin/fail2ban/README.md @@ -18,7 +18,7 @@ It produces one chart with multiple lines (one line per jail) ## Configuration Edit the `python.d/fail2ban.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/freeradius/README.md b/collectors/python.d.plugin/freeradius/README.md index 9f9798397c..9839287ae6 100644 --- a/collectors/python.d.plugin/freeradius/README.md +++ b/collectors/python.d.plugin/freeradius/README.md @@ -54,7 +54,7 @@ It produces: ## Configuration Edit the `python.d/freeradius.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/gearman/README.md b/collectors/python.d.plugin/gearman/README.md index 3148cb8684..d24362bde2 100644 --- a/collectors/python.d.plugin/gearman/README.md +++ b/collectors/python.d.plugin/gearman/README.md @@ -28,7 +28,7 @@ It produces: ## Configuration Edit the `python.d/gearman.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/go_expvar/README.md b/collectors/python.d.plugin/go_expvar/README.md index 94a6113985..7f7845e53d 100644 --- a/collectors/python.d.plugin/go_expvar/README.md +++ b/collectors/python.d.plugin/go_expvar/README.md @@ -116,9 +116,8 @@ the use of `netdata`s `go_expvar` module. ### Using Netdata go_expvar module -The `go_expvar` module is disabled by default. To enable it, edit [`python.d.conf`](../python.d.conf) -(to edit it on your system run `/etc/netdata/edit-config python.d.conf`), and change the `go_expvar` -variable to `yes`: +The `go_expvar` module is disabled by default. To enable it, edit `python.d.conf` (to edit it on your system run +`/etc/netdata/edit-config python.d.conf`), and change the `go_expvar` variable to `yes`: ``` # Enable / Disable python.d.plugin modules @@ -134,10 +133,9 @@ go_expvar: yes ... ``` -Next, we need to edit the module configuration file (found at [`/etc/netdata/python.d/go_expvar.conf`](go_expvar.conf) by default) -(to edit it on your system run `/etc/netdata/edit-config python.d/go_expvar.conf`). -The module configuration consists of jobs, where each job can be used to monitor a separate Go application. -Let's see a sample job configuration: +Next, we need to edit the module configuration file (found at `/etc/netdata/python.d/go_expvar.conf` by default) (to +edit it on your system run `/etc/netdata/edit-config python.d/go_expvar.conf`). The module configuration consists of +jobs, where each job can be used to monitor a separate Go application. Let's see a sample job configuration: ``` # /etc/netdata/python.d/go_expvar.conf @@ -212,8 +210,8 @@ See [this issue](https://github.com/netdata/netdata/pull/1902#issuecomment-28449 Please see these two links to the official Netdata documentation for more information about the values: -- [External plugins - charts](../../plugins.d/#chart) -- [Chart variables](../#global-variables-order-and-chart) +- [External plugins - charts](/collectors/plugins.d/README.md#chart) +- [Chart variables](/collectors/python.d.plugin/README.md#global-variables-order-and-chart) **Line definitions** @@ -236,7 +234,7 @@ hidden: False ``` Please see the following link for more information about the options and their default values: -[External plugins - dimensions](../../plugins.d/#dimension) +[External plugins - dimensions](/collectors/plugins.d/README.md#dimension) Apart from top-level expvars, this plugin can also parse expvars stored in a multi-level map; All dicts in the resulting JSON document are then flattened to one level. @@ -258,7 +256,7 @@ the first defined key wins and all subsequent keys with the same name are ignore ## Configuration Edit the `python.d/go_expvar.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/haproxy/README.md b/collectors/python.d.plugin/haproxy/README.md index cf1874bc3a..730002ef99 100644 --- a/collectors/python.d.plugin/haproxy/README.md +++ b/collectors/python.d.plugin/haproxy/README.md @@ -38,7 +38,7 @@ It produces: ## Configuration Edit the `python.d/hapxory.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/hddtemp/README.md b/collectors/python.d.plugin/hddtemp/README.md index 86151a88a4..ecf1bba81f 100644 --- a/collectors/python.d.plugin/hddtemp/README.md +++ b/collectors/python.d.plugin/hddtemp/README.md @@ -17,7 +17,7 @@ It produces one chart **Temperature** with dynamic number of dimensions (one per ## Configuration Edit the `python.d/hddtemp.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/hpssa/README.md b/collectors/python.d.plugin/hpssa/README.md index 55a49cb081..8369c30d2f 100644 --- a/collectors/python.d.plugin/hpssa/README.md +++ b/collectors/python.d.plugin/hpssa/README.md @@ -40,7 +40,7 @@ hpssa: yes ``` Edit the `python.d/hpssa.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/httpcheck/README.md b/collectors/python.d.plugin/httpcheck/README.md index 7099886f54..c8ed0b5748 100644 --- a/collectors/python.d.plugin/httpcheck/README.md +++ b/collectors/python.d.plugin/httpcheck/README.md @@ -27,7 +27,7 @@ Following charts are drawn per job: ## Configuration Edit the `python.d/httpcheck.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/icecast/README.md b/collectors/python.d.plugin/icecast/README.md index 4b3cc8f9f4..c98afe7bc4 100644 --- a/collectors/python.d.plugin/icecast/README.md +++ b/collectors/python.d.plugin/icecast/README.md @@ -22,7 +22,7 @@ It produces the following charts: ## Configuration Edit the `python.d/icecast.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`. ```bash cd /etc/netdata # Replace this path with your Netdata config directory, if different diff --git a/collectors/python.d.plugin/ipfs/README.md b/collectors/python.d.plugin/ipfs/README.md index a47ac97c2e..28c18d1525 100644 --- a/collectors/python.d.plugin/ipfs/README.md +++ b/collectors/python.d.plugin/ipfs/README.md @@ -21,7 +21,7 @@ Collects [IPFS](https://ipfs.io) basic information like file system bandwidth, p ## Configuration Edit the `python.d/ipfs.conf` configuration file using `edit-config` from the your agent's [config -directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically a