summaryrefslogtreecommitdiffstats
path: root/docs/guides
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/configure/performance.md6
-rw-r--r--docs/guides/monitor/anomaly-detection.md4
-rw-r--r--docs/guides/monitor/lamp-stack.md9
-rw-r--r--docs/guides/monitor/process.md4
-rw-r--r--docs/guides/monitor/raspberry-pi-anomaly-detection.md8
-rw-r--r--docs/guides/monitor/statsd.md2
-rw-r--r--docs/guides/python-collector.md2
-rw-r--r--docs/guides/step-by-step/step-10.md2
-rw-r--r--docs/guides/troubleshoot/monitor-debug-applications-ebpf.md2
9 files changed, 23 insertions, 16 deletions
diff --git a/docs/guides/configure/performance.md b/docs/guides/configure/performance.md
index 5f93a8cd4..8e0108979 100644
--- a/docs/guides/configure/performance.md
+++ b/docs/guides/configure/performance.md
@@ -155,6 +155,12 @@ All the settings are found in the `[global]` section of `netdata.conf`:
dbengine multihost disk space = 256
```
+Metric retention is not important in certain use cases, such as:
+ - Data collection nodes stream collected metrics collected to a centralization point.
+ - Data collection nodes export their metrics to another time series DB, or are scraped by Prometheus
+ - Netdata installed only during incidents, to get richer information.
+In such cases, you may not want to use the dbengine at all and instead opt for memory mode `memory mode = ram` or `memory mode = none`.
+
## Run Netdata behind Nginx
A dedicated web server like Nginx provides far more robustness than the Agent's internal [web server](/web/README.md).
diff --git a/docs/guides/monitor/anomaly-detection.md b/docs/guides/monitor/anomaly-detection.md
index 2fa4896c6..f680f5f2e 100644
--- a/docs/guides/monitor/anomaly-detection.md
+++ b/docs/guides/monitor/anomaly-detection.md
@@ -35,7 +35,7 @@ server](https://user-images.githubusercontent.com/1153921/103586700-da5b0a00-4ea
## Prerequisites
-- A node running the Netdata Agent. If you don't yet have that, [get Netdata](/docs/get/README.md).
+- A node running the Netdata Agent. If you don't yet have that, [get Netdata](/docs/get-started.mdx).
- A Netdata Cloud account. [Sign up](https://app.netdata.cloud) if you don't have one already.
- Familiarity with configuring the Netdata Agent with [`edit-config`](/docs/configure/nodes.md).
- _Optional_: An Nginx web server running on the same node to follow the example configuration steps.
@@ -55,7 +55,7 @@ repo](https://github.com/netdata/community/tree/main/netdata-agent-api/netdata-p
sudo su -s /bin/bash netdata
# Install required packages for the netdata user
-pip3 install --user netdata-pandas==0.0.32 numba==0.50.1 scikit-learn==0.23.2 pyod==0.8.3
+pip3 install --user netdata-pandas==0.0.38 numba==0.50.1 scikit-learn==0.23.2 pyod==0.8.3
```
> If the `pip3` command fails, you need to install it. For example, on an Ubuntu system, use `sudo apt install
diff --git a/docs/guides/monitor/lamp-stack.md b/docs/guides/monitor/lamp-stack.md
index f11dfe5bd..95aa03f0b 100644
--- a/docs/guides/monitor/lamp-stack.md
+++ b/docs/guides/monitor/lamp-stack.md
@@ -56,8 +56,8 @@ To follow this tutorial, you need:
## Install the Netdata Agent
-If you don't have the free, open-source [Netdata Agent](/docs/get/README.md) installed on your node yet, get started
-with a [single kickstart command](/packaging/installer/methods/kickstart.md):
+If you don't have the free, open-source Netdata monitoring agent installed on your node yet, get started with a [single
+kickstart command](/docs/get-started.mdx):
```bash
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
@@ -167,8 +167,7 @@ If the Netdata Agent isn't already open in your browser, open a new tab and navi
> If you [signed up](https://app.netdata.cloud/sign-up?cloudRoute=/spaces) for Netdata Cloud earlier, you can also view
> the exact same LAMP stack metrics there, plus additional features, like drag-and-drop custom dashboards. Be sure to
-> [claim your node](/docs/get/README.md#claim-your-node-to-netdata-cloud) to start streaming metrics to your browser
-> through Netdata Cloud.
+> [claim your node](/claim/README.md) to start streaming metrics to your browser through Netdata Cloud.
Netdata automatically organizes all metrics and charts onto a single page for easy navigation. Peek at gauges to see
overall system performance, then scroll down to see more. Click-and-drag with your mouse to pan _all_ charts back and
@@ -240,7 +239,7 @@ source of issues faster with [Metric Correlations](https://learn.netdata.cloud/d
### Related reference documentation
-- [Netdata Agent · Get Netdata](/docs/get/README.md)
+- [Netdata Agent · Get started](/docs/get-started.mdx)
- [Netdata Agent · Apache data collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/apache)
- [Netdata Agent · Web log collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog)
- [Netdata Agent · MySQL data collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql)
diff --git a/docs/guides/monitor/process.md b/docs/guides/monitor/process.md
index 0f7c6861a..d322035b1 100644
--- a/docs/guides/monitor/process.md
+++ b/docs/guides/monitor/process.md
@@ -34,8 +34,8 @@ With Netdata's process monitoring, you can:
## Prerequisites
-- One or more Linux nodes running the [Netdata Agent](/docs/get/README.md). If you need more time to understand
- Netdata before following this guide, see the [infrastructure](/docs/quickstart/infrastructure.md) or
+- One or more Linux nodes running [Netdata](/docs/get-started.mdx). If you need more time to understand Netdata before
+ following this guide, see the [infrastructure](/docs/quickstart/infrastructure.md) or
[single-node](/docs/quickstart/single-node.md) monitoring quickstarts.
- A general understanding of how to [configure the Netdata Agent](/docs/configure/nodes.md) using `edit-config`.
- A Netdata Cloud account. [Sign up](https://app.netdata.cloud) if you don't have one already.
diff --git a/docs/guides/monitor/raspberry-pi-anomaly-detection.md b/docs/guides/monitor/raspberry-pi-anomaly-detection.md
index f5587a89b..90ad763b8 100644
--- a/docs/guides/monitor/raspberry-pi-anomaly-detection.md
+++ b/docs/guides/monitor/raspberry-pi-anomaly-detection.md
@@ -24,8 +24,8 @@ Read on to learn all the steps and enable unsupervised anomaly detection on your
## What you need to get started
- A Raspberry Pi running Raspbian, which we'll call a _node_.
-- The [open-source Netdata Agent](https://github.com/netdata/netdata). If you don't have it installed on your node yet,
- [get it now](/docs/get/README.md).
+- The [open-source Netdata](https://github.com/netdata/netdata) monitoring agent. If you don't have it installed on your
+ node yet, [get started now](/docs/get-started.mdx).
## Install dependencies
@@ -56,7 +56,7 @@ sudo su -s /bin/bash netdata
Then pass in the location to find `llvm` as an environment variable for `pip3`.
```bash
-LLVM_CONFIG=llvm-config-9 pip3 install --user llvmlite numpy==1.20.1 netdata-pandas==0.0.32 numba==0.50.1 scikit-learn==0.23.2 pyod==0.8.3
+LLVM_CONFIG=llvm-config-9 pip3 install --user llvmlite numpy==1.20.1 netdata-pandas==0.0.38 numba==0.50.1 scikit-learn==0.23.2 pyod==0.8.3
```
## Enable the anomalies collector
@@ -121,7 +121,7 @@ feedback on our [community forum](https://community.netdata.cloud/t/anomalies-co
### Related reference documentation
-- [Netdata Agent · Get Netdata](/docs/get/README.md)
+- [Netdata Agent · Get Netdata](/docs/get-started.mdx)
- [Netdata Agent · Anomalies collector](/collectors/python.d.plugin/anomalies/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%2Fdocs%2Fguides%2Fmonitor%2Fraspberry-pi-anomaly-detection&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/docs/guides/monitor/statsd.md b/docs/guides/monitor/statsd.md
index 9b1de3047..120715b19 100644
--- a/docs/guides/monitor/statsd.md
+++ b/docs/guides/monitor/statsd.md
@@ -215,7 +215,7 @@ To enable this StatsD configuration, [restart Netdata](/docs/configure/start-sto
## Final touches
-At this point, you have used StatsD to gather metrics for k6, creating a whole new section in your Netdata dashboard in the process. Uil can further customize the icon of the particular section, as well as the description for each chart.
+At this point, you have used StatsD to gather metrics for k6, creating a whole new section in your Netdata dashboard in the process. Moreover, you can further customize the icon of the particular section, as well as the description for each chart.
To edit the section, please follow the Netdata [documentation](https://learn.netdata.cloud/docs/agent/web/gui#customizing-the-local-dashboard).
diff --git a/docs/guides/python-collector.md b/docs/guides/python-collector.md
index f327da322..0478bffe0 100644
--- a/docs/guides/python-collector.md
+++ b/docs/guides/python-collector.md
@@ -29,7 +29,7 @@ covered here, or use the included examples for collecting and organizing eithre
## What you need to get started
- A physical or virtual Linux system, which we'll call a _node_.
-- A working installation of the free, open-source [Netdata Agent](/docs/get/README.md).
+- A working installation of the free and open-source [Netdata](/docs/get-started.mdx) monitoring agent.
## Jobs and elements of a Python collector
diff --git a/docs/guides/step-by-step/step-10.md b/docs/guides/step-by-step/step-10.md
index 28ab47c67..d1c065c51 100644
--- a/docs/guides/step-by-step/step-10.md
+++ b/docs/guides/step-by-step/step-10.md
@@ -104,6 +104,8 @@ upstream backend {
server {
listen 80;
+ # uncomment the line if you want nginx to listen on IPv6 address
+ #listen [::]:80;
# Change `example.com` to match your domain name.
server_name netdata.example.com;
diff --git a/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md b/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
index 13efa20e8..d6c4b0697 100644
--- a/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
+++ b/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
@@ -91,7 +91,7 @@ Let's turn on the `return` mode for more granularity when debugging Firefox's be
```bash
cd /etc/netdata # Replace this path with your Netdata config directory
-sudo ./edit-config ebpf.conf
+sudo ./edit-config ebpf.d.conf
```
Replace `entry` with `return`: