Clean up and better cross-link new docsv2 documents (#10015)
* Finish cleanup pass * Fixes for Amy
Joel Hans committed
Oct 1, 2020 at 07:49 UTC
82ccdfd45eccf420ab11f4ffbdaf4eb3565c9f31
13 files changed
+86
-65
docs/collect/application-metrics.md
+4
@@ -69,6 +69,10 @@ list](/collectors/COLLECTORS.md#service-and-application-collectors) that can run
69
70
## What's next?
71
72
+If you haven't yet seen the [supported collectors list](/collectors/COLLECTORS.md) give it a once-over for any
73
+additional applications you may want to monitor using Netdata's native collectors, or the [generic Prometheus
74
+collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus).
75
+
76
Collecting all the available metrics on your nodes, and across your entire infrastructure, is just one piece of the
77
puzzle. Next, learn more about Netdata's famous real-time visualizations by [viewing all your nodes at a
78
glance](/docs/visualize/view-all-nodes.md).
docs/collect/container-metrics.md
+7
-5
@@ -70,11 +70,13 @@ your k8s infrastructure.
70
71
- A [Helm chart](https://github.com/netdata/helmchart), which bootstraps a Netdata Agent pod on every node in your
72
cluster, plus an additional parent pod for storing metrics and managing alarm notifications.
73
-- A [service discovery plugin](https://github.com/netdata/agent-service-discovery), which discovers and immediately
74
- monitors 22 different services that might be running inside of your cluster's pods. Service discovery happens
75
- without manual intervention as pods are created, destroyed, or moved between nodes. [Compatible
76
- services](https://github.com/netdata/helmchart#service-discovery-and-supported-services) include Nginx, Apache,
77
- MySQL, CoreDNS, and much more.
73
+- A [service discovery plugin](https://github.com/netdata/agent-service-discovery), which discovers and creates
74
+ configuration files for [compatible
75
+ applications](https://github.com/netdata/helmchart#service-discovery-and-supported-services) and any endpoints
76
+ covered by our [generic Prometheus
77
+ collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus). With these
78
+ configuration files, Netdata collects metrics from any compatible applications as they run _inside_ of a pod.
79
+ Service discovery happens without manual intervention as pods are created, destroyed, or moved between nodes.
80
- A [Kubelet collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubelet), which runs
81
on each node in a k8s cluster to monitor the number of pods/containers, the volume of operations on each container,
82
and more.
docs/collect/system-metrics.md
+6
-3
@@ -39,9 +39,12 @@ collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules
39
[windows_exporter](https://github.com/prometheus-community/windows_exporter), a small Go-based binary that you can run
40
on Windows systems. The WMI collector then gathers metrics from an endpoint created by windows_exporter.
41
42
-First, [install
43
-windows_exporter](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/wmi#configuration) and run it:
44
-`windows_exporter-0.13.0-amd64.exe --collectors.enabled="cpu,memory,net,logical_disk,os,system,logon"`.
42
+First, [download windows_exporter](https://github.com/prometheus-community/windows_exporter#installation) and run it
43
+with the following collectors enabled, changing `0.14.0` to the version you downloaded.
44
+
45
+```powershell
46
+windows_exporter-0.14.0-amd64.exe --collectors.enabled="cpu,memory,net,logical_disk,os,system,logon"
47
+```
48
49
Next, [configure the WMI
50
collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/wmi#configuration) to point to the URL
docs/configure/nodes.md
+5
-7
@@ -40,16 +40,14 @@ Upon installation, the Netdata config directory contains a few files and directo
40
`/usr/lib/netdata/conf.d`, as they are overwritten by updates to the Netdata Agent._
41
- `edit-config` is a shell script used for [editing configuration files](#use-edit-config-to-edit-netdataconf).
42
- `go.d/`, `python.d/`, `charts.d/`, `node.d`/, and `custom-plugins.d/`, which are directories for each of Netdata's
43
- [orchestrators](/collectors/plugins.d/README.md#external-plugins-overview). These directories can each contain
44
- additional `.conf` files for configuring specific collectors.
43
+ [orchestrators](/collectors/plugins.d/README.md). These directories can each contain additional `.conf` files for
44
+ configuring specific collectors.
45
46
## Use `edit-config` to edit `netdata.conf`
47
48
-The best way to edit any configuration file is with `edit-config` script. This script opens existing Netdata
49
-configuration files using your system's `$EDITOR`. If the file doesn't yet exist in your config directory, the script
50
-copies the stock version from `/usr/lib/netdata/conf.d` and opens it for editing.
51
-
52
-`edit-config` is the recommended way to easily and safely edit Netdata's configuration.
48
+The **recommended way to easily and safely edit Netdata's configuration** is with the `edit-config` script. This script
49
+opens existing Netdata configuration files using your system's `$EDITOR`. If the file doesn't yet exist in your config
50
+directory, the script copies the stock version from `/usr/lib/netdata/conf.d` and opens it for editing.
51
52
Run `edit-config` without any options to see details on its usage and a list of all the configuration files you can
53
edit.
docs/configure/secure-nodes.md
+9
-8
@@ -8,7 +8,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/s
8
9
# Secure your nodes
10
11
-Upon installation, the Netdata Agent serves the local dashboard at port `19999`. If the node is accessible to the
11
+Upon installation, the Netdata Agent serves the **local dashboard** at port `19999`. If the node is accessible to the
12
internet at large, anyone can access the dashboard and your node's metrics at `http://NODE:19999`. We made this decision
13
so that the local dashboard was immediately accessible to users, and so that we don't dictate how professionals set up
14
and secure their infrastructures.
@@ -27,9 +27,9 @@ Instead of dictating how to secure your infrastructure, we give you many options
27
that align with your goals and your organization's standards.
28
29
- [Disable the local dashboard](#disable-the-local-dashboard): **Simplest and recommended method** for those who have
30
- added nodes to Netdata Cloud and view metrics there.
31
-- [Restrict access to the local dashboard](#restrict-access-to-the-local-dashboard): Allow dashboard access from only
32
- certain IP addresses, such as a trusted static IP or connections from behind a management LAN. Full support for
30
+ added nodes to Netdata Cloud and view dashboards and metrics there.
31
+- [Restrict access to the local dashboard](#restrict-access-to-the-local-dashboard): Allow local dashboard access from
32
+ only certain IP addresses, such as a trusted static IP or connections from behind a management LAN. Full support for
33
Netdata Cloud.
34
- [Use a reverse proxy](#use-a-reverse-proxy): Password-protect a local dashboard and enable TLS to secure it. Full
35
support for Netdata Cloud.
@@ -39,13 +39,13 @@ that align with your goals and your organization's standards.
39
This is the _recommended method for those who have claimed their nodes to Netdata Cloud_ and prefer viewing real-time
40
metrics using the Nodes view and Cloud dashboards.
41
42
-You can disable the local dashboard entirely but retain the encrypted Agent-Cloud link ([ACLK](/aclk/README.md)) that
42
+You can disable the local dashboard (and API) but retain the encrypted Agent-Cloud link ([ACLK](/aclk/README.md)) that
43
allows you to stream metrics on demand from your nodes via the Netdata Cloud interface. This change mitigates all
44
concerns about revealing metrics and system design to the internet at large, while keeping all the functionality you
45
-need to view metrics and troubleshoot issues.
45
+need to view metrics and troubleshoot issues with Netdata Cloud.
46
47
Open `netdata.conf` with `./edit-config netdata.conf`. Scroll down to the `[web]` section, and find the `mode =
48
-static-threaded` setting. To disable the local dashboard, change this setting to `none`.
48
+static-threaded` setting, and change it to `none`.
49
50
```conf
51
[web]
@@ -97,7 +97,8 @@ The `allow connections from` setting is global and restricts access to the dashb
97
```
98
99
See the [web server](/web/server/README.md#access-lists) docs for additional details about access lists. You can take
100
-access lists one step further by [enabling SSL](/web/server/README.md#enabling-tls-support) to encrypt data in transit.
100
+access lists one step further by [enabling SSL](/web/server/README.md#enabling-tls-support) to encrypt data from local
101
+dashboard in transit. The connection to Netdata Cloud is always secured with TLS.
102
103
## Use a reverse proxy
104
docs/get/README.md
+24
-15
@@ -9,10 +9,10 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/get/README.
9
import { OneLineInstall } from '../src/components/OneLineInstall/'
10
import { Install, InstallBox } from '../src/components/InstallBox/'
11
12
-Netdata uses an open-source monitoring Agent and web application [together](/docs/overview/what-is-netdata.md) to help
13
-you collect every metric, visualize the health of your systems, and troubleshoot complex performance problems. Once
14
-you've signed in to Netdata Cloud and installed the Netdata Agent on all your nodes, you can claim these nodes and see
15
-their real-time metrics on a single interface.
12
+Netdata uses the open-source Netdata Agent and Netdata Cloud web application
13
+[together](/docs/overview/what-is-netdata.md) to help you collect every metric, visualize the health of your nodes, and
14
+troubleshoot complex performance problems. Once you've signed in to Netdata Cloud and installed the Netdata Agent on all
15
+your nodes, you can claim your nodes and see their real-time metrics on a single interface.
16
17
## Sign in to Netdata Cloud
18
@@ -28,7 +28,7 @@ devices. It runs on Linux distributions (**Ubuntu**, **Debian**, **CentOS**, and
28
required.
29
30
> ⚠️ Many distributions ship with third-party packages of Netdata, which we cannot maintain or keep up-to-date. For the
31
-> best experience, use one of the methods described or link to below.
31
+> best experience, use one of the methods described or linked to below.
32
33
The **recommended** way to install the Netdata Agent on a Linux system is our one-line [kickstart
34
script](/packaging/installer/methods/kickstart.md). This script automatically installs dependencies and builds Netdata
@@ -62,18 +62,22 @@ platform to see specific instructions.
62
<InstallBox
63
to="/docs/agent/packaging/installer/methods/cloud-providers"
64
img="/img/index/methods/cloud.svg"
65
+ imgDark="/img/index/methods/cloud-dark.svg"
66
os="Cloud providers (GCP, AWS, Azure)" />
67
<InstallBox
68
to="/docs/agent/packaging/installer/methods/packages"
69
img="/img/index/methods/package.svg"
70
+ imgDark="/img/index/methods/package-dark.svg"
71
os="Linux with .deb/.rpm" />
72
<InstallBox
73
to="/docs/agent/packaging/installer/methods/kickstart-64"
74
img="/img/index/methods/static.svg"
75
+ imgDark="/img/index/methods/static-dark.svg"
76
os="Linux with static 64-bit binary" />
77
<InstallBox
78
to="/docs/agent/packaging/installer/methods/manual"
79
img="/img/index/methods/git.svg"
80
+ imgDark="/img/index/methods/git-dark.svg"
81
os="Linux from Git" />
82
<InstallBox
83
to="/docs/agent/packaging/installer/methods/freebsd"
@@ -94,33 +98,38 @@ connection to Netdata Cloud using the [Agent-Cloud link](/aclk/README.md), and p
98
access to that node.
99
100
When you view a node in Netdata Cloud, the Agent running on that node streams metrics, metadata, and alarm status to
97
-Netdata Cloud, which in turn streams those metrics to your web browser. Netdata Cloud does not store or log metrics or
98
-alarm status.
101
+Netdata Cloud, which in turn streams those metrics to your web browser. Netdata Cloud [does not
102
+store](/docs/store/distributed-data-architecture.md#does-netdata-cloud-store-my-metrics) or log metrics values.
103
104
To claim a node, you need to run the claiming script. In Netdata Cloud, click on your Space's name, then **Manage your
105
Space** in the dropdown. Click **Nodes** in the panel that appears. Copy the script and run it in your node's terminal.
102
-For example:
106
+The script looks like the following, with long strings instead of `TOKEN` and `ROOM1,ROOM2`:
107
108
```bash
109
sudo netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud
110
```
111
108
-The script should return `Agent was successfully claimed.` after creating a new RSA pair and establishing the link to
109
-Netdata Cloud.
112
+The script returns `Agent was successfully claimed.` after creating a new RSA pair and establishing the link to Netdata
113
+Cloud. If the script returns an error, try our [troubleshooting tips](/claim/README.md#troubleshooting).
114
111
-For more information on the claiming process, why we implemented it, and how it works, see the [claim](/claim/README.md)
112
-and [Agent-Cloud link](/aclk/README.md) reference docs.
115
+> 💡 Our claiming reference guide also contains instructions for claiming [Docker
116
+> containers](/claim/README.md#claim-an-agent-running-in-docker), [Kubernetes cluster parent
117
+> pods](/claim/README.md#claim-an-agent-running-in-docker), via a [proxy](/claim/README.md#claim-through-a-proxy), and
118
+> more.
119
120
<details>
121
<summary>Watch how claiming nodes works</summary>
122
<iframe width="820" height="460" src="https://www.youtube.com/embed/UAzVvhMab8g" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
123
</details>
124
125
+For more information on the claiming process, why we implemented it, and how it works, see the [claim](/claim/README.md)
126
+and [Agent-Cloud link](/aclk/README.md) reference docs.
127
+
128
## What's next?
129
121
-At this point, you have set up your free Netdata Cloud account, installed the Agent, and claimed one or more nodes to
122
-your Space. You're ready to start monitoring, visualizing, and troubleshooting with Netdata. We have two quickstart
123
-guides based on the scope of what you need to monitor:
130
+At this point, you have set up your free Netdata Cloud account, installed the Netdata Agent on your node(s), and claimed
131
+one or more nodes to your Space. You're ready to start monitoring, visualizing, and troubleshooting with Netdata. We
132
+have two quickstart guides based on the scope of what you need to monitor.
133
134
Interested in monitoring a single node? Check out our [single-node monitoring
135
quickstart](/docs/quickstart/single-node.md).
docs/monitor/configure-alarms.md
+3
-5
@@ -60,10 +60,8 @@ Save the file and [reload Netdata's health configuration](#reload-health-configu
60
61
### Silence an individual alarm
62
63
-Many Netdata users don't need all the default alarms enabled. Instead of disabling any given alarm, or even _all_
64
-alarms, you can silence individual alarms by changing one line in a given health entity.
65
-
66
-To silence any single alarm, change the `to:` line to `silent`.
63
+Instead of disabling an alarm altogether, or even disabling _all_ alarms, you can silence individual alarms by changing
64
+one line in a given health entity. To silence any single alarm, change the `to:` line in its entity to `silent`.
65
66
```yaml
67
to: silent
@@ -72,7 +70,7 @@ To silence any single alarm, change the `to:` line to `silent`.
70
## Write a new health entity
71
72
While tuning existing alarms may work in some cases, you may need to write entirely new health entities based on how
75
-your systems and applications work.
73
+your systems, containers, and applications work.
74
75
Read Netdata's [health reference](/health/REFERENCE.md#health-entity-reference) for a full listing of the format,
76
syntax, and functionality of health entities.
docs/monitor/view-active-alarms.md
+8
-8
@@ -16,25 +16,25 @@ active alarms in both the local dashboard and Netdata Cloud.
16
17
You can see active alarms from any node in your infrastructure in two ways: Click on the bell 🔔 icon in the top
18
navigation, or click on the first column of any node's row in Nodes. This column's color changes based on the node's
19
-health status: gray is `CLEAR`, yellow is `WARNING`, and red is `CRITICAL`.
19
+[health status](/health/REFERENCE.md#alarm-statuses): gray is `CLEAR`, yellow is `WARNING`, and red is `CRITICAL`.
20
21
-
21
+
23
24
The Alarms panel lists all active alarms for nodes within that War Room, and tells you which chart triggered the alarm,
25
what that chart's current value is, the alarm that triggered it, and when the alarm status first began.
26
27
-You can use the input field in the Alarms panel to filter active alarms. You can sort by the node's name, alarm, status,
28
-chart that triggered the alarm, or the operating system. Read more about the [filtering
27
+Use the input field in the Alarms panel to filter active alarms. You can sort by the node's name, alarm, status, chart
28
+that triggered the alarm, or the operating system. Read more about the [filtering
29
syntax](/docs/visualize/view-all-nodes.md#filter-and-group-your-infrastructure) to build valuable filters for your
30
infrastructure.
31
32
Click on the 3-dot icon (`⋮`) to view active alarm information or navigate directly to the offending chart in that
33
node's Cloud dashboard with the **Go to chart** button.
34
35
-The active alarm information gives you in-depth information about the alarm that's been triggered. You can see the
36
-alarm's configuration, how it calculates warning or critical alarms, and which configuration file you could edit on that
37
-node if you want to tweak or disable the alarm to better suit your needs.
35
+The active alarm information gives you details about the alarm that's been triggered. You can see the alarm's
36
+configuration, how it calculates warning or critical alarms, and which configuration file you could edit on that node if
37
+you want to tweak or disable the alarm to better suit your needs.
38
39
docs/overview/what-is-netdata.md
+4
-3
@@ -10,7 +10,7 @@ Netdata helps sysadmins, SREs, DevOps engineers, and IT professionals collect al
10
applications, visualize these metrics in real-time, and troubleshoot complex performance problems.
11
12
Netdata's solution uses two components, the Netdata Agent and Netdata Cloud, to deliver real-time performance and health
13
-monitoring for both single nodes and entire infrastructures.
13
+monitoring for both single nodes and entire infrastructure.
14
15
## Netdata Agent
16
@@ -18,8 +18,9 @@ Netdata's distributed monitoring Agent collects thousands of metrics from system
18
configuration. It runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT
19
devices.
20
21
-You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms
22
-(Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` required.
21
+You can [install](/docs/get/README.md#install-the-netdata-agent) Netdata on most Linux distributions (Ubuntu, Debian,
22
+CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems
23
+(FreeBSD, macOS), with no `sudo` required.
24
25
docs/overview/why-netdata.md
+1
-1
@@ -14,7 +14,7 @@ Netdata is:
14
15
## Simple to deploy
16
17
-- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures
17
+- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures.
18
- **Zero configuration and maintenance** required to collect thousands of metrics, every second, from the underlying
19
OS and running applications.
20
- **Prebuilt charts and alarms** alert you to common anomalies and performance issues without manual configuration.
docs/quickstart/infrastructure.md
+10
-5
@@ -9,17 +9,22 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/
9
10
Together, the Netdata Agent and Netdata Cloud create a powerful, infinitely-scalable infrastructure monitoring solution.
11
12
-The Netdata Agent uses zero-configuration collectors to gather metrics from every application and container instantly.
13
-The distributed data model lets you monitor everything without a slow and troublesome centralized data lake for your
14
-infrastructure's metrics, reducing the resources you need to invest in metrics retention. Netdata Cloud unifies all the
15
-metrics from these distributed nodes on customizable, interactive, and real-time visualizations.
12
+The Netdata Agent uses zero-configuration collectors to gather metrics from every application and container instantly,
13
+and uses Netdata's [distributed data architecture](/docs/store/distributed-data-architecture.md) to store metrics
14
+locally. Without a slow and troublesome centralized data lake for your infrastructure's metrics, you reduce the
15
+resources you need to invest in, and the complexity of, monitoring your infrastructure.
16
+
17
+Netdata Cloud unifies monitoring your infrastructure by _centralizing the interface_ you use to query and visualize your
18
+nodes' metrics, not the data. By streaming metrics values to your browser, with Netdata Cloud acting as the secure proxy
19
+between them, you can monitor your infrastructure using customizable, interactive, and real-time visualizations from any
20
+numbe of distributed nodes.
21
22
In this quickstart guide, you'll learn how to see key metrics from all your nodes in one interface and build your first
23
dashboard for aggregating like metrics from many distributed nodes. You'll then take a peek into configuring individual
24
nodes and get helpful pointers about collecting all the metrics from every critical application in your infrastructure.
25
26
> This quickstart assumes you've installed the Netdata Agent on more than one node in your infrastructure, and claimed
22
-> that node to your Space in Netdata Cloud. If you haven't yet, see the [_Get Netdata_ doc](/docs/get/README.md) for
27
+> those nodes to your Space in Netdata Cloud. If you haven't yet, see the [_Get Netdata_ doc](/docs/get/README.md) for
28
> details on installation and claiming.
29
30
## See your infrastructure's metrics
docs/store/distributed-data-architecture.md
+1
-1
@@ -9,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/store/distr
9
Netdata uses a distributed data architecture to help you collect and store per-second metrics from any number of nodes.
10
Every node in your infrastructure, whether it's one or a thousand, stores the metrics it collects.
11
12
-Netdata Cloud bridges the gap between many distributed databases by _centralizing the interface you use_ to query and
12
+Netdata Cloud bridges the gap between many distributed databases by _centralizing the interface_ you use to query and
13
visualize your nodes' metrics. When you [look at charts in Netdata
14
Cloud](/docs/visualize/interact-dashboards-charts.md), the metrics values are queried directly from that node's database
15
and securely streamed to Netdata Cloud, which proxies them to your browser.
docs/visualize/view-all-nodes.md
+4
-4
@@ -54,15 +54,15 @@ Nodes](https://user-images.githubusercontent.com/1153921/93496405-03d83180-f8c4-
54
## Filter and group your infrastructure
55
56
Use the filter input next to the Nodes heading to filter the nodes in a given War Room. The filtering feature supports
57
-relational operators (==, !=, contains, and !contains) and logical operators (AND, OR), plus the name, OS, or services
58
-running on your nodes to quickly turn any War Room into a focused troubleshooting interface. See what services Netdata
59
-Cloud can filter by in the [supported collectors list](/collectors/COLLECTORS.md).
57
+relational operators (`==`, `!=`, `contains`, and `!contains`) and logical operators (`AND`, `OR`), plus the name, OS,
58
+or services running on your nodes to quickly turn any War Room into a focused troubleshooting interface. See what
59
+services Netdata Cloud can filter by in the [supported collectors list](/collectors/COLLECTORS.md).
60
61
For example, `name == centos OR os == debian` filters any nodes by the exact name centos or has Debian as its operating
62
system.
63
64
You can also use parentheses around operators to create more sophisticated filters. `(name contains aws AND os contains
65
-ubuntu) OR services == apache` shows only nodes that have aws in the hostname and are Ubuntu-based, or any nodes that
65
+ubuntu) OR services == apache` shows only nodes that have `aws` in the hostname and are Ubuntu-based, or any nodes that
66
have an Apache webserver running on them.
67
68
![Filtering a War Room in Netdata