Docs housekeeping for SEO and syntax, part 1 (#10388)
* First pass to get the script working right * Finish adding analytics tags
Joel Hans committed
Jan 7, 2021 at 11:44 UTC
46a8075c8ff6da974d1b39f5b3b9eb50385892c1
151 files changed
+344
-303
BREAKING_CHANGES.md
+5
-4
@@ -1,10 +1,11 @@
1
<!--
2
----
3
-title: "Breaking Changes"
2
+title: "Breaking changes"
3
+description: "On occasion, the Netdata team must make significant changes to the open-source Netdata Agent. We publish those breaking changes here for reference."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/BREAKING_CHANGES.md
5
----
5
-->
6
8
-# Breaking Changes
7
+# Breaking changes
8
9
- 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)]
10
+
11
+[](<>)
BUILD.md
+1
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "The build system"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/BUILD.md
5
----
4
-->
5
6
# The build system
@@ -364,3 +362,4 @@ Some smaller miscellaeneous suggestions:
362
* [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)
363
* [how to write platform checks](https://gitlab.kitware.com/cmake/community/wikis/doc/tutorials/How-To-Write-Platform-Checks)
364
365
+[](<>)
CODE_OF_CONDUCT.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata Community Code of Conduct"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/CODE_OF_CONDUCT.md
5
----
4
-->
5
6
# Netdata Community Code of Conduct
REDISTRIBUTED.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Redistributed software"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/REDISTRIBUTED.md
5
----
4
-->
5
6
# Redistributed software
SECURITY.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Security Policy"
3
+description: "The Netdata team maintains and adheres to a formal process any time a member of the community reports a security vulnerability."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/SECURITY.md
5
----
5
-->
6
7
# Security Policy
backends/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Metrics long term archiving"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/README.md
5
----
4
-->
5
6
# Metrics long term archiving
backends/TIMESCALE.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Writing metrics to TimescaleDB"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/TIMESCALE.md
5
----
4
-->
5
6
# Writing metrics to TimescaleDB
backends/WALKTHROUGH.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata, Prometheus, Grafana stack"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/WALKTHROUGH.md
5
----
4
-->
5
6
# Netdata, Prometheus, Grafana stack
backends/aws_kinesis/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Using Netdata with AWS Kinesis Data Streams"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/aws_kinesis/README.md
5
----
4
-->
5
6
# Using Netdata with AWS Kinesis Data Streams
backends/mongodb/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "MongoDB backend"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/mongodb/README.md
5
----
4
-->
5
6
# MongoDB backend
backends/opentsdb/README.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "OpenTSDB with HTTP"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/opentsdb/README.md
5
----
4
-->
5
6
# OpenTSDB with HTTP
@@ -36,3 +34,5 @@ After your proxy is configured, make the following changes to `netdata.conf`:
34
35
In this example, we used the port `8082` for our reverse proxy. If your reverse proxy listens on a different port,
36
change the `destination = localhost:8082` line accordingly.
37
+
38
+[]()
backends/prometheus/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Using Netdata with Prometheus"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/prometheus/README.md
5
----
4
-->
5
6
# Using Netdata with Prometheus
backends/prometheus/remote_write/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Prometheus remote write backend"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/prometheus/remote_write/README.md
5
----
4
-->
5
6
# Prometheus remote write backend
build_external/README.md
+1
-2
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "External build-system"
3
date: 2020-03-31
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/build_external/README.md
6
----
5
-->
6
7
# External build-system
@@ -127,3 +125,4 @@ Notes:
125
* There is not yet a good way to configure the target agent container from the docker-compose command line.
126
* Several other containers should be in this compose (a paho client, tshark etc).
127
128
+[]()
claim/README.md
+1
-1
@@ -1,6 +1,6 @@
1
<!--
2
title: "Agent claiming"
3
-description: "Agent claiming allows a Netdata Agent, running on a distributed node, to securely connect to Netdata Cloud. A Space's administrator creates a claiming token, which is used to add an Agent to their Space via the Agent-Cloud link."
3
+description: "Agent claiming allows a Netdata Agent, running on a distributed node, to securely connect to Netdata Cloud via the encrypted Agent-Cloud link (ACLK)."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/claim/README.md
5
-->
6
cli/README.md
+4
-5
@@ -1,13 +1,12 @@
1
<!--
2
----
3
-title: "Netdata cli"
2
+title: "Netdata CLI"
3
+description: "The Netdata Agent includes a command-line experience for reloading health configuration, reopening log files, halting the daemon, and more."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/cli/README.md
5
----
5
-->
6
8
-# Netdata cli
7
+# Netdata CLI
8
10
-You can see the commands netdatacli supports by executing it with `netdatacli` and entering `help` in
9
+You can see the commands `netdatacli` supports by executing it with `netdatacli` and entering `help` in
10
standard input. All commands are given as standard input to `netdatacli`.
11
12
The commands that a running netdata agent can execute are the following:
collectors/QUICKSTART.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Collectors quickstart"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/QUICKSTART.md
5
----
4
-->
5
6
# Collectors quickstart
@@ -123,3 +121,5 @@ popular collectors.
121
Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our
122
[internal plugin API](/collectors/REFERENCE.md#internal-plugins-api) or our [external plugin
123
docs](/collectors/plugins.d/README.md).
124
+
125
+[]()
collectors/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Collecting metrics"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/README.md
5
----
4
-->
5
6
# Collecting metrics
collectors/REFERENCE.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Collectors configuration reference"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md
5
----
4
-->
5
6
# Collectors configuration reference
@@ -184,3 +182,5 @@ through this, is to examine what other similar plugins do.
182
## Write a custom collector
183
184
You can add custom collectors by following the [external plugins documentation](../collectors/plugins.d/).
185
+
186
+[]()
collectors/cgroups.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "cgroups.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md
5
----
4
-->
5
6
# cgroups.plugin
collectors/checks.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "checks.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/checks.plugin/README.md
5
----
4
-->
5
6
# checks.plugin
collectors/cups.plugin/README.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "cups.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md
5
----
4
-->
5
6
# cups.plugin
@@ -60,3 +58,5 @@ For each destination the plugin provides these charts:
58
- processing
59
60
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.
61
+
62
+[]()
collectors/diskspace.plugin/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "diskspace.plugin"
3
+description: "Monitor the disk usage space of mounted disks in real-time with the Netdata Agent, plus preconfigured alarms for disks at risk of filling up."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md
5
----
5
-->
6
7
# diskspace.plugin
collectors/fping.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "fping.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/fping.plugin/README.md
5
----
4
-->
5
6
# fping.plugin
collectors/freebsd.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "freebsd.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md
5
----
4
-->
5
6
# freebsd.plugin
collectors/freeipmi.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "freeipmi.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md
5
----
4
-->
5
6
# freeipmi.plugin
collectors/idlejitter.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "idlejitter.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md
5
----
4
-->
5
6
# idlejitter.plugin
collectors/ioping.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "ioping.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md
5
----
4
-->
5
6
# ioping.plugin
collectors/macos.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "macos.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md
5
----
4
-->
5
6
# macos.plugin
collectors/nfacct.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "nfacct.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md
5
----
4
-->
5
6
# nfacct.plugin
collectors/perf.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "perf.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md
5
----
4
-->
5
6
# perf.plugin
collectors/plugins.d/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "External plugins overview"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/plugins.d/README.md
5
----
4
-->
5
6
# External plugins overview
collectors/proc.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "proc.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md
5
----
4
-->
5
6
# proc.plugin
collectors/python.d.plugin/alarms/README.md
+2
@@ -54,3 +54,5 @@ local:
54
```
55
56
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`
57
+
58
+[]()
collectors/python.d.plugin/am2320/README.md
+2
@@ -50,3 +50,5 @@ Software install:
50
- save the file.
51
- restart the netdata service.
52
- check the dashboard.
53
+
54
+[]()
collectors/python.d.plugin/anomalies/README.md
+2
@@ -225,3 +225,5 @@ If you would like to go deeper on what exactly the anomalies collector is doing
225
- [Mendeley public group](https://www.mendeley.com/community/interesting-anomaly-detection-papers/) with some interesting anomaly detection papers we have been reading.
226
- 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.
227
- Novelty and outlier detection in the [scikit-learn documentation](https://scikit-learn.org/stable/modules/outlier_detection.html).
228
+
229
+[]()
collectors/python.d.plugin/gearman/README.md
+1
-1
@@ -48,4 +48,4 @@ localhost:
48
49
When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`.
50
51
----
51
+[]()
collectors/python.d.plugin/hpssa/README.md
+2
@@ -51,3 +51,5 @@ If `ssacli` cannot be found in the `PATH`, configure it in `hpssa.conf`.
51
```yaml
52
ssacli_path: /usr/sbin/ssacli
53
```
54
+
55
+[]()
collectors/python.d.plugin/riakkv/README.md
+2
@@ -124,3 +124,5 @@ With no explicit configuration given, the module will attempt to connect to
124
The default update frequency for the plugin is set to 2 seconds as Riak
125
internally updates the metrics every second. If we were to update the metrics
126
every second, the resulting graph would contain odd jitter.
127
+
128
+[]()
collectors/slabinfo.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "slabinfo.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md
5
----
4
-->
5
6
# slabinfo.plugin
collectors/statsd.plugin/README.md
+11
-10
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "statsd.plugin"
3
+description: "The Netdata Agent is a fully-featured statsd server that collects metrics from any custom application and visualizes them in real-time."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/README.md
5
----
5
-->
6
7
# statsd.plugin
@@ -219,7 +218,8 @@ The same chart with the `sum` unselected:
218
219
### synthetic statsd charts
220
222
-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.
221
+Use synthetic charts to create dedicated sections on the dashboard to render the charts, with control over the main
222
+menu, the submenus, the charts, the dimensions on each chart, and more.
223
224
Synthetic charts are organized in
225
@@ -229,7 +229,7 @@ Synthetic charts are organized in
229
230
For each application you need to create a `.conf` file in `/etc/netdata/statsd.d`.
231
232
-So, to create the statsd application `myapp`, you can create the file `/etc/netdata/statsd.d/myapp.conf`, with this content:
232
+So, to create the statsd application `myapp`, create the file `/etc/netdata/statsd.d/myapp.conf`, with this content:
233
234
```
235
[app]
@@ -271,9 +271,9 @@ Using the above configuration `myapp` should get its own section on the dashboar
271
272
`[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.
273
274
-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.
274
+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.
275
276
-You can add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters:
276
+Add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters:
277
278
1. the metric name, as it is collected (it has to be matched by the `metrics =` pattern of the app)
279
2. the dimension name, as it should be shown on the chart
@@ -351,12 +351,12 @@ Netdata uses this dictionary as follows:
351
352
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.
353
354
-So, you can use the dictionary in 2 ways:
354
+Use the dictionary in 2 ways:
355
356
1. set `dimension = myapp.metric1 ''` and have at the dictionary `myapp.metric1 = metric1 name`
357
2. set `dimension = myapp.metric1 'm1'` and have at the dictionary `m1 = metric1 name`
358
359
-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}`.
359
+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}`.
360
361
> 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.
362
@@ -389,7 +389,7 @@ To add all response codes of `myapp.api.get` to a chart use this:
389
dimension = pattern 'myapp.api.get.* '' last 1 1
390
```
391
392
-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:
392
+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:
393
394
```
395
[dictionary]
@@ -451,7 +451,8 @@ Using the above, the dimensions will be added as `GET`, `ADD` and `DELETE`.
451
452
## sending statsd metrics from shell scripts
453
454
-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.
454
+Send/update statsd metrics from shell scripts to visualize automated jobs you run on your servers using the Netdata
455
+Agent.
456
457
The command you need to run is:
458
collectors/tc.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "tc.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md
5
----
4
-->
5
6
# tc.plugin
collectors/xenstat.plugin/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "xenstat.plugin"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/xenstat.plugin/README.md
5
----
4
-->
5
6
# xenstat.plugin
contrib/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata contrib"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/README.md
5
----
4
-->
5
6
# Netdata contrib
contrib/sles11/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Spec to build Netdata RPM for sles 11"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/sles11/README.md
5
----
4
-->
5
6
# Spec to build Netdata RPM for sles 11
daemon/README.md
-2
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Netdata daemon"
3
date: 2020-04-29
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/README.md
6
----
5
-->
6
7
# Netdata daemon
daemon/config/README.md
+1
-3
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Daemon configuration"
4
-date: 2020-03-31
3
+description: "The Netdata Agent's daemon is installed preconfigured to collect thousands of metrics every second, but is highly configurable for real-world workloads."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/config/README.md
6
----
5
-->
6
7
# Daemon configuration
database/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Database"
3
+description: "The Netdata Agent leverages multiple, user-configurable time-series databases that use RAM and/or disk to store metrics on any type of node."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/database/README.md
5
----
5
-->
6
7
# Database
diagrams/data_structures/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Data structures"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/diagrams/data_structures/README.md
5
----
4
-->
5
6
# Data structures
docs/Add-more-charts-to-netdata.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Add more charts to Netdata"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-charts-to-netdata.md
5
----
4
-->
5
6
# Add more charts to Netdata
@@ -14,3 +12,5 @@ guide](/collectors/QUICKSTART.md) for more information.
12
13
See the [list of supported collectors](/collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics
14
from.
15
+
16
+[]()
docs/Demo-Sites.md
-2
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Demo sites"
3
date: 2020-03-26
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md
6
----
5
-->
6
7
# Demo sites
docs/Donations-netdata-has-received.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Donations"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Donations-netdata-has-received.md
5
----
4
-->
5
6
# Donations
docs/README.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Read documentation on <https://learn.netdata.cloud>"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/README.md
5
----
4
-->
5
6
# Read documentation on <https://learn.netdata.cloud>
@@ -15,3 +13,5 @@ uses a few extra Markdown features that GitHub doesn't support natively. Other t
13
perfect.
14
15
Now get out there and build an exceptional infrastructure.
16
+
17
+[](<>)
docs/Running-behind-apache.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata via apache's mod_proxy"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md
5
----
4
-->
5
6
# Netdata via apache's mod_proxy
docs/Running-behind-caddy.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata via Caddy"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-caddy.md
5
----
4
-->
5
6
# Netdata via Caddy
docs/Running-behind-haproxy.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata via HAProxy"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-haproxy.md
5
----
4
-->
5
6
# Netdata via HAProxy
docs/Running-behind-lighttpd.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata via lighttpd v1.4.x"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-lighttpd.md
5
----
4
-->
5
6
# Netdata via lighttpd v1.4.x
docs/Running-behind-nginx.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Running Netdata behind Nginx"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-nginx.md
5
----
4
-->
5
6
# Running Netdata behind Nginx
docs/a-github-star-is-important.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "A GitHub star is important"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/a-github-star-is-important.md
5
----
4
-->
5
6
# A GitHub star is important
docs/agent-cloud.md
+3
-3
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Use the Agent with Netdata Cloud"
3
date: 2020-05-04
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/agent-cloud.md
6
----
5
-->
6
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:
74
- Follow the 5-minute [get started with Cloud](https://learn.netdata.cloud/docs/cloud/get-started/) guide to finish
75
onboarding and claim your first nodes.
76
- Better understand how agents connect securely to the Cloud with [claiming](/claim/README.md) and [Agent-Cloud
79
- link](/aclk/README.md) documentation.
\ No newline at end of file
77
+ link](/aclk/README.md) documentation.
78
+
79
+[]()
docs/anonymous-statistics.md
+3
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Anonymous statistics"
3
+description: "The Netdata Agent collects anonymous usage information by default and sends it to Google Analytics for quality assurance and product decisions."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-statistics.md
5
----
5
-->
6
7
# Anonymous statistics
@@ -106,3 +105,5 @@ Each of these opt-out processes does the following:
105
- Forces the anonymous statistics script to exit immediately.
106
- Stops the Google Tag Manager Javascript snippet, which remains on the dashboard, from firing and sending any data to
107
Google Analytics.
108
+
109
+[]()
docs/configuration-guide.md
new
+211
@@ -0,0 +1,211 @@
1
+<!--
2
+title: "Configuration guide"
3
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configuration-guide.md
4
+-->
5
+
6
+# Configuration guide
7
+
8
+No configuration is required to run Netdata, but you will find plenty of options to tweak, so that you can adapt it to
9
+your particular needs.
10
+
11
+<details markdown="1"><summary>Configuration files are placed in `/etc/netdata`.</summary>
12
+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`).</details>
13
+
14
+Under that directory you will see the following:
15
+
16
+- `netdata.conf` is [the main configuration file](/daemon/config/README.md#daemon-configuration)
17
+- `edit-config` is an sh script that you can use to easily and safely edit the configuration. Just run it to see its
18
+ usage.
19
+- Other directories, initially empty, where your custom configurations for alarms and collector plugins/modules will
20
+ be copied from the stock configuration, if and when you customize them using `edit-config`.
21
+- `orig` is a symbolic link to the directory `/usr/lib/netdata/conf.d`, which contains the stock configurations for
22
+ everything not included in `netdata.conf`:
23
+ - `health_alarm_notify.conf` is where you configure how and to who Netdata will send [alarm
24
+ notifications](/health/notifications/README.md#netdata-alarm-notifications).
25
+ - `health.d` is the directory that contains the alarm triggers for [health
26
+ monitoring](/health/README.md#health-monitoring). It contains one .conf file per collector.
27
+ - The [modular plugin orchestrators](/collectors/plugins.d/README.md#external-plugins-overview) have:
28
+ - One config file each, mainly to turn their modules on and off: `python.d.conf` for
29
+ [python](/collectors/python.d.plugin/README.md#pythondplugin), `node.d.conf` for
30
+ [nodejs](/collectors/node.d.plugin/README.md#nodedplugin) and `charts.d.conf` for
31
+ [bash](/collectors/charts.d.plugin/README.md#chartsdplugin) modules.
32
+ - One directory each, where the module-specific configuration files can be found.
33
+ - `stream.conf` is where you configure [streaming and
34
+ replication](/streaming/README.md#streaming-and-replication)
35
+ - `stats.d` is a directory under which you can add .conf files to add [synthetic
36
+ charts](/collectors/statsd.plugin/README.md#synthetic-statsd-charts).
37
+ - Individual collector plugin config files, such as `fping.conf` for the [fping
38
+ plugin](/collectors/fping.plugin/) and `apps_groups.conf` for the [apps plugin](/collectors/apps.plugin/)
39
+
40
+So there are many configuration files to control every aspect of Netdata's behavior. It can be overwhelming at first,
41
+but you won't have to deal with any of them, unless you have specific things you need to change. The following HOWTO
42
+will guide you on how to customize your Netdata, based on what you want to do.
43
+
44
+## How to
45
+
46
+### Persist my configuration
47
+
48
+In `http://localhost:19999/netdata.conf`, you will see the following two parameters:
49
+
50
+```bash
51
+ # config directory = /etc/netdata
52
+ # stock config directory = /usr/lib/netdata/conf.d
53
+```
54
+
55
+To persist your configurations, don't edit the files under the `stock config directory` directly. Use the `sudo [config
56
+directory]/edit-config` command, or copy the stock config file to its proper place under the `config directory` and edit
57
+it there.
58
+
59
+### Change what I see
60
+
61
+#### Increase the long-term metrics retention period
62
+
63
+Increase the values for the `page cache size` and `dbengine disk space` settings in the [`[global]`
64
+section](/daemon/config/README.md#global-section-options) of `netdata.conf`. Read our guide on [increasing
65
+long-term metrics storage](/docs/guides/longer-metrics-storage.md) and the [memory requirements for the database
66
+engine](/database/engine/README.md#memory-requirements).
67
+
68
+#### Reduce the data collection frequency
69
+
70
+Increase `update every` in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options). This is another
71
+way to increase your metrics retention period, but at a lower resolution than the default 1s.
72
+
73
+#### Modify how a chart is displayed
74
+
75
+In `netdata.conf` under `# Per chart configuration` you will find several [\[CHART_NAME\]
76
+sections](/daemon/config/README.md#per-chart-configuration), where you can control all aspects of a specific chart.
77
+
78
+#### Disable a collector
79
+
80
+Entire plugins can be turned off from the [netdata.conf \[plugins\]](/daemon/config/README.md#plugins-section-options)
81
+section. To disable specific modules of a plugin orchestrator, you need to edit one of the following:
82
+
83
+- `python.d.conf` for [python](/collectors/python.d.plugin/README.md)
84
+- `node.d.conf` for [nodejs](/collectors/node.d.plugin/README.md)
85
+- `charts.d.conf` for [bash](/collectors/charts.d.plugin/README.md)
86
+
87
+#### Show charts with zero metrics
88
+
89
+By default, Netdata will enable monitoring metrics for disks, memory, and network only when they are not zero. If they
90
+are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected
91
+and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear
92
+though). Use `yes` instead of `auto` in plugin configuration sections to enable these charts permanently. You can also
93
+set the `enable zero metrics` option to `yes` in the `[global]` section which enables charts with zero metrics for all
94
+internal Netdata plugins.
95
+
96
+### Modify alarms and notifications
97
+
98
+#### Add a new alarm
99
+
100
+You can add a new alarm definition either by editing an existing stock alarm config file under `health.d` (e.g.
101
+`/etc/netdata/edit-config health.d/load.conf`), or by adding a new `.conf` file under `/etc/netdata/health.d`. The
102
+documentation on how to define an alarm is in [health monitoring](/health/README.md). It is
103
+suggested to look at some of the stock alarm definitions, so you can ensure you understand how the various options work.
104
+
105
+#### Turn off all alarms and notifications
106
+
107
+Just set `enabled = no` in the [netdata.conf \[health\]](/daemon/config/README.md#health-section-options) section
108
+
109
+#### Modify or disable a specific alarm
110
+
111
+The `health.d` directory that contains the alarm triggers for [health monitoring](/health/README.md). It has
112
+one .conf file per collector. You can easily find the .conf file you will need to modify, by looking for the "source"
113
+line on the table that appears on the right side of an alarm on the Netdata gui.
114
+
115
+For example, if you click on Alarms and go to the tab 'All', the default Netdata installation will show you at the top
116
+the configured alarm for `10 min cpu usage` (it's the name of the badge). Looking at the table on the right side, you
117
+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
118
+to run `/etc/netdata/edit-config health.d/cpu.conf` and look for alarm at line 4 of the conf file.
119
+
120
+As stated at the top of the .conf file, **you can disable an alarm notification by setting the 'to' line to: silent**.
121
+To modify how the alarm gets triggered, we suggest that you go through the guide on [health
122
+monitoring](/health/README.md#health-monitoring).
123
+
124
+#### Receive notifications using my preferred method
125
+
126
+You only need to configure `health_alarm_notify.conf`. To learn how to do it, read first [alarm
127
+notifications](/health/notifications/README.md#netdata-alarm-notifications) and then open the submenu `Supported
128
+Notifications` under `Alarm notifications` in the documentation to find the specific page on your preferred notification
129
+method.
130
+
131
+### Make security-related customizations
132
+
133
+#### Change the Netdata web server access lists
134
+
135
+You have several options under the [netdata.conf \[web\]](/web/server/README.md#access-lists) section.
136
+
137
+#### Stop sending info to registry.my-netdata.io
138
+
139
+You will need to configure the `[registry]` section in `netdata.conf`. First read the [registry
140
+documentation](/registry/). In it, are instructions on how to [run your own
141
+registry](/registry/README.md#run-your-own-registry).
142
+
143
+#### Change the IP address/port Netdata listens to
144
+
145
+The settings are under the `[web]` section. Look at the [web server
146
+documentation](/web/server/README.md#binding-netdata-to-multiple-ports) for more info.
147
+
148
+### System resource usage
149
+
150
+#### Reduce the resources Netdata uses
151
+
152
+The [Netdata performance guide](/docs/guides/configure/performance.md) outlines many ways to reduce the Netdata
153
+CPU/disk/RAM utilization to levels suitable even for the weakest [IoT devices](/docs/netdata-for-IoT.md).
154
+
155
+#### Change when Netdata saves metrics to disk
156
+
157
+[netdata.conf \[global\]](/daemon/config/README.md#global-section-options): `memory mode`
158
+
159
+#### Prevent Netdata from getting immediately killed when my server runs out of memory
160
+
161
+You can change the Netdata [OOM score](/daemon/README.md#oom-score) in `[global]`.
162
+
163
+### Other
164
+
165
+#### Move Netdata directories
166
+
167
+The various directory paths are in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options).
168
+
169
+## How Netdata configuration works
170
+
171
+The configuration files are `name = value` dictionaries with `[sections]`. Write whatever you like there as long as it
172
+follows this simple format.
173
+
174
+Netdata loads this dictionary and then when the code needs a value from it, it just looks up the `name` in the
175
+dictionary at the proper `section`. In all places, in the code, there are both the `names` and their `default values`,
176
+so if something is not found in the configuration file, the default is used. The lookup is made using B-Trees and hashes
177
+(no string comparisons), so they are super fast. Also the `names` of the settings can be `my super duper setting that
178
+once set to yes, will turn the world upside down = no` - so goodbye to most of the documentation involved.
179
+
180
+Next, Netdata can generate a valid configuration for the user to edit. No need to remember anything. Just get the
181
+configuration from the server (`/netdata.conf` on your Netdata server), edit it and save it.
182
+
183
+Last, what about options you believe you have set, but you misspelled?When you get the configuration file from the
184
+server, there will be a comment above all `name = value` pairs the server does not use. So you know that whatever you
185
+wrote there, is not used.
186
+
187
+## Netdata simple patterns
188
+
189
+Unix prefers regular expressions. But they are just too hard, too cryptic to use, write and understand.
190
+
191
+So, Netdata supports [simple patterns](/libnetdata/simple_pattern/README.md).
192
+
193
+## Netdata labels
194
+
195
+Beginning with 1.20, Netdata accepts user-defined **host labels**. These labels are defined in the section `[host
196
+labels]`.
197
+
198
+Read more about how these labels work and why they're an effective way to organize complex infrasturctures in our
199
+guide: [Use host labels to organize systems, metrics, and alarms](/docs/guides/using-host-labels.md).
200
+
201
+To define a label inside this section, some rules needs to be followed, or Netdata will reject the label. The following
202
+restrictions are applied for label names:
203
+
204
+- Names cannot start with `_`, but it can be present in other parts of the name.
205
+- Names only accept alphabet letters, numbers, dots, and dashes.
206
+
207
+The policy for values is more flexible, but you can not use exclamation marks (`!`), whitespaces (` `), single quotes
208
+(`'`), double quotes (`"`), or asterisks (`*`), because they are used to compare label values in health alarms and
209
+templates.
210
+
211
+[](<>)
docs/getting-started.md
-2
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Get started guide"
3
date: 2020-05-04
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/getting-started.md
6
----
5
-->
6
7
# Get started guide
docs/guides/deploy/ansible.md
+1
-1
@@ -1,6 +1,6 @@
1
<!--
2
title: Deploy Netdata with Ansible
3
-description: Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code.
3
+description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
4
image: /img/seo/guides/deploy/ansible.png
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
6
-->
docs/guides/export/export-netdata-metrics-graphite.md
+1
-1
@@ -1,6 +1,6 @@
1
<!--
2
title: Export and visualize Netdata metrics in Graphite
3
-description: Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis.
3
+description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis."
4
image: /img/seo/guides/export/export-netdata-metrics-graphite.png
5
-->
6
docs/guides/monitor/dimension-templates.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Use dimension templates to create dynamic alarms"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/monitor/health/dimension-templates.md
5
----
4
-->
5
6
# Use dimension templates to create dynamic alarms
docs/guides/monitor/stop-notifications-alarms.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Stop notifications for individual alarms"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/stop-notifications-alarms.md
5
----
4
-->
5
6
# Stop notifications for individual alarms
docs/netdata-for-IoT.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata for IoT"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-for-IoT.md
5
----
4
-->
5
6
# Netdata for IoT
docs/netdata-security.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Security design"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-security.md
5
----
4
-->
5
6
# Security design
docs/privacy-policy.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Privacy Policy"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/privacy-policy.md
5
----
4
-->
5
6
# Privacy Policy
docs/terms-of-use.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Terms of Use"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/terms-of-use.md
5
----
4
-->
5
6
# Terms of Use
docs/why-netdata/1s-granularity.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "1s granularity"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/1s-granularity.md
5
----
4
-->
5
6
# 1s granularity
docs/why-netdata/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Why Netdata"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/README.md
5
----
4
-->
5
6
# Why Netdata
docs/why-netdata/immediate-results.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Immediate results"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/immediate-results.md
5
----
4
-->
5
6
# Immediate results
docs/why-netdata/meaningful-presentation.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Meaningful presentation"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/meaningful-presentation.md
5
----
4
-->
5
6
# Meaningful presentation
docs/why-netdata/unlimited-metrics.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Unlimited metrics"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/unlimited-metrics.md
5
----
4
-->
5
6
# Unlimited metrics
health/notifications/alerta/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "alerta.io"
3
+description: "Send alarm notifications to Alerta to see the latest health status updates from multiple nodes in a single interface."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md
5
----
5
-->
6
7
# alerta.io
health/notifications/awssns/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Amazon SNS"
3
+description: "hello"
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md
5
----
5
-->
6
7
# Amazon SNS
health/notifications/custom/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Custom"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md
5
----
4
-->
5
6
# Custom
health/notifications/discord/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Discordapp.com"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md
5
----
4
-->
5
6
# Discordapp.com
health/notifications/dynatrace/README.md
+2
@@ -32,3 +32,5 @@ The default value is `CUSTOM_INFO`.
32
This is a required parameter.
33
6. Specify the annotation type. This is the source of the Dynatrace event. Put whatever it fits you, for example,
34
_Netdata Alarm_, which is also the default value.
35
+
36
+[]()
health/notifications/email/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Email"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md
5
----
4
-->
5
6
# Email
health/notifications/irc/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "IRC"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md
5
----
4
-->
5
6
# IRC
health/notifications/kavenegar/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Kavenegar"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md
5
----
4
-->
5
6
# Kavenegar
health/notifications/messagebird/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Messagebird"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md
5
----
4
-->
5
6
# Messagebird
health/notifications/pagerduty/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "PagerDuty"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md
5
----
4
-->
5
6
# PagerDuty
health/notifications/prowl/README.md
+2
@@ -25,3 +25,5 @@ the Prowl website after registering.
25
26
Once you have an API key, simply specify that as a recipient for Prowl
27
notifications.
28
+
29
+[]()
health/notifications/pushbullet/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "PushBullet"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md
5
----
4
-->
5
6
# PushBullet
health/notifications/pushover/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "PushOver"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md
5
----
4
-->
5
6
# PushOver
health/notifications/rocketchat/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Rocket.Chat"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md
5
----
4
-->
5
6
# Rocket.Chat
health/notifications/slack/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Slack"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md
5
----
4
-->
5
6
# Slack
health/notifications/smstools3/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "SMS Server Tools 3"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md
5
----
4
-->
5
6
# SMS Server Tools 3
health/notifications/syslog/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Syslog"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md
5
----
4
-->
5
6
# Syslog
health/notifications/telegram/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Telegram"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md
5
----
4
-->
5
6
# Telegram
health/notifications/twilio/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Twilio"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md
5
----
4
-->
5
6
# Twilio
health/notifications/web/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Dashboard"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md
5
----
4
-->
5
6
# Dashboard
libnetdata/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "libnetdata"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/README.md
5
----
4
-->
5
6
# libnetdata
libnetdata/adaptive_resortable_list/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Adaptive Re-sortable List (ARL)"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/adaptive_resortable_list/README.md
5
----
4
-->
5
6
# Adaptive Re-sortable List (ARL)
libnetdata/avl/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "AVL"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/README.md
5
----
4
-->
5
6
# AVL
libnetdata/buffer/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "BUFFER"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/buffer/README.md
5
----
4
-->
5
6
# BUFFER
libnetdata/circular_buffer/README.md
+1
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "circular_buffer"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circular_buffer/README.md
5
----
4
-->
5
6
# Circular Buffer
@@ -11,3 +9,4 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circu
9
and grow up to a maximum size as it fills. Two indices within the structure track the current
10
`read` and `write` position for data.
11
12
+[]()
libnetdata/config/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata ini config files"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/config/README.md
5
----
4
-->
5
6
# Netdata ini config files
libnetdata/json/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "json"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/README.md
5
----
4
-->
5
6
# json
libnetdata/procfile/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "PROCFILE"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procfile/README.md
5
----
4
-->
5
6
# PROCFILE
libnetdata/storage_number/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata storage number"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/storage_number/README.md
5
----
4
-->
5
6
# Netdata storage number
packaging/DISTRIBUTIONS.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata distribution support matrix"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/DISTRIBUTIONS.md
5
----
4
-->
5
6
# Netdata distribution support matrix
packaging/installer/README.md
+2
@@ -249,3 +249,5 @@ issue altogether. Or, you can manually remove one version of OpenSSL to remove t
249
Our current build process has some issues when using certain configurations of the `clang` C compiler on Linux. See [the
250
section on `nonrepresentable section on output`
251
errors](/packaging/installer/methods/manual.md#nonrepresentable-section-on-output-errors) for a workaround.
252
+
253
+[](<>)
packaging/installer/UNINSTALL.md
+1
@@ -1,5 +1,6 @@
1
<!--
2
title: "Uninstall Netdata"
3
+description: "If you are no longer interested in using the Netdata Agent, use the self-contained uninstaller to remove all traces of binaries and configuration files."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/UNINSTALL.md
5
-->
6
packaging/installer/methods/alpine.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Install Netdata on Alpine 3.x"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/alpine.md
5
----
4
-->
5
6
# Install Netdata on Alpine 3.x
@@ -34,3 +32,5 @@ chmod 755 /etc/local.d/netdata.stop
32
# enable the local service to start automatically
33
rc-update add local
34
```
35
+
36
+[](<>)
packaging/installer/methods/cloud-providers.md
+4
-3
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Install Netdata on cloud providers"
3
+description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/cloud-providers.md
5
----
5
-->
6
7
# Install Netdata on cloud providers
@@ -16,7 +15,7 @@ aims to document some of those steps for popular cloud providers.
15
16
> This document is a work-in-progress! If you find new issues specific to a cloud provider, or would like to help
17
> clarify the correct workaround, please [create an
19
-> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request%2C+needs+triage&template=feature_request.md)
18
+> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request.md)
19
> with your process and instructions on using the provider's interface to complete the workaround.
20
21
- [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
@@ -127,3 +126,5 @@ Name: Netdata
126
```
127
128
Click **Add** to apply your new inbound security rule.
129
+
130
+[](<>)
packaging/installer/methods/freebsd.md
+2
@@ -104,3 +104,5 @@ The `netdata-updater.sh` script will update your Agent.
104
| `--disable-x86-sse` | Disable SSE instructions. By default SSE optimizations are enabled|
105
| `--zlib-is-really-here` or `--libs-are-really-here` | If you get errors about missing zlib or libuuid but you know it is available, you might have a broken pkg-config. Use this option to proceed without checking pkg-config|
106
|`--disable-telemetry` | Use this flag to opt-out from our anonymous telemetry progam. (DO_NOT_TRACK=1)|
107
+
108
+[](<>)
packaging/installer/methods/freenas.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Install Netdata on FreeNAS"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freenas.md
5
----
4
-->
5
6
# Install Netdata on FreeNAS
@@ -22,3 +20,5 @@ To start the Netdata service:
20
```sh
21
service netdata start
22
```
23
+
24
+[](<>)
packaging/installer/methods/kickstart-64.md
+3
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Install Netdata with kickstart-static64.sh"
3
+description: "The kickstart-static64.sh script installs a pre-compiled static binary, including all dependencies required to connect to Netdata Cloud, with one command."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart-64.md
5
----
5
-->
6
7
# Install Netdata with kickstart-static64.sh
@@ -93,3 +92,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
92
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
93
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
94
external databases, and more.
95
+
96
+[](<>)
packaging/installer/methods/kickstart.md
+3
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Install Netdata with kickstart.sh"
3
+description: "The kickstart.sh script installs Netdata from source, including all dependencies required to connect to Netdata Cloud, with a single command."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md
5
----
5
-->
6
7
# Install Netdata with kickstart.sh
@@ -76,3 +75,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
75
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
76
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
77
external databases, and more.
78
+
79
+[](<>)
packaging/installer/methods/macos.md
+2
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Install Netdata on macOS"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/macos.md
5
----
4
-->
5
6
# Install Netdata on macOS
@@ -88,3 +86,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
86
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
87
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
88
external databases, and more.
89
+
90
+[](<>)
packaging/installer/methods/manual.md
+3
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Install Netdata on Linux from a Git checkout"
3
+description: "Use the Netdata Agent source code from GitHub, plus helper scripts to set up your system, to install Netdata without packages or binaries."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/manual.md
5
----
5
-->
6
7
# Install Netdata on Linux from a Git checkout
@@ -226,3 +225,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
225
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
226
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
227
external databases, and more.
228
+
229
+[](<>)
packaging/installer/methods/offline.md
+14
-7
@@ -1,24 +1,24 @@
1
<!--
2
----
2
title: "Install Netdata on offline systems"
3
+description: "Install the Netdata Agent on offline/air gapped systems to benefit from real-time, per-second monitoring without connecting to the internet."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/offline.md
5
----
5
-->
6
7
# Install Netdata on offline systems
8
10
-You can install Netdata on systems without internet access, but you need to take a few extra steps to make it work.
9
+The Netdata Agent installs on offline or air gapped systems with a few additional steps.
10
11
By default, the `kickstart.sh` and `kickstart-static64.sh` download Netdata assets, like the precompiled binary and a
13
-few dependencies, using the system's internet connection, but you can also supply these files from the local filesystem.
12
+few dependencies, using the system's internet connection, but the Agent installer can also use equivalent files already
13
+present on the local filesystem.
14
15
First, download the required files. If you're using `kickstart.sh`, you need the Netdata tarball, the checksums, the
16
go.d plugin binary, and the go.d plugin configuration. If you're using `kickstart-static64.sh`, you need only the
17
Netdata tarball and checksums.
18
19
-Download the files you need to a system of yours that's connected to the internet. You can use the commands below, or
20
-visit the [latest Netdata release page](https://github.com/netdata/netdata/releases/latest) and [latest go.d plugin
21
-release page](https://github.com/netdata/go.d.plugin/releases) to download the required files manually.
19
+Download the files you need to a system of yours that's connected to the internet. Use the commands below, or visit the
20
+[latest Netdata release page](https://github.com/netdata/netdata/releases/latest) and [latest go.d plugin release
21
+page](https://github.com/netdata/go.d.plugin/releases) to download the required files manually.
22
23
**If you're using `kickstart.sh`**, use the following commands:
24
@@ -78,6 +78,7 @@ bash kickstart-static64.sh --local-files /tmp/netdata-(version-number-here).gz.r
78
79
## What's next?
80
81
+<<<<<<< HEAD
82
When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
83
[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
84
@@ -86,3 +87,9 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
87
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
88
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
89
external databases, and more.
90
+=======
91
+Or, get the full guided tour of Netdata's capabilities with our [step-by-step
92
+guide](/docs/guides/step-by-step/step-00.md)!
93
+
94
+[]()
95
+>>>>>>> dda27d9c (First pass to get the script working right)
packaging/installer/methods/packages.md
+5
-3
@@ -1,6 +1,6 @@
1
<!--
2
title: "Install Netdata with .deb/.rpm packages"
3
-desciption: "Install the Netdata Agent with Linux packages that support Ubuntu, Debian, Fedora, RHEL, CentOS, openSUSE, and more."
3
+description: "Install the Netdata Agent with Linux packages that support Ubuntu, Debian, Fedora, RHEL, CentOS, openSUSE, and more."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/packages.md
5
-->
6
@@ -25,13 +25,13 @@ packagecloud only provides HTTPS access to repositories they host, which means i
25
repositories are only accessible via HTTPS. This is known to cause issues with some setups that use a caching proxy for
26
package downloads.
27
28
-If you are using such a setup, there are a couple of ways you can work around this:
28
+If you are using such a setup, there are a couple of ways to work around this:
29
30
- Configure your proxy to automatically pass through HTTPS connections without caching them. This is the simplest
31
solution, but means that downloads of Netdata pacakges will not be cached.
32
- Mirror the respository locally on your proxy system, and use that mirror when installing on other systems. This
33
requires more setup and more disk space on the caching host, but it lets you cache the packages locally.
34
-- Some specific caching proxies may have alternative configuration options to deal with these issues. You can find
34
+- Some specific caching proxies may have alternative configuration options to deal with these issues. Find
35
such options in their documentation.
36
37
## What's next?
@@ -44,3 +44,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
44
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
45
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
46
external databases, and more.
47
+
48
+[]()
packaging/installer/methods/pfsense.md
+2
@@ -80,3 +80,5 @@ If you experience an issue with `/usr/bin/install` being absent in pfSense 2.3 o
80
workaround from <https://redmine.pfsense.org/issues/6643>
81
82
**Note:** In pfSense, the Netdata configuration files are located under `/usr/local/etc/netdata`.
83
+
84
+[](<>)
packaging/installer/methods/source.md
+2
-2
@@ -1,7 +1,7 @@
1
<!--
2
title: "Manually build Netdata from source"
3
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/source.md
3
description: "Package maintainers and power users may be interested in manually building Netdata from source without using any of our installation scripts."
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/source.md
5
-->
6
7
# Manually build Netdata from source
@@ -288,4 +288,4 @@ repository](https://github.com/netdata/kernel-collector/blob/master/README.md),
288
which outlines both the required dependencies, as well as multiple
289
options for building the code.
290
291
-[](<>)
291
+[](<>)
packaging/installer/methods/synology.md
+3
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Install Netdata on Synology"
3
+description: "The Netdata Agent can be installed on AMD64-compatible NAS systems using the 64-bit pre-compiled static binary."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md
5
----
5
-->
6
7
# Install Netdata on Synology
@@ -49,3 +48,5 @@ installed. You'll have to do this manually:
48
```
49
50
3. Make sure `/etc/rc.netdata` is executable: `chmod 0755 /etc/rc.netdata`.
51
+
52
+[](<>)
packaging/maintainers/README.md
-2
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Package Maintainers"
3
date: 2020-03-31
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/maintainers/README.md
6
----
5
-->
6
7
# Package Maintainers
packaging/makeself/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Netdata static binary build"
3
+description: "Users can build the static 64-bit binary package that we ship with every release of the open-source Netdata Agent for debugging or specialize purposes."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/makeself/README.md
5
----
5
-->
6
7
# Netdata static binary build
parser/README.md
+3
-1
@@ -144,4 +144,6 @@ Output
144
- The parser is deallocated
145
146
Returns
147
-- none
\ No newline at end of file
147
+- none
148
+
149
+[]()
registry/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Registry"
3
+description: "Netdata utilizes a central registry of machines/person GUIDs, URLs, and opt-in account information to provide unified cross-server dashboards."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/registry/README.md
5
----
5
-->
6
7
# Registry
tests/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Testing"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/README.md
5
----
4
-->
5
6
# Testing
tests/health_mgmtapi/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Health command API tester"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgmtapi/README.md
5
----
4
-->
5
6
# Health command API tester
web/api/badges/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata badges"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/badges/README.md
5
----
4
-->
5
6
# Netdata badges
web/api/exporters/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Exporters"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/README.md
5
----
4
-->
5
6
# Exporters
web/api/exporters/prometheus/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "prometheus exporter"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/prometheus/README.md
5
----
4
-->
5
6
# prometheus exporter
web/api/exporters/shell/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "shell exporter"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/shell/README.md
5
----
4
-->
5
6
# shell exporter
web/api/formatters/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Query formatting"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/README.md
5
----
4
-->
5
6
# Query formatting
web/api/formatters/csv/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "CSV formatter"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/csv/README.md
5
----
4
-->
5
6
# CSV formatter
web/api/formatters/json/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "JSON formatter"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/json/README.md
5
----
4
-->
5
6
# JSON formatter
web/api/formatters/ssv/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "SSV formatter"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/ssv/README.md
5
----
4
-->
5
6
# SSV formatter
web/api/formatters/value/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Value formatter"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/value/README.md
5
----
4
-->
5
6
# Value formatter
web/api/health/README.md
-2
@@ -1,9 +1,7 @@
1
<!--
2
----
2
title: "Health API Calls"
3
date: 2020-04-27
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/health/README.md
6
----
5
-->
6
7
# Health API Calls
web/api/queries/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Database Queries"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/README.md
5
----
4
-->
5
6
# Database Queries
web/api/queries/average/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Average or Mean"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/average/README.md
5
----
4
-->
5
6
# Average or Mean
web/api/queries/des/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "double exponential smoothing"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/des/README.md
5
----
4
-->
5
6
# double exponential smoothing
web/api/queries/incremental_sum/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Incremental Sum (`incremental_sum`)"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/incremental_sum/README.md
5
----
4
-->
5
6
# Incremental Sum (`incremental_sum`)
web/api/queries/max/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Max"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/max/README.md
5
----
4
-->
5
6
# Max
web/api/queries/median/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Median"
3
+description: "Use median in API queries and health entities to find the "middle" value from a sample, eliminating any unwanted spikes in the returned metrics."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/median/README.md
5
----
5
-->
6
7
# Median
web/api/queries/min/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Min"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/min/README.md
5
----
4
-->
5
6
# Min
web/api/queries/ses/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Single (or Simple) Exponential Smoothing (`ses`)"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/ses/README.md
5
----
4
-->
5
6
# Single (or Simple) Exponential Smoothing (`ses`)
web/api/queries/stddev/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "standard deviation (`stddev`)"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/stddev/README.md
5
----
4
-->
5
6
# standard deviation (`stddev`)
web/api/queries/sum/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Sum"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/sum/README.md
5
----
4
-->
5
6
# Sum
web/gui/confluence/README.md
-2
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Atlassian Confluence dashboards"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/confluence/README.md
5
----
4
-->
5
6
# Atlassian Confluence dashboards
web/gui/custom/README.md
+1
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Custom dashboards"
3
+description: "Build custom dashboards with key metrics from one or more nodes running the Netdata Agent and host them anywhere."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/custom/README.md
5
----
5
-->
6
7
# Custom dashboards
web/server/README.md
+9
-10
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "Web server"
3
+description: "The Netdata Agent's local static-threaded web server serves dashboards and real-time visualizations with security and DDoS protection."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/server/README.md
5
----
5
-->
6
7
# Web server
@@ -12,14 +11,14 @@ It uses non-blocking I/O and respects the `keep-alive` HTTP header to serve mult
11
12
## Configuration
13
15
-You can disable the web server by editing `netdata.conf` and setting:
14
+Disable the web server by editing `netdata.conf` and setting:
15
16
```
17
[web]
18
mode = none
19
```
20
22
-With the web server enabled, you can control the number of threads and sockets with the following settings:
21
+With the web server enabled, control the number of threads and sockets with the following settings:
22
23
```
24
[web]
@@ -33,7 +32,7 @@ The `web server max sockets` setting is automatically adjusted to 50% of the max
32
33
### Binding Netdata to multiple ports
34
36
-Netdata can bind to multiple IPs and ports, offering access to different services on each. Up to 100 sockets can be used (you can increase it at compile time with `CFLAGS="-DMAX_LISTEN_FDS=200" ./netdata-installer.sh ...`).
35
+Netdata can bind to multiple IPs and ports, offering access to different services on each. Up to 100 sockets can be used (increase it at compile time with `CFLAGS="-DMAX_LISTEN_FDS=200" ./netdata-installer.sh ...`).
36
37
The ports to bind are controlled via `[web].bind to`, like this:
38
@@ -87,14 +86,14 @@ To enable TLS, provide the path to your certificate and private key in the `[web
86
87
Both files must be readable by the `netdata` user. If either of these files do not exist or are unreadable, Netdata will fall back to HTTP. For a parent-child connection, only the parent needs these settings.
88
90
-For test purposes, you can generate self-signed certificates with the following command:
89
+For test purposes, generate self-signed certificates with the following command:
90
91
```bash
92
openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out cert.pem
93
```
94
95
> If you use 4096 bits for your key and the certificate, Netdata will need more CPU to process the communication.
97
-> `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. You can verify the difference
96
+> `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. Verify the difference
97
> by running:
98
>
99
> ```sh
@@ -103,7 +102,7 @@ openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out
102
103
### Select TLS version
104
106
-Beginning with version 1.21, you can also specify the TLS version and the ciphers that you want to use:
105
+Beginning with version 1.21, specify the TLS version and the ciphers that you want to use:
106
107
```conf
108
[web]
@@ -122,7 +121,7 @@ When the certificates are defined and unless any other options are provided, a N
121
- Redirect all incoming HTTP web server requests to HTTPS. Applies to the dashboard, the API, `netdata.conf` and badges.
122
- Allow incoming child connections to use both unencrypted and encrypted communications for streaming.
123
125
-To change this behavior, you need to modify the `bind to` setting in the `[web]` section of `netdata.conf`. At the end of each port definition, you can append `^SSL=force` or `^SSL=optional`. What happens with these settings differs, depending on whether the port is used for HTTP/S requests, or for streaming.
124
+To change this behavior, you need to modify the `bind to` setting in the `[web]` section of `netdata.conf`. At the end of each port definition, append `^SSL=force` or `^SSL=optional`. What happens with these settings differs, depending on whether the port is used for HTTP/S requests, or for streaming.
125
126
| SSL setting | HTTP requests|HTTPS requests|Unencrypted Streams|Encrypted Streams|
127
|:---------:|:-----------:|:------------:|:-----------------:|:----------------|
@@ -159,7 +158,7 @@ When you start using Netdata with TLS, you may find errors in the Netdata log, w
158
159
Most of the time, these errors are due to incompatibilities between your browser's options related to TLS/SSL protocols and Netdata's internal configuration. The most common error is `error:00000006:lib(0):func(0):EVP lib`.
160
162
-In the near future, Netdata will allow our users to change the internal configuration to avoid similar errors. Until then, we're recommending only the most common and safe encryption protocols, which you can find above.
161
+In the near future, Netdata will allow our users to change the internal configuration to avoid similar errors. Until then, we're recommending only the most common and safe encryption protocols listed above.
162
163
### Access lists
164
web/server/static/README.md
+2
-2
@@ -1,8 +1,7 @@
1
<!--
2
----
2
title: "`static-threaded` web server"
3
+description: "The Netdata Agent's static-threaded web server spawns a fixed nubmer of threads that listen to web requests and uses non-blocking I/O."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/server/static/README.md
5
----
5
-->
6
7
# `static-threaded` web server
@@ -14,4 +13,5 @@ The kernel distributes the incoming requests to them.
13
Each thread uses non-blocking I/O so it can serve any number of web requests in parallel.
14
15
This web server respects the `keep-alive` HTTP header to serve multiple HTTP requests via the same connection.
16
+
17
[](<>)