From 46a8075c8ff6da974d1b39f5b3b9eb50385892c1 Mon Sep 17 00:00:00 2001 From: Joel Hans Date: Thu, 7 Jan 2021 11:44:43 -0700 Subject: Docs housekeeping for SEO and syntax, part 1 (#10388) * First pass to get the script working right * Finish adding analytics tags --- BREAKING_CHANGES.md | 9 +- BUILD.md | 3 +- CODE_OF_CONDUCT.md | 2 - REDISTRIBUTED.md | 2 - SECURITY.md | 3 +- backends/README.md | 2 - backends/TIMESCALE.md | 2 - backends/WALKTHROUGH.md | 2 - backends/aws_kinesis/README.md | 2 - backends/mongodb/README.md | 2 - backends/opentsdb/README.md | 4 +- backends/prometheus/README.md | 2 - backends/prometheus/remote_write/README.md | 2 - build_external/README.md | 3 +- claim/README.md | 2 +- cli/README.md | 9 +- collectors/QUICKSTART.md | 4 +- collectors/README.md | 2 - collectors/REFERENCE.md | 4 +- collectors/cgroups.plugin/README.md | 2 - collectors/checks.plugin/README.md | 2 - collectors/cups.plugin/README.md | 4 +- collectors/diskspace.plugin/README.md | 3 +- collectors/fping.plugin/README.md | 2 - collectors/freebsd.plugin/README.md | 2 - collectors/freeipmi.plugin/README.md | 2 - collectors/idlejitter.plugin/README.md | 2 - collectors/ioping.plugin/README.md | 2 - collectors/macos.plugin/README.md | 2 - collectors/nfacct.plugin/README.md | 2 - collectors/perf.plugin/README.md | 2 - collectors/plugins.d/README.md | 2 - collectors/proc.plugin/README.md | 2 - collectors/python.d.plugin/alarms/README.md | 2 + collectors/python.d.plugin/am2320/README.md | 2 + collectors/python.d.plugin/anomalies/README.md | 2 + collectors/python.d.plugin/gearman/README.md | 2 +- collectors/python.d.plugin/hpssa/README.md | 2 + collectors/python.d.plugin/riakkv/README.md | 2 + collectors/slabinfo.plugin/README.md | 2 - collectors/statsd.plugin/README.md | 21 +- collectors/tc.plugin/README.md | 2 - collectors/xenstat.plugin/README.md | 2 - contrib/README.md | 2 - contrib/sles11/README.md | 2 - daemon/README.md | 2 - daemon/config/README.md | 4 +- database/README.md | 3 +- diagrams/data_structures/README.md | 2 - docs/Add-more-charts-to-netdata.md | 4 +- docs/Demo-Sites.md | 2 - docs/Donations-netdata-has-received.md | 2 - docs/README.md | 4 +- docs/Running-behind-apache.md | 2 - docs/Running-behind-caddy.md | 2 - docs/Running-behind-haproxy.md | 2 - docs/Running-behind-lighttpd.md | 2 - docs/Running-behind-nginx.md | 2 - docs/a-github-star-is-important.md | 2 - docs/agent-cloud.md | 6 +- docs/anonymous-statistics.md | 5 +- docs/configuration-guide.md | 211 +++++++++++++++++++++ docs/getting-started.md | 2 - docs/guides/deploy/ansible.md | 2 +- .../export/export-netdata-metrics-graphite.md | 2 +- docs/guides/monitor/dimension-templates.md | 2 - docs/guides/monitor/stop-notifications-alarms.md | 2 - docs/netdata-for-IoT.md | 2 - docs/netdata-security.md | 2 - docs/privacy-policy.md | 2 - docs/terms-of-use.md | 2 - docs/why-netdata/1s-granularity.md | 2 - docs/why-netdata/README.md | 2 - docs/why-netdata/immediate-results.md | 2 - docs/why-netdata/meaningful-presentation.md | 2 - docs/why-netdata/unlimited-metrics.md | 2 - health/notifications/alerta/README.md | 3 +- health/notifications/awssns/README.md | 3 +- health/notifications/custom/README.md | 2 - health/notifications/discord/README.md | 2 - health/notifications/dynatrace/README.md | 2 + health/notifications/email/README.md | 2 - health/notifications/irc/README.md | 2 - health/notifications/kavenegar/README.md | 2 - health/notifications/messagebird/README.md | 2 - health/notifications/pagerduty/README.md | 2 - health/notifications/prowl/README.md | 2 + health/notifications/pushbullet/README.md | 2 - health/notifications/pushover/README.md | 2 - health/notifications/rocketchat/README.md | 2 - health/notifications/slack/README.md | 2 - health/notifications/smstools3/README.md | 2 - health/notifications/syslog/README.md | 2 - health/notifications/telegram/README.md | 2 - health/notifications/twilio/README.md | 2 - health/notifications/web/README.md | 2 - libnetdata/README.md | 2 - libnetdata/adaptive_resortable_list/README.md | 2 - libnetdata/avl/README.md | 2 - libnetdata/buffer/README.md | 2 - libnetdata/circular_buffer/README.md | 3 +- libnetdata/config/README.md | 2 - libnetdata/json/README.md | 2 - libnetdata/procfile/README.md | 2 - libnetdata/storage_number/README.md | 2 - packaging/DISTRIBUTIONS.md | 2 - packaging/installer/README.md | 2 + packaging/installer/UNINSTALL.md | 1 + packaging/installer/methods/alpine.md | 4 +- packaging/installer/methods/cloud-providers.md | 7 +- packaging/installer/methods/freebsd.md | 2 + packaging/installer/methods/freenas.md | 4 +- packaging/installer/methods/kickstart-64.md | 5 +- packaging/installer/methods/kickstart.md | 5 +- packaging/installer/methods/macos.md | 4 +- packaging/installer/methods/manual.md | 5 +- packaging/installer/methods/offline.md | 21 +- packaging/installer/methods/packages.md | 8 +- packaging/installer/methods/pfsense.md | 2 + packaging/installer/methods/source.md | 4 +- packaging/installer/methods/synology.md | 5 +- packaging/maintainers/README.md | 2 - packaging/makeself/README.md | 3 +- parser/README.md | 4 +- registry/README.md | 3 +- tests/README.md | 2 - tests/health_mgmtapi/README.md | 2 - web/api/badges/README.md | 2 - web/api/exporters/README.md | 2 - web/api/exporters/prometheus/README.md | 2 - web/api/exporters/shell/README.md | 2 - web/api/formatters/README.md | 2 - web/api/formatters/csv/README.md | 2 - web/api/formatters/json/README.md | 2 - web/api/formatters/ssv/README.md | 2 - web/api/formatters/value/README.md | 2 - web/api/health/README.md | 2 - web/api/queries/README.md | 2 - web/api/queries/average/README.md | 2 - web/api/queries/des/README.md | 2 - web/api/queries/incremental_sum/README.md | 2 - web/api/queries/max/README.md | 2 - web/api/queries/median/README.md | 3 +- web/api/queries/min/README.md | 2 - web/api/queries/ses/README.md | 2 - web/api/queries/stddev/README.md | 2 - web/api/queries/sum/README.md | 2 - web/gui/confluence/README.md | 2 - web/gui/custom/README.md | 3 +- web/server/README.md | 19 +- web/server/static/README.md | 4 +- 151 files changed, 344 insertions(+), 303 deletions(-) create mode 100644 docs/configuration-guide.md diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index 3d432888a7..20d055621a 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -1,10 +1,11 @@ -# Breaking Changes +# Breaking changes - remove deprecated bash modules (`apache`, `cpu_apps`, `cpufreq`, `exim`, `hddtemp`, `load_average`, `mem_apps`, `mysql`, `nginx`, `phpfpm`, `postfix`, `squid`, `tomcat`) [[#7962](https://github.com/netdata/netdata/pull/7962)] + +[![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%2BREAKING_CHANGES&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/BUILD.md b/BUILD.md index 4791bae37a..deb30b37f4 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,8 +1,6 @@ # The build system @@ -364,3 +362,4 @@ Some smaller miscellaeneous suggestions: * [header checks in CMake](https://stackoverflow.com/questions/647892/how-to-check-header-files-and-library-functions-in-cmake-like-it-is-done-in-auto) * [how to write platform checks](https://gitlab.kitware.com/cmake/community/wikis/doc/tutorials/How-To-Write-Platform-Checks) +[![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%2FBUILD&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index df053b7bf8..12e959d96d 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,8 +1,6 @@ # Netdata Community Code of Conduct diff --git a/REDISTRIBUTED.md b/REDISTRIBUTED.md index 5a3c328709..fb256b5fce 100644 --- a/REDISTRIBUTED.md +++ b/REDISTRIBUTED.md @@ -1,8 +1,6 @@ # Redistributed software diff --git a/SECURITY.md b/SECURITY.md index b44e4e689b..e823e227aa 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,8 +1,7 @@ # Security Policy diff --git a/backends/README.md b/backends/README.md index ef0719b86b..8d53fd664e 100644 --- a/backends/README.md +++ b/backends/README.md @@ -1,8 +1,6 @@ # Metrics long term archiving diff --git a/backends/TIMESCALE.md b/backends/TIMESCALE.md index dad851fc29..854c4112e8 100644 --- a/backends/TIMESCALE.md +++ b/backends/TIMESCALE.md @@ -1,8 +1,6 @@ # Writing metrics to TimescaleDB diff --git a/backends/WALKTHROUGH.md b/backends/WALKTHROUGH.md index 612270cac1..76dd62f834 100644 --- a/backends/WALKTHROUGH.md +++ b/backends/WALKTHROUGH.md @@ -1,8 +1,6 @@ # Netdata, Prometheus, Grafana stack diff --git a/backends/aws_kinesis/README.md b/backends/aws_kinesis/README.md index 10efe528c3..a2b682517e 100644 --- a/backends/aws_kinesis/README.md +++ b/backends/aws_kinesis/README.md @@ -1,8 +1,6 @@ # Using Netdata with AWS Kinesis Data Streams diff --git a/backends/mongodb/README.md b/backends/mongodb/README.md index cba8109721..7c7996e1be 100644 --- a/backends/mongodb/README.md +++ b/backends/mongodb/README.md @@ -1,8 +1,6 @@ # MongoDB backend diff --git a/backends/opentsdb/README.md b/backends/opentsdb/README.md index 20abce88c0..b9d0b9873b 100644 --- a/backends/opentsdb/README.md +++ b/backends/opentsdb/README.md @@ -1,8 +1,6 @@ # OpenTSDB with HTTP @@ -36,3 +34,5 @@ After your proxy is configured, make the following changes to `netdata.conf`: In this example, we used the port `8082` for our reverse proxy. If your reverse proxy listens on a different port, change the `destination = localhost:8082` line accordingly. + +[![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%2Fbackends%2Fopentsdb%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/backends/prometheus/README.md b/backends/prometheus/README.md index 3b4719b970..10275fa205 100644 --- a/backends/prometheus/README.md +++ b/backends/prometheus/README.md @@ -1,8 +1,6 @@ # Using Netdata with Prometheus diff --git a/backends/prometheus/remote_write/README.md b/backends/prometheus/remote_write/README.md index c9ae2b1297..b83575e100 100644 --- a/backends/prometheus/remote_write/README.md +++ b/backends/prometheus/remote_write/README.md @@ -1,8 +1,6 @@ # Prometheus remote write backend diff --git a/build_external/README.md b/build_external/README.md index 8305836b02..f52f55734a 100644 --- a/build_external/README.md +++ b/build_external/README.md @@ -1,9 +1,7 @@ # External build-system @@ -127,3 +125,4 @@ Notes: * There is not yet a good way to configure the target agent container from the docker-compose command line. * Several other containers should be in this compose (a paho client, tshark etc). +[![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%2Fbuild_external%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/claim/README.md b/claim/README.md index 17fe255815..a2e5116c13 100644 --- a/claim/README.md +++ b/claim/README.md @@ -1,6 +1,6 @@ diff --git a/cli/README.md b/cli/README.md index 8cb33975bf..93812372ab 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,13 +1,12 @@ -# Netdata cli +# Netdata CLI -You can see the commands netdatacli supports by executing it with `netdatacli` and entering `help` in +You can see the commands `netdatacli` supports by executing it with `netdatacli` and entering `help` in standard input. All commands are given as standard input to `netdatacli`. The commands that a running netdata agent can execute are the following: diff --git a/collectors/QUICKSTART.md b/collectors/QUICKSTART.md index e0f1ccecd7..a691ffc4c3 100644 --- a/collectors/QUICKSTART.md +++ b/collectors/QUICKSTART.md @@ -1,8 +1,6 @@ # Collectors quickstart @@ -123,3 +121,5 @@ popular collectors. Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our [internal plugin API](/collectors/REFERENCE.md#internal-plugins-api) or our [external plugin docs](/collectors/plugins.d/README.md). + +[![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%2FQUICKSTART&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/README.md b/collectors/README.md index 5fed208c9c..ef1f9610c1 100644 --- a/collectors/README.md +++ b/collectors/README.md @@ -1,8 +1,6 @@ # Collecting metrics diff --git a/collectors/REFERENCE.md b/collectors/REFERENCE.md index a49c838859..08a405dc7b 100644 --- a/collectors/REFERENCE.md +++ b/collectors/REFERENCE.md @@ -1,8 +1,6 @@ # Collectors configuration reference @@ -184,3 +182,5 @@ through this, is to examine what other similar plugins do. ## Write a custom collector You can add custom collectors by following the [external plugins documentation](../collectors/plugins.d/). + +[![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%2REFERENCE&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/cgroups.plugin/README.md b/collectors/cgroups.plugin/README.md index 853c0f5946..9b26deb2ce 100644 --- a/collectors/cgroups.plugin/README.md +++ b/collectors/cgroups.plugin/README.md @@ -1,8 +1,6 @@ # cgroups.plugin diff --git a/collectors/checks.plugin/README.md b/collectors/checks.plugin/README.md index 57de81e1c1..5f1a6b912b 100644 --- a/collectors/checks.plugin/README.md +++ b/collectors/checks.plugin/README.md @@ -1,8 +1,6 @@ # checks.plugin diff --git a/collectors/cups.plugin/README.md b/collectors/cups.plugin/README.md index 1d52f09e68..373602dca1 100644 --- a/collectors/cups.plugin/README.md +++ b/collectors/cups.plugin/README.md @@ -1,8 +1,6 @@ # cups.plugin @@ -60,3 +58,5 @@ For each destination the plugin provides these charts: - processing At the moment only job status pending, processing, and held are reported because we do not have a method to collect stopped, canceled, aborted and completed jobs which scales. + +[![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%2cups.plugin%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/diskspace.plugin/README.md b/collectors/diskspace.plugin/README.md index 8f814018ac..a8b41c861d 100644 --- a/collectors/diskspace.plugin/README.md +++ b/collectors/diskspace.plugin/README.md @@ -1,8 +1,7 @@ # diskspace.plugin diff --git a/collectors/fping.plugin/README.md b/collectors/fping.plugin/README.md index ad12faaca1..4aca2a9de3 100644 --- a/collectors/fping.plugin/README.md +++ b/collectors/fping.plugin/README.md @@ -1,8 +1,6 @@ # fping.plugin diff --git a/collectors/freebsd.plugin/README.md b/collectors/freebsd.plugin/README.md index 47090b29ed..1b519a6594 100644 --- a/collectors/freebsd.plugin/README.md +++ b/collectors/freebsd.plugin/README.md @@ -1,8 +1,6 @@ # freebsd.plugin diff --git a/collectors/freeipmi.plugin/README.md b/collectors/freeipmi.plugin/README.md index 7ea57ed8ac..64328fc9e7 100644 --- a/collectors/freeipmi.plugin/README.md +++ b/collectors/freeipmi.plugin/README.md @@ -1,8 +1,6 @@ # freeipmi.plugin diff --git a/collectors/idlejitter.plugin/README.md b/collectors/idlejitter.plugin/README.md index 139b9b1690..3703e2ee25 100644 --- a/collectors/idlejitter.plugin/README.md +++ b/collectors/idlejitter.plugin/README.md @@ -1,8 +1,6 @@ # idlejitter.plugin diff --git a/collectors/ioping.plugin/README.md b/collectors/ioping.plugin/README.md index a48511c005..08b0ce8b15 100644 --- a/collectors/ioping.plugin/README.md +++ b/collectors/ioping.plugin/README.md @@ -1,8 +1,6 @@ # ioping.plugin diff --git a/collectors/macos.plugin/README.md b/collectors/macos.plugin/README.md index 7e61efcd04..800eb0e85e 100644 --- a/collectors/macos.plugin/README.md +++ b/collectors/macos.plugin/README.md @@ -1,8 +1,6 @@ # macos.plugin diff --git a/collectors/nfacct.plugin/README.md b/collectors/nfacct.plugin/README.md index ac5092f2ae..1bd8a46e8f 100644 --- a/collectors/nfacct.plugin/README.md +++ b/collectors/nfacct.plugin/README.md @@ -1,8 +1,6 @@ # nfacct.plugin diff --git a/collectors/perf.plugin/README.md b/collectors/perf.plugin/README.md index 2131e71671..d4bb41cb60 100644 --- a/collectors/perf.plugin/README.md +++ b/collectors/perf.plugin/README.md @@ -1,8 +1,6 @@ # perf.plugin diff --git a/collectors/plugins.d/README.md b/collectors/plugins.d/README.md index 3ce463e228..913ad9177c 100644 --- a/collectors/plugins.d/README.md +++ b/collectors/plugins.d/README.md @@ -1,8 +1,6 @@ # External plugins overview diff --git a/collectors/proc.plugin/README.md b/collectors/proc.plugin/README.md index 6a8dc71142..085afb4fb6 100644 --- a/collectors/proc.plugin/README.md +++ b/collectors/proc.plugin/README.md @@ -1,8 +1,6 @@ # proc.plugin diff --git a/collectors/python.d.plugin/alarms/README.md b/collectors/python.d.plugin/alarms/README.md index ea90529529..ea96061cc7 100644 --- a/collectors/python.d.plugin/alarms/README.md +++ b/collectors/python.d.plugin/alarms/README.md @@ -54,3 +54,5 @@ local: ``` It will default to pulling all alarms at each time step from the Netdata rest api at `http://127.0.0.1:19999/api/v1/alarms?all` + +[![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%2Fpython.d.plugin%2Falarms%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/python.d.plugin/am2320/README.md b/collectors/python.d.plugin/am2320/README.md index cfc8a69501..c17b33dfa1 100644 --- a/collectors/python.d.plugin/am2320/README.md +++ b/collectors/python.d.plugin/am2320/README.md @@ -50,3 +50,5 @@ Software install: - save the file. - restart the netdata service. - check the dashboard. + +[![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%2Fpython.d.plugin%2Fam2320%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/python.d.plugin/anomalies/README.md b/collectors/python.d.plugin/anomalies/README.md index 95245a450e..487a11a095 100644 --- a/collectors/python.d.plugin/anomalies/README.md +++ b/collectors/python.d.plugin/anomalies/README.md @@ -225,3 +225,5 @@ If you would like to go deeper on what exactly the anomalies collector is doing - [Mendeley public group](https://www.mendeley.com/community/interesting-anomaly-detection-papers/) with some interesting anomaly detection papers we have been reading. - Good [blog post](https://www.anodot.com/blog/what-is-anomaly-detection/) from Anodot on time series anomaly detection. Anodot also have some great whitepapers in this space too that some may find useful. - Novelty and outlier detection in the [scikit-learn documentation](https://scikit-learn.org/stable/modules/outlier_detection.html). + +[![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%2Fpython.d.plugin%2Fanomalies%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/python.d.plugin/gearman/README.md b/collectors/python.d.plugin/gearman/README.md index 7e96f8fc62..b9fc914bf7 100644 --- a/collectors/python.d.plugin/gearman/README.md +++ b/collectors/python.d.plugin/gearman/README.md @@ -48,4 +48,4 @@ localhost: When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`. ---- +[![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%2Fpython.d.plugin%2Fgearman%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/python.d.plugin/hpssa/README.md b/collectors/python.d.plugin/hpssa/README.md index b1157bf9fa..426f19c536 100644 --- a/collectors/python.d.plugin/hpssa/README.md +++ b/collectors/python.d.plugin/hpssa/README.md @@ -51,3 +51,5 @@ If `ssacli` cannot be found in the `PATH`, configure it in `hpssa.conf`. ```yaml ssacli_path: /usr/sbin/ssacli ``` + +[![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%2Fpython.d.plugin%2Fhpssa%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/python.d.plugin/riakkv/README.md b/collectors/python.d.plugin/riakkv/README.md index fe62c67189..d0ea9a1379 100644 --- a/collectors/python.d.plugin/riakkv/README.md +++ b/collectors/python.d.plugin/riakkv/README.md @@ -124,3 +124,5 @@ With no explicit configuration given, the module will attempt to connect to The default update frequency for the plugin is set to 2 seconds as Riak internally updates the metrics every second. If we were to update the metrics every second, the resulting graph would contain odd jitter. + +[![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%2Fpython.d.plugin%2Friakkv%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/collectors/slabinfo.plugin/README.md b/collectors/slabinfo.plugin/README.md index 3ba701838d..21d83c999b 100644 --- a/collectors/slabinfo.plugin/README.md +++ b/collectors/slabinfo.plugin/README.md @@ -1,8 +1,6 @@ # slabinfo.plugin diff --git a/collectors/statsd.plugin/README.md b/collectors/statsd.plugin/README.md index 681d48294f..d5bc0d1ad5 100644 --- a/collectors/statsd.plugin/README.md +++ b/collectors/statsd.plugin/README.md @@ -1,8 +1,7 @@ # statsd.plugin @@ -219,7 +218,8 @@ The same chart with the `sum` unselected: ### synthetic statsd charts -Using synthetic charts, you can create dedicated sections on the dashboard to render the charts. You can control everything: the main menu, the submenus, the charts, the dimensions on each chart, etc. +Use synthetic charts to create dedicated sections on the dashboard to render the charts, with control over the main +menu, the submenus, the charts, the dimensions on each chart, and more. Synthetic charts are organized in @@ -229,7 +229,7 @@ Synthetic charts are organized in For each application you need to create a `.conf` file in `/etc/netdata/statsd.d`. -So, to create the statsd application `myapp`, you can create the file `/etc/netdata/statsd.d/myapp.conf`, with this content: +So, to create the statsd application `myapp`, create the file `/etc/netdata/statsd.d/myapp.conf`, with this content: ``` [app] @@ -271,9 +271,9 @@ Using the above configuration `myapp` should get its own section on the dashboar `[dictionary]` defines name-value associations. These are used to renaming metrics, when added to synthetic charts. Metric names are also defined at each `dimension` line. However, using the dictionary dimension names can be declared globally, for each app and is the only way to rename dimensions when using patterns. Of course the dictionary can be empty or missing. -Then, you can add any number of charts. Each chart should start with `[id]`. The chart will be called `app_name.id`. `family` controls the submenu on the dashboard. `context` controls the alarm templates. `priority` controls the ordering of the charts on the dashboard. The rest of the settings are informational. +Then, add any number of charts. Each chart should start with `[id]`. The chart will be called `app_name.id`. `family` controls the submenu on the dashboard. `context` controls the alarm templates. `priority` controls the ordering of the charts on the dashboard. The rest of the settings are informational. -You can add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters: +Add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters: 1. the metric name, as it is collected (it has to be matched by the `metrics =` pattern of the app) 2. the dimension name, as it should be shown on the chart @@ -351,12 +351,12 @@ Netdata uses this dictionary as follows: 3. If any of the above succeeds, Netdata uses the `value` of the dictionary, to set the name of the dimension. The dimensions will have as ID the original statsd metric name, and as name, the dictionary value. -So, you can use the dictionary in 2 ways: +Use the dictionary in 2 ways: 1. set `dimension = myapp.metric1 ''` and have at the dictionary `myapp.metric1 = metric1 name` 2. set `dimension = myapp.metric1 'm1'` and have at the dictionary `m1 = metric1 name` -In both cases, the dimension will be added with ID `myapp.metric1` and will be named `metric1 name`. So, in alarms you can use either of the 2 as `${myapp.metric1}` or `${metric1 name}`. +In both cases, the dimension will be added with ID `myapp.metric1` and will be named `metric1 name`. So, in alarms use either of the 2 as `${myapp.metric1}` or `${metric1 name}`. > keep in mind that if you add multiple times the same statsd metric to a chart, Netdata will append `TYPE` to the dimension ID, so `myapp.metric1` will be added as `myapp.metric1_last` or `myapp.metric1_events`, etc. If you add multiple times the same metric with the same `TYPE` to a chart, Netdata will also append an incremental counter to the dimension ID, i.e. `myapp.metric1_last1`, `myapp.metric1_last2`, etc. @@ -389,7 +389,7 @@ To add all response codes of `myapp.api.get` to a chart use this: dimension = pattern 'myapp.api.get.* '' last 1 1 ``` -The above will add dimension named `200`, `400` and `500` (yes, Netdata extracts the wildcarded part of the metric name - so the dimensions will be named with whatever the `*` matched). You can rename the dimensions with this: +The above will add dimension named `200`, `400` and `500` (yes, Netdata extracts the wildcarded part of the metric name - so the dimensions will be named with whatever the `*` matched). Rename the dimensions with this: ``` [dictionary] @@ -451,7 +451,8 @@ Using the above, the dimensions will be added as `GET`, `ADD` and `DELETE`. ## sending statsd metrics from shell scripts -You can send/update statsd metrics from shell scripts. You can use this feature, to visualize in Netdata automated jobs you run on your servers. +Send/update statsd metrics from shell scripts to visualize automated jobs you run on your servers using the Netdata +Agent. The command you need to run is: diff --git a/collectors/tc.plugin/README.md b/collectors/tc.plugin/README.md index 3ef47c11a8..70e31c236b 100644 --- a/collectors/tc.plugin/README.md +++ b/collectors/tc.plugin/README.md @@ -1,8 +1,6 @@ # tc.plugin diff --git a/collectors/xenstat.plugin/README.md b/collectors/xenstat.plugin/README.md index 7d79d41faf..61be271d99 100644 --- a/collectors/xenstat.plugin/README.md +++ b/collectors/xenstat.plugin/README.md @@ -1,8 +1,6 @@ # xenstat.plugin diff --git a/contrib/README.md b/contrib/README.md index a9e89ce11a..e253efa993 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -1,8 +1,6 @@ # Netdata contrib diff --git a/contrib/sles11/README.md b/contrib/sles11/README.md index 3bb995f38e..4cdf7e9f91 100644 --- a/contrib/sles11/README.md +++ b/contrib/sles11/README.md @@ -1,8 +1,6 @@ # Spec to build Netdata RPM for sles 11 diff --git a/daemon/README.md b/daemon/README.md index 29fc6a6125..9aa483b711 100644 --- a/daemon/README.md +++ b/daemon/README.md @@ -1,9 +1,7 @@ # Netdata daemon diff --git a/daemon/config/README.md b/daemon/config/README.md index 211039396b..71c0c0e841 100644 --- a/daemon/config/README.md +++ b/daemon/config/README.md @@ -1,9 +1,7 @@ # Daemon configuration diff --git a/database/README.md b/database/README.md index 1dca14c262..9fef705803 100644 --- a/database/README.md +++ b/database/README.md @@ -1,8 +1,7 @@ # Database diff --git a/diagrams/data_structures/README.md b/diagrams/data_structures/README.md index 4e9d14f4ae..27705c5489 100644 --- a/diagrams/data_structures/README.md +++ b/diagrams/data_structures/README.md @@ -1,8 +1,6 @@ # Data structures diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md index d607111b3f..a16f2e9dbc 100644 --- a/docs/Add-more-charts-to-netdata.md +++ b/docs/Add-more-charts-to-netdata.md @@ -1,8 +1,6 @@ # Add more charts to Netdata @@ -14,3 +12,5 @@ guide](/collectors/QUICKSTART.md) for more information. See the [list of supported collectors](/collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics from. + +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2FAdd-more-charts-to-netdata&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/docs/Demo-Sites.md b/docs/Demo-Sites.md index 2fce066b37..8af1282ba4 100644 --- a/docs/Demo-Sites.md +++ b/docs/Demo-Sites.md @@ -1,9 +1,7 @@ # Demo sites diff --git a/docs/Donations-netdata-has-received.md b/docs/Donations-netdata-has-received.md index 2c75b87436..df6c040bab 100644 --- a/docs/Donations-netdata-has-received.md +++ b/docs/Donations-netdata-has-received.md @@ -1,8 +1,6 @@ # Donations diff --git a/docs/README.md b/docs/README.md index c483cb7ad1..47950f3889 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,6 @@ # Read documentation on @@ -15,3 +13,5 @@ uses a few extra Markdown features that GitHub doesn't support natively. Other t perfect. Now get out there and build an exceptional infrastructure. + +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/docs/Running-behind-apache.md b/docs/Running-behind-apache.md index 930c220fda..8a547e7b4f 100644 --- a/docs/Running-behind-apache.md +++ b/docs/Running-behind-apache.md @@ -1,8 +1,6 @@ # Netdata via apache's mod_proxy diff --git a/docs/Running-behind-caddy.md b/docs/Running-behind-caddy.md index 01934b5749..c1d57504ad 100644 --- a/docs/Running-behind-caddy.md +++ b/docs/Running-behind-caddy.md @@ -1,8 +1,6 @@ # Netdata via Caddy diff --git a/docs/Running-behind-haproxy.md b/docs/Running-behind-haproxy.md index 212779b4b2..d4b09f85c7 100644 --- a/docs/Running-behind-haproxy.md +++ b/docs/Running-behind-haproxy.md @@ -1,8 +1,6 @@ # Netdata via HAProxy diff --git a/docs/Running-behind-lighttpd.md b/docs/Running-behind-lighttpd.md index 25c62cff4d..8649158002 100644 --- a/docs/Running-behind-lighttpd.md +++ b/docs/Running-behind-lighttpd.md @@ -1,8 +1,6 @@ # Netdata via lighttpd v1.4.x diff --git a/docs/Running-behind-nginx.md b/docs/Running-behind-nginx.md index 35e6c8051a..2f47447da3 100644 --- a/docs/Running-behind-nginx.md +++ b/docs/Running-behind-nginx.md @@ -1,8 +1,6 @@ # Running Netdata behind Nginx diff --git a/docs/a-github-star-is-important.md b/docs/a-github-star-is-important.md index 6730dfecfe..d309d3928a 100644 --- a/docs/a-github-star-is-important.md +++ b/docs/a-github-star-is-important.md @@ -1,8 +1,6 @@ # A GitHub star is important diff --git a/docs/agent-cloud.md b/docs/agent-cloud.md index 2a03582c2b..061b8472db 100644 --- a/docs/agent-cloud.md +++ b/docs/agent-cloud.md @@ -1,9 +1,7 @@ # Use the Agent with Netdata Cloud @@ -76,4 +74,6 @@ about how you might want to use or configure Cloud, we recommend the following: - Follow the 5-minute [get started with Cloud](https://learn.netdata.cloud/docs/cloud/get-started/) guide to finish onboarding and claim your first nodes. - Better understand how agents connect securely to the Cloud with [claiming](/claim/README.md) and [Agent-Cloud - link](/aclk/README.md) documentation. \ No newline at end of file + link](/aclk/README.md) documentation. + +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fagent-cloud&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md index 71c995a519..70c502d063 100644 --- a/docs/anonymous-statistics.md +++ b/docs/anonymous-statistics.md @@ -1,8 +1,7 @@ # Anonymous statistics @@ -106,3 +105,5 @@ Each of these opt-out processes does the following: - Forces the anonymous statistics script to exit immediately. - Stops the Google Tag Manager Javascript snippet, which remains on the dashboard, from firing and sending any data to Google Analytics. + +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fanonymous-statistics&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md new file mode 100644 index 0000000000..06b61d08d1 --- /dev/null +++ b/docs/configuration-guide.md @@ -0,0 +1,211 @@ + + +# Configuration guide + +No configuration is required to run Netdata, but you will find plenty of options to tweak, so that you can adapt it to +your particular needs. + +
Configuration files are placed in `/etc/netdata`. +Depending on your installation method, Netdata will have been installed either directly under `/`, or under `/opt/netdata`. The paths mentioned here and in the documentation in general assume that your installation is under `/`. If it is not, you will find the exact same paths under `/opt/netdata` as well. (i.e. `/etc/netdata` will be `/opt/netdata/etc/netdata`).
+ +Under that directory you will see the following: + +- `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 + be copied from the stock configuration, if and when you customize them using `edit-config`. +- `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). + - `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: + - 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. + - 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) + - `stats.d` is a directory under which you can add .conf files to add [synthetic + 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/) + +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 +will guide you on how to customize your Netdata, based on what you want to do. + +## How to + +### Persist my configuration + +In `http://localhost:19999/netdata.conf`, you will see the following two parameters: + +```bash + # config directory = /etc/netdata + # stock config directory = /usr/lib/netdata/conf.d +``` + +To persist your configurations, don't edit the files under the `stock config directory` directly. Use the `sudo [config +directory]/edit-config` command, or copy the stock config file to its proper place under the `config directory` and edit +it there. + +### Change what I see + +#### 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 guide on [increasing +long-term metrics storage](/docs/guides/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 +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. + +#### Disable a collector + +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) + +#### Show charts with zero metrics + +By default, Netdata will enable monitoring metrics for disks, memory, and network only when they are not zero. If they +are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected +and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear +though). Use `yes` instead of `auto` in plugin configuration sections to enable these charts permanently. You can also +set the `enable zero metrics` option to `yes` in the `[global]` section which enables charts with zero metrics for all +internal Netdata plugins. + +### Modify alarms and notifications + +#### Add a new alarm + +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 +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 + +#### Modify or disable a specific alarm + +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. + +For example, if you click on Alarms and go to the tab 'All', the default Netdata installation will show you at the top +the configured alarm for `10 min cpu usage` (it's the name of the badge). Looking at the table on the right side, you +will see a row that says: `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. This way, you know that you will need +to run `/etc/netdata/edit-config health.d/cpu.conf` and look for alarm at line 4 of the conf file. + +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). + +#### 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` under `Alarm notifications` in the documentation to find the specific page on your preferred notification +method. + +### Make security-related customizations + +#### Change the Netdata web server access lists + +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). + +#### 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. + +### System resource usage + +#### Reduce the resources Netdata uses + +The [Netdata performance guide](/docs/guides/configure/performance.md) outlines many ways 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` + +#### 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]`. + +### Other + +#### Move Netdata directories + +The various directory paths are in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options). + +## How Netdata configuration works + +The configuration files are `name = value` dictionaries with `[sections]`. Write whatever you like there as long as it +follows this simple format. + +Netdata loads this dictionary and then when the code needs a value from it, it just looks up the `name` in the +dictionary at the proper `section`. In all places, in the code, there are both the `names` and their `default values`, +so if something is not found in the configuration file, the default is used. The lookup is made using B-Trees and hashes +(no string comparisons), so they are super fast. Also the `names` of the settings can be `my super duper setting that +once set to yes, will turn the world upside down = no` - so goodbye to most of the documentation involved. + +Next, Netdata can generate a valid configuration for the user to edit. No need to remember anything. Just get the +configuration from the server (`/netdata.conf` on your Netdata server), edit it and save it. + +Last, what about options you believe you have set, but you misspelled?When you get the configuration file from the +server, there will be a comment above all `name = value` pairs the server does not use. So you know that whatever you +wrote there, is not used. + +## Netdata simple patterns + +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/README.md). + +## Netdata labels + +Beginning with 1.20, Netdata accepts user-defined **host labels**. These labels are defined in the section `[host +labels]`. + +Read more about how these labels work and why they're an effective way to organize complex infrasturctures in our +guide: [Use host labels to organize systems, metrics, and alarms](/docs/guides/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: + +- Names cannot start with `_`, but it can be present in other parts of the name. +- Names only accept alphabet letters, numbers, dots, and dashes. + +The policy for values is more flexible, but you can not use exclamation marks (`!`), whitespaces (` `), single quotes +(`'`), double quotes (`"`), or asterisks (`*`), because they are used to compare label values in health alarms and +templates. + +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fconfiguration-guide&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/docs/getting-started.md b/docs/getting-started.md index 74597c10b3..1ccab4247b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,9 +1,7 @@ # Get started guide diff --git a/docs/guides/deploy/ansible.md b/docs/guides/deploy/ansible.md index 887ba5e07a..8298fd00c8 100644 --- a/docs/guides/deploy/ansible.md +++ b/docs/guides/deploy/ansible.md @@ -1,6 +1,6 @@ diff --git a/docs/guides/export/export-netdata-metrics-graphite.md b/docs/guides/export/export-netdata-metrics-graphite.md index 4b11c3b15c..9a4a4f5ca6 100644 --- a/docs/guides/export/export-netdata-metrics-graphite.md +++ b/docs/guides/export/export-netdata-metrics-graphite.md @@ -1,6 +1,6 @@ diff --git a/docs/guides/monitor/dimension-templates.md b/docs/guides/monitor/dimension-templates.md index 5fe3ae9632..da1faed8b4 100644 --- a/docs/guides/monitor/dimension-templates.md +++ b/docs/guides/monitor/dimension-templates.md @@ -1,8 +1,6 @@ # Use dimension templates to create dynamic alarms diff --git a/docs/guides/monitor/stop-notifications-alarms.md b/docs/guides/monitor/stop-notifications-alarms.md index bf897e0f57..587880ab11 100644 --- a/docs/guides/monitor/stop-notifications-alarms.md +++ b/docs/guides/monitor/stop-notifications-alarms.md @@ -1,8 +1,6 @@ # Stop notifications for individual alarms diff --git a/docs/netdata-for-IoT.md b/docs/netdata-for-IoT.md index abd2d5ddda..77b95229fd 100644 --- a/docs/netdata-for-IoT.md +++ b/docs/netdata-for-IoT.md @@ -1,8 +1,6 @@ # Netdata for IoT diff --git a/docs/netdata-security.md b/docs/netdata-security.md index 97b9bae939..e020c0c8d2 100644 --- a/docs/netdata-security.md +++ b/docs/netdata-security.md @@ -1,8 +1,6 @@ # Security design diff --git a/docs/privacy-policy.md b/docs/privacy-policy.md index 561803783a..0152b0e0f5 100644 --- a/docs/privacy-policy.md +++ b/docs/privacy-policy.md @@ -1,8 +1,6 @@ # Privacy Policy diff --git a/docs/terms-of-use.md b/docs/terms-of-use.md index 652dbc97f1..a3cbd0099c 100644 --- a/docs/terms-of-use.md +++ b/docs/terms-of-use.md @@ -1,8 +1,6 @@ # Terms of Use diff --git a/docs/why-netdata/1s-granularity.md b/docs/why-netdata/1s-granularity.md index bd0f9624d1..a2cc65b8f4 100644 --- a/docs/why-netdata/1s-granularity.md +++ b/docs/why-netdata/1s-granularity.md @@ -1,8 +1,6 @@ # 1s granularity diff --git a/docs/why-netdata/README.md b/docs/why-netdata/README.md index d0c3206089..39cda51e23 100644 --- a/docs/why-netdata/README.md +++ b/docs/why-netdata/README.md @@ -1,8 +1,6 @@ # Why Netdata diff --git a/docs/why-netdata/immediate-results.md b/docs/why-netdata/immediate-results.md index 589f6afd1f..ba7c7d684a 100644 --- a/docs/why-netdata/immediate-results.md +++ b/docs/why-netdata/immediate-results.md @@ -1,8 +1,6 @@ # Immediate results diff --git a/docs/why-netdata/meaningful-presentation.md b/docs/why-netdata/meaningful-presentation.md index 4236fae4c5..64d83b4f62 100644 --- a/docs/why-netdata/meaningful-presentation.md +++ b/docs/why-netdata/meaningful-presentation.md @@ -1,8 +1,6 @@ # Meaningful presentation diff --git a/docs/why-netdata/unlimited-metrics.md b/docs/why-netdata/unlimited