Covert our documentation links to GH absolute links (#14344)
Signed-off-by: Tasos Katsoulas <tasos@netdata.cloud>
Tasos Katsoulas committed
Feb 2, 2023 at 15:23 UTC
9f1403de7d3ea2633768d34095afcf880c7c4e2d
221 files changed
+2647
-2253
README.md
+21
-21
@@ -22,7 +22,7 @@ It gives you the ability to automatically identify processes, collect and store
22
23
[Netdata Cloud](https://www.netdata.cloud) is a hosted web interface that gives you **Free**, real-time visibility into your **Entire Infrastructure** with secure access to your Netdata Agents. It provides an ability to automatically route your requests to the most relevant agents to display your metrics, based on the stored metadata (Agents topology, what metrics are collected on specific Agents as well as the retention information for each metric).
24
25
-It gives you some extra features, like [Metric Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations), [Anomaly Advisor](https://learn.netdata.cloud/docs/cloud/insights/anomaly-advisor), [anomaly rates on every chart](https://blog.netdata.cloud/anomaly-rate-in-every-chart/) and much more.
25
+It gives you some extra features, like [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md), [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx), [anomaly rates on every chart](https://blog.netdata.cloud/anomaly-rate-in-every-chart/) and much more.
26
27
Try it for yourself right now by checking out the Netdata Cloud [demo space](https://app.netdata.cloud/spaces/netdata-demo/rooms/all-nodes/overview) (No sign up or login needed).
28
@@ -77,7 +77,7 @@ Here's what you can expect from Netdata:
77
synchronize charts as you pan through time, zoom in on anomalies, and more.
78
- **Visual anomaly detection**: Our UI/UX emphasizes the relationships between charts to help you detect the root
79
cause of anomalies.
80
-- **Machine learning (ML) features out of the box**: Unsupervised ML-based [anomaly detection](https://learn.netdata.cloud/docs/cloud/insights/anomaly-advisor), every second, every metric, zero-config! [Metric correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations) to help with short-term change detection. And other [additional](https://learn.netdata.cloud/guides/monitor/anomaly-detection) ML-based features to help make your life easier.
80
+- **Machine learning (ML) features out of the box**: Unsupervised ML-based [anomaly detection](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx), every second, every metric, zero-config! [Metric correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to help with short-term change detection. And other [additional](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection.md) ML-based features to help make your life easier.
81
- **Scales to infinity**: You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not
82
centralized by default, so there is no limit.
83
- **Several operating modes**: Autonomous host monitoring (the default), headless data collector, forwarding proxy,
@@ -88,17 +88,17 @@ Netdata works with tons of applications, notifications platforms, and other time
88
89
- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
90
immediately visualize them into meaningful charts designed for troubleshooting. See [everything we
91
- support](https://learn.netdata.cloud/docs/agent/collectors/collectors).
91
+ support](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
92
- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
93
- platform](https://learn.netdata.cloud/docs/monitor/enable-notifications) to inform you of anomalies just seconds
93
+ platform](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to inform you of anomalies just seconds
94
after they affect your node.
95
- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
96
- Cloud-based databases](https://learn.netdata.cloud/docs/export/external-databases) for best-in-class
96
+ Cloud-based databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) for best-in-class
97
interoperability.
98
99
> 💡 **Want to leverage the monitoring power of Netdata across entire infrastructure**? View metrics from
100
> any number of distributed nodes in a single interface and unlock even more
101
-> [features](https://learn.netdata.cloud/docs/overview/why-netdata) with [Netdata
101
+> [features](https://github.com/netdata/netdata/blob/master/docs/overview/why-netdata.md) with [Netdata
102
> Cloud](https://learn.netdata.cloud/docs/overview/what-is-netdata#netdata-cloud).
103
104
## Get Netdata
@@ -117,7 +117,7 @@ Netdata works with tons of applications, notifications platforms, and other time
117
118
### Infrastructure view
119
120
-Due to the distributed nature of the Netdata ecosystem, it is recommended to setup not only one Netdata Agent on your production system, but also an additional Netdata Agent acting as a [Parent](https://learn.netdata.cloud/docs/agent/streaming). A local Netdata Agent (child), without any database or alarms, collects metrics and sends them to another Netdata Agent (parent). The same parent can collect data for any number of child nodes and serves as a centralized health check engine for each child by triggering alerts on their behalf.
120
+Due to the distributed nature of the Netdata ecosystem, it is recommended to setup not only one Netdata Agent on your production system, but also an additional Netdata Agent acting as a [Parent](https://github.com/netdata/netdata/blob/master/streaming/README.md). A local Netdata Agent (child), without any database or alarms, collects metrics and sends them to another Netdata Agent (parent). The same parent can collect data for any number of child nodes and serves as a centralized health check engine for each child by triggering alerts on their behalf.
121
122
123
@@ -127,7 +127,7 @@ Community version is free to use forever. No restriction on number of nodes, clu
127
128
#### Claiming existing Agents
129
130
-You can easily [connect (claim)](https://learn.netdata.cloud/docs/agent/claim) your existing Agents to the Cloud to unlock features for free and to find weaknesses before they turn into outages.
130
+You can easily [connect (claim)](https://github.com/netdata/netdata/blob/master/claim/README.md) your existing Agents to the Cloud to unlock features for free and to find weaknesses before they turn into outages.
131
132
### Single Node view
133
@@ -138,7 +138,7 @@ installation script](https://learn.netdata.cloud/docs/agent/packaging/installer/
138
and builds all dependencies, including those required to connect to [Netdata Cloud](https://netdata.cloud/cloud) if you
139
choose, and enables [automatic nightly
140
updates](https://learn.netdata.cloud/docs/agent/packaging/installer#nightly-vs-stable-releases) and [anonymous
141
-statistics](https://learn.netdata.cloud/docs/agent/anonymous-statistics).
141
+statistics](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md).
142
<!-- candidate for reuse -->
143
```bash
144
wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
@@ -149,7 +149,7 @@ To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://
149
### Docker
150
151
You can also try out Netdata's capabilities in a [Docker
152
-container](https://learn.netdata.cloud/docs/agent/packaging/docker/):
152
+container](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md):
153
154
```bash
155
docker run -d --name=netdata \
@@ -173,16 +173,16 @@ To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://
173
### Other operating systems
174
175
See our documentation for [additional operating
176
-systems](/packaging/installer/README.md#have-a-different-operating-system-or-want-to-try-another-method), including
177
-[Kubernetes](/packaging/installer/methods/kubernetes.md), [`.deb`/`.rpm`
178
-packages](/packaging/installer/methods/kickstart.md#native-packages), and more.
176
+systems](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#have-a-different-operating-system-or-want-to-try-another-method), including
177
+[Kubernetes](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md), [`.deb`/`.rpm`
178
+packages](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md#native-packages), and more.
179
180
### Post-installation
181
182
-When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
183
-[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
182
+When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
183
+[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
184
185
-Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
185
+Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
186
187
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
188
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
@@ -215,7 +215,7 @@ to collect metrics, troubleshoot via charts, export to external databases, and m
215
216
## Community
217
218
-Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://learn.netdata.cloud/contribute/code-of-conduct).
218
+Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
219
220
Find most of the Netdata team in our [community forums](https://community.netdata.cloud). It's the best place to
221
ask questions, find resources, and engage with passionate professionals. The team is also available and active in our [Discord](https://discord.com/invite/mPZ6WZKKG2) too.
@@ -235,18 +235,18 @@ You can also find Netdata on:
235
236
Contributions are the lifeblood of open-source projects. While we continue to invest in and improve Netdata, we need help to democratize monitoring!
237
238
-- Read our [Contributing Guide](https://learn.netdata.cloud/contribute/handbook), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums!
238
+- Read our [Contributing Guide](https://github.com/netdata/.github/blob/main/CONTRIBUTING.md), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums!
239
- We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9)
240
- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=%5BBug%5D%3A+).
241
- View our [Security Policy](https://github.com/netdata/netdata/security/policy).
242
243
-Package maintainers should read the guide on [building Netdata from source](/packaging/installer/methods/source.md) for
243
+Package maintainers should read the guide on [building Netdata from source](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md) for
244
instructions on building each Netdata component from source and preparing a package.
245
246
## License
247
248
-The Netdata Agent is [GPLv3+](/LICENSE). Netdata re-distributes other open-source tools and libraries. Please check the
249
-[third party licenses](/REDISTRIBUTED.md).
248
+The Netdata Agent is [GPLv3+](https://github.com/netdata/netdata/blob/master/LICENSE). Netdata re-distributes other open-source tools and libraries. Please check the
249
+[third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).
250
251
## Is it any good?
252
aclk/README.md
+10
-10
@@ -29,8 +29,8 @@ this is not an option in your case always verify the current domain resolution (
29
:::
30
31
For a guide to connecting a node using the ACLK, plus additional troubleshooting and reference information, read our [get
32
-started with Cloud](https://learn.netdata.cloud/docs/cloud/get-started) guide or the full [connect to Cloud
33
-documentation](/claim/README.md).
32
+started with Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx) guide or the full [connect to Cloud
33
+documentation](https://github.com/netdata/netdata/blob/master/claim/README.md).
34
35
## Data privacy
36
[Data privacy](https://netdata.cloud/privacy/) is very important to us. We firmly believe that your data belongs to
@@ -41,7 +41,7 @@ The data passes through our systems, but it isn't stored.
41
42
However, to be able to offer the stunning visualizations and advanced functionality of Netdata Cloud, it does store a limited number of _metadata_.
43
44
-Read more about [Data privacy in the Netdata Cloud](https://learn.netdata.cloud/docs/cloud/data-privacy) in the documentation.
44
+Read more about [Data privacy in the Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/data-privacy.mdx) in the documentation.
45
46
47
## Enable and configure the ACLK
@@ -57,7 +57,7 @@ configuration uses two settings:
57
```
58
59
If your Agent needs to use a proxy to access the internet, you must [set up a proxy for
60
-connecting to cloud](/claim/README.md#connect-through-a-proxy).
60
+connecting to cloud](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-through-a-proxy).
61
62
You can configure following keys in the `netdata.conf` section `[cloud]`:
63
```
@@ -76,8 +76,8 @@ You have two options if you prefer to disable the ACLK and not use Netdata Cloud
76
### Disable at installation
77
78
You can pass the `--disable-cloud` parameter to the Agent installation when using a kickstart script
79
-([kickstart.sh](/packaging/installer/methods/kickstart.md), or a [manual installation from
80
-Git](/packaging/installer/methods/manual.md).
79
+([kickstart.sh](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md), or a [manual installation from
80
+Git](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md).
81
82
When you pass this parameter, the installer does not download or compile any extra libraries. Once running, the Agent
83
kills the thread responsible for the ACLK and connecting behavior, and behaves as though the ACLK, and thus Netdata Cloud,
@@ -131,12 +131,12 @@ Restart your Agent to disable the ACLK.
131
### Re-enable the ACLK
132
133
If you first disable the ACLK and any Cloud functionality and then decide you would like to use Cloud, you must either
134
-[reinstall Netdata](/packaging/installer/REINSTALL.md) with Cloud enabled or change the runtime setting in your
134
+[reinstall Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md) with Cloud enabled or change the runtime setting in your
135
`cloud.conf` file.
136
137
If you passed `--disable-cloud` to `netdata-installer.sh` during installation, you must
138
-[reinstall](/packaging/installer/REINSTALL.md) your Agent. Use the same method as before, but pass `--require-cloud` to
139
-the installer. When installation finishes you can [connect your node](/claim/README.md#how-to-connect-a-node).
138
+[reinstall](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md) your Agent. Use the same method as before, but pass `--require-cloud` to
139
+the installer. When installation finishes you can [connect your node](https://github.com/netdata/netdata/blob/master/claim/README.md#how-to-connect-a-node).
140
141
If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf` file, edit the file again and change
142
`enabled` to `yes`:
@@ -146,6 +146,6 @@ If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf`
146
enabled = yes
147
```
148
149
-Restart your Agent and [connect your node](/claim/README.md#how-to-connect-a-node).
149
+Restart your Agent and [connect your node](https://github.com/netdata/netdata/blob/master/claim/README.md#how-to-connect-a-node).
150
151
claim/README.md
+23
-23
@@ -12,10 +12,10 @@ learn_rel_path: "Setup"
12
13
You can securely connect a Netdata Agent, running on a distributed node, to Netdata Cloud. A Space's
14
administrator creates a **claiming token**, which is used to add an Agent to their Space via the [Agent-Cloud link
15
-(ACLK)](/aclk/README.md).
15
+(ACLK)](https://github.com/netdata/netdata/blob/master/aclk/README.md).
16
17
Are you just starting out with Netdata Cloud? See our [get started with
18
-Cloud](https://learn.netdata.cloud/docs/cloud/get-started) guide for a walkthrough of the process and simplified
18
+Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) guide for a walkthrough of the process and simplified
19
instructions.
20
21
When connecting an agent (also referred to as a node) to Netdata Cloud, you must complete a verification process that proves you have some level of authorization to manage the node itself. This verification is a security feature that helps prevent unauthorized users from seeing the data on your node.
@@ -26,13 +26,13 @@ Netdata Cloud.
26
> The connection process ensures no third party can add your node, and then view your node's metrics, in a Cloud account,
27
> Space, or War Room that you did not authorize.
28
29
-By connecting a node, you opt-in to sending data from your Agent to Netdata Cloud via the [ACLK](/aclk/README.md). This
29
+By connecting a node, you opt-in to sending data from your Agent to Netdata Cloud via the [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md). This
30
data is encrypted by TLS while it is in transit. We use the RSA keypair created during the connection process to authenticate the
31
identity of the Netdata Agent when it connects to the Cloud. While the data does flow through Netdata Cloud servers on its way
32
from Agents to the browser, we do not store or log it.
33
34
You can connect a node during the Netdata Cloud onboarding process, or after you created a Space by clicking on **Connect
35
-Nodes** in the [Spaces management area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
35
+Nodes** in the [Spaces management area](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx#manage-spaces).
36
37
There are two important notes regarding connecting nodes:
38
@@ -46,7 +46,7 @@ There will be three main flows from where you might want to connect a node to Ne
46
* when you are on an [
47
War Room](#empty-war-room) and you want to connect your first node
48
* when you are at the [Manage Space](#manage-space-or-war-room) area and you select **Connect Nodes** to connect a node, coming from Manage Space or Manage War Room
49
-* when you are on the [Nodes view page](https://learn.netdata.cloud/docs/cloud/visualize/nodes) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
49
+* when you are on the [Nodes view page](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
50
51
Please note that only the administrators of a Space in Netdata Cloud can view the claiming token and accompanying script, generated by Netdata Cloud, to trigger the connection process.
52
@@ -70,11 +70,11 @@ finished onboarding.
70
To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy and paste the script
71
given by Netdata Cloud into your node's terminal.
72
73
-When coming from [Nodes view page](https://learn.netdata.cloud/docs/cloud/visualize/nodes) the room parameter is already defined to current War Room.
73
+When coming from [Nodes view page](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) the room parameter is already defined to current War Room.
74
75
### Connect an agent running in Linux
76
77
-If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
77
+If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
78
79
```
80
wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://api.netdata.cloud
@@ -84,7 +84,7 @@ the node in your Space after 60 seconds, see the [troubleshooting information](#
84
85
Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](#connect-an-agent-without-root-privileges) section.
86
87
-For more details on what are the extra parameters `claim-token`, `claim-rooms` and `claim-url` please refer to [Connect node to Netdata Cloud during installation](/packaging/installer/methods/kickstart.md#connect-node-to-netdata-cloud-during-installation).
87
+For more details on what are the extra parameters `claim-token`, `claim-rooms` and `claim-url` please refer to [Connect node to Netdata Cloud during installation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md#connect-node-to-netdata-cloud-during-installation).
88
89
### Connect an agent without root privileges
90
@@ -118,7 +118,7 @@ connected on startup or restart.
118
119
For the connection process to work, the contents of `/var/lib/netdata` _must_ be preserved across container
120
restarts using a persistent volume. See our [recommended `docker run` and Docker Compose
121
-examples](/packaging/docker/README.md#create-a-new-netdata-agent-container) for details.
121
+examples](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md#create-a-new-netdata-agent-container) for details.
122
123
#### Known issues on older hosts with seccomp enabled
124
@@ -289,7 +289,7 @@ you don't see the node in your Space after 60 seconds, see the [troubleshooting
289
290
### Connect an agent running in macOS
291
292
-To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/methods/macos.md#install-netdata-with-our-automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
292
+To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md#install-netdata-with-our-automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
293
294
```bash
295
curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install-prefix /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://api.netdata.cloud
@@ -299,7 +299,7 @@ the node in your Space after 60 seconds, see the [troubleshooting information](#
299
300
### Connect a Kubernetes cluster's parent Netdata pod
301
302
-Read our [Kubernetes installation](/packaging/installer/methods/kubernetes.md#connect-your-kubernetes-cluster-to-netdata-cloud)
302
+Read our [Kubernetes installation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md#connect-your-kubernetes-cluster-to-netdata-cloud)
303
for details on connecting a parent Netdata pod.
304
305
### Connect through a proxy
@@ -328,7 +328,7 @@ For example, a HTTP proxy setting may look like the following:
328
proxy = http://proxy.example.com:1080 # With a URL
329
```
330
331
-You can now move on to connecting. When you connect with the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) script, add the `--claim-proxy=` parameter and
331
+You can now move on to connecting. When you connect with the [kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#automatic-one-line-installation-script) script, add the `--claim-proxy=` parameter and
332
append the same proxy setting you added to `netdata.conf`.
333
334
```bash
@@ -340,7 +340,7 @@ you don't see the node in your Space after 60 seconds, see the [troubleshooting
340
341
### Troubleshooting
342
343
-If you're having trouble connecting a node, this may be because the [ACLK](/aclk/README.md) cannot connect to Cloud.
343
+If you're having trouble connecting a node, this may be because the [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md) cannot connect to Cloud.
344
345
With the Netdata Agent running, visit `http://NODE:19999/api/v1/info` in your browser, replacing `NODE` with the IP
346
address or hostname of your Agent. The returned JSON contains four keys that will be helpful to diagnose any issues you
@@ -373,7 +373,7 @@ If you run the kickstart script and get the following error `Existing install ap
373
374
If you are using an unsupported package, such as a third-party `.deb`/`.rpm` package provided by your distribution,
375
please remove that package and reinstall using our [recommended kickstart
376
-script](/docs/get-started.mdx#install-on-linux-with-one-line-installer).
376
+script](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx#install-on-linux-with-one-line-installer).
377
378
#### kickstart: Failed to write new machine GUID
379
@@ -393,7 +393,7 @@ if you installed Netdata to `/opt/netdata`, use `/opt/netdata/bin/netdata-claim.
393
394
If you are using an unsupported package, such as a third-party `.deb`/`.rpm` package provided by your distribution,
395
please remove that package and reinstall using our [recommended kickstart
396
-script](/docs/get-started.mdx#install-on-linux-with-one-line-installer).
396
+script](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx#install-on-linux-with-one-line-installer).
397
398
#### Connecting on older distributions (Ubuntu 14.04, Debian 8, CentOS 6)
399
@@ -402,7 +402,7 @@ If you're running an older Linux distribution or one that has reached EOL, such
402
versions of OpenSSL cannot perform [hostname validation](https://wiki.openssl.org/index.php/Hostname_validation), which
403
helps securely encrypt SSL connections.
404
405
-We recommend you reinstall Netdata with a [static build](/packaging/installer/methods/kickstart.md#static-builds), which uses an
405
+We recommend you reinstall Netdata with a [static build](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md#static-builds), which uses an
406
up-to-date version of OpenSSL with hostname validation enabled.
407
408
If you choose to continue using the outdated version of OpenSSL, your node will still connect to Netdata Cloud, albeit
@@ -420,7 +420,7 @@ Additionally, check that the `enabled` setting in `var/lib/netdata/cloud.d/cloud
420
enabled = true
421
```
422
423
-To fix this issue, reinstall Netdata using your [preferred method](/packaging/installer/README.md) and do not add the
423
+To fix this issue, reinstall Netdata using your [preferred method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) and do not add the
424
`--disable-cloud` option.
425
426
#### cloud-available is false / ACLK Available: No
@@ -510,20 +510,20 @@ tool, and details about the files found in `cloud.d`.
510
511
### The `cloud.conf` file
512
513
-This section defines how and whether your Agent connects to [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/)
514
-using the [ACLK](/aclk/README.md).
513
+This section defines how and whether your Agent connects to [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx)
514
+using the [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md).
515
516
| setting | default | info |
517
|:-------------- |:------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------- |
518
| cloud base url | https://api.netdata.cloud | The URL for the Netdata Cloud web application. You should not change this. If you want to disable Cloud, change the `enabled` setting. |
519
-| enabled | yes | The runtime option to disable the [Agent-Cloud link](/aclk/README.md) and prevent your Agent from connecting to Netdata Cloud. |
519
+| enabled | yes | The runtime option to disable the [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/aclk/README.md) and prevent your Agent from connecting to Netdata Cloud. |
520
521
### kickstart script
522
523
-The best way to install Netdata and connect your nodes to Netdata Cloud is with our automatic one-line installation script, [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script). This script will install the Netdata Agent, in case it isn't already installed, and connect your node to Netdata Cloud.
523
+The best way to install Netdata and connect your nodes to Netdata Cloud is with our automatic one-line installation script, [kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#automatic-one-line-installation-script). This script will install the Netdata Agent, in case it isn't already installed, and connect your node to Netdata Cloud.
524
525
This works with:
526
-* most Linux distributions, see [Netdata's platform support policy](/packaging/PLATFORM_SUPPORT.md)
526
+* most Linux distributions, see [Netdata's platform support policy](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md)
527
* macOS
528
529
For details on how to run this script please check [How to connect a node](#how-to-connect-a-node) and choose your environment.
@@ -578,7 +578,7 @@ netdatacli reload-claiming-state
578
579
This reloads the Agent connection state from disk.
580
581
-Our recommendation is to trigger the connection process using the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) whenever possible.
581
+Our recommendation is to trigger the connection process using the [kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#automatic-one-line-installation-script) whenever possible.
582
583
### Netdata Agent command line
584
cli/README.md
+1
-1
@@ -39,6 +39,6 @@ aclk-state [json]
39
Returns current state of ACLK and Cloud connection. (optionally in json)
40
```
41
42
-Those commands are the same that can be sent to netdata via [signals](/daemon/README.md#command-line-options).
42
+Those commands are the same that can be sent to netdata via [signals](https://github.com/netdata/netdata/blob/master/daemon/README.md#command-line-options).
43
44
collectors/COLLECTORS.md
+316
-197
@@ -14,16 +14,19 @@ Netdata uses collectors to help you gather metrics from your favorite applicatio
14
real-time, interactive charts. The following list includes collectors for both external services/applications and
15
internal system metrics.
16
17
-Learn more about [how collectors work](/docs/collect/how-collectors-work.md), and then learn how to [enable or
18
-configure](/docs/collect/enable-configure.md) any of the below collectors using the same process.
17
+Learn more
18
+about [how collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md), and
19
+then learn how to [enable or
20
+configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) any of the below collectors using the same process.
21
22
Some collectors have both Go and Python versions as we continue our effort to migrate all collectors to Go. In these
23
cases, _Netdata always prioritizes the Go version_, and we highly recommend you use the Go versions for the best
24
experience.
25
24
-If you want to use a Python version of a collector, you need to explicitly [disable the Go
25
-version](/docs/collect/enable-configure.md), and enable the Python version. Netdata then skips the Go version and
26
-attempts to load the Python version and its accompanying configuration file.
26
+If you want to use a Python version of a collector, you need to
27
+explicitly [disable the Go version](https://github.com/netdata/netdata/blob/masterhttps://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md),
28
+and enable the Python version. Netdata then skips the Go version and attempts to load the Python version and its
29
+accompanying configuration file.
30
31
If you don't see the app/service you'd like to monitor in this list:
32
@@ -33,7 +36,7 @@ If you don't see the app/service you'd like to monitor in this list:
36
a [feature request](https://github.com/netdata/netdata/issues/new/choose) on GitHub.
37
- If you have basic software development skills, you can add your own plugin
38
in [Go](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin#how-to-develop-a-collector)
36
- or [Python](https://learn.netdata.cloud/guides/python-collector)
39
+ or [Python](https://github.com/netdata/netdata/blob/master/docs/guides/python-collector.md)
40
41
Supported Collectors List:
42
@@ -76,256 +79,300 @@ configure any of these collectors according to your setup and infrastructure.
79
80
### Generic
81
79
-- [Prometheus endpoints](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus): Gathers
82
+- [Prometheus endpoints](https://github.com/netdata/go.d.plugin/blob/master/modules/prometheus/README.md): Gathers
83
metrics from any number of Prometheus endpoints, with support to autodetect more than 600 services and applications.
81
-- [Pandas](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin/pandas): A Python collector that gathers
82
- metrics from a [pandas](https://pandas.pydata.org/) dataframe. Pandas is a high level data processing library in
83
- Python that can read various formats of data from local files or web endpoints. Custom processing and transformation
84
+- [Pandas](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/pandas/README.md): A Python
85
+ collector that gathers
86
+ metrics from a [pandas](https://pandas.pydata.org/) dataframe. Pandas is a high level data processing library in
87
+ Python that can read various formats of data from local files or web endpoints. Custom processing and transformation
88
logic can also be expressed as part of the collector configuration.
89
90
### APM (application performance monitoring)
91
88
-- [Go applications](/collectors/python.d.plugin/go_expvar/README.md): Monitor any Go application that exposes its
92
+- [Go applications](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/go_expvar/README.md):
93
+ Monitor any Go application that exposes its
94
metrics with the `expvar` package from the Go standard library.
90
-- [Java Spring Boot 2
91
- applications](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/springboot2/):
95
+- [Java Spring Boot 2 applications](https://github.com/netdata/go.d.plugin/blob/master/modules/springboot2/README.md):
96
Monitor running Java Spring Boot 2 applications that expose their metrics with the use of the Spring Boot Actuator.
93
-- [statsd](/collectors/statsd.plugin/README.md): Implement a high performance `statsd` server for Netdata.
94
-- [phpDaemon](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/phpdaemon/): Collect worker
97
+- [statsd](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md): Implement a high
98
+ performance `statsd` server for Netdata.
99
+- [phpDaemon](https://github.com/netdata/go.d.plugin/blob/master/modules/phpdaemon/README.md): Collect worker
100
statistics (total, active, idle), and uptime for web and network applications.
96
-- [uWSGI](/collectors/python.d.plugin/uwsgi/README.md): Monitor performance metrics exposed by the uWSGI Stats
101
+- [uWSGI](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/uwsgi/README.md): Monitor
102
+ performance metrics exposed by the uWSGI Stats
103
Server.
104
105
### Containers and VMs
106
101
-- [Docker containers](/collectors/cgroups.plugin/README.md): Monitor the health and performance of individual Docker
102
- containers using the cgroups collector plugin.
103
-- [DockerD](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/docker/): Collect container health statistics.
104
-- [Docker Engine](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/docker_engine/): Collect
107
+- [Docker containers](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md): Monitor the
108
+ health and performance of individual Docker containers using the cgroups collector plugin.
109
+- [DockerD](https://github.com/netdata/go.d.plugin/blob/master/modules/docker/README.md): Collect container health
110
+ statistics.
111
+- [Docker Engine](https://github.com/netdata/go.d.plugin/blob/master/modules/docker_engine/README.md): Collect
112
runtime statistics from the `docker` daemon using the `metrics-address` feature.
106
-- [Docker Hub](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dockerhub/): Collect statistics
113
+- [Docker Hub](https://github.com/netdata/go.d.plugin/blob/master/modules/dockerhub/README.md): Collect statistics
114
about Docker repositories, such as pulls, starts, status, time since last update, and more.
108
-- [Libvirt](/collectors/cgroups.plugin/README.md): Monitor the health and performance of individual Libvirt containers
115
+- [Libvirt](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md): Monitor the health and
116
+ performance of individual Libvirt containers
117
using the cgroups collector plugin.
110
-- [LXC](/collectors/cgroups.plugin/README.md): Monitor the health and performance of individual LXC containers using
118
+- [LXC](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md): Monitor the health and
119
+ performance of individual LXC containers using
120
the cgroups collector plugin.
112
-- [LXD](/collectors/cgroups.plugin/README.md): Monitor the health and performance of individual LXD containers using
121
+- [LXD](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md): Monitor the health and
122
+ performance of individual LXD containers using
123
the cgroups collector plugin.
114
-- [systemd-nspawn](/collectors/cgroups.plugin/README.md): Monitor the health and performance of individual
124
+- [systemd-nspawn](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md): Monitor the
125
+ health and performance of individual
126
systemd-nspawn containers using the cgroups collector plugin.
116
-- [vCenter Server Appliance](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/vcsa/): Monitor
127
+- [vCenter Server Appliance](https://github.com/netdata/go.d.plugin/blob/master/modules/vcsa/README.md): Monitor
128
appliance system, components, and software update health statuses via the Health API.
118
-- [vSphere](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/vsphere/): Collect host and virtual
129
+- [vSphere](https://github.com/netdata/go.d.plugin/blob/master/modules/vsphere/README.md): Collect host and virtual
130
machine performance metrics.
120
-- [Xen/XCP-ng](/collectors/xenstat.plugin/README.md): Collect XenServer and XCP-ng metrics using `libxenstat`.
131
+- [Xen/XCP-ng](https://github.com/netdata/netdata/blob/master/collectors/xenstat.plugin/README.md): Collect XenServer
132
+ and XCP-ng metrics using `libxenstat`.
133
134
### Data stores
135
124
-- [CockroachDB](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/): Monitor various
136
+- [CockroachDB](https://github.com/netdata/go.d.plugin/blob/master/modules/cockroachdb/README.md): Monitor various
137
database components using `_status/vars` endpoint.
126
-- [Consul](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/consul/): Capture service and unbound
138
+- [Consul](https://github.com/netdata/go.d.plugin/blob/master/modules/consul/README.md): Capture service and unbound
139
checks status (passing, warning, critical, maintenance).
128
-- [Couchbase](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/couchbase/): Gather per-bucket
140
+- [Couchbase](https://github.com/netdata/go.d.plugin/blob/master/modules/couchbase/README.md): Gather per-bucket
141
metrics from any number of instances of the distributed JSON document database.
130
-- [CouchDB](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/couchdb): Monitor database health and
142
+- [CouchDB](https://github.com/netdata/go.d.plugin/blob/master/modules/couchdb/README.md): Monitor database health and
143
performance metrics
144
(reads/writes, HTTP traffic, replication status, etc).
133
-- [MongoDB](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mongodb): Collect server, database,
145
+- [MongoDB](https://github.com/netdata/go.d.plugin/blob/master/modules/mongodb/README.md): Collect server, database,
146
replication and sharding performance and health metrics.
135
-- [MySQL](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql/): Collect database global,
147
+- [MySQL](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md): Collect database global,
148
replication and per user statistics.
137
-- [OracleDB](/collectors/python.d.plugin/oracledb/README.md): Monitor database performance and health metrics.
138
-- [Pika](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/pika/): Gather metric, such as clients,
149
+- [OracleDB](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/oracledb/README.md): Monitor
150
+ database performance and health metrics.
151
+- [Pika](https://github.com/netdata/go.d.plugin/blob/master/modules/pika/README.md): Gather metric, such as clients,
152
memory usage, queries, and more from the Redis interface-compatible database.
140
-- [Postgres](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/postgres): Collect database health
153
+- [Postgres](https://github.com/netdata/go.d.plugin/blob/master/modules/postgres/README.md): Collect database health
154
and performance metrics.
142
-- [ProxySQL](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/proxysql): Monitor database backend
155
+- [ProxySQL](https://github.com/netdata/go.d.plugin/blob/master/modules/proxysql/README.md): Monitor database backend
156
and frontend performance metrics.
144
-- [Redis](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/redis/): Monitor status from any
157
+- [Redis](https://github.com/netdata/go.d.plugin/blob/master/modules/redis/README.md): Monitor status from any
158
number of database instances by reading the server's response to the `INFO ALL` command.
146
-- [RethinkDB](/collectors/python.d.plugin/rethinkdbs/README.md): Collect database server and cluster statistics.
147
-- [Riak KV](/collectors/python.d.plugin/riakkv/README.md): Collect database stats from the `/stats` endpoint.
148
-- [Zookeeper](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/zookeeper/): Monitor application
159
+- [RethinkDB](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/rethinkdbs/README.md): Collect
160
+ database server and cluster statistics.
161
+- [Riak KV](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/riakkv/README.md): Collect
162
+ database stats from the `/stats` endpoint.
163
+- [Zookeeper](https://github.com/netdata/go.d.plugin/blob/master/modules/zookeeper/README.md): Monitor application
164
health metrics reading the server's response to the `mntr` command.
150
-- [Memcached](/collectors/python.d.plugin/memcached/README.md): Collect memory-caching system performance metrics.
165
+- [Memcached](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/memcached/README.md): Collect
166
+ memory-caching system performance metrics.
167
168
### Distributed computing
169
154
-- [BOINC](/collectors/python.d.plugin/boinc/README.md): Monitor the total number of tasks, open tasks, and task
170
+- [BOINC](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/boinc/README.md): Monitor the total
171
+ number of tasks, open tasks, and task
172
states for the distributed computing client.
156
-- [Gearman](/collectors/python.d.plugin/gearman/README.md): Collect application summary (queued, running) and per-job
173
+- [Gearman](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/gearman/README.md): Collect
174
+ application summary (queued, running) and per-job
175
worker statistics (queued, idle, running).
176
177
### Email
178
161
-- [Dovecot](/collectors/python.d.plugin/dovecot/README.md): Collect email server performance metrics by reading the
179
+- [Dovecot](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/dovecot/README.md): Collect email
180
+ server performance metrics by reading the
181
server's response to the `EXPORT global` command.
163
-- [EXIM](/collectors/python.d.plugin/exim/README.md): Uses the `exim` tool to monitor the queue length of a
182
+- [EXIM](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/exim/README.md): Uses the `exim` tool
183
+ to monitor the queue length of a
184
mail/message transfer agent (MTA).
165
-- [Postfix](/collectors/python.d.plugin/postfix/README.md): Uses the `postqueue` tool to monitor the queue length of a
185
+- [Postfix](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/postfix/README.md): Uses
186
+ the `postqueue` tool to monitor the queue length of a
187
mail/message transfer agent (MTA).
188
189
### Kubernetes
190
170
-- [Kubelet](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubelet/): Monitor one or more
191
+- [Kubelet](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubelet/README.md): Monitor one or more
192
instances of the Kubelet agent and collects metrics on number of pods/containers running, volume of Docker
193
operations, and more.
173
-- [kube-proxy](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubeproxy/): Collect
194
+- [kube-proxy](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubeproxy/README.md): Collect
195
metrics, such as syncing proxy rules and REST client requests, from one or more instances of `kube-proxy`.
175
-- [Service discovery](https://github.com/netdata/agent-service-discovery/): Find what services are running on a
196
+- [Service discovery](https://github.com/netdata/agent-service-discovery/README.md): Find what services are running on a
197
cluster's pods, converts that into configuration files, and exports them so they can be monitored by Netdata.
198
199
### Logs
200
180
-- [Fluentd](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/fluentd/): Gather application
201
+- [Fluentd](https://github.com/netdata/go.d.plugin/blob/master/modules/fluentd/README.md): Gather application
202
plugins metrics from an endpoint provided by `in_monitor plugin`.
182
-- [Logstash](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/logstash/): Monitor JVM threads,
203
+- [Logstash](https://github.com/netdata/go.d.plugin/blob/master/modules/logstash/README.md): Monitor JVM threads,
204
memory usage, garbage collection statistics, and more.
184
-- [OpenVPN status logs](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/openvpn_status_log): Parse
205
+- [OpenVPN status logs](https://github.com/netdata/go.d.plugin/blob/master/modules/openvpn_status_log/README.md): Parse
206
server log files and provide summary (client, traffic) metrics.
186
-- [Squid web server logs](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/squidlog/): Tail Squid
207
+- [Squid web server logs](https://github.com/netdata/go.d.plugin/blob/master/modules/squidlog/README.md): Tail Squid
208
access logs to return the volume of requests, types of requests, bandwidth, and much more.
209
- [Web server logs (Go version for Apache,
189
- NGINX)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/): Tail access logs and provide
210
+ NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md/): Tail access logs and provide
211
very detailed web server performance statistics. This module is able to parse 200k+ rows in less than half a second.
191
-- [Web server logs (Apache, NGINX)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog): Tail
212
+- [Web server logs (Apache, NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md): Tail
213
access log
214
file and collect web server/caching proxy metrics.
215
216
### Messaging
217
197
-- [ActiveMQ](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/activemq/): Collect message broker
218
+- [ActiveMQ](https://github.com/netdata/go.d.plugin/blob/master/modules/activemq/README.md): Collect message broker
219
queues and topics statistics using the ActiveMQ Console API.
199
-- [Beanstalk](/collectors/python.d.plugin/beanstalk/README.md): Collect server and tube-level statistics, such as CPU
220
+- [Beanstalk](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/beanstalk/README.md): Collect
221
+ server and tube-level statistics, such as CPU
222
usage, jobs rates, commands, and more.
201
-- [Pulsar](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/pulsar/): Collect summary,
223
+- [Pulsar](https://github.com/netdata/go.d.plugin/blob/master/modules/pulsar/README.md): Collect summary,
224
namespaces, and topics performance statistics.
203
-- [RabbitMQ (Go)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/rabbitmq/): Collect message
225
+- [RabbitMQ (Go)](https://github.com/netdata/go.d.plugin/blob/master/modules/rabbitmq/README.md): Collect message
226
broker overview, system and per virtual host metrics.
205
-- [RabbitMQ (Python)](/collectors/python.d.plugin/rabbitmq/README.md): Collect message broker global and per virtual
227
+- [RabbitMQ (Python)](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/rabbitmq/README.md):
228
+ Collect message broker global and per virtual
229
host metrics.
207
-- [VerneMQ](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/vernemq/): Monitor MQTT broker
230
+- [VerneMQ](https://github.com/netdata/go.d.plugin/blob/master/modules/vernemq/README.md): Monitor MQTT broker
231
health and performance metrics. It collects all available info for both MQTTv3 and v5 communication
232
233
### Network
234
212
-- [Bind 9](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/bind/): Collect nameserver summary
235
+- [Bind 9](https://github.com/netdata/go.d.plugin/blob/master/modules/bind/README.md): Collect nameserver summary
236
performance statistics via a web interface (`statistics-channels` feature).
214
-- [Chrony](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/chrony): Monitor the precision and
237
+- [Chrony](https://github.com/netdata/go.d.plugin/blob/master/modules/chrony/README.md): Monitor the precision and
238
statistics of a local `chronyd` server.
216
-- [CoreDNS](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/coredns/): Measure DNS query round
239
+- [CoreDNS](https://github.com/netdata/go.d.plugin/blob/master/modules/coredns/README.md): Measure DNS query round
240
trip time.
218
-- [Dnsmasq](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsmasq_dhcp/): Automatically
241
+- [Dnsmasq](https://github.com/netdata/go.d.plugin/blob/master/modules/dnsmasq_dhcp/README.md): Automatically
242
detects all configured `Dnsmasq` DHCP ranges and Monitor their utilization.
220
-- [DNSdist](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsdist/): Collect
243
+- [DNSdist](https://github.com/netdata/go.d.plugin/blob/master/modules/dnsdist/README.md): Collect
244
load-balancer performance and health metrics.
222
-- [Dnsmasq DNS Forwarder](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsmasq/): Gather
245
+- [Dnsmasq DNS Forwarder](https://github.com/netdata/go.d.plugin/blob/master/modules/dnsmasq/README.md): Gather
246
queries, entries, operations, and events for the lightweight DNS forwarder.
224
-- [DNS Query Time](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsquery/): Monitor the round
247
+- [DNS Query Time](https://github.com/netdata/go.d.plugin/blob/master/modules/dnsquery/README.md): Monitor the round
248
trip time for DNS queries in milliseconds.
226
-- [Freeradius](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/freeradius/): Collect
249
+- [Freeradius](https://github.com/netdata/go.d.plugin/blob/master/modules/freeradius/README.md): Collect
250
server authentication and accounting statistics from the `status server`.
228
-- [Libreswan](/collectors/charts.d.plugin/libreswan/README.md): Collect bytes-in, bytes-out, and uptime metrics.
229
-- [Icecast](/collectors/python.d.plugin/icecast/README.md): Monitor the number of listeners for active sources.
230
-- [ISC Bind (RDNC)](/collectors/python.d.plugin/bind_rndc/README.md): Collect nameserver summary performance
251
+- [Libreswan](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/libreswan/README.md): Collect
252
+ bytes-in, bytes-out, and uptime metrics.
253
+- [Icecast](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/icecast/README.md): Monitor the
254
+ number of listeners for active sources.
255
+- [ISC Bind (RDNC)](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/bind_rndc/README.md):
256
+ Collect nameserver summary performance
257
statistics using the `rndc` tool.
232
-- [ISC DHCP](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/isc_dhcpd): Reads a
258
+- [ISC DHCP](https://github.com/netdata/go.d.plugin/blob/master/modules/isc_dhcpd/README.md): Reads a
259
`dhcpd.leases` file and collects metrics on total active leases, pool active leases, and pool utilization.
234
-- [OpenLDAP](/collectors/python.d.plugin/openldap/README.md): Provides statistics information from the OpenLDAP
260
+- [OpenLDAP](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/openldap/README.md): Provides
261
+ statistics information from the OpenLDAP
262
(`slapd`) server.
236
-- [NSD](/collectors/python.d.plugin/nsd/README.md): Monitor nameserver performance metrics using the `nsd-control`
263
+- [NSD](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/nsd/README.md): Monitor nameserver
264
+ performance metrics using the `nsd-control`
265
tool.
266
- [NTP daemon](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/ntpd): Monitor the system variables
267
of the local `ntpd` daemon (optionally including variables of the polled peers) using the NTP Control Message Protocol
268
via a UDP socket.
241
-- [OpenSIPS](/collectors/charts.d.plugin/opensips/README.md): Collect server health and performance metrics using the
269
+- [OpenSIPS](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/opensips/README.md): Collect
270
+ server health and performance metrics using the
271
`opensipsctl` tool.
243
-- [OpenVPN](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/openvpn/): Gather server summary
272
+- [OpenVPN](https://github.com/netdata/go.d.plugin/blob/master/modules/openvpn/README.md): Gather server summary
273
(client, traffic) and per user metrics (traffic, connection time) stats using `management-interface`.
245
-- [Pi-hole](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/pihole/): Monitor basic (DNS
274
+- [Pi-hole](https://github.com/netdata/go.d.plugin/blob/master/modules/pihole/README.md): Monitor basic (DNS
275
queries, clients, blocklist) and extended (top clients, top permitted, and blocked domains) statistics using the PHP
276
API.
248
-- [PowerDNS Authoritative Server](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/powerdns):
277
+- [PowerDNS Authoritative Server](https://github.com/netdata/go.d.plugin/blob/master/modules/powerdns/README.md):
278
Monitor one or more instances of the nameserver software to collect questions, events, and latency metrics.
250
-- [PowerDNS Recursor](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/powerdns_recursor):
279
+- [PowerDNS Recursor](https://github.com/netdata/go.d.plugin/blob/master/modules/powerdns/README.md_recursor):
280
Gather incoming/outgoing questions, drops, timeouts, and cache usage from any number of DNS recursor instances.
252
-- [RetroShare](/collectors/python.d.plugin/retroshare/README.md): Monitor application bandwidth, peers, and DHT
281
+- [RetroShare](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/retroshare/README.md): Monitor
282
+ application bandwidth, peers, and DHT
283
metrics.
254
-- [Tor](/collectors/python.d.plugin/tor/README.md): Capture traffic usage statistics using the Tor control port.
255
-- [Unbound](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/unbound/): Collect DNS resolver
284
+- [Tor](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/tor/README.md): Capture traffic usage
285
+ statistics using the Tor control port.
286
+- [Unbound](https://github.com/netdata/go.d.plugin/blob/master/modules/unbound/README.md): Collect DNS resolver
287
summary and extended system and per thread metrics via the `remote-control` interface.
288
289
### Provisioning
290
260
-- [Puppet](/collectors/python.d.plugin/puppet/README.md): Monitor the status of Puppet Server and Puppet DB.
291
+- [Puppet](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/puppet/README.md): Monitor the
292
+ status of Puppet Server and Puppet DB.
293
294
### Remote devices
295
264
-- [AM2320](/collectors/python.d.plugin/am2320/README.md): Monitor sensor temperature and humidity.
265
-- [Access point](/collectors/charts.d.plugin/ap/README.md): Monitor client, traffic and signal metrics using the `aw`
296
+- [AM2320](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/am2320/README.md): Monitor sensor
297
+ temperature and humidity.
298
+- [Access point](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/ap/README.md): Monitor
299
+ client, traffic and signal metrics using the `aw`
300
tool.
267
-- [APC UPS](/collectors/charts.d.plugin/apcupsd/README.md): Capture status information using the `apcaccess` tool.
268
-- [Energi Core](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/energid): Monitor
301
+- [APC UPS](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/apcupsd/README.md): Capture status
302
+ information using the `apcaccess` tool.
303
+- [Energi Core](https://github.com/netdata/go.d.plugin/blob/master/modules/energid/README.md): Monitor
304
blockchain indexes, memory usage, network usage, and transactions of wallet instances.
270
-- [UPS/PDU](/collectors/charts.d.plugin/nut/README.md): Read the status of UPS/PDU devices using the `upsc` tool.
271
-- [SNMP devices](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/snmp): Gather data using the SNMP
305
+- [UPS/PDU](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/nut/README.md): Read the status of
306
+ UPS/PDU devices using the `upsc` tool.
307
+- [SNMP devices](https://github.com/netdata/go.d.plugin/blob/master/modules/snmp/README.md): Gather data using the SNMP
308
protocol.
273
-- [1-Wire sensors](/collectors/python.d.plugin/w1sensor/README.md): Monitor sensor temperature.
309
+- [1-Wire sensors](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/w1sensor/README.md):
310
+ Monitor sensor temperature.
311
312
### Search
313
277
-- [Elasticsearch](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/elasticsearch): Collect
314
+- [Elasticsearch](https://github.com/netdata/go.d.plugin/blob/master/modules/elasticsearch/README.md): Collect
315
dozens of metrics on search engine performance from local nodes and local indices. Includes cluster health and
316
statistics.
280
-- [Solr](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/solr/): Collect application search
317
+- [Solr](https://github.com/netdata/go.d.plugin/blob/master/modules/solr/README.md): Collect application search
318
requests, search errors, update requests, and update errors statistics.
319
320
### Storage
321
285
-- [Ceph](/collectors/python.d.plugin/ceph/README.md): Monitor the Ceph cluster usage and server data consumption.
286
-- [HDFS](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/hdfs/): Monitor health and performance
322
+- [Ceph](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/ceph/README.md): Monitor the Ceph
323
+ cluster usage and server data consumption.
324
+- [HDFS](https://github.com/netdata/go.d.plugin/blob/master/modules/hdfs/README.md): Monitor health and performance
325
metrics for filesystem datanodes and namenodes.
288
-- [IPFS](/collectors/python.d.plugin/ipfs/README.md): Collect file system bandwidth, peers, and repo metrics.
289
-- [Scaleio](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/scaleio/): Monitor storage system,
326
+- [IPFS](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/ipfs/README.md): Collect file system
327
+ bandwidth, peers, and repo metrics.
328
+- [Scaleio](https://github.com/netdata/go.d.plugin/blob/master/modules/scaleio/README.md): Monitor storage system,
329
storage pools, and SDCS health and performance metrics via VxFlex OS Gateway API.
291
-- [Samba](/collectors/python.d.plugin/samba/README.md): Collect file sharing metrics using the `smbstatus` tool.
330
+- [Samba](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/samba/README.md): Collect file
331
+ sharing metrics using the `smbstatus` tool.
332
333
### Web
334
295
-- [Apache](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/apache/): Collect Apache web
335
+- [Apache](https://github.com/netdata/go.d.plugin/blob/master/modules/apache/README.md): Collect Apache web
336
server performance metrics via the `server-status?auto` endpoint.
297
-- [HAProxy](/collectors/python.d.plugin/haproxy/README.md): Collect frontend, backend, and health metrics.
298
-- [HTTP endpoints](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/httpcheck/): Monitor
337
+- [HAProxy](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/haproxy/README.md): Collect
338
+ frontend, backend, and health metrics.
339
+- [HTTP endpoints](https://github.com/netdata/go.d.plugin/blob/master/modules/httpcheck/README.md): Monitor
340
any HTTP endpoint's availability and response time.
300
-- [Lighttpd](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/lighttpd/): Collect web server
341
+- [Lighttpd](https://github.com/netdata/go.d.plugin/blob/master/modules/lighttpd/README.md): Collect web server
342
performance metrics using the `server-status?auto` endpoint.
302
-- [Lighttpd2](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/lighttpd2/): Collect web server
343
+- [Lighttpd2](https://github.com/netdata/go.d.plugin/blob/master/modules/lighttpd2/README.md): Collect web server
344
performance metrics using the `server-status?format=plain` endpoint.
304
-- [Litespeed](/collectors/python.d.plugin/litespeed/README.md): Collect web server data (network, connection,
345
+- [Litespeed](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/litespeed/README.md): Collect
346
+ web server data (network, connection,
347
requests, cache) by reading `.rtreport*` files.
306
-- [Nginx](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx/): Monitor web server
348
+- [Nginx](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md): Monitor web server
349
status information by gathering metrics via `ngx_http_stub_status_module`.
308
-- [Nginx VTS](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginxvts/): Gathers metrics from
350
+- [Nginx VTS](https://github.com/netdata/go.d.plugin/blob/master/modules/nginxvts/README.md): Gathers metrics from
351
any Nginx deployment with the _virtual host traffic status module_ enabled, including metrics on uptime, memory
352
usage, and cache, and more.
311
-- [PHP-FPM](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/phpfpm/): Collect application
353
+- [PHP-FPM](https://github.com/netdata/go.d.plugin/blob/master/modules/phpfpm/README.md): Collect application
354
summary and processes health metrics by scraping the status page (`/status?full`).
313
-- [TCP endpoints](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/portcheck/): Monitor any
355
+- [TCP endpoints](https://github.com/netdata/go.d.plugin/blob/master/modules/portcheck/README.md): Monitor any
356
TCP endpoint's availability and response time.
315
-- [Spigot Minecraft servers](/collectors/python.d.plugin/spigotmc/README.md): Monitor average ticket rate and number
357
+- [Spigot Minecraft servers](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/spigotmc/README.md):
358
+ Monitor average ticket rate and number
359
of users.
317
-- [Squid](/collectors/python.d.plugin/squid/README.md): Monitor client and server bandwidth/requests by gathering
360
+- [Squid](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/squid/README.md): Monitor client and
361
+ server bandwidth/requests by gathering
362
data from the Cache Manager component.
319
-- [Tengine](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/tengine/): Monitor web server
363
+- [Tengine](https://github.com/netdata/go.d.plugin/blob/master/modules/tengine/README.md): Monitor web server
364
statistics using information provided by `ngx_http_reqstat_module`.
321
-- [Tomcat](/collectors/python.d.plugin/tomcat/README.md): Collect web server performance metrics from the Manager App
365
+- [Tomcat](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/tomcat/README.md): Collect web
366
+ server performance metrics from the Manager App
367
(`/manager/status?XML=true`).
323
-- [Traefik](/collectors/python.d.plugin/traefik/README.md): Uses Traefik's Health API to provide statistics.
324
-- [Varnish](/collectors/python.d.plugin/varnish/README.md): Provides HTTP accelerator global, backends (VBE), and
368
+- [Traefik](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/traefik/README.md): Uses Traefik's
369
+ Health API to provide statistics.
370
+- [Varnish](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/varnish/README.md): Provides HTTP
371
+ accelerator global, backends (VBE), and
372
disks (SMF) statistics using the `varnishstat` tool.
326
-- [x509 check](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/x509check/): Monitor certificate
373
+- [x509 check](https://github.com/netdata/go.d.plugin/blob/master/modules/x509check/README.md): Monitor certificate
374
expiration time.
328
-- [Whois domain expiry](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/whoisquery/): Checks the
375
+- [Whois domain expiry](https://github.com/netdata/go.d.plugin/blob/master/modules/whoisquery/README.md): Checks the
376
remaining time until a given domain is expired.
377
378
## System collectors
@@ -335,139 +382,198 @@ The Netdata Agent can collect these system- and hardware-level metrics using a v
382
383
### Applications
384
338
-- [Fail2ban](/collectors/python.d.plugin/fail2ban/README.md): Parses configuration files to detect all jails, then
385
+- [Fail2ban](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/fail2ban/README.md): Parses
386
+ configuration files to detect all jails, then
387
uses log files to report ban rates and volume of banned IPs.
340
-- [Monit](/collectors/python.d.plugin/monit/README.md): Monitor statuses of targets (service-checks) using the XML
388
+- [Monit](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/monit/README.md): Monitor statuses
389
+ of targets (service-checks) using the XML
390
stats interface.
391
- [WMI (Windows Management Instrumentation)
343
- exporter](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/wmi/): Collect CPU, memory,
392
+ exporter](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md): Collect CPU, memory,
393
network, disk, OS, system, and log-in metrics scraping `wmi_exporter`.
394
395
### Disks and filesystems
396
348
-- [BCACHE](/collectors/proc.plugin/README.md): Monitor BCACHE statistics with the the `proc.plugin` collector.
349
-- [Block devices](/collectors/proc.plugin/README.md): Gather metrics about the health and performance of block
397
+- [BCACHE](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor BCACHE statistics
398
+ with the the `proc.plugin` collector.
399
+- [Block devices](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Gather metrics about
400
+ the health and performance of block
401
devices using the the `proc.plugin` collector.
351
-- [Btrfs](/collectors/proc.plugin/README.md): Monitors Btrfs filesystems with the the `proc.plugin` collector.
352
-- [Device mapper](/collectors/proc.plugin/README.md): Gather metrics about the Linux device mapper with the proc
402
+- [Btrfs](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitors Btrfs filesystems
403
+ with the the `proc.plugin` collector.
404
+- [Device mapper](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Gather metrics about
405
+ the Linux device mapper with the proc
406
collector.
354
-- [Disk space](/collectors/diskspace.plugin/README.md): Collect disk space usage metrics on Linux mount points.
355
-- [Clock synchronization](/collectors/timex.plugin/README.md): Collect the system clock synchronization status on Linux.
356
-- [Files and directories](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/filecheck): Gather
407
+- [Disk space](https://github.com/netdata/netdata/blob/master/collectors/diskspace.plugin/README.md): Collect disk space
408
+ usage metrics on Linux mount points.
409
+- [Clock synchronization](https://github.com/netdata/netdata/blob/master/collectors/timex.plugin/README.md): Collect the
410
+ system clock synchronization status on Linux.
411
+- [Files and directories](https://github.com/netdata/go.d.plugin/blob/master/modules/filecheck/README.md): Gather
412
metrics about the existence, modification time, and size of files or directories.
358
-- [ioping.plugin](/collectors/ioping.plugin/README.md): Measure disk read/write latency.
359
-- [NFS file servers and clients](/collectors/proc.plugin/README.md): Gather operations, utilization, and space usage
413
+- [ioping.plugin](https://github.com/netdata/netdata/blob/master/collectors/ioping.plugin/README.md): Measure disk
414
+ read/write latency.
415
+- [NFS file servers and clients](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md):
416
+ Gather operations, utilization, and space usage
417
using the the `proc.plugin` collector.
361
-- [RAID arrays](/collectors/proc.plugin/README.md): Collect health, disk status, operation status, and more with the
418
+- [RAID arrays](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Collect health, disk
419
+ status, operation status, and more with the
420
the `proc.plugin` collector.
363
-- [Veritas Volume Manager](/collectors/proc.plugin/README.md): Gather metrics about the Veritas Volume Manager (VVM).
364
-- [ZFS](/collectors/proc.plugin/README.md): Monitor bandwidth and utilization of ZFS disks/partitions using the proc
421
+- [Veritas Volume Manager](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Gather
422
+ metrics about the Veritas Volume Manager (VVM).
423
+- [ZFS](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor bandwidth and
424
+ utilization of ZFS disks/partitions using the proc
425
collector.
426
427
### eBPF
428
369
-- [Files](/collectors/ebpf.plugin/README.md): Provides information about how often a system calls kernel
429
+- [Files](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md): Provides information about
430
+ how often a system calls kernel
431
functions related to file descriptors using the eBPF collector.
371
-- [Virtual file system (VFS)](/collectors/ebpf.plugin/README.md): Monitor IO, errors, deleted objects, and
432
+- [Virtual file system (VFS)](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md): Monitor
433
+ IO, errors, deleted objects, and
434
more for kernel virtual file systems (VFS) using the eBPF collector.
373
-- [Processes](/collectors/ebpf.plugin/README.md): Monitor threads, task exits, and errors using the eBPF collector.
435
+- [Processes](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md): Monitor threads, task
436
+ exits, and errors using the eBPF collector.
437
438
### Hardware
439
377
-- [Adaptec RAID](/collectors/python.d.plugin/adaptec_raid/README.md): Monitor logical and physical devices health
440
+- [Adaptec RAID](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/adaptec_raid/README.md):
441
+ Monitor logical and physical devices health
442
metrics using the `arcconf` tool.
379
-- [CUPS](/collectors/cups.plugin/README.md): Monitor CUPS.
380
-- [FreeIPMI](/collectors/freeipmi.plugin/README.md): Uses `libipmimonitoring-dev` or `libipmimonitoring-devel` to
443
+- [CUPS](https://github.com/netdata/netdata/blob/master/collectors/cups.plugin/README.md): Monitor CUPS.
444
+- [FreeIPMI](https://github.com/netdata/netdata/blob/master/collectors/freeipmi.plugin/README.md):
445
+ Uses `libipmimonitoring-dev` or `libipmimonitoring-devel` to
446
monitor the number of sensors, temperatures, voltages, currents, and more.
382
-- [Hard drive temperature](/collectors/python.d.plugin/hddtemp/README.md): Monitor the temperature of storage
447
+- [Hard drive temperature](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/hddtemp/README.md):
448
+ Monitor the temperature of storage
449
devices.
384
-- [HP Smart Storage Arrays](/collectors/python.d.plugin/hpssa/README.md): Monitor controller, cache module, logical
450
+- [HP Smart Storage Arrays](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/hpssa/README.md):
451
+ Monitor controller, cache module, logical
452
and physical drive state, and temperature using the `ssacli` tool.
386
-- [MegaRAID controllers](/collectors/python.d.plugin/megacli/README.md): Collect adapter, physical drives, and
453
+- [MegaRAID controllers](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/megacli/README.md):
454
+ Collect adapter, physical drives, and
455
battery stats using the `megacli` tool.
388
-- [NVIDIA GPU](/collectors/python.d.plugin/nvidia_smi/README.md): Monitor performance metrics (memory usage, fan
456
+- [NVIDIA GPU](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/nvidia_smi/README.md): Monitor
457
+ performance metrics (memory usage, fan
458
speed, pcie bandwidth utilization, temperature, and more) using the `nvidia-smi` tool.
390
-- [Sensors](/collectors/python.d.plugin/sensors/README.md): Reads system sensors information (temperature, voltage,
459
+- [Sensors](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/sensors/README.md): Reads system
460
+ sensors information (temperature, voltage,
461
electric current, power, and more) from `/sys/devices/`.
392
-- [S.M.A.R.T](/collectors/python.d.plugin/smartd_log/README.md): Reads SMART Disk Monitoring daemon logs.
462
+- [S.M.A.R.T](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/smartd_log/README.md): Reads
463
+ SMART Disk Monitoring daemon logs.
464
465
### Memory
466
396
-- [Available memory](/collectors/proc.plugin/README.md): Tracks changes in available RAM using the the `proc.plugin`
467
+- [Available memory](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Tracks changes in
468
+ available RAM using the the `proc.plugin`
469
collector.
398
-- [Committed memory](/collectors/proc.plugin/README.md): Monitor committed memory using the `proc.plugin` collector.
399
-- [Huge pages](/collectors/proc.plugin/README.md): Gather metrics about huge pages in Linux and FreeBSD with the
470
+- [Committed memory](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor committed
471
+ memory using the `proc.plugin` collector.
472
+- [Huge pages](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Gather metrics about
473
+ huge pages in Linux and FreeBSD with the
474
`proc.plugin` collector.
401
-- [KSM](/collectors/proc.plugin/README.md): Measure the amount of merging, savings, and effectiveness using the
475
+- [KSM](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Measure the amount of merging,
476
+ savings, and effectiveness using the
477
`proc.plugin` collector.
403
-- [Numa](/collectors/proc.plugin/README.md): Gather metrics on the number of non-uniform memory access (NUMA) events
478
+- [Numa](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Gather metrics on the number
479
+ of non-uniform memory access (NUMA) events
480
every second using the `proc.plugin` collector.
405
-- [Page faults](/collectors/proc.plugin/README.md): Collect the number of memory page faults per second using the
481
+- [Page faults](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Collect the number of
482
+ memory page faults per second using the
483
`proc.plugin` collector.
407
-- [RAM](/collectors/proc.plugin/README.md): Collect metrics on system RAM, available RAM, and more using the
484
+- [RAM](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Collect metrics on system RAM,
485
+ available RAM, and more using the
486
`proc.plugin` collector.
409
-- [SLAB](/collectors/slabinfo.plugin/README.md): Collect kernel SLAB details on Linux systems.
410
-- [swap](/collectors/proc.plugin/README.md): Monitor the amount of free and used swap at every second using the
487
+- [SLAB](https://github.com/netdata/netdata/blob/master/collectors/slabinfo.plugin/README.md): Collect kernel SLAB
488
+ details on Linux systems.
489
+- [swap](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor the amount of free
490
+ and used swap at every second using the
491
`proc.plugin` collector.
412
-- [Writeback memory](/collectors/proc.plugin/README.md): Collect how much memory is actively being written to disk at
492
+- [Writeback memory](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Collect how much
493
+ memory is actively being written to disk at
494
every second using the `proc.plugin` collector.
495
496
### Networks
497
417
-- [Access points](/collectors/charts.d.plugin/ap/README.md): Visualizes data related to access points.
418
-- [Ping](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/ping/): Measure network latency, jitter and packet loss between the monitored node
498
+- [Access points](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/ap/README.md): Visualizes
499
+ data related to access points.
500
+- [Ping](https://github.com/netdata/go.d.plugin/blob/master/modules/ping/README.md): Measure network latency, jitter and
501
+ packet loss between the monitored node
502
and any number of remote network end points.
420
-- [Netfilter](/collectors/nfacct.plugin/README.md): Collect netfilter firewall, connection tracker, and accounting
503
+- [Netfilter](https://github.com/netdata/netdata/blob/master/collectors/nfacct.plugin/README.md): Collect netfilter
504
+ firewall, connection tracker, and accounting
505
metrics using `libmnl` and `libnetfilter_acct`.
422
-- [Network stack](/collectors/proc.plugin/README.md): Monitor the networking stack for errors, TCP connection aborts,
506
+- [Network stack](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor the
507
+ networking stack for errors, TCP connection aborts,
508
bandwidth, and more.
424
-- [Network QoS](/collectors/tc.plugin/README.md): Collect traffic QoS metrics (`tc`) of Linux network interfaces.
425
-- [SYNPROXY](/collectors/proc.plugin/README.md): Monitor entries uses, SYN packets received, TCP cookies, and more.
509
+- [Network QoS](https://github.com/netdata/netdata/blob/master/collectors/tc.plugin/README.md): Collect traffic QoS
510
+ metrics (`tc`) of Linux network interfaces.
511
+- [SYNPROXY](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor entries uses, SYN
512
+ packets received, TCP cookies, and more.
513
514
### Operating systems
515
429
-- [freebsd.plugin](freebsd.plugin/README.md): Collect resource usage and performance data on FreeBSD systems.
430
-- [macOS](/collectors/macos.plugin/README.md): Collect resource usage and performance data on macOS systems.
516
+- [freebsd.plugin](https://github.com/netdata/netdata/blob/master/collectors/freebsd.plugin/README.md): Collect resource
517
+ usage and performance data on FreeBSD systems.
518
+- [macOS](https://github.com/netdata/netdata/blob/master/collectors/macos.plugin/README.md): Collect resource usage and
519
+ performance data on macOS systems.
520
521
### Processes
522
434
-- [Applications](/collectors/apps.plugin/README.md): Gather CPU, disk, memory, network, eBPF, and other metrics per
523
+- [Applications](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md): Gather CPU, disk,
524
+ memory, network, eBPF, and other metrics per
525
application using the `apps.plugin` collector.
436
-- [systemd](/collectors/cgroups.plugin/README.md): Monitor the CPU and memory usage of systemd services using the
526
+- [systemd](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md): Monitor the CPU and
527
+ memory usage of systemd services using the
528
`cgroups.plugin` collector.
438
-- [systemd unit states](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/systemdunits): See the
529
+- [systemd unit states](https://github.com/netdata/go.d.plugin/blob/master/modules/systemdunits/README.md): See the
530
state (active, inactive, activating, deactivating, failed) of various systemd unit types.
440
-- [System processes](/collectors/proc.plugin/README.md): Collect metrics on system load and total processes running
531
+- [System processes](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Collect metrics
532
+ on system load and total processes running
533
using `/proc/loadavg` and the `proc.plugin` collector.
442
-- [Uptime](/collectors/proc.plugin/README.md): Monitor the uptime of a system using the `proc.plugin` collector.
534
+- [Uptime](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor the uptime of a
535
+ system using the `proc.plugin` collector.
536
537
### Resources
538
446
-- [CPU frequency](/collectors/proc.plugin/README.md): Monitor CPU frequency, as set by the `cpufreq` kernel module,
539
+- [CPU frequency](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor CPU
540
+ frequency, as set by the `cpufreq` kernel module,
541
using the `proc.plugin` collector.
448
-- [CPU idle](/collectors/proc.plugin/README.md): Measure CPU idle every second using the `proc.plugin` collector.
449
-- [CPU performance](/collectors/perf.plugin/README.md): Collect CPU performance metrics using performance monitoring
542
+- [CPU idle](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Measure CPU idle every
543
+ second using the `proc.plugin` collector.
544
+- [CPU performance](https://github.com/netdata/netdata/blob/master/collectors/perf.plugin/README.md): Collect CPU
545
+ performance metrics using performance monitoring
546
units (PMU).
451
-- [CPU throttling](/collectors/proc.plugin/README.md): Gather metrics about thermal throttling using the `/proc/stat`
547
+- [CPU throttling](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Gather metrics
548
+ about thermal throttling using the `/proc/stat`
549
module and the `proc.plugin` collector.
453
-- [CPU utilization](/collectors/proc.plugin/README.md): Capture CPU utilization, both system-wide and per-core, using
550
+- [CPU utilization](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Capture CPU
551
+ utilization, both system-wide and per-core, using
552
the `/proc/stat` module and the `proc.plugin` collector.
455
-- [Entropy](/collectors/proc.plugin/README.md): Monitor the available entropy on a system using the `proc.plugin`
553
+- [Entropy](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor the available
554
+ entropy on a system using the `proc.plugin`
555
collector.
457
-- [Interprocess Communication (IPC)](/collectors/proc.plugin/README.md): Monitor IPC semaphores and shared memory
556
+- [Interprocess Communication (IPC)](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md):
557
+ Monitor IPC semaphores and shared memory
558
using the `proc.plugin` collector.
459
-- [Interrupts](/collectors/proc.plugin/README.md): Monitor interrupts per second using the `proc.plugin` collector.
460
-- [IdleJitter](/collectors/idlejitter.plugin/README.md): Measure CPU latency and jitter on all operating systems.
461
-- [SoftIRQs](/collectors/proc.plugin/README.md): Collect metrics on SoftIRQs, both system-wide and per-core, using the
559
+- [Interrupts](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Monitor interrupts per
560
+ second using the `proc.plugin` collector.
561
+- [IdleJitter](https://github.com/netdata/netdata/blob/master/collectors/idlejitter.plugin/README.md): Measure CPU
562
+ latency and jitter on all operating systems.
563
+- [SoftIRQs](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Collect metrics on
564
+ SoftIRQs, both system-wide and per-core, using the
565
`proc.plugin` collector.
463
-- [SoftNet](/collectors/proc.plugin/README.md): Capture SoftNet events per second, both system-wide and per-core,
566
+- [SoftNet](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md): Capture SoftNet events per
567
+ second, both system-wide and per-core,
568
using the `proc.plugin` collector.
569
570
### Users
571
468
-- [systemd-logind](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/logind/): Monitor active sessions, users, and seats tracked
572
+- [systemd-logind](https://github.com/netdata/go.d.plugin/blob/master/modules/logind/README.md): Monitor active
573
+ sessions, users, and seats tracked
574
by `systemd-logind` or `elogind`.
470
-- [User/group usage](/collectors/apps.plugin/README.md): Gather CPU, disk, memory, network, and other metrics per user
575
+- [User/group usage](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md): Gather CPU, disk,
576
+ memory, network, and other metrics per user
577
and user group using the `apps.plugin` collector.
578
579
## Netdata collectors
@@ -476,13 +582,18 @@ These collectors are recursive in nature, in that they monitor some function of
582
collectors are described only in code and associated charts in Netdata dashboards.
583
584
- [ACLK (code only)](https://github.com/netdata/netdata/blob/master/aclk/legacy/aclk_stats.c): View whether a Netdata
479
- Agent is connected to Netdata Cloud via the [ACLK](/aclk/README.md), the volume of queries, process times, and more.
480
-- [Alarms](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin/alarms): This collector creates an
585
+ Agent is connected to Netdata Cloud via the [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md), the
586
+ volume of queries, process times, and more.
587
+- [Alarms](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/alarms/README.md): This collector
588
+ creates an
589
**Alarms** menu with one line plot showing the alarm states of a Netdata Agent over time.
482
-- [Anomalies](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin/anomalies): This collector uses the
590
+- [Anomalies](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md): This
591
+ collector uses the
592
Python PyOD library to perform unsupervised anomaly detection on your Netdata charts and/or dimensions.
593
- [Exporting (code only)](https://github.com/netdata/netdata/blob/master/exporting/send_internal_metrics.c): Gather
485
- metrics on CPU utilization for the [exporting engine](/exporting/README.md), and specific metrics for each enabled
594
+ metrics on CPU utilization for
595
+ the [exporting engine](https://github.com/netdata/netdata/blob/master/exporting/README.md), and specific metrics for
596
+ each enabled
597
exporting connector.
598
- [Global statistics (code only)](https://github.com/netdata/netdata/blob/master/daemon/global_statistics.c): See
599
metrics on the CPU utilization, network traffic, volume of web clients, API responses, database engine usage, and
@@ -496,8 +607,10 @@ If you're interested in developing a new collector that you'd like to contribute
607
the `go.d.plugin`.
608
609
- [go.d.plugin](https://github.com/netdata/go.d.plugin): An orchestrator for data collection modules written in `go`.
499
-- [python.d.plugin](python.d.plugin/README.md): An orchestrator for data collection modules written in `python` v2/v3.
500
-- [charts.d.plugin](charts.d.plugin/README.md): An orchestrator for data collection modules written in `bash` v4+.
610
+- [python.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md): An
611
+ orchestrator for data collection modules written in `python` v2/v3.
612
+- [charts.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/README.md): An
613
+ orchestrator for data collection modules written in `bash` v4+.
614
615
## Third-party collectors
616
@@ -509,13 +622,17 @@ default. To use a third-party collector, visit their GitHub/documentation page a
622
623
In general the below steps should be sufficient to use a third party collector.
624
512
-1. Download collector code file into [folder expected by Netdata](https://learn.netdata.cloud/docs/agent/collectors/plugins.d#environment-variables).
513
-2. Download default collector configuration file into [folder expected by Netdata](https://learn.netdata.cloud/docs/agent/collectors/plugins.d#environment-variables).
514
-3. [Edit configuration file](/docs/collect/enable-configure#configure-a-collector) from step 2 if required.
515
-4. [Enable collector](/docs/collect/enable-configure#enable-a-collector-or-its-orchestrator).
516
-5. [Restart Netdata](/docs/configure/start-stop-restart.md)
625
+1. Download collector code file
626
+ into [folder expected by Netdata](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#environment-variables).
627
+2. Download default collector configuration file
628
+ into [folder expected by Netdata](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#environment-variables).
629
+3. [Edit configuration file](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure#configure-a-collector)
630
+ from step 2 if required.
631
+4. [Enable collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure#enable-a-collector-or-its-orchestrator).
632
+5. [Restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md)
633
518
-For example below are the steps to enable the [Python ClickHouse collector](https://github.com/netdata/community/tree/main/collectors/python.d.plugin/clickhouse).
634
+For example below are the steps to enable
635
+the [Python ClickHouse collector](https://github.com/netdata/community/tree/main/collectors/python.d.plugin/clickhouse).
636
637
```bash
638
# download python collector script to /usr/libexec/netdata/python.d/
@@ -538,7 +655,6 @@ $ sudo systemctl restart netdata
655
656
</details>
657
541
-
658
- [CyberPower UPS](https://github.com/HawtDogFlvrWtr/netdata_cyberpwrups_plugin): Polls CyberPower UPS data using
659
PowerPanel® Personal Linux.
660
- [Logged-in users](https://github.com/veksh/netdata-numsessions): Collect the number of currently logged-on users.
@@ -549,9 +665,12 @@ $ sudo systemctl restart netdata
665
- [Teamspeak 3](https://github.com/coraxx/netdata_ts3_plugin): Pulls active users and bandwidth from TeamSpeak 3
666
servers.
667
- [SSH](https://github.com/Yaser-Amiri/netdata-ssh-module): Monitor failed authentication requests of an SSH server.
552
-- [ClickHouse](https://github.com/netdata/community/tree/main/collectors/python.d.plugin/clickhouse): Monitor [ClickHouse](https://clickhouse.com/) database.
668
+- [ClickHouse](https://github.com/netdata/community/tree/main/collectors/python.d.plugin/clickhouse):
669
+ Monitor [ClickHouse](https://clickhouse.com/) database.
670
671
## Etc
672
556
-- [charts.d example](charts.d.plugin/example/README.md): An example `charts.d` collector.
557
-- [python.d example](python.d.plugin/example/README.md): An example `python.d` collector.
673
+- [charts.d example](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/example/README.md): An
674
+ example `charts.d` collector.
675
+- [python.d example](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/example/README.md): An
676
+ example `python.d` collector.
collectors/README.md
+20
-18
@@ -11,42 +11,44 @@ learn_rel_path: "References/Collectors"
11
# Collecting metrics
12
13
Netdata can collect metrics from hundreds of different sources, be they internal data created by the system itself, or
14
-external data created by services or applications. To see _all_ of the sources Netdata collects from, view our [list of
15
-supported collectors](/collectors/COLLECTORS.md).
14
+external data created by services or applications. To see _all_ of the sources Netdata collects from, view our
15
+[list of supported collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
16
17
There are two essential points to understand about how collecting metrics works in Netdata:
18
19
-- All collectors are **installed by default** with every installation of Netdata. You do not need to install
20
- collectors manually to collect metrics from new sources.
21
-- Upon startup, Netdata will **auto-detect** any application or service that has a
22
- [collector](/collectors/COLLECTORS.md), as long as both the collector and the app/service are configured correctly.
19
+- All collectors are **installed by default** with every installation of Netdata. You do not need to install
20
+ collectors manually to collect metrics from new sources.
21
+- Upon startup, Netdata will **auto-detect** any application or service that has a
22
+ [collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md), as long as both the collector
23
+ and the app/service are configured correctly.
24
25
Most users will want to enable a new Netdata collector for their app/service. For those details, see
25
-our [collectors' configuration reference](/collectors/REFERENCE.md).
26
+our [collectors' configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md).
27
28
## Take your next steps with collectors
29
29
-[Supported collectors list](/collectors/COLLECTORS.md)
30
+[Supported collectors list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md)
31
31
-[Collectors configuration reference](/collectors/REFERENCE.md)
32
+[Collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md)
33
34
## Guides
35
35
-[Monitor Nginx or Apache web server log files with Netdata](/docs/guides/collect-apache-nginx-web-logs.md)
36
+[Monitor Nginx or Apache web server log files with Netdata](https://github.com/netdata/netdata/blob/master/docs/guides/collect-apache-nginx-web-logs.md)
37
37
-[Monitor CockroachDB metrics with Netdata](/docs/guides/monitor-cockroachdb.md)
38
+[Monitor CockroachDB metrics with Netdata](https://github.com/netdata/netdata/blob/master/docs/guides/monitor-cockroachdb.md)
39
39
-[Monitor Unbound DNS servers with Netdata](/docs/guides/collect-unbound-metrics.md)
40
+[Monitor Unbound DNS servers with Netdata](https://github.com/netdata/netdata/blob/master/docs/guides/collect-unbound-metrics.md)
41
41
-[Monitor a Hadoop cluster with Netdata](/docs/guides/monitor-hadoop-cluster.md)
42
+[Monitor a Hadoop cluster with Netdata](https://github.com/netdata/netdata/blob/master/docs/guides/monitor-hadoop-cluster.md)
43
44
## Related features
45
45
-**[Dashboards](/web/README.md)**: Visualize your newly-collect metrics in real-time using Netdata's [built-in
46
-dashboard](/web/gui/README.md).
46
+**[Dashboards](https://github.com/netdata/netdata/blob/master/web/README.md)**: Visualize your newly-collect metrics in
47
+real-time using Netdata's [built-in dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md).
48
48
-**[Exporting](/exporting/README.md)**: Extend our built-in [database engine](/database/engine/README.md), which supports
49
-long-term metrics storage, by archiving metrics to external databases like Graphite, Prometheus, MongoDB, TimescaleDB, and more.
50
-It can export metrics to multiple databases simultaneously.
49
+**[Exporting](https://github.com/netdata/netdata/blob/master/exporting/README.md)**: Extend our
50
+built-in [database engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md), which supports
51
+long-term metrics storage, by archiving metrics to external databases like Graphite, Prometheus, MongoDB, TimescaleDB,
52
+and more. It can export metrics to multiple databases simultaneously.
53
54
collectors/REFERENCE.md
+3
-3
@@ -23,7 +23,7 @@ independent processes in a variety of programming languages based on their purpo
23
MySQL database, among many others.
24
25
For most users, enabling individual collectors for the application/service you're interested in is far more important
26
-than knowing which plugin it uses. See our [collectors list](/collectors/COLLECTORS.md) to see whether your favorite app/service has
26
+than knowing which plugin it uses. See our [collectors list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) to see whether your favorite app/service has
27
a collector, and then read the documentation for that specific collector to figure out how to enable it.
28
29
There are three types of plugins:
@@ -35,7 +35,7 @@ There are three types of plugins:
35
independent processes. They communicate with the daemon via pipes.
36
- **Plugin orchestrators**, which are external plugins that instead support a number of **modules**. Modules are a
37
type of collector. We have a few plugin orchestrators available for those who want to develop their own collectors,
38
- but focus most of our efforts on the [Go plugin](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/).
38
+ but focus most of our efforts on the [Go plugin](https://github.com/netdata/go.d.plugin/blob/master/README.md).
39
40
## Enable, configure, and disable modules
41
@@ -169,5 +169,5 @@ through this, is to examine what other similar plugins do.
169
170
## Write a custom collector
171
172
-You can add custom collectors by following the [external plugins documentation](/collectors/plugins.d/README.md).
172
+You can add custom collectors by following the [external plugins documentation](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md).
173
collectors/apps.plugin/README.md
+5
-5
@@ -66,8 +66,8 @@ Each of these sections provides the same number of charts:
66
- Network
67
- Sockets open (`apps.sockets`)
68
69
-In addition, if the [eBPF collector](/collectors/ebpf.plugin/README.md) is running, your dashboard will also show an
70
-additional [list of charts](/collectors/ebpf.plugin/README.md#integration-with-appsplugin) using low-level Linux
69
+In addition, if the [eBPF collector](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md) is running, your dashboard will also show an
70
+additional [list of charts](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md#integration-with-appsplugin) using low-level Linux
71
metrics.
72
73
The above are reported:
@@ -163,10 +163,10 @@ There are a few command line options you can pass to `apps.plugin`. The list of
163
### Integration with eBPF
164
165
If you don't see charts under the **eBPF syscall** or **eBPF net** sections, you should edit your
166
-[`ebpf.d.conf`](/collectors/ebpf.plugin/README.md#configure-the-ebpf-collector) file to ensure the eBPF program is enabled.
166
+[`ebpf.d.conf`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md#configure-the-ebpf-collector) file to ensure the eBPF program is enabled.
167
168
Also see our [guide on troubleshooting apps with eBPF
169
-metrics](/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md) for ideas on how to interpret these charts in a
169
+metrics](https://github.com/netdata/netdata/blob/master/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md) for ideas on how to interpret these charts in a
170
few scenarios.
171
172
## Permissions
@@ -237,7 +237,7 @@ Examples below for process group `sql`:
237
- Open Pipes 
238
- Open Sockets 
239
240
-For more information about badges check [Generating Badges](/web/api/badges/README.md)
240
+For more information about badges check [Generating Badges](https://github.com/netdata/netdata/blob/master/web/api/badges/README.md)
241
242
## Comparison with console tools
243
collectors/cgroups.plugin/README.md
+2
-2
@@ -78,7 +78,7 @@ currently unsupported when using unified cgroups.
78
### enabled cgroups
79
80
To provide a sane default, Netdata uses the
81
-following [pattern list](https://learn.netdata.cloud/docs/agent/libnetdata/simple_pattern):
81
+following [pattern list](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md):
82
83
- checks the pattern against the path of the cgroup
84
@@ -309,4 +309,4 @@ cannot find, but immediately:
309
- I/O full pressure
310
311
Network interfaces are monitored by means of
312
-the [proc plugin](/collectors/proc.plugin/README.md#monitored-network-interface-metrics).
312
+the [proc plugin](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md#monitored-network-interface-metrics).
collectors/charts.d.plugin/README.md
+5
-5
@@ -64,11 +64,11 @@ For a module called `X`, the following criteria must be met:
64
the collector cannot be used).
65
66
- `X_create()` - creates the Netdata charts, following the standard Netdata plugin guides as described in
67
- **[External Plugins](/collectors/plugins.d/README.md)** (commands `CHART` and `DIMENSION`).
67
+ **[External Plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md)** (commands `CHART` and `DIMENSION`).
68
The return value does matter: 0 = OK, 1 = FAILED.
69
70
- `X_update()` - collects the values for the defined charts, following the standard Netdata plugin guides
71
- as described in **[External Plugins](/collectors/plugins.d/README.md)** (commands `BEGIN`, `SET`, `END`).
71
+ as described in **[External Plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md)** (commands `BEGIN`, `SET`, `END`).
72
The return value also matters: 0 = OK, 1 = FAILED.
73
74
5. The following global variables are available to be set:
@@ -76,7 +76,7 @@ For a module called `X`, the following criteria must be met:
76
77
The module script may use more functions or variables. But all of them must begin with `X_`.
78
79
-The standard Netdata plugin variables are also available (check **[External Plugins](/collectors/plugins.d/README.md)**).
79
+The standard Netdata plugin variables are also available (check **[External Plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md)**).
80
81
### X_check()
82
@@ -90,7 +90,7 @@ connect to a local mysql database to find out if it can read the values it needs
90
### X_create()
91
92
The purpose of the BASH function `X_create()` is to create the charts and dimensions using the standard Netdata
93
-plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**).
93
+plugin guides (**[External Plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md)**).
94
95
`X_create()` will be called just once and only after `X_check()` was successful.
96
You can however call it yourself when there is need for it (for example to add a new dimension to an existing chart).
@@ -100,7 +100,7 @@ A non-zero return value will disable the collector.
100
### X_update()
101
102
`X_update()` will be called repeatedly every `X_update_every` seconds, to collect new values and send them to Netdata,
103
-following the Netdata plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**).
103
+following the Netdata plugin guides (**[External Plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md)**).
104
105
The function will be called with one parameter: microseconds since the last time it was run. This value should be
106
appended to the `BEGIN` statement of every chart updated by the collector script.
collectors/charts.d.plugin/ap/README.md
+1
-1
@@ -86,7 +86,7 @@ Station 40:b8:37:5a:ed:5e (on wlan0)
86
## Configuration
87
88
Edit the `charts.d/ap.conf` configuration file using `edit-config` from the Netdata [config
89
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
89
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
90
91
```bash
92
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/charts.d.plugin/apcupsd/README.md
+1
-1
@@ -14,7 +14,7 @@ Monitors different APC UPS models and retrieves status information using `apcacc
14
## Configuration
15
16
Edit the `charts.d/apcupsd.conf` configuration file using `edit-config` from the Netdata [config
17
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
17
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
18
19
```bash
20
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/charts.d.plugin/libreswan/README.md
+1
-1
@@ -25,7 +25,7 @@ The following charts are created, **per tunnel**:
25
## Configuration
26
27
Edit the `charts.d/libreswan.conf` configuration file using `edit-config` from the Netdata [config
28
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
28
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
29
30
```bash
31
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/charts.d.plugin/nut/README.md
+1
-1
@@ -54,7 +54,7 @@ The following charts will be created:
54
## Configuration
55
56
Edit the `charts.d/nut.conf` configuration file using `edit-config` from the Netdata [config
57
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
57
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
58
59
```bash
60
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/charts.d.plugin/opensips/README.md
+1
-1
@@ -12,7 +12,7 @@ learn_rel_path: "References/Collectors references/Networking"
12
## Configuration
13
14
Edit the `charts.d/opensips.conf` configuration file using `edit-config` from the Netdata [config
15
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
15
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
16
17
```bash
18
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/charts.d.plugin/sensors/README.md
+2
-2
@@ -31,7 +31,7 @@ One chart for every sensor chip found and each of the above will be created.
31
## Enable the collector
32
33
The `sensors` collector is disabled by default. To enable it, edit the `charts.d.conf` file using `edit-config` from the
34
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
34
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
35
36
```bash
37
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -48,7 +48,7 @@ sensors=force
48
## Configuration
49
50
Edit the `charts.d/sensors.conf` configuration file using `edit-config` from the
51
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
51
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
52
53
```bash
54
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/diskspace.plugin/README.md
+1
-1
@@ -42,6 +42,6 @@ Charts can be enabled/disabled for every mount separately:
42
# inodes usage = auto
43
```
44
45
-> for disks performance monitoring, see the `proc` plugin, [here](/collectors/proc.plugin/README.md#monitoring-disks)
45
+> for disks performance monitoring, see the `proc` plugin, [here](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md#monitoring-disks)
46
47
collectors/ebpf.plugin/README.md
+12
-12
@@ -15,7 +15,7 @@ The Netdata Agent provides many [eBPF](https://ebpf.io/what-is-ebpf/) programs t
15
> ❗ eBPF monitoring only works on Linux systems and with specific Linux kernels, including all kernels newer than `4.11.0`, and all kernels on CentOS 7.6 or later. For kernels older than `4.11.0`, improved support is in active development.
16
17
This document provides comprehensive details about the `ebpf.plugin`.
18
-For hands-on configuration and troubleshooting tips see our [tutorial on troubleshooting apps with eBPF metrics](/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md).
18
+For hands-on configuration and troubleshooting tips see our [tutorial on troubleshooting apps with eBPF metrics](https://github.com/netdata/netdata/blob/master/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md).
19
20
<figure>
21
<img src="https://user-images.githubusercontent.com/1153921/74746434-ad6a1e00-5222-11ea-858a-a7882617ae02.png" alt="An example of VFS charts, made possible by the eBPF collector plugin" />
@@ -44,12 +44,12 @@ If your Agent is v1.22 or older, you may to enable the collector yourself.
44
45
To enable or disable the entire eBPF collector:
46
47
-1. Navigate to the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory).
47
+1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
48
```bash
49
cd /etc/netdata
50
```
51
52
-2. Use the [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit `netdata.conf`.
52
+2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit `netdata.conf`.
53
54
```bash
55
./edit-config netdata.conf
@@ -69,11 +69,11 @@ You can configure the eBPF collector's behavior to fine-tune which metrics you r
69
70
To edit the `ebpf.d.conf`:
71
72
-1. Navigate to the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory).
72
+1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
73
```bash
74
cd /etc/netdata
75
```
76
-2. Use the [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit [`ebpf.d.conf`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/ebpf.d.conf).
76
+2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit [`ebpf.d.conf`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/ebpf.d.conf).
77
78
```bash
79
./edit-config ebpf.d.conf
@@ -105,7 +105,7 @@ accepts the following values:
105
#### Integration with `apps.plugin`
106
107
The eBPF collector also creates charts for each running application through an integration with the
108
-[`apps.plugin`](/collectors/apps.plugin/README.md). This integration helps you understand how specific applications
108
+[`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md). This integration helps you understand how specific applications
109
interact with the Linux kernel.
110
111
If you want to enable `apps.plugin` integration, change the "apps" setting to "yes".
@@ -123,7 +123,7 @@ it runs.
123
#### Integration with `cgroups.plugin`
124
125
The eBPF collector also creates charts for each cgroup through an integration with the
126
-[`cgroups.plugin`](/collectors/cgroups.plugin/README.md). This integration helps you understand how a specific cgroup
126
+[`cgroups.plugin`](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md). This integration helps you understand how a specific cgroup
127
interacts with the Linux kernel.
128
129
The integration with `cgroups.plugin` is disabled by default to avoid creating overhead on your system. If you want to
@@ -245,7 +245,7 @@ The eBPF collector enables and runs the following eBPF programs by default:
245
You can also enable the following eBPF programs:
246
247
- `cachestat`: Netdata's eBPF data collector creates charts about the memory page cache. When the integration with
248
- [`apps.plugin`](/collectors/apps.plugin/README.md) is enabled, this collector creates charts for the whole host _and_
248
+ [`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) is enabled, this collector creates charts for the whole host _and_
249
for each application.
250
- `dcstat` : This eBPF program creates charts that show information about file access using directory cache. It appends
251
`kprobes` for `lookup_fast()` and `d_lookup()` to identify if files are inside directory cache, outside and files are
@@ -262,11 +262,11 @@ You can configure each thread of the eBPF data collector. This allows you to ove
262
263
To configure an eBPF thread:
264
265
-1. Navigate to the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory).
265
+1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
266
```bash
267
cd /etc/netdata
268
```
269
-2. Use the [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit a thread configuration file. The following configuration files are available:
269
+2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit a thread configuration file. The following configuration files are available:
270
271
- `network.conf`: Configuration for the [`network` thread](#network-configuration). This config file overwrites the global options and also
272
lets you specify which network the eBPF collector monitors.
@@ -305,7 +305,7 @@ You can configure the information shown on `outbound` and `inbound` charts with
305
306
When you define a `ports` setting, Netdata will collect network metrics for that specific port. For example, if you
307
write `ports = 19999`, Netdata will collect only connections for itself. The `hostnames` setting accepts
308
-[simple patterns](/libnetdata/simple_pattern/README.md). The `ports`, and `ips` settings accept negation (`!`) to deny
308
+[simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md). The `ports`, and `ips` settings accept negation (`!`) to deny
309
specific values or asterisk alone to define all values.
310
311
In the above example, Netdata will collect metrics for all ports between 1 and 443, with the exception of 53 (domain)
@@ -882,7 +882,7 @@ significantly increases kernel memory usage by several hundred MB.
882
883
If your node is experiencing high memory usage and there is no obvious culprit to be found in the `apps.mem` chart,
884
consider testing for high kernel memory usage by [disabling eBPF monitoring](#configuring-ebpfplugin). Next,
885
-[restart Netdata](/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see if system memory
885
+[restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see if system memory
886
usage (see the `system.ram` chart) has dropped significantly.
887
888
Beginning with `v1.31`, kernel memory usage is configurable via the [`pid table size` setting](#ebpf-load-mode)
collectors/plugins.d/README.md
+12
-12
@@ -16,18 +16,18 @@ from external processes, thus allowing Netdata to use **external plugins**.
16
17
|plugin|language|O/S|description|
18
|:----:|:------:|:-:|:----------|
19
-|[apps.plugin](/collectors/apps.plugin/README.md)|`C`|linux, freebsd|monitors the whole process tree on Linux and FreeBSD and breaks down system resource usage by **process**, **user** and **user group**.|
20
-|[charts.d.plugin](/collectors/charts.d.plugin/README.md)|`BASH`|all|a **plugin orchestrator** for data collection modules written in `BASH` v4+.|
21
-|[cups.plugin](/collectors/cups.plugin/README.md)|`C`|all|monitors **CUPS**|
19
+|[apps.plugin](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md)|`C`|linux, freebsd|monitors the whole process tree on Linux and FreeBSD and breaks down system resource usage by **process**, **user** and **user group**.|
20
+|[charts.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/README.md)|`BASH`|all|a **plugin orchestrator** for data collection modules written in `BASH` v4+.|
21
+|[cups.plugin](https://github.com/netdata/netdata/blob/master/collectors/cups.plugin/README.md)|`C`|all|monitors **CUPS**|
22
|[ebpf.plugin](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md)|`C`|linux|monitors different metrics on environments using kernel internal functions.|
23
|[go.d.plugin](https://github.com/netdata/go.d.plugin/blob/master/README.md)|`GO`|all|collects metrics from the system, applications, or third-party APIs.|
24
-|[ioping.plugin](/collectors/ioping.plugin/README.md)|`C`|all|measures disk latency.|
25
-|[freeipmi.plugin](/collectors/freeipmi.plugin/README.md)|`C`|linux|collects metrics from enterprise hardware sensors, on Linux servers.|
26
-|[nfacct.plugin](/collectors/nfacct.plugin/README.md)|`C`|linux|collects netfilter firewall, connection tracker and accounting metrics using `libmnl` and `libnetfilter_acct`.|
27
-|[xenstat.plugin](/collectors/xenstat.plugin/README.md)|`C`|linux|collects XenServer and XCP-ng metrics using `lxenstat`.|
28
-|[perf.plugin](/collectors/perf.plugin/README.md)|`C`|linux|collects CPU performance metrics using performance monitoring units (PMU).|
29
-|[python.d.plugin](/collectors/python.d.plugin/README.md)|`python`|all|a **plugin orchestrator** for data collection modules written in `python` v2 or v3 (both are supported).|
30
-|[slabinfo.plugin](/collectors/slabinfo.plugin/README.md)|`C`|linux|collects kernel internal cache objects (SLAB) metrics.|
24
+|[ioping.plugin](https://github.com/netdata/netdata/blob/master/collectors/ioping.plugin/README.md)|`C`|all|measures disk latency.|
25
+|[freeipmi.plugin](https://github.com/netdata/netdata/blob/master/collectors/freeipmi.plugin/README.md)|`C`|linux|collects metrics from enterprise hardware sensors, on Linux servers.|
26
+|[nfacct.plugin](https://github.com/netdata/netdata/blob/master/collectors/nfacct.plugin/README.md)|`C`|linux|collects netfilter firewall, connection tracker and accounting metrics using `libmnl` and `libnetfilter_acct`.|
27
+|[xenstat.plugin](https://github.com/netdata/netdata/blob/master/collectors/xenstat.plugin/README.md)|`C`|linux|collects XenServer and XCP-ng metrics using `lxenstat`.|
28
+|[perf.plugin](https://github.com/netdata/netdata/blob/master/collectors/perf.plugin/README.md)|`C`|linux|collects CPU performance metrics using performance monitoring units (PMU).|
29
+|[python.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md)|`python`|all|a **plugin orchestrator** for data collection modules written in `python` v2 or v3 (both are supported).|
30
+|[slabinfo.plugin](https://github.com/netdata/netdata/blob/master/collectors/slabinfo.plugin/README.md)|`C`|linux|collects kernel internal cache objects (SLAB) metrics.|
31
32
Plugin orchestrators may also be described as **modular plugins**. They are modular since they accept custom made modules to be included. Writing modules for these plugins is easier than accessing the native Netdata API directly. You will find modules already available for each orchestrator under the directory of the particular modular plugin (e.g. under python.d.plugin for the python orchestrator).
33
Each of these modular plugins has each own methods for defining modules. Please check the examples and their documentation.
@@ -508,12 +508,12 @@ or do not output the line at all.
508
## Modular Plugins
509
510
1. **python**, use `python.d.plugin`, there are many examples in the [python.d
511
- directory](/collectors/python.d.plugin/README.md)
511
+ directory](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md)
512
513
python is ideal for Netdata plugins. It is a simple, yet powerful way to collect data, it has a very small memory footprint, although it is not the most CPU efficient way to do it.
514
515
2. **BASH**, use `charts.d.plugin`, there are many examples in the [charts.d
516
- directory](/collectors/charts.d.plugin/README.md)
516
+ directory](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/README.md)
517
518
BASH is the simplest scripting language for collecting values. It is the less efficient though in terms of CPU resources. You can use it to collect data quickly, but extensive use of it might use a lot of system resources.
519
collectors/proc.plugin/README.md
+1
-1
@@ -404,7 +404,7 @@ You can set the following values for each configuration option:
404
405
There are several alarms defined in `health.d/net.conf`.
406
407
-The tricky ones are `inbound packets dropped` and `inbound packets dropped ratio`. They have quite a strict policy so that they warn users about possible issues. These alarms can be annoying for some network configurations. It is especially true for some bonding configurations if an interface is a child or a bonding interface itself. If it is expected to have a certain number of drops on an interface for a certain network configuration, a separate alarm with different triggering thresholds can be created or the existing one can be disabled for this specific interface. It can be done with the help of the [families](/health/REFERENCE.md#alarm-line-families) line in the alarm configuration. For example, if you want to disable the `inbound packets dropped` alarm for `eth0`, set `families: !eth0 *` in the alarm definition for `template: inbound_packets_dropped`.
407
+The tricky ones are `inbound packets dropped` and `inbound packets dropped ratio`. They have quite a strict policy so that they warn users about possible issues. These alarms can be annoying for some network configurations. It is especially true for some bonding configurations if an interface is a child or a bonding interface itself. If it is expected to have a certain number of drops on an interface for a certain network configuration, a separate alarm with different triggering thresholds can be created or the existing one can be disabled for this specific interface. It can be done with the help of the [families](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-families) line in the alarm configuration. For example, if you want to disable the `inbound packets dropped` alarm for `eth0`, set `families: !eth0 *` in the alarm definition for `template: inbound_packets_dropped`.
408
409
#### configuration
410
collectors/python.d.plugin/README.md
+3
-3
@@ -90,7 +90,7 @@ plugin](https://raw.githubusercontent.com/netdata/netdata/master/collectors/pyth
90
Netdata (as opposed to having to install Netdata from source again with your new changes) to can copy over the relevant
91
file to where Netdata expects it and then either `sudo systemctl restart netdata` to have it be picked up and used by
92
Netdata or you can just run the updated collector in debug mode by following a process like below (this assumes you have
93
-[installed Netdata from a GitHub fork](https://learn.netdata.cloud/docs/agent/packaging/installer/methods/manual) you
93
+[installed Netdata from a GitHub fork](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md) you
94
have made to do your development on).
95
96
```bash
@@ -129,7 +129,7 @@ CHART = {
129
]}
130
```
131
132
-All names are better explained in the [External Plugins](/collectors/plugins.d/README.md) section.
132
+All names are better explained in the [External Plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md) section.
133
Parameters like `priority` and `update_every` are handled by `python.d.plugin`.
134
135
### `Service` class
@@ -231,7 +231,7 @@ For additional security it uses python `subprocess.Popen` (without `shell=True`
231
232
_Examples: `apache`, `nginx`, `tomcat`_
233
234
-_Multiple Endpoints (urls) Examples: [`rabbitmq`](/collectors/python.d.plugin/rabbitmq/README.md) (simpler).
234
+_Multiple Endpoints (urls) Examples: [`rabbitmq`](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/rabbitmq/README.md) (simpler).
235
236
237
_Variables from config file_: `url`, `user`, `pass`.
collectors/python.d.plugin/adaptec_raid/README.md
+3
-3
@@ -55,7 +55,7 @@ systemctl restart netdata.service
55
## Enable the collector
56
57
The `adaptec_raid` collector is disabled by default. To enable it, use `edit-config` from the
58
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
58
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
59
file.
60
61
```bash
@@ -64,12 +64,12 @@ sudo ./edit-config python.d.conf
64
```
65
66
Change the value of the `adaptec_raid` setting to `yes`. Save the file and restart the Netdata Agent with `sudo
67
-systemctl restart netdata`, or the [appropriate method](/docs/configure/start-stop-restart.md) for your system.
67
+systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
68
69
## Configuration
70
71
Edit the `python.d/adaptec_raid.conf` configuration file using `edit-config` from the
72
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
72
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
73
74
```bash
75
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/alarms/README.md
+2
-2
@@ -26,7 +26,7 @@ Below is an example of the chart produced when running `stress-ng --all 2` for a
26
27
## Configuration
28
29
-Enable the collector and [restart Netdata](/docs/configure/start-stop-restart.md).
29
+Enable the collector and [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
30
31
```bash
32
cd /etc/netdata/
@@ -36,7 +36,7 @@ sudo systemctl restart netdata
36
```
37
38
If needed, edit the `python.d/alarms.conf` configuration file using `edit-config` from the your agent's [config
39
-directory](/docs/configure/nodes.md), which is usually at `/etc/netdata`.
39
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is usually at `/etc/netdata`.
40
41
```bash
42
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/am2320/README.md
+1
-1
@@ -24,7 +24,7 @@ It produces the following charts:
24
## Configuration
25
26
Edit the `python.d/am2320.conf` configuration file using `edit-config` from the Netdata [config
27
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
27
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
28
29
```bash
30
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/anomalies/README.md
+4
-4
@@ -11,7 +11,7 @@ learn_rel_path: "References/Collectors references/Misc"
11
12
# Anomaly detection with Netdata
13
14
-**Note**: Check out the [Netdata Anomaly Advisor](https://learn.netdata.cloud/docs/cloud/insights/anomaly-advisor) for a more native anomaly detection experience within Netdata.
14
+**Note**: Check out the [Netdata Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx) for a more native anomaly detection experience within Netdata.
15
16
This collector uses the Python [PyOD](https://pyod.readthedocs.io/en/latest/index.html) library to perform unsupervised [anomaly detection](https://en.wikipedia.org/wiki/Anomaly_detection) on your Netdata charts and/or dimensions.
17
@@ -74,7 +74,7 @@ The configuration for the anomalies collector defines how it will behave on your
74
_**Note**: If you are unsure about any of the below configuration options then it's best to just ignore all this and leave the `anomalies.conf` file alone to begin with. Then you can return to it later if you would like to tune things a bit more once the collector is running for a while and you have a feeling for its performance on your node._
75
76
Edit the `python.d/anomalies.conf` configuration file using `edit-config` from the your agent's [config
77
-directory](/docs/configure/nodes.md), which is usually at `/etc/netdata`.
77
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is usually at `/etc/netdata`.
78
79
```bash
80
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -220,7 +220,7 @@ If you would like to go deeper on what exactly the anomalies collector is doing
220
221
## Notes
222
223
-- Python 3 is required as the [`netdata-pandas`](https://github.com/netdata/netdata-pandas) package uses Python async libraries ([asks](https://pypi.org/project/asks/) and [trio](https://pypi.org/project/trio/)) to make asynchronous calls to the [Netdata REST API](https://learn.netdata.cloud/docs/agent/web/api) to get the required data for each chart.
223
+- Python 3 is required as the [`netdata-pandas`](https://github.com/netdata/netdata-pandas) package uses Python async libraries ([asks](https://pypi.org/project/asks/) and [trio](https://pypi.org/project/trio/)) to make asynchronous calls to the [Netdata REST API](https://github.com/netdata/netdata/blob/master/web/api/README.md) to get the required data for each chart.
224
- Python 3 is also required for the underlying ML libraries of [numba](https://pypi.org/project/numba/), [scikit-learn](https://pypi.org/project/scikit-learn/), and [PyOD](https://pypi.org/project/pyod/).
225
- It may take a few hours or so (depending on your choice of `train_secs_n`) for the collector to 'settle' into it's typical behaviour in terms of the trained models and probabilities you will see in the normal running of your node.
226
- As this collector does most of the work in Python itself, with [PyOD](https://pyod.readthedocs.io/en/latest/) leveraging [numba](https://numba.pydata.org/) under the hood, you may want to try it out first on a test or development system to get a sense of its performance characteristics on a node similar to where you would like to use it.
@@ -235,7 +235,7 @@ If you would like to go deeper on what exactly the anomalies collector is doing
235
- If you activate this collector on a fresh node, it might take a little while to build up enough data to calculate a realistic and useful model.
236
- Some models like `iforest` can be comparatively expensive (on same n1-standard-2 system above ~2s runtime during predict, ~40s training time, ~50% cpu on both train and predict) so if you would like to use it you might be advised to set a relatively high `update_every` maybe 10, 15 or 30 in `anomalies.conf`.
237
- Setting a higher `train_every_n` and `update_every` is an easy way to devote less resources on the node to anomaly detection. Specifying less charts and a lower `train_n_secs` will also help reduce resources at the expense of covering less charts and maybe a more noisy model if you set `train_n_secs` to be too small for how your node tends to behave.
238
-- If you would like to enable this on a Raspberry Pi, then check out [this guide](https://learn.netdata.cloud/guides/monitor/raspberry-pi-anomaly-detection) which will guide you through first installing LLVM.
238
+- If you would like to enable this on a Raspberry Pi, then check out [this guide](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/raspberry-pi-anomaly-detection.md) which will guide you through first installing LLVM.
239
240
## Useful links and further reading
241
collectors/python.d.plugin/beanstalk/README.md
+1
-1
@@ -115,7 +115,7 @@ Provides server and tube-level statistics.
115
## Configuration
116
117
Edit the `python.d/beanstalk.conf` configuration file using `edit-config` from the Netdata [config
118
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
118
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
119
120
```bash
121
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/bind_rndc/README.md
+1
-1
@@ -61,7 +61,7 @@ It produces:
61
## Configuration
62
63
Edit the `python.d/bind_rndc.conf` configuration file using `edit-config` from the Netdata [config
64
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
64
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
65
66
```bash
67
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/boinc/README.md
+1
-1
@@ -16,7 +16,7 @@ It provides charts tracking the total number of tasks and active tasks, as well
16
## Configuration
17
18
Edit the `python.d/boinc.conf` configuration file using `edit-config` from the Netdata [config
19
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
19
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
20
21
```bash
22
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/ceph/README.md
+1
-1
@@ -31,7 +31,7 @@ Monitors the ceph cluster usage and consumption data of a server, and produces:
31
## Configuration
32
33
Edit the `python.d/ceph.conf` configuration file using `edit-config` from the Netdata [config
34
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
34
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
35
36
```bash
37
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/changefinder/README.md
+1
-1
@@ -97,7 +97,7 @@ leave the `changefinder.conf` file alone to begin with. Then you can return to i
97
a bit more once the collector is running for a while and you have a feeling for its performance on your node._
98
99
Edit the `python.d/changefinder.conf` configuration file using `edit-config` from the your
100
-agent's [config directory](/docs/configure/nodes.md), which is usually at `/etc/netdata`.
100
+agent's [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is usually at `/etc/netdata`.
101
102
```bash
103
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/dovecot/README.md
+1
-1
@@ -81,7 +81,7 @@ Module gives information with following charts:
81
## Configuration
82
83
Edit the `python.d/dovecot.conf` configuration file using `edit-config` from the Netdata [config
84
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
84
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
85
86
```bash
87
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/example/README.md
+1
-1
@@ -13,6 +13,6 @@ You can add custom data collectors using Python.
13
14
Netdata provides an [example python data collection module](https://github.com/netdata/netdata/tree/master/collectors/python.d.plugin/example).
15
16
-If you want to write your own collector, read our [writing a new Python module](/collectors/python.d.plugin/README.md#how-to-write-a-new-module) tutorial.
16
+If you want to write your own collector, read our [writing a new Python module](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#how-to-write-a-new-module) tutorial.
17
18
collectors/python.d.plugin/fail2ban/README.md
+1
-1
@@ -61,7 +61,7 @@ To persist the changes after rotating the log file, add `create 640 root netdata
61
## Configuration
62
63
Edit the `python.d/fail2ban.conf` configuration file using `edit-config` from the
64
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
64
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
65
66
```bash
67
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/gearman/README.md
+1
-1
@@ -30,7 +30,7 @@ It produces:
30
## Configuration
31
32
Edit the `python.d/gearman.conf` configuration file using `edit-config` from the Netdata [config
33
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
33
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
34
35
```bash
36
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/go_expvar/README.md
+5
-5
@@ -212,8 +212,8 @@ See [this issue](https://github.com/netdata/netdata/pull/1902#issuecomment-28449
212
213
Please see these two links to the official Netdata documentation for more information about the values:
214
215
-- [External plugins - charts](/collectors/plugins.d/README.md#chart)
216
-- [Chart variables](/collectors/python.d.plugin/README.md#global-variables-order-and-chart)
215
+- [External plugins - charts](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#chart)
216
+- [Chart variables](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#global-variables-order-and-chart)
217
218
**Line definitions**
219
@@ -236,7 +236,7 @@ hidden: False
236
```
237
238
Please see the following link for more information about the options and their default values:
239
-[External plugins - dimensions](/collectors/plugins.d/README.md#dimension)
239
+[External plugins - dimensions](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#dimension)
240
241
Apart from top-level expvars, this plugin can also parse expvars stored in a multi-level map;
242
All dicts in the resulting JSON document are then flattened to one level.
@@ -258,7 +258,7 @@ the first defined key wins and all subsequent keys with the same name are ignore
258
## Enable the collector
259
260
The `go_expvar` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config
261
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
261
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.
262
263
```bash
264
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -271,7 +271,7 @@ restart netdata`, or the appropriate method for your system, to finish enabling
271
## Configuration
272
273
Edit the `python.d/go_expvar.conf` configuration file using `edit-config` from the Netdata [config
274
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
274
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
275
276
```bash
277
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/haproxy/README.md
+1
-1
@@ -42,7 +42,7 @@ It produces:
42
## Configuration
43
44
Edit the `python.d/haproxy.conf` configuration file using `edit-config` from the Netdata [config
45
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
45
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
46
47
```bash
48
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/hddtemp/README.md
+1
-1
@@ -19,7 +19,7 @@ It produces one chart **Temperature** with dynamic number of dimensions (one per
19
## Configuration
20
21
Edit the `python.d/hddtemp.conf` configuration file using `edit-config` from the Netdata [config
22
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
22
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
23
24
```bash
25
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/hpssa/README.md
+4
-4
@@ -54,7 +54,7 @@ systemctl restart netdata.service
54
## Enable the collector
55
56
The `hpssa` collector is disabled by default. To enable it, use `edit-config` from the
57
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
57
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
58
file.
59
60
```bash
@@ -63,12 +63,12 @@ sudo ./edit-config python.d.conf
63
```
64
65
Change the value of the `hpssa` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
66
-restart netdata`, or the [appropriate method](/docs/configure/start-stop-restart.md) for your system.
66
+restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
67
68
## Configuration
69
70
Edit the `python.d/hpssa.conf` configuration file using `edit-config` from the
71
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
71
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
72
73
```bash
74
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -82,5 +82,5 @@ ssacli_path: /usr/sbin/ssacli
82
```
83
84
Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate
85
-method](/docs/configure/start-stop-restart.md) for your system.
85
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
86
collectors/python.d.plugin/icecast/README.md
+1
-1
@@ -24,7 +24,7 @@ It produces the following charts:
24
## Configuration
25
26
Edit the `python.d/icecast.conf` configuration file using `edit-config` from the Netdata [config
27
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
27
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
28
29
```bash
30
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/ipfs/README.md
+1
-1
@@ -23,7 +23,7 @@ It produces the following charts:
23
## Configuration
24
25
Edit the `python.d/ipfs.conf` configuration file using `edit-config` from the Netdata [config
26
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
26
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
27
28
```bash
29
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/litespeed/README.md
+1
-1
@@ -56,7 +56,7 @@ It produces:
56
## Configuration
57
58
Edit the `python.d/litespeed.conf` configuration file using `edit-config` from the Netdata [config
59
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
59
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
60
61
```bash
62
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/megacli/README.md
+3
-3
@@ -56,7 +56,7 @@ systemctl restart netdata.service
56
## Enable the collector
57
58
The `megacli` collector is disabled by default. To enable it, use `edit-config` from the
59
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
59
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
60
file.
61
62
```bash
@@ -70,7 +70,7 @@ with `sudo systemctl restart netdata`, or the appropriate method for your system
70
## Configuration
71
72
Edit the `python.d/megacli.conf` configuration file using `edit-config` from the
73
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
73
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
74
75
```bash
76
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -84,6 +84,6 @@ do_battery: yes
84
```
85
86
Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate
87
-method](/docs/configure/start-stop-restart.md) for your system.
87
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
88
89
collectors/python.d.plugin/memcached/README.md
+1
-1
@@ -79,7 +79,7 @@ Collects memory-caching system performance metrics. It reads server response to
79
## Configuration
80
81
Edit the `python.d/memcached.conf` configuration file using `edit-config` from the Netdata [config
82
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
82
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
83
84
```bash
85
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/monit/README.md
+21
-18
@@ -9,29 +9,32 @@ learn_rel_path: "References/Collectors references/Storage"
9
10
# Monit monitoring with Netdata
11
12
-Monit monitoring module. Data is grabbed from stats XML interface (exists for a long time, but not mentioned in official documentation). Mostly this plugin shows statuses of monit targets, i.e. [statuses of specified checks](https://mmonit.com/monit/documentation/monit.html#Service-checks).
12
+Monit monitoring module. Data is grabbed from stats XML interface (exists for a long time, but not mentioned in official
13
+documentation). Mostly this plugin shows statuses of monit targets, i.e.
14
+[statuses of specified checks](https://mmonit.com/monit/documentation/monit.html#Service-checks).
15
14
-1. **Filesystems**
16
+1. **Filesystems**
17
16
- - Filesystems
17
- - Directories
18
- - Files
19
- - Pipes
18
+ - Filesystems
19
+ - Directories
20
+ - Files
21
+ - Pipes
22
21
-2. **Applications**
23
+2. **Applications**
24
23
- - Processes (+threads/childs)
24
- - Programs
25
+ - Processes (+threads/childs)
26
+ - Programs
27
26
-3. **Network**
28
+3. **Network**
29
28
- - Hosts (+latency)
29
- - Network interfaces
30
+ - Hosts (+latency)
31
+ - Network interfaces
32
33
## Configuration
34
33
-Edit the `python.d/monit.conf` configuration file using `edit-config` from the Netdata [config
34
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
35
+Edit the `python.d/monit.conf` configuration file using `edit-config` from the
36
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically
37
+at `/etc/netdata`.
38
39
```bash
40
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -42,10 +45,10 @@ Sample:
45
46
```yaml
47
local:
45
- name : 'local'
46
- url : 'http://localhost:2812'
47
- user: : admin
48
- pass: : monit
48
+ name: 'local'
49
+ url: 'http://localhost:2812'
50
+ user: : admin
51
+ pass: : monit
52
```
53
54
If no configuration is given, module will attempt to connect to monit as `http://localhost:2812`.
collectors/python.d.plugin/nvidia_smi/README.md
+2
-2
@@ -11,7 +11,7 @@ learn_rel_path: "References/Collectors references/Devices"
11
12
Monitors performance metrics (memory usage, fan speed, pcie bandwidth utilization, temperature, etc.) using `nvidia-smi` cli tool.
13
14
-> **Warning**: this collector does not work when the Netdata Agent is [running in a container](https://learn.netdata.cloud/docs/agent/packaging/docker).
14
+> **Warning**: this collector does not work when the Netdata Agent is [running in a container](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md).
15
16
17
## Requirements and Notes
@@ -51,7 +51,7 @@ It produces the following charts:
51
## Configuration
52
53
Edit the `python.d/nvidia_smi.conf` configuration file using `edit-config` from the Netdata [config
54
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
54
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
55
56
```bash
57
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/openldap/README.md
+1
-1
@@ -59,7 +59,7 @@ Statistics are taken from LDAP monitoring interface. Manual page, slapd-monitor(
59
## Configuration
60
61
Edit the `python.d/openldap.conf` configuration file using `edit-config` from the Netdata [config
62
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
62
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
63
64
```bash
65
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/oracledb/README.md
+1
-1
@@ -74,7 +74,7 @@ GRANT SELECT_CATALOG_ROLE TO netdata;
74
## Configuration
75
76
Edit the `python.d/oracledb.conf` configuration file using `edit-config` from the Netdata [config
77
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
77
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
78
79
```bash
80
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/puppet/README.md
+1
-1
@@ -36,7 +36,7 @@ Following charts are drawn:
36
## Configuration
37
38
Edit the `python.d/puppet.conf` configuration file using `edit-config` from the Netdata [config
39
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
39
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
40
41
```bash
42
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/rabbitmq/README.md
+1
-1
@@ -96,7 +96,7 @@ Per Vhost charts:
96
## Configuration
97
98
Edit the `python.d/rabbitmq.conf` configuration file using `edit-config` from the Netdata [config
99
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
99
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
100
101
```bash
102
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/rethinkdbs/README.md
+17
-16
@@ -13,27 +13,28 @@ Collects database server and cluster statistics.
13
14
Following charts are drawn:
15
16
-1. **Connected Servers**
16
+1. **Connected Servers**
17
18
- - connected
19
- - missing
18
+ - connected
19
+ - missing
20
21
-2. **Active Clients**
21
+2. **Active Clients**
22
23
- - active
23
+ - active
24
25
-3. **Queries** per second
25
+3. **Queries** per second
26
27
- - queries
27
+ - queries
28
29
-4. **Documents** per second
29
+4. **Documents** per second
30
31
- - documents
31
+ - documents
32
33
## Configuration
34
35
-Edit the `python.d/rethinkdbs.conf` configuration file using `edit-config` from the Netdata [config
36
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
35
+Edit the `python.d/rethinkdbs.conf` configuration file using `edit-config` from the
36
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically
37
+at `/etc/netdata`.
38
39
```bash
40
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -42,11 +43,11 @@ sudo ./edit-config python.d/rethinkdbs.conf
43
44
```yaml
45
localhost:
45
- name : 'local'
46
- host : '127.0.0.1'
47
- port : 28015
48
- user : "user"
49
- password : "pass"
46
+ name: 'local'
47
+ host: '127.0.0.1'
48
+ port: 28015
49
+ user: "user"
50
+ password: "pass"
51
```
52
53
When no configuration file is found, module tries to connect to `127.0.0.1:28015`.
collectors/python.d.plugin/retroshare/README.md
+1
-1
@@ -25,7 +25,7 @@ This module produces the following charts:
25
## Configuration
26
27
Edit the `python.d/retroshare.conf` configuration file using `edit-config` from the Netdata [config
28
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
28
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
29
30
```bash
31
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/riakkv/README.md
+1
-1
@@ -106,7 +106,7 @@ listed
106
## Configuration
107
108
Edit the `python.d/riakkv.conf` configuration file using `edit-config` from the Netdata [config
109
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
109
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
110
111
```bash
112
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/samba/README.md
+3
-3
@@ -98,7 +98,7 @@ systemctl restart netdata.service
98
## Enable the collector
99
100
The `samba` collector is disabled by default. To enable it, use `edit-config` from the
101
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
101
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`, to edit the `python.d.conf`
102
file.
103
104
```bash
@@ -107,12 +107,12 @@ sudo ./edit-config python.d.conf
107
```
108
109
Change the value of the `samba` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl
110
-restart netdata`, or the [appropriate method](/docs/configure/start-stop-restart.md) for your system.
110
+restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
111
112
## Configuration
113
114
Edit the `python.d/samba.conf` configuration file using `edit-config` from the
115
-Netdata [config directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
115
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
116
117
```bash
118
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/sensors/README.md
+2
-2
@@ -16,7 +16,7 @@ Charts are created dynamically.
16
## Configuration
17
18
Edit the `python.d/sensors.conf` configuration file using `edit-config` from the Netdata [config
19
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
19
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
20
21
```bash
22
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -29,7 +29,7 @@ There have been reports from users that on certain servers, ACPI ring buffer err
29
We are tracking such cases in issue [#827](https://github.com/netdata/netdata/issues/827).
30
Please join this discussion for help.
31
32
-When `lm-sensors` doesn't work on your device (e.g. for RPi temperatures), use [the legacy bash collector](https://learn.netdata.cloud/docs/agent/collectors/charts.d.plugin/sensors)
32
+When `lm-sensors` doesn't work on your device (e.g. for RPi temperatures), use [the legacy bash collector](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/sensors/README.md)
33
34
---
35
collectors/python.d.plugin/smartd_log/README.md
+1
-1
@@ -109,7 +109,7 @@ Otherwise, all the smartd `.csv` files may get written to `/var/lib/smartmontool
109
## Configuration
110
111
Edit the `python.d/smartd_log.conf` configuration file using `edit-config` from the Netdata [config
112
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
112
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
113
114
```bash
115
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/spigotmc/README.md
+1
-1
@@ -21,7 +21,7 @@ the data returned by the `tps` or `list` console commands.
21
## Configuration
22
23
Edit the `python.d/spigotmc.conf` configuration file using `edit-config` from the Netdata [config
24
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
24
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
25
26
```bash
27
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/squid/README.md
+1
-1
@@ -38,7 +38,7 @@ It produces following charts:
38
## Configuration
39
40
Edit the `python.d/squid.conf` configuration file using `edit-config` from the Netdata [config
41
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
41
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
42
43
```bash
44
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/tomcat/README.md
+1
-1
@@ -33,7 +33,7 @@ Charts:
33
## Configuration
34
35
Edit the `python.d/tomcat.conf` configuration file using `edit-config` from the Netdata [config
36
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
36
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
37
38
```bash
39
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/tor/README.md
+1
-1
@@ -26,7 +26,7 @@ It produces only one chart:
26
## Configuration
27
28
Edit the `python.d/tor.conf` configuration file using `edit-config` from the Netdata [config
29
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
29
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
30
31
```bash
32
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/traefik/README.md
+28
-27
@@ -13,45 +13,46 @@ Uses the `health` API to provide statistics.
13
14
It produces:
15
16
-1. **Responses** by statuses
16
+1. **Responses** by statuses
17
18
- - success (1xx, 2xx, 304)
19
- - error (5xx)
20
- - redirect (3xx except 304)
21
- - bad (4xx)
22
- - other (all other responses)
18
+ - success (1xx, 2xx, 304)
19
+ - error (5xx)
20
+ - redirect (3xx except 304)
21
+ - bad (4xx)
22
+ - other (all other responses)
23
24
-2. **Responses** by codes
24
+2. **Responses** by codes
25
26
- - 2xx (successful)
27
- - 5xx (internal server errors)
28
- - 3xx (redirect)
29
- - 4xx (bad)
30
- - 1xx (informational)
31
- - other (non-standart responses)
26
+ - 2xx (successful)
27
+ - 5xx (internal server errors)
28
+ - 3xx (redirect)
29
+ - 4xx (bad)
30
+ - 1xx (informational)
31
+ - other (non-standart responses)
32
33
-3. **Detailed Response Codes** requests/s (number of responses for each response code family individually)
33
+3. **Detailed Response Codes** requests/s (number of responses for each response code family individually)
34
35
-4. **Requests**/s
35
+4. **Requests**/s
36
37
- - request statistics
37
+ - request statistics
38
39
-5. **Total response time**
39
+5. **Total response time**
40
41
- - sum of all response time
41
+ - sum of all response time
42
43
-6. **Average response time**
43
+6. **Average response time**
44
45
-7. **Average response time per iteration**
45
+7. **Average response time per iteration**
46
47
-8. **Uptime**
47
+8. **Uptime**
48
49
- - Traefik server uptime
49
+ - Traefik server uptime
50
51
## Configuration
52
53
-Edit the `python.d/traefik.conf` configuration file using `edit-config` from the Netdata [config
54
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
53
+Edit the `python.d/traefik.conf` configuration file using `edit-config` from the
54
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically
55
+at `/etc/netdata`.
56
57
```bash
58
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -63,11 +64,11 @@ Needs only `url` to server's `health`
64
Here is an example for local server:
65
66
```yaml
66
-update_every : 1
67
-priority : 60000
67
+update_every: 1
68
+priority: 60000
69
70
local:
70
- url : 'http://localhost:8080/health'
71
+ url: 'http://localhost:8080/health'
72
```
73
74
Without configuration, module attempts to connect to `http://localhost:8080/health`.
collectors/python.d.plugin/uwsgi/README.md
+1
-1
@@ -32,7 +32,7 @@ Following charts are drawn:
32
## Configuration
33
34
Edit the `python.d/uwsgi.conf` configuration file using `edit-config` from the Netdata [config
35
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
35
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
36
37
```bash
38
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/varnish/README.md
+1
-1
@@ -48,7 +48,7 @@ For every storage (SMF, SMA, or MSE):
48
## Configuration
49
50
Edit the `python.d/varnish.conf` configuration file using `edit-config` from the Netdata [config
51
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
51
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
52
53
```bash
54
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/w1sensor/README.md
+1
-1
@@ -19,7 +19,7 @@ Charts are created dynamically based on the number of detected sensors.
19
## Configuration
20
21
Edit the `python.d/w1sensor.conf` configuration file using `edit-config` from the Netdata [config
22
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
22
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
23
24
```bash
25
cd /etc/netdata # Replace this path with your Netdata config directory, if different
collectors/python.d.plugin/zscores/README.md
+1
-1
@@ -12,7 +12,7 @@ learn_rel_path: "References/Collectors references/Uncategorized"
12
13
Smoothed, rolling [Z-Scores](https://en.wikipedia.org/wiki/Standard_score) for selected metrics or charts.
14
15
-This collector uses the [Netdata rest api](https://learn.netdata.cloud/docs/agent/web/api) to get the `mean` and `stddev`
15
+This collector uses the [Netdata rest api](https://github.com/netdata/netdata/blob/master/web/api/README.md) to get the `mean` and `stddev`
16
for each dimension on specified charts over a time range (defined by `train_secs` and `offset_secs`). For each dimension
17
it will calculate a Z-Score as `z = (x - mean) / stddev` (clipped at `z_clip`). Scores are then smoothed over
18
time (`z_smooth_n`) and, if `mode: 'per_chart'`, aggregated across dimensions to a smoothed, rolling chart level Z-Score
collectors/statsd.plugin/README.md
+7
-7
@@ -29,11 +29,11 @@ On synthetic charts, we can have alarms as with any metric and chart.
29
30
- [K6 load testing tool](https://k6.io)
31
- **Description:** k6 is a developer-centric, free and open-source load testing tool built for making performance testing a productive and enjoyable experience.
32
- - [Documentation](/collectors/statsd.plugin/k6.md)
32
+ - [Documentation](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/k6.md)
33
- [Configuration](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/k6.conf)
34
- [Asterisk](https://www.asterisk.org/)
35
- **Description:** Asterisk is an Open Source PBX and telephony toolkit.
36
- - [Documentation](/collectors/statsd.plugin/asterisk.md)
36
+ - [Documentation](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/asterisk.md)
37
- [Configuration](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/asterisk.conf)
38
39
## Metrics supported by Netdata
@@ -206,7 +206,7 @@ Netdata can visualize StatsD collected metrics in 2 ways:
206
207
### Private metric charts
208
209
-Private charts are controlled with `create private charts for metrics matching = *`. This setting accepts a space-separated list of [simple patterns](/libnetdata/simple_pattern/README.md). Netdata will create private charts for all metrics **by default**.
209
+Private charts are controlled with `create private charts for metrics matching = *`. This setting accepts a space-separated list of [simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md). Netdata will create private charts for all metrics **by default**.
210
211
For example, to render charts for all `myapp.*` metrics, except `myapp.*.badmetric`, use:
212
@@ -214,7 +214,7 @@ For example, to render charts for all `myapp.*` metrics, except `myapp.*.badmetr
214
create private charts for metrics matching = !myapp.*.badmetric myapp.*
215
```
216
217
-You can specify Netdata StatsD to have a different `memory mode` than the rest of the Netdata Agent. You can read more about `memory mode` in the [documentation](/database/README.md).
217
+You can specify Netdata StatsD to have a different `memory mode` than the rest of the Netdata Agent. You can read more about `memory mode` in the [documentation](https://github.com/netdata/netdata/blob/master/database/README.md).
218
219
The default behavior is to use the same settings as the rest of the Netdata Agent. If you wish to change them, edit the following settings:
220
- `private charts memory mode`
@@ -293,7 +293,7 @@ Synthetic charts are organized in
293
- **charts for each application** aka family in Netdata Dashboard.
294
- **StatsD metrics for each chart** /aka charts and context Netdata Dashboard.
295
296
-> You can read more about how the Netdata Agent organizes information in the relevant [documentation](/web/README.md)
296
+> You can read more about how the Netdata Agent organizes information in the relevant [documentation](https://github.com/netdata/netdata/blob/master/web/README.md)
297
298
For each application you need to create a `.conf` file in `/etc/netdata/statsd.d`.
299
@@ -330,7 +330,7 @@ Using the above configuration `myapp` should get its own section on the dashboar
330
`[app]` starts a new application definition. The supported settings in this section are:
331
332
- `name` defines the name of the app.
333
-- `metrics` is a Netdata [simple pattern](/libnetdata/simple_pattern/README.md). This pattern should match all the possible StatsD metrics that will be participating in the application `myapp`.
333
+- `metrics` is a Netdata [simple pattern](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md). This pattern should match all the possible StatsD metrics that will be participating in the application `myapp`.
334
- `private charts = yes|no`, enables or disables private charts for the metrics matched.
335
- `gaps when not collected = yes|no`, enables or disables gaps on the charts of the application in case that no metrics are collected.
336
- `memory mode` sets the memory mode for all charts of the application. The default is the global default for Netdata (not the global default for StatsD private charts). We suggest not to use this (we have commented it out in the example) and let your app use the global default for Netdata, which is our dbengine.
@@ -356,7 +356,7 @@ So, the format is this:
356
dimension = [pattern] METRIC NAME TYPE MULTIPLIER DIVIDER OPTIONS
357
```
358
359
-`pattern` is a keyword. When set, `METRIC` is expected to be a Netdata [simple pattern](/libnetdata/simple_pattern/README.md) that will be used to match all the StatsD metrics to be added to the chart. So, `pattern` automatically matches any number of StatsD metrics, all of which will be added as separate chart dimensions.
359
+`pattern` is a keyword. When set, `METRIC` is expected to be a Netdata [simple pattern](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) that will be used to match all the StatsD metrics to be added to the chart. So, `pattern` automatically matches any number of StatsD metrics, all of which will be added as separate chart dimensions.
360
361
`TYPE`, `MULTIPLIER`, `DIVIDER` and `OPTIONS` are optional.
362
collectors/tc.plugin/README.md
+1
-1
@@ -71,7 +71,7 @@ QoS is about 2 features:
71
72
When your system is under a DDoS attack, it will get a lot more bandwidth compared to the one it can handle and probably your applications will crash. Setting a limit on the inbound traffic using QoS, will protect your servers (throttle the requests) and depending on the size of the attack may allow your legitimate users to access the server, while the attack is taking place.
73
74
- Using QoS together with a [SYNPROXY](/collectors/proc.plugin/README.md) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](/collectors/proc.plugin/README.md).
74
+ Using QoS together with a [SYNPROXY](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md).
75
76
On top of all these, QoS is extremely light. You will configure it once, and this is it. It will not bother you again and it will not use any noticeable CPU resources, especially on application and database servers.
77
collectors/timex.plugin/README.md
+1
-1
@@ -23,7 +23,7 @@ An unsynchronized clock may indicate a hardware clock error, or an issue with UT
23
24
## Configuration
25
26
-Edit the `netdata.conf` configuration file using [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
26
+Edit the `netdata.conf` configuration file using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
27
28
Scroll down to the `[plugin:timex]` section to find the available options:
29
contribution-guidelines.md
+158
-114
@@ -2,40 +2,52 @@
2
3
Welcome to our docs developer guidelines!
4
5
-We store documentation related to Netdata inside of the [`netdata/netdata` repository](https://github.com/netdata/netdata) on GitHub.
5
+We store documentation related to Netdata inside of
6
+the [`netdata/netdata` repository](https://github.com/netdata/netdata) on GitHub.
7
8
The Netdata team aggregates and publishes all documentation at [learn.netdata.cloud](/) using
9
[Docusaurus](https://v2.docusaurus.io/) over at the [`netdata/learn` repository](https://github.com/netdata/learn).
10
11
## Before you get started
12
12
-Anyone interested in contributing to documentation should first read the [Netdata style guide](#styling-guide) further down below and the [Netdata Community Code of Conduct](/contribute/code-of-conduct).
13
+Anyone interested in contributing to documentation should first read the [Netdata style guide](#styling-guide) further
14
+down below and the [Netdata Community Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
15
14
-Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on creating paragraphs, styled text, lists, tables, and more, and read further down about some special occasions [while writing in MDX](#mdx-and-markdown).
16
+Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read
17
+the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on
18
+creating paragraphs, styled text, lists, tables, and more, and read further down about some special
19
+occasions [while writing in MDX](#mdx-and-markdown).
20
21
### Netdata's Documentation structure
22
23
Netdata's documentation is separated into 5 categories.
24
20
-- **Getting Started**: This section’s purpose is to present “What is Netdata” and for whom is it for while also presenting all the ways Netdata can be deployed. That includes Netdata’s platform support, Standalone deployment, Parent-child deployments, deploying on Kubernetes and also deploying on IoT nodes.
21
- - Stored in **WIP**
22
- - Published in **WIP**
23
-- **Concepts**: This section’s purpose is to take a pitch on all the aspects of Netdata. We present the functionality of each component/idea and support it with examples but we don’t go deep into technical details.
24
- - Stored in the `/docs/concepts` directory in the `netdata/netdata` repository.
25
- - Published in **WIP**
26
-- **Tasks**: This section's purpose is to break down any operation into a series of fundamental tasks for the Netdata solution.
27
- - Stored in the `/docs/tasks` directory in the `netdata/netdata` repository.
28
- - Published in **WIP**
29
-- **References**: This section’s purpose is to explain thoroughly every part of Netdata. That covers settings, configurations and so on.
30
- - Stored near the component they refer to.
31
- - Published in **WIP**
32
-- **Collectors References**: This section’s purpose is to explain thoroughly every collector that Netdata supports and it's configuration options.
33
- - Stored in stored near the collector they refer to.
34
- - Published in **WIP**
25
+- **Getting Started**: This section’s purpose is to present “What is Netdata” and for whom is it for while also
26
+ presenting all the ways Netdata can be deployed. That includes Netdata’s platform support, Standalone deployment,
27
+ Parent-child deployments, deploying on Kubernetes and also deploying on IoT nodes.
28
+ - Stored in **WIP**
29
+ - Published in **WIP**
30
+- **Concepts**: This section’s purpose is to take a pitch on all the aspects of Netdata. We present the functionality of
31
+ each component/idea and support it with examples but we don’t go deep into technical details.
32
+ - Stored in the `/docs/concepts` directory in the `netdata/netdata` repository.
33
+ - Published in **WIP**
34
+- **Tasks**: This section's purpose is to break down any operation into a series of fundamental tasks for the Netdata
35
+ solution.
36
+ - Stored in the `/docs/tasks` directory in the `netdata/netdata` repository.
37
+ - Published in **WIP**
38
+- **References**: This section’s purpose is to explain thoroughly every part of Netdata. That covers settings,
39
+ configurations and so on.
40
+ - Stored near the component they refer to.
41
+ - Published in **WIP**
42
+- **Collectors References**: This section’s purpose is to explain thoroughly every collector that Netdata supports and
43
+ it's configuration options.
44
+ - Stored in stored near the collector they refer to.
45
+ - Published in **WIP**
46
47
## How to contribute
48
38
-The easiest way to contribute to Netdata's documentation is to edit a file directly on GitHub. This is perfect for small fixes to a single document, such as fixing a typo or clarifying a confusing sentence.
49
+The easiest way to contribute to Netdata's documentation is to edit a file directly on GitHub. This is perfect for small
50
+fixes to a single document, such as fixing a typo or clarifying a confusing sentence.
51
52
Click on the **Edit this page** button on any published document on [Netdata Learn](https://learn.netdata.cloud). Each
53
page has two of these buttons: One beneath the table of contents, and another at the end of the document, which take you
@@ -49,28 +61,39 @@ Jump down to our instructions on [PRs](#making-a-pull-request) for your next ste
61
62
### Edit locally
63
52
-Editing documentation locally is the preferred method for complex changes that span multiple documents or change the documentation's style or structure.
64
+Editing documentation locally is the preferred method for complex changes that span multiple documents or change the
65
+documentation's style or structure.
66
54
-Create a fork of the Netdata Agent repository by visit the [Netdata repository](https://github.com/netdata/netdata) and clicking on the **Fork** button.
67
+Create a fork of the Netdata Agent repository by visit the [Netdata repository](https://github.com/netdata/netdata) and
68
+clicking on the **Fork** button.
69
56
-GitHub will ask you where you want to clone the repository. When finished, you end up at the index of your forked Netdata Agent repository. Clone your fork to your local machine:
70
+GitHub will ask you where you want to clone the repository. When finished, you end up at the index of your forked
71
+Netdata Agent repository. Clone your fork to your local machine:
72
73
```bash
74
git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git
75
```
76
62
-Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping the [Netdata style guide](/contribute/style-guide) in mind. Add, commit, and push changes to your fork. When you're finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull request based on the changes you made in the new branch of your fork.
77
+Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping
78
+the [Netdata style guide](https://github.com/netdata/netdata/blob/master/docs/contributing/style-guide.md) in mind. Add, commit, and push changes to your fork. When you're
79
+finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull request
80
+based on the changes you made in the new branch of your fork.
81
82
### Making a pull request
83
66
-Pull requests (PRs) should be concise and informative. See our [PR guidelines](/contribute/handbook#pr-guidelines) for specifics.
84
+Pull requests (PRs) should be concise and informative. See our [PR guidelines](/contribute/handbook#pr-guidelines) for
85
+specifics.
86
68
-- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50 characters.
69
-- The description should explain what was changed and why. Verify that you tested any code or processes that you are trying to change.
87
+- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50
88
+ characters.
89
+- The description should explain what was changed and why. Verify that you tested any code or processes that you are
90
+ trying to change.
91
71
-The Netdata team will review your PR and assesses it for correctness, conciseness, and overall quality. We may point to specific sections and ask for additional information or other fixes.
92
+The Netdata team will review your PR and assesses it for correctness, conciseness, and overall quality. We may point to
93
+specific sections and ask for additional information or other fixes.
94
73
-After merging your PR, the Netdata team rebuilds the [documentation site](https://learn.netdata.cloud) to publish the changed documentation.
95
+After merging your PR, the Netdata team rebuilds the [documentation site](https://learn.netdata.cloud) to publish the
96
+changed documentation.
97
98
## Writing Docs
99
@@ -78,34 +101,43 @@ We have three main types of Docs: **References**, **Concepts** and **Tasks**.
101
102
### Metadata Tags
103
81
-
104
All of the Docs however have what we call "metadata" tags. these help to organize the document upon publishing.
105
106
So let's go through the different necessary metadata tags to get a document properly published on Learn:
107
108
- Docusaurus Specific:\
87
-These metadata tags are parsed automatically by Docusaurus and are rendered in the published document. **Note**: Netdata only uses the Docusaurus metadata tags releveant for our documentation infrastructure.
88
- - `title: "The title of the document"` : Here we specify the title of our document, which is going to be converted to the heading of the published page.
89
- - `description: "The description of the file"`: Here we give a description of what this file is about.
90
- - `custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md`: Here is an example of the link that the user will be redirected to if he clicks the "Edit this page button", as you see it leads directly to the edit page of the source file.
109
+ These metadata tags are parsed automatically by Docusaurus and are rendered in the published document. **Note**:
110
+ Netdata only uses the Docusaurus metadata tags releveant for our documentation infrastructure.
111
+ - `title: "The title of the document"` : Here we specify the title of our document, which is going to be converted
112
+ to the heading of the published page.
113
+ - `description: "The description of the file"`: Here we give a description of what this file is about.
114
+ - `custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md`: Here is an example of
115
+ the link that the user will be redirected to if he clicks the "Edit this page button", as you see it leads
116
+ directly to the edit page of the source file.
117
- Netdata Learn specific:
92
- - `learn_status: "..."`
93
- - The options for this tag are:
94
- - `"published"`
95
- - `"unpublished"`
96
- - `learn_topic_type: "..."`
97
- - The options for this tag are:
98
- - `"Getting Started"`
99
- - `"Concepts"`
100
- - `"Tasks"`
101
- - `"References"`
102
- - `"Collectors References"`
103
- - This is the Topic that the file belongs to, and this is going to resemble the start directory of the file's path on Learn for example if we write `"Concepts"` in the field, then the file is going to be placed under `/Concepts/....` inside Learn.
104
- - `learn_rel_path: "/example/"`
105
- - This tag represents the rest of the path, without the filename in the end, so in this case if the file is a Concept, it would go under `Concepts/example/filename.md`. If you want to place the file under the "root" topic folder, input `"/"`.
106
- - ⚠️ In case any of these "Learn" tags are missing or falsely inputted the file will remain unpublished. This is by design to prevent non-properly tagged files from getting published.
107
-
108
-While Docusaurus can make use of more metadata tags than the above, these are the minimum we require to publish the file on Learn.
118
+ - `learn_status: "..."`
119
+ - The options for this tag are:
120
+ - `"published"`
121
+ - `"unpublished"`
122
+ - `learn_topic_type: "..."`
123
+ - The options for this tag are:
124
+ - `"Getting Started"`
125
+ - `"Concepts"`
126
+ - `"Tasks"`
127
+ - `"References"`
128
+ - `"Collectors References"`
129
+ - This is the Topic that the file belongs to, and this is going to resemble the start directory of the file's
130
+ path on Learn for example if we write `"Concepts"` in the field, then the file is going to be placed
131
+ under `/Concepts/....` inside Learn.
132
+ - `learn_rel_path: "/example/"`
133
+ - This tag represents the rest of the path, without the filename in the end, so in this case if the file is a
134
+ Concept, it would go under `Concepts/example/filename.md`. If you want to place the file under the "root"
135
+ topic folder, input `"/"`.
136
+ - ⚠️ In case any of these "Learn" tags are missing or falsely inputted the file will remain unpublished. This is by
137
+ design to prevent non-properly tagged files from getting published.
138
+
139
+While Docusaurus can make use of more metadata tags than the above, these are the minimum we require to publish the file
140
+on Learn.
141
142
### Doc Templates
143
@@ -193,10 +225,10 @@ Needs only `url` to server's `server-status?auto`. Here is an example for 2 serv
225
226
```yaml
227
jobs:
196
-- name: local
197
- url: http://127.0.0.1/server-status?auto
198
-- name: remote
199
- url: http://203.0.113.10/server-status?auto
228
+ - name: local
229
+ url: http://127.0.0.1/server-status?auto
230
+ - name: remote
231
+ url: http://203.0.113.10/server-status?auto
232
```
233
234
For all available options please see
@@ -234,7 +266,8 @@ Describe all the information that the user needs to know before proceeding with
266
267
## Context
268
237
-Describe the background information of the Task, the purpose of the Task, and what will the user achieve by completing it.
269
+Describe the background information of the Task, the purpose of the Task, and what will the user achieve by completing
270
+it.
271
272
## Steps
273
@@ -268,7 +301,8 @@ The template of the Concept files is:
301
302
## Description
303
271
-In our concepts we have a more loose structure, the goal is to communicate the "concept" to the user, starting with simple language that even a new user can understand, and building from there.
304
+In our concepts we have a more loose structure, the goal is to communicate the "concept" to the user, starting with
305
+simple language that even a new user can understand, and building from there.
306
307
</details>
308
@@ -335,7 +369,8 @@ Netdata is a global company in every sense, with employees, contributors, and us
369
communicate in a way that is clear and easily understood by everyone.
370
371
Here are some guidelines, pointers, and questions to be aware of as you write to ensure your writing is universal. Some
338
-of these are expanded into individual sections in the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
372
+of these are expanded into individual sections in
373
+the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
374
375
- Would this language make sense to someone who doesn't work here?
376
- Could someone quickly scan this document and understand the material?
@@ -364,8 +399,8 @@ of these are expanded into individual sections in the [language, grammar, and me
399
400
To ensure Netdata's writing is clear, concise, and universal, we have established standards for language, grammar, and
401
certain writing mechanics. However, if you're writing about Netdata for an external publication, such as a guest blog
367
-post, follow that publication's style guide or standards, while keeping the [preferred spelling of Netdata
368
-terms](#netdata-specific-terms) in mind.
402
+post, follow that publication's style guide or standards, while keeping
403
+the [preferred spelling of Netdata terms](#netdata-specific-terms) in mind.
404
405
### Active voice
406
@@ -374,7 +409,7 @@ the sentence is action. In passive voice, the subject is acted upon. A famous ex
409
"mistakes were made."
410
411
| | |
377
-| --------------- | ----------------------------------------------------------------------------------------- |
412
+|-----------------|-------------------------------------------------------------------------------------------|
413
| Not recommended | When an alarm is triggered by a metric, a notification is sent by Netdata. |
414
| **Recommended** | When a metric triggers an alarm, Netdata sends a notification to your preferred endpoint. |
415
@@ -388,16 +423,16 @@ implied, depending on your sentence structure.
423
One valid exception is when a member of the Netdata team or community wants to write about said team or community.
424
425
| | |
391
-| ------------------------------ | ------------------------------------------------------------ |
426
+|--------------------------------|--------------------------------------------------------------|
427
| Not recommended | To install Netdata, we should try the one-line installer... |
428
| **Recommended** | To install Netdata, you should try the one-line installer... |
429
| **Recommended**, implied "you" | To install Netdata, try the one-line installer... |
430
431
### "Easy" or "simple"
432
398
-Using words that imply the complexity of a task or feature goes against our policy of [universal
399
-communication](#universal-communication). If you claim that a task is easy and the reader struggles to complete it, you
400
-may inadvertently discourage them.
433
+Using words that imply the complexity of a task or feature goes against our policy
434
+of [universal communication](#universal-communication). If you claim that a task is easy and the reader struggles to
435
+complete it, you may inadvertently discourage them.
436
437
However, if you give users two options and want to relay that one option is genuinely less complex than another, be
438
specific about how and why.
@@ -433,7 +468,7 @@ capitalization. In summary:
468
- Capitalize the first word of every new sentence.
469
- Don't use uppercase for emphasis. (Netdata is the BEST!)
470
- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
436
- Docker, Apache, NGINX)
471
+ Docker, Apache, NGINX)
472
- Avoid camel case (NetData) or all caps (NETDATA).
473
474
Whenever you refer to the company Netdata, Inc., or the open-source monitoring agent the company develops, capitalize
@@ -443,7 +478,7 @@ However, if you are referring to a process, user, or group on a Linux system, us
478
inline code block: `` `netdata` ``.
479
480
| | |
446
-| --------------- | ---------------------------------------------------------------------------------------------- |
481
+|-----------------|------------------------------------------------------------------------------------------------|
482
| Not recommended | The netdata agent, which spawns the netdata process, is actively maintained by netdata, inc. |
483
| **Recommended** | The Netdata Agent, which spawns the `netdata` process, is actively maintained by Netdata, Inc. |
484
@@ -457,7 +492,7 @@ guidelines.
492
Also, don't put a period (`.`) or colon (`:`) at the end of a title or header.
493
494
| | |
460
-| --------------- | --------------------------------------------------------------------------------------------------- |
495
+|-----------------|-----------------------------------------------------------------------------------------------------|
496
| Not recommended | Getting Started Guide <br />Service Discovery and Auto-Detection: <br />Install netdata with docker |
497
| **Recommended** | Getting started guide <br />Service discovery and auto-detection <br />Install Netdata with Docker |
498
@@ -471,7 +506,7 @@ When introducing an abbreviation to a document for the first time, give the read
506
shortened version at the same time. For example:
507
508
> Use Netdata to monitor Extended Berkeley Packet Filter (eBPF) metrics in real-time.
474
-After you define an abbreviation, don't switch back and forth. Use only the abbreviation for the rest of the document.
509
+> After you define an abbreviation, don't switch back and forth. Use only the abbreviation for the rest of the document.
510
511
You can also use abbreviations in a document's title to keep the title short and relevant. If you do this, you should
512
still introduce the spelled-out name alongside the abbreviation as soon as possible.
@@ -482,7 +517,7 @@ When instructing users to take action, give them the context first. By placing t
517
beginning of the sentence, users can immediately know if they want to read more, follow a link, or skip ahead.
518
519
| | |
485
-| --------------- | ------------------------------------------------------------------------------ |
520
+|-----------------|--------------------------------------------------------------------------------|
521
| Not recommended | Read the reference guide if you'd like to learn more about custom dashboards. |
522
| **Recommended** | If you'd like to learn more about custom dashboards, read the reference guide. |
523
@@ -492,7 +527,7 @@ The Oxford comma is the comma used after the second-to-last item in a list of th
527
before "and" or "or."
528
529
| | |
495
-| --------------- | ---------------------------------------------------------------------------- |
530
+|-----------------|------------------------------------------------------------------------------|
531
| Not recommended | Netdata can monitor RAM, disk I/O, MySQL queries per second and lm-sensors. |
532
| **Recommended** | Netdata can monitor RAM, disk I/O, MySQL queries per second, and lm-sensors. |
533
@@ -501,19 +536,19 @@ before "and" or "or."
536
Do not mention future releases or upcoming features in writing unless they have been previously communicated via a
537
public roadmap.
538
504
-In particular, documentation must describe, as accurately as possible, the Netdata Agent _as of the [latest
505
-commit](https://github.com/netdata/netdata/commits/master) in the GitHub repository_. For Netdata Cloud, documentation
506
-must reflect the *current state* of [production](https://app.netdata.cloud).
539
+In particular, documentation must describe, as accurately as possible, the Netdata Agent _as of
540
+the [latest commit](https://github.com/netdata/netdata/commits/master) in the GitHub repository_. For Netdata Cloud,
541
+documentation must reflect the *current state* of [production](https://app.netdata.cloud).
542
543
### Informational links
544
545
Every link should clearly state its destination. Don't use words like "here" to describe where a link will take your
546
reader.
547
513
-| | |
514
-| --------------- | ------------------------------------------------------------------------------------------ |
515
-| Not recommended | To install Netdata, click [here](/docs/agent/packaging/installer). |
516
-| **Recommended** | To install Netdata, read the [installation instructions](/docs/agent/packaging/installer). |
548
+| | |
549
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|
550
+| Not recommended | To install Netdata, click [here](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
551
+| **Recommended** | To install Netdata, read the [installation instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
552
553
Use links as often as required to provide necessary context. Blog posts and guides require less hyperlinks than
554
documentation. See the section on [linking between documentation](#linking-between-documentation) for guidance on the
@@ -546,7 +581,7 @@ Use `NODE` instead of an actual or example IP address/hostname when referencing
581
or API endpoint in a browser.
582
583
| | |
549
-| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
584
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
585
| Not recommended | Navigate to `http://example.com:19999` in your browser to see Netdata's dashboard. <br />Navigate to `http://203.0.113.0:19999` in your browser to see Netdata's dashboard. |
586
| **Recommended** | Navigate to `http://NODE:19999` in your browser to see Netdata's dashboard. |
587
@@ -563,16 +598,17 @@ Netdata Agent installation will have commands under the same paths. When applica
598
path, providing a recommendation or instructions on how to view the running configuration, which includes the correct
599
paths.
600
566
-For example, the [configuration](/docs/configure/nodes) doc first teaches users how to find the Netdata config
601
+For example, the [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) doc first
602
+teaches users how to find the Netdata config
603
directory and navigate to it, then runs commands from the `/etc/netdata` path so that the instructions are more
604
universal.
605
606
Don't include full paths, beginning from the system's root (`/`), as these might not work on certain systems.
607
572
-| | |
573
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
574
-| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
575
-| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](/docs/configure/nodes#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
608
+| | |
609
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
610
+| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
611
+| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
612
613
### `sudo`
614
@@ -584,7 +620,7 @@ For example, most users need to use `sudo` with the `edit-config` script, becaus
620
by the `netdata` user. Same goes for restarting the Netdata Agent with `systemctl`.
621
622
| | |
587
-| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
623
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------|
624
| Not recommended | Run `edit-config netdata.conf` to configure the Netdata Agent. <br />Run `systemctl restart netdata` to restart the Netdata Agent. |
625
| **Recommended** | Run `sudo edit-config netdata.conf` to configure the Netdata Agent. <br />Run `sudo systemctl restart netdata` to restart the Netdata Agent. |
626
@@ -615,14 +651,19 @@ If you want to see all the settings, open the
651
### MDX and markdown
652
653
While writing in Docusaurus, you might want to take leverage of it's features that are supported in MDX formatted files.
618
-One of those that we use is [Tabs](https://docusaurus.io/docs/next/markdown-features/tabs). They use an HTML syntax, which requires some changes in the way we write markdown inside them.
654
+One of those that we use is [Tabs](https://docusaurus.io/docs/next/markdown-features/tabs). They use an HTML syntax,
655
+which requires some changes in the way we write markdown inside them.
656
657
In detail:
658
622
-Due to a bug with docusaurus, we prefer to use `<h1>heading</h1> instead of # H1` so that docusaurus doesn't render the contents of all Tabs on the right hand side, while not being able to navigate them [relative link](https://github.com/facebook/docusaurus/issues/7008).
659
+Due to a bug with docusaurus, we prefer to use `<h1>heading</h1> instead of # H1` so that docusaurus doesn't render the
660
+contents of all Tabs on the right hand side, while not being able to navigate
661
+them [relative link](https://github.com/facebook/docusaurus/issues/7008).
662
663
You can use markdown syntax for every other styling you want to do except Admonitions:
625
-For admonitions, follow [this](https://docusaurus.io/docs/markdown-features/admonitions#usage-in-jsx) guide to use admonitions inside JSX. While writing in JSX, all the markdown stylings have to be in HTML format to be rendered properly.
664
+For admonitions, follow [this](https://docusaurus.io/docs/markdown-features/admonitions#usage-in-jsx) guide to use
665
+admonitions inside JSX. While writing in JSX, all the markdown stylings have to be in HTML format to be rendered
666
+properly.
667
668
### Frontmatter
669
@@ -645,7 +686,7 @@ this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of th
686
the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
687
688
For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
648
-Ansible](/guides/deploy/ansible).
689
+Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
690
691
```markdown
692
<!--
@@ -665,23 +706,25 @@ forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
706
707
### Admonitions
708
668
-In addition to basic markdown syntax, we also encourage the use of admonition syntax, which allows for a more aesthetically seamless presentation of supplemental information. For general instructions on using admonitions, feel free to read this [feature guide](https://docusaurus.io/docs/markdown-features/admonitions).
709
+In addition to basic markdown syntax, we also encourage the use of admonition syntax, which allows for a more
710
+aesthetically seamless presentation of supplemental information. For general instructions on using admonitions, feel
711
+free to read this [feature guide](https://docusaurus.io/docs/markdown-features/admonitions).
712
670
-We encourage the use of **Note** admonitions to provide important supplemental information to a user within a task step, reference item, or concept passage.
713
+We encourage the use of **Note** admonitions to provide important supplemental information to a user within a task step,
714
+reference item, or concept passage.
715
672
-Additionally, you should use a **Caution** admonition to provide necessary information to present any risk to a user's setup or data.
716
+Additionally, you should use a **Caution** admonition to provide necessary information to present any risk to a user's
717
+setup or data.
718
674
-**Danger** admonitions should be avoided, as these admonitions are typically applied to reduce physical or bodily harm to an individual.
719
+**Danger** admonitions should be avoided, as these admonitions are typically applied to reduce physical or bodily harm
720
+to an individual.
721
722
### Linking between documentation
723
724
Documentation should link to relevant pages whenever it's relevant and provides valuable context to the reader.
725
680
-Links should always reference the full path to the document, beginning at the root of the Netdata Agent repository
681
-(`/`), and ending with the `.md` file extension. Avoid relative links or traversing up directories using `../`.
682
-
683
-For example, if you want to link to our node configuration document, link to `/docs/configure/nodes.md`. To reference
684
-the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`.
726
+We link between markdown documents by using its GitHub absolute link for
727
+instance `[short description of what we reference](https://github.com/netdata/netdata/blob/master/contribution-guidelines.md)`
728
729
### References to UI elements
730
@@ -700,7 +743,8 @@ try to supplement the text with an [image](#images).
743
744
Don't rely on images to convey features, ideas, or instructions. Accompany every image with descriptive alt text.
745
703
-In Markdown, use the standard image syntax, ``, and place the alt text between the brackets `[]`. Here's an example
746
+In Markdown, use the standard image syntax, ``, and place the alt text between the
747
+brackets `[]`. Here's an example
748
using our logo:
749
750
```markdown
@@ -741,8 +785,8 @@ inline char *health_stock_config_dir(void) {
785
}
786
```
787
744
-Prism also supports titles and line highlighting. See the [Docusaurus
745
-documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
788
+Prism also supports titles and line highlighting. See
789
+the [Docusaurus documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
790
791
## Word list
792
@@ -750,24 +794,24 @@ The following tables describe the standard spelling, capitalization, and usage o
794
795
### Netdata-specific terms
796
753
-| Term | Definition |
754
-| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
755
-| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](/docs/agent/claim). The claimed node will then appear in your Space and any War Rooms you added it to. |
756
-| **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use *netdata* or *NetData*. <br /><br />**Note:** You should use "Netdata" when referencing any general element, function, or part of the user experience. In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write *Learn more about enabling alarm notifications on your preferred platforms* instead of *Netdata sends alarm notifications to your preferred platforms*. |
757
-| **Netdata Agent** or **Open-source Netdata Agent** | The free and open source [monitoring agent](https://github.com/netdata/netdata) that you can install on all of your distributed systems, whether they're physical, virtual, containerized, ephemeral, and more. The Agent monitors systems running Linux, Docker, Kubernetes, macOS, FreeBSD, and more, and collects metrics from hundreds of popular services and applications. <br /><br /> **Note:** You should avoid referencing the Netdata Agent or Open-source Netdata agent in any scenario that does not specifically require the distinction for clear instructions. |
758
-| **Netdata Cloud** | The web application hosted at [https://app.netdata.cloud](https://app.netdata.cloud) that helps you monitor an entire infrastructure of distributed systems in real time. <br /><br />**Notes:** Never use *Cloud* without the preceding *Netdata* to avoid ambiguity. You should avoid referencing Netdata Cloud in any scenario that does not specifically require the distinction for clear instructions. | |
759
-| **Netdata community** | Contributors to any of Netdata's [open-source projects](/contribute/projects), members of the [community forum](https://community.netdata.cloud/). |
760
-| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
761
-| **node** | A system on which the Netdata Agent is installed. The system can be physical, virtual, in a Docker container, and more. Depending on your infrastructure, you may have one, dozens, or hundreds of nodes. Some nodes are *ephemeral*, in that they're created/destroyed automatically by an orchestrator service. |
762
-| **Space** | The highest level container within Netdata Cloud for a user to organize their team members and nodes within their infrastructure. A Space likely represents an entire organization or a large team. <br /><br />*Space* is always capitalized. |
763
-| **unreachable node** | A connected node with a disrupted [Agent-Cloud link](/docs/agent/aclk). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. |
764
-| **visited node** | A node which has had its Agent dashboard directly visited by a user. A list of these is maintained on a per-user basis. |
765
-| **War Room** | A smaller grouping of nodes where users can view key metrics in real-time and monitor the health of many nodes with their alarm status. War Rooms can be used to organize nodes in any way that makes sense for your infrastructure, such as by a service, purpose, physical location, and more. <br /><br />*War Room* is always capitalized. |
797
+| Term | Definition |
798
+|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
799
+| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](https://github.com/netdata/netdata/blob/master/claim/README.md). The claimed node will then appear in your Space and any War Rooms you added it to. |
800
+| **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use *netdata* or *NetData*. <br /><br />**Note:** You should use "Netdata" when referencing any general element, function, or part of the user experience. In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write *Learn more about enabling alarm notifications on your preferred platforms* instead of *Netdata sends alarm notifications to your preferred platforms*. |
801
+| **Netdata Agent** or **Open-source Netdata Agent** | The free and open source [monitoring agent](https://github.com/netdata/netdata) that you can install on all of your distributed systems, whether they're physical, virtual, containerized, ephemeral, and more. The Agent monitors systems running Linux, Docker, Kubernetes, macOS, FreeBSD, and more, and collects metrics from hundreds of popular services and applications. <br /><br /> **Note:** You should avoid referencing the Netdata Agent or Open-source Netdata agent in any scenario that does not specifically require the distinction for clear instructions. |
802
+| **Netdata Cloud** | The web application hosted at [https://app.netdata.cloud](https://app.netdata.cloud) that helps you monitor an entire infrastructure of distributed systems in real time. <br /><br />**Notes:** Never use *Cloud* without the preceding *Netdata* to avoid ambiguity. You should avoid referencing Netdata Cloud in any scenario that does not specifically require the distinction for clear instructions. | |
803
+| **Netdata community** | Contributors to any of Netdata's [open-source projects](https://github.com/netdata/learn/blob/master/contribute/projects.mdx), members of the [community forum](https://community.netdata.cloud/). |
804
+| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
805
+| **node** | A system on which the Netdata Agent is installed. The system can be physical, virtual, in a Docker container, and more. Depending on your infrastructure, you may have one, dozens, or hundreds of nodes. Some nodes are *ephemeral*, in that they're created/destroyed automatically by an orchestrator service. |
806
+| **Space** | The highest level container within Netdata Cloud for a user to organize their team members and nodes within their infrastructure. A Space likely represents an entire organization or a large team. <br /><br />*Space* is always capitalized. |
807
+| **unreachable node** | A connected node with a disrupted [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/aclk/README.md). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. |
808
+| **visited node** | A node which has had its Agent dashboard directly visited by a user. A list of these is maintained on a per-user basis. |
809
+| **War Room** | A smaller grouping of nodes where users can view key metrics in real-time and monitor the health of many nodes with their alarm status. War Rooms can be used to organize nodes in any way that makes sense for your infrastructure, such as by a service, purpose, physical location, and more. <br /><br />*War Room* is always capitalized. |
810
811
### Other technical terms
812
813
| Term | Definition |
770
-| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
814
+|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
815
| **filesystem** | Use instead of *file system*. |
816
| **preconfigured** | The concept that many of Netdata's features come with sane defaults that users don't need to configure to find [immediate value](/docs/overview/why-netdata#simple-to-deploy). |
817
| **real time**/**real-time** | Use *real time* as a noun phrase, most often with *in*: *Netdata collects metrics in real time*. Use *real-time* as an adjective: _Netdata collects real-time metrics from hundreds of supported applications and services. |
daemon/README.md
+3
-3
@@ -15,7 +15,7 @@ learn_rel_path: "References/Configuration"
15
- You can start Netdata by executing it with `/usr/sbin/netdata` (the installer will also start it).
16
17
- You can stop Netdata by killing it with `killall netdata`. You can stop and start Netdata at any point. When
18
- exiting, the [database engine](/database/engine/README.md) saves metrics to `/var/cache/netdata/dbengine/` so that
18
+ exiting, the [database engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md) saves metrics to `/var/cache/netdata/dbengine/` so that
19
it can continue when started again.
20
21
Access to the web site, for all graphs, is by default on port `19999`, so go to:
@@ -206,7 +206,7 @@ The command line options of the Netdata 1.10.0 version are the following:
206
- USR2 Reload health configuration.
207
```
208
209
-You can send commands during runtime via [netdatacli](/cli/README.md).
209
+You can send commands during runtime via [netdatacli](https://github.com/netdata/netdata/blob/master/cli/README.md).
210
211
## Log files
212
@@ -372,7 +372,7 @@ all programs), edit `netdata.conf` and set:
372
process nice level = -1
373
```
374
375
-then execute this to [restart Netdata](/docs/configure/start-stop-restart.md):
375
+then execute this to [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md):
376
377
```sh
378
sudo systemctl restart netdata
daemon/config/README.md
+31
-31
@@ -26,24 +26,24 @@ adapt the general behavior of Netdata, in great detail. You can find all these s
26
accessing the URL `https://netdata.server.hostname:19999/netdata.conf`. For example check the configuration file
27
of [netdata.firehol.org](http://netdata.firehol.org/netdata.conf). HTTP access to this file is limited by default to
28
[private IPs](https://en.wikipedia.org/wiki/Private_network), via
29
-the [web server access lists](/web/server/README.md#access-lists).
29
+the [web server access lists](https://github.com/netdata/netdata/blob/master/web/server/README.md#access-lists).
30
31
`netdata.conf` has sections stated with `[section]`. You will see the following sections:
32
33
-1. `[global]` to [configure](#global-section-options) the [Netdata daemon](/daemon/README.md).
33
+1. `[global]` to [configure](#global-section-options) the [Netdata daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md).
34
2. `[db]` to [configure](#db-section-options) the database of Netdata.
35
3. `[directories]` to [configure](#directories-section-options) the directories used by Netdata.
36
4. `[logs]` to [configure](#logs-section-options) the Netdata logging.
37
5. `[environment variables]` to [configure](#environment-variables-section-options) the environment variables used
38
Netdata.
39
-6. `[sqlite]` to [configure](#sqlite-section-options) the [Netdata daemon](/daemon/README.md) SQLite settings.
40
-7. `[ml]` to configure settings for [machine learning](/ml/README.md).
41
-8. `[health]` to [configure](#health-section-options) general settings for [health monitoring](/health/README.md).
42
-9. `[web]` to [configure the web server](/web/server/README.md).
43
-10. `[registry]` for the [Netdata registry](/registry/README.md).
44
-11. `[global statistics]` for the [Netdata registry](/registry/README.md).
45
-12. `[statsd]` for the general settings of the [stats.d.plugin](/collectors/statsd.plugin/README.md).
46
-13. `[plugins]` to [configure](#plugins-section-options) which [collectors](/collectors/README.md) to use and PATH
39
+6. `[sqlite]` to [configure](#sqlite-section-options) the [Netdata daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md) SQLite settings.
40
+7. `[ml]` to configure settings for [machine learning](https://github.com/netdata/netdata/blob/master/ml/README.md).
41
+8. `[health]` to [configure](#health-section-options) general settings for [health monitoring](https://github.com/netdata/netdata/blob/master/health/README.md).
42
+9. `[web]` to [configure the web server](https://github.com/netdata/netdata/blob/master/web/server/README.md).
43
+10. `[registry]` for the [Netdata registry](https://github.com/netdata/netdata/blob/master/registry/README.md).
44
+11. `[global statistics]` for the [Netdata registry](https://github.com/netdata/netdata/blob/master/registry/README.md).
45
+12. `[statsd]` for the general settings of the [stats.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md).
46
+13. `[plugins]` to [configure](#plugins-section-options) which [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) to use and PATH
47
settings.
48
14. `[plugin:NAME]` sections for each collector plugin, under the
49
comment [Per plugin configuration](#per-plugin-configuration).
@@ -54,7 +54,7 @@ comment on settings it does not currently use.
54
55
## Applying changes
56
57
-After `netdata.conf` has been modified, Netdata needs to be [restarted](/docs/configure/start-stop-restart.md) for
57
+After `netdata.conf` has been modified, Netdata needs to be [restarted](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for
58
changes to apply:
59
60
```bash
@@ -75,10 +75,10 @@ Please note that your data history will be lost if you have modified `history` p
75
76
| setting | default | info |
77
|:-------------------------------------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
78
-| process scheduling policy | `keep` | See [Netdata process scheduling policy](/daemon/README.md#netdata-process-scheduling-policy) |
78
+| process scheduling policy | `keep` | See [Netdata process scheduling policy](https://github.com/netdata/netdata/blob/master/daemon/README.md#netdata-process-scheduling-policy) |
79
| OOM score | `0` | |
80
-| glibc malloc arena max for plugins | `1` | See [Virtual memory](/daemon/README.md#virtual-memory). |
81
-| glibc malloc arena max for Netdata | `1` | See [Virtual memory](/daemon/README.md#virtual-memory). |
80
+| glibc malloc arena max for plugins | `1` | See [Virtual memory](https://github.com/netdata/netdata/blob/master/daemon/README.md#virtual-memory). |
81
+| glibc malloc arena max for Netdata | `1` | See [Virtual memory](https://github.com/netdata/netdata/blob/master/daemon/README.md#virtual-memory). |
82
| hostname | auto-detected | The hostname of the computer running Netdata. |
83
| host access prefix | empty | This is used in docker environments where /proc, /sys, etc have to be accessed via another path. You may also have to set SYS_PTRACE capability on the docker for this work. Check [issue 43](https://github.com/netdata/netdata/issues/43). |
84
| timezone | auto-detected | The timezone retrieved from the environment variable |
@@ -90,21 +90,21 @@ Please note that your data history will be lost if you have modified `history` p
90
| setting | default | info |
91
|:---------------------------------------------:|:----------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
92
| mode | `dbengine` | `dbengine`: The default for long-term metrics storage with efficient RAM and disk usage. Can be extended with `dbengine page cache size MB` and `dbengine disk space MB`. <br />`save`: Netdata will save its round robin database on exit and load it on startup. <br />`map`: Cache files will be updated in real-time. Not ideal for systems with high load or slow disks (check `man mmap`). <br />`ram`: The round-robin database will be temporary and it will be lost when Netdata exits. <br />`alloc`: Similar to `ram`, but can significantly reduce memory usage, when combined with a low retention and does not support KSM. <br />`none`: Disables the database at this host, and disables health monitoring entirely, as that requires a database of metrics. Not to be used together with streaming. |
93
-| retention | `3600` | Used with `mode = save/map/ram/alloc`, not the default `mode = dbengine`. This number reflects the number of entries the `netdata` daemon will by default keep in memory for each chart dimension. Check [Memory Requirements](/database/README.md) for more information. |
94
-| storage tiers | `1` | The number of storage tiers you want to have in your dbengine. Check the tiering mechanism in the [dbengine's reference](/database/engine/README.md#tiering). You can have up to 5 tiers of data (including the _Tier 0_). This number ranges between 1 and 5. |
93
+| retention | `3600` | Used with `mode = save/map/ram/alloc`, not the default `mode = dbengine`. This number reflects the number of entries the `netdata` daemon will by default keep in memory for each chart dimension. Check [Memory Requirements](https://github.com/netdata/netdata/blob/master/database/README.md) for more information. |
94
+| storage tiers | `1` | The number of storage tiers you want to have in your dbengine. Check the tiering mechanism in the [dbengine's reference](https://github.com/netdata/netdata/blob/master/database/engine/README.md#tiering). You can have up to 5 tiers of data (including the _Tier 0_). This number ranges between 1 and 5. |
95
| dbengine page cache size MB | `32` | Determines the amount of RAM in MiB that is dedicated to caching for _Tier 0_ Netdata metric values. |
96
| dbengine tier **`N`** page cache size MB | `32` | Determines the amount of RAM in MiB that is dedicated for caching Netdata metric values of the **`N`** tier. <br /> `N belongs to [1..4]` ||
97
| dbengine disk space MB | `256` | Determines the amount of disk space in MiB that is dedicated to storing _Tier 0_ Netdata metric values and all related metadata describing them. This option is available **only for legacy configuration** (`Agent v1.23.2 and prior`). |
98
| dbengine multihost disk space MB | `256` | Same functionality as `dbengine disk space MB`, but includes support for storing metrics streamed to a parent node by its children. Can be used in single-node environments as well. This setting is only for _Tier 0_ metrics. |
99
| dbengine tier **`N`** multihost disk space MB | `256` | Same functionality as `dbengine multihost disk space MB`, but stores metrics of the **`N`** tier (both parent node and its children). Can be used in single-node environments as well. <br /> `N belongs to [1..4]` |
100
-| update every | `1` | The frequency in seconds, for data collection. For more information see the [performance guide](/docs/guides/configure/performance.md). These metrics stored as _Tier 0_ data. Explore the tiering mechanism in the [dbengine's reference](/database/engine/README.md#tiering). |
100
+| update every | `1` | The frequency in seconds, for data collection. For more information see the [performance guide](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md). These metrics stored as _Tier 0_ data. Explore the tiering mechanism in the [dbengine's reference](https://github.com/netdata/netdata/blob/master/database/engine/README.md#tiering). |
101
| dbengine tier **`N`** update every iterations | `60` | The down sampling value of each tier from the previous one. For each Tier, the greater by one Tier has N (equal to 60 by default) less data points of any metric it collects. This setting can take values from `2` up to `255`. <br /> `N belongs to [1..4]` |
102
| dbengine tier **`N`** back fill | `New` | Specifies the strategy of recreating missing data on each Tier from the exact lower Tier. <br /> `New`: Sees the latest point on each Tier and save new points to it only if the exact lower Tier has available points for it's observation window (`dbengine tier N update every iterations` window). <br /> `none`: No back filling is applied. <br /> `N belongs to [1..4]` |
103
-| memory deduplication (ksm) | `yes` | When set to `yes`, Netdata will offer its in-memory round robin database and the dbengine page cache to kernel same page merging (KSM) for deduplication. For more information check [Memory Deduplication - Kernel Same Page Merging - KSM](/database/README.md#ksm) |
104
-| cleanup obsolete charts after secs | `3600` | See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also sets the timeout for cleaning up obsolete dimensions |
103
+| memory deduplication (ksm) | `yes` | When set to `yes`, Netdata will offer its in-memory round robin database and the dbengine page cache to kernel same page merging (KSM) for deduplication. For more information check [Memory Deduplication - Kernel Same Page Merging - KSM](https://github.com/netdata/netdata/blob/master/database/README.md#ksm) |
104
+| cleanup obsolete charts after secs | `3600` | See [monitoring ephemeral containers](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also sets the timeout for cleaning up obsolete dimensions |
105
| gap when lost iterations above | `1` | |
106
| cleanup orphan hosts after secs | `3600` | How long to wait until automatically removing from the DB a remote Netdata host (child) that is no longer sending data. |
107
-| delete obsolete charts files | `yes` | See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also affects the deletion of files for obsolete dimensions |
107
+| delete obsolete charts files | `yes` | See [monitoring ephemeral containers](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also affects the deletion of files for obsolete dimensions |
108
| delete orphan hosts files | `yes` | Set to `no` to disable non-responsive host removal. |
109
| enable zero metrics | `no` | Set to `yes` to show charts when all their metrics are zero. |
110
@@ -121,7 +121,7 @@ The multiplication of all the **enabled** tiers `dbengine tier N update every i
121
|:-------------------:|:------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
122
| config | `/etc/netdata` | The directory configuration files are kept. |
123
| stock config | `/usr/lib/netdata/conf.d` | |
124
-| log | `/var/log/netdata` | The directory in which the [log files](/daemon/README.md#log-files) are kept. |
124
+| log | `/var/log/netdata` | The directory in which the [log files](https://github.com/netdata/netdata/blob/master/daemon/README.md#log-files) are kept. |
125
| web | `/usr/share/netdata/web` | The directory the web static files are kept. |
126
| cache | `/var/cache/netdata` | The directory the memory database will be stored if and when Netdata exits. Netdata will re-read the database when it will start again, to continue from the same point. |
127
| lib | `/var/lib/netdata` | Contains the alarm log and the Netdata instance GUID. |
@@ -130,14 +130,14 @@ The multiplication of all the **enabled** tiers `dbengine tier N update every i
130
| plugins | `"/usr/libexec/netdata/plugins.d" "/etc/netdata/custom-plugins.d"` | The directory plugin programs are kept. This setting supports multiple directories, space separated. If any directory path contains spaces, enclose it in single or double quotes. |
131
| health config | `/etc/netdata/health.d` | The directory containing the user alarm configuration files, to override the stock configurations |
132
| stock health config | `/usr/lib/netdata/conf.d/health.d` | Contains the stock alarm configuration files for each collector |
133
-| registry | `/opt/netdata/var/lib/netdata/registry` | Contains the [registry](/registry/README.md) database and GUID that uniquely identifies each Netdata Agent |
133
+| registry | `/opt/netdata/var/lib/netdata/registry` | Contains the [registry](https://github.com/netdata/netdata/blob/master/registry/README.md) database and GUID that uniquely identifies each Netdata Agent |
134
135
### [logs] section options
136
137
| setting | default | info |
138
|:----------------------------------:|:-----------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
139
-| debug flags | `0x0000000000000000` | Bitmap of debug options to enable. For more information check [Tracing Options](/daemon/README.md#debugging). |
140
-| debug | `/var/log/netdata/debug.log` | The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to `syslog` to send the debug messages to syslog, or `none` to disable this log. For more information check [Tracing Options](/daemon/README.md#debugging). |
139
+| debug flags | `0x0000000000000000` | Bitmap of debug options to enable. For more information check [Tracing Options](https://github.com/netdata/netdata/blob/master/daemon/README.md#debugging). |
140
+| debug | `/var/log/netdata/debug.log` | The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to `syslog` to send the debug messages to syslog, or `none` to disable this log. For more information check [Tracing Options](https://github.com/netdata/netdata/blob/master/daemon/README.md#debugging). |
141
| error | `/var/log/netdata/error.log` | The filename to save error messages for Netdata daemon and all plugins (`stderr` is sent here for all Netdata programs, including the plugins). You can also set it to `syslog` to send the errors to syslog, or `none` to disable this log. |
142
| access | `/var/log/netdata/access.log` | The filename to save the log of web clients accessing Netdata charts. You can also set it to `syslog` to send the access log to syslog, or `none` to disable this log. |
143
| facility | `daemon` | A facility keyword is used to specify the type of system that is logging the message. |
@@ -168,9 +168,9 @@ The multiplication of all the **enabled** tiers `dbengine tier N update every i
168
This section controls the general behavior of the health monitoring capabilities of Netdata.
169
170
Specific alarms are configured in per-collector config files under the `health.d` directory. For more info, see [health
171
-monitoring](/health/README.md).
171
+monitoring](https://github.com/netdata/netdata/blob/master/health/README.md).
172
173
-[Alarm notifications](/health/notifications/README.md) are configured in `health_alarm_notify.conf`.
173
+[Alarm notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md) are configured in `health_alarm_notify.conf`.
174
175
| setting | default | info |
176
|:----------------------------------------------:|:------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -180,11 +180,11 @@ monitoring](/health/README.md).
180
| run at least every seconds | `10` | Controls how often all alarm conditions should be evaluated. |
181
| postpone alarms during hibernation for seconds | `60` | Prevents false alarms. May need to be increased if you get alarms during hibernation. |
182
| rotate log every lines | 2000 | Controls the number of alarm log entries stored in `<lib directory>/health-log.db`, where `<lib directory>` is the one configured in the [\[global\] section](#global-section-options) |
183
-| enabled alarms | * | Defines which alarms to load from both user and stock directories. This is a [simple pattern](/libnetdata/simple_pattern/README.md) list of alarm or template names. Can be used to disable specific alarms. For example, `enabled alarms = !oom_kill *` will load all alarms except `oom_kill`. |
183
+| enabled alarms | * | Defines which alarms to load from both user and stock directories. This is a [simple pattern](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) list of alarm or template names. Can be used to disable specific alarms. For example, `enabled alarms = !oom_kill *` will load all alarms except `oom_kill`. |
184
185
### [web] section options
186
187
-Refer to the [web server documentation](/web/server/README.md)
187
+Refer to the [web server documentation](https://github.com/netdata/netdata/blob/master/web/server/README.md)
188
189
### [plugins] section options
190
@@ -204,7 +204,7 @@ Additionally, there will be the following options:
204
### [registry] section options
205
206
To understand what this section is and how it should be configured, please refer to
207
-the [registry documentation](/registry/README.md).
207
+the [registry documentation](https://github.com/netdata/netdata/blob/master/registry/README.md).
208
209
## Per-plugin configuration
210
@@ -212,7 +212,7 @@ The configuration options for plugins appear in sections following the pattern `
212
213
### Internal plugins
214
215
-Most internal plugins will provide additional options. Check [Internal Plugins](/collectors/README.md) for more
215
+Most internal plugins will provide additional options. Check [Internal Plugins](https://github.com/netdata/netdata/blob/master/collectors/README.md) for more
216
information.
217
218
Please note, that by default Netdata will enable monitoring metrics for disks, memory, and network only when they are
@@ -228,7 +228,7 @@ External plugins will have only 2 options at `netdata.conf`:
228
229
| setting | default | info |
230
|:---------------:|:--------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------|
231
-| update every | the value of `[global].update every` setting | The frequency in seconds the plugin should collect values. For more information check the [performance guide](/docs/guides/configure/performance.md). |
231
+| update every | the value of `[global].update every` setting | The frequency in seconds the plugin should collect values. For more information check the [performance guide](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md). |
232
| command options | - | Additional command line options to pass to the plugin. | |
233
234
External plugins that need additional configuration may support a dedicated file in `/etc/netdata`. Check their
database/README.md
+6
-6
@@ -13,12 +13,12 @@ learn_rel_path: "Setup"
13
Netdata is fully capable of long-term metrics storage, at per-second granularity, via its default database engine
14
(`dbengine`). But to remain as flexible as possible, Netdata supports several storage options:
15
16
-1. `dbengine`, (the default) data are in database files. The [Database Engine](/database/engine/README.md) works like a
16
+1. `dbengine`, (the default) data are in database files. The [Database Engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md) works like a
17
traditional database. There is some amount of RAM dedicated to data caching and indexing and the rest of the data
18
reside compressed on disk. The number of history entries is not fixed in this case, but depends on the configured
19
disk space and the effective compression ratio of the data stored. This is the **only mode** that supports changing
20
the data collection update frequency (`update every`) **without losing** the previously stored metrics. For more
21
- details see [here](/database/engine/README.md).
21
+ details see [here](https://github.com/netdata/netdata/blob/master/database/engine/README.md).
22
23
2. `ram`, data are purely in memory. Data are never saved on disk. This mode uses `mmap()` and supports [KSM](#ksm).
24
@@ -42,13 +42,13 @@ The default mode `[db].mode = dbengine` has been designed to scale for longer re
42
for parent Agents in the _Parent - Child_ setups
43
44
The other available database modes are designed to minimize resource utilization and should only be considered on
45
-[Parent - Child](/docs/metrics-storage-management/how-streaming-works.mdx) setups at the children side and only when the
45
+[Parent - Child](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx) setups at the children side and only when the
46
resource constraints are very strict.
47
48
So,
49
50
- On a single node setup, use `[db].mode = dbengine`.
51
-- On a [Parent - Child](/docs/metrics-storage-management/how-streaming-works.mdx) setup, use `[db].mode = dbengine` on the
51
+- On a [Parent - Child](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx) setup, use `[db].mode = dbengine` on the
52
parent to increase retention, a more resource efficient mode like, `dbengine` with light retention settings, and
53
`save`, `ram` or `none` modes for the children to minimize resource utilization.
54
@@ -68,7 +68,7 @@ Metrics retention is controlled only by the disk space allocated to storing metr
68
CPU required by the agent to query longer timeframes.
69
70
Since Netdata Agents usually run on the edge, on production systems, Netdata Agent **parents** should be considered.
71
-When having a [**parent - child**](/docs/metrics-storage-management/how-streaming-works.mdx) setup, the child (the
71
+When having a [**parent - child**](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx) setup, the child (the
72
Netdata Agent running on a production system) delegates all of its functions, including longer metrics retention and
73
querying, to the parent node that can dedicate more resources to this task. A single Netdata Agent parent can centralize
74
multiple children Netdata Agents (dozens, hundreds, or even thousands depending on its available resources).
@@ -89,7 +89,7 @@ every 2 seconds. This will **cut in half** both CPU and RAM resources consumed b
89
On very weak devices you might have to use `[db].update every = 5` and `[db].retention = 720` (still 1 hour of data, but
90
1/5 of the CPU and RAM resources).
91
92
-You can also disable [data collection plugins](/collectors/README.md) that you don't need. Disabling such plugins will also
92
+You can also disable [data collection plugins](https://github.com/netdata/netdata/blob/master/collectors/README.md) that you don't need. Disabling such plugins will also
93
free both CPU and RAM resources.
94
95
## Memory optimizations
database/engine/README.md
+3
-3
@@ -305,7 +305,7 @@ Agent.
305
##### Information
306
307
For more information about setting `[db].mode` on your nodes, in addition to other streaming configurations, see
308
-[streaming](/streaming/README.md).
308
+[streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md).
309
310
## Requirements & limitations
311
@@ -331,7 +331,7 @@ An important observation is that RAM usage depends on both the `page cache size`
331
options.
332
333
You can use
334
-our [database engine calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
334
+our [database engine calculator](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
335
to validate the memory requirements for your particular system(s) and configuration (**out-of-date**).
336
337
### Disk space
@@ -403,7 +403,7 @@ location is `/var/cache/netdata/dbengine/*`). The higher numbered filenames cont
403
can safely delete some pairs of files when Netdata is stopped to manually free up some space.
404
405
_Users should_ **back up** _their `./dbengine` folders if they consider this data to be important._ You can also set up
406
-one or more [exporting connectors](/exporting/README.md) to send your Netdata metrics to other databases for long-term
406
+one or more [exporting connectors](https://github.com/netdata/netdata/blob/master/exporting/README.md) to send your Netdata metrics to other databases for long-term
407
storage at lower granularity.
408
409
## Operation
docs/Add-more-charts-to-netdata.md
+2
-2
@@ -5,9 +5,9 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-ch
5
6
# Add more charts to Netdata
7
8
-This file has been deprecated. Please see our [collectors docs](/collectors/README.md) for more information.
8
+This file has been deprecated. Please see our [collectors docs](https://github.com/netdata/netdata/blob/master/collectors/README.md) for more information.
9
10
## Available data collection modules
11
12
-See the [list of supported collectors](/collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics
12
+See the [list of supported collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics
13
from.
docs/Running-behind-apache.md
+1
-1
@@ -353,7 +353,7 @@ If your apache server is not on localhost, you can set:
353
354
*note: Netdata v1.9+ support `allow connections from`*
355
356
-`allow connections from` accepts [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to match against the connection IP address.
356
+`allow connections from` accepts [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to match against the connection IP address.
357
358
## prevent the double access.log
359
docs/Running-behind-h2o.md
+2
-2
@@ -105,7 +105,7 @@ Using the above, you access Netdata on the backend servers, like this:
105
106
### Encrypt the communication between H2O and Netdata
107
108
-In case Netdata's web server has been [configured to use TLS](/web/server/README.md#enabling-tls-support), it is
108
+In case Netdata's web server has been [configured to use TLS](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support), it is
109
necessary to specify inside the H2O configuration that the final destination is using TLS. To do this, change the
110
`http://` on the `proxy.reverse.url` line in your H2O configuration with `https://`
111
@@ -173,7 +173,7 @@ If your H2O server is not on localhost, you can set:
173
174
*note: Netdata v1.9+ support `allow connections from`*
175
176
-`allow connections from` accepts [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to match against
176
+`allow connections from` accepts [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to match against
177
the connection IP address.
178
179
## Prevent the double access.log
docs/Running-behind-nginx.md
+2
-2
@@ -173,7 +173,7 @@ Using the above, you access Netdata on the backend servers, like this:
173
174
### Encrypt the communication between Nginx and Netdata
175
176
-In case Netdata's web server has been [configured to use TLS](/web/server/README.md#enabling-tls-support), it is
176
+In case Netdata's web server has been [configured to use TLS](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support), it is
177
necessary to specify inside the Nginx configuration that the final destination is using TLS. To do this, please, append
178
the following parameters in your `nginx.conf`
179
@@ -247,7 +247,7 @@ If your Nginx server is not on localhost, you can set:
247
248
*note: Netdata v1.9+ support `allow connections from`*
249
250
-`allow connections from` accepts [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to match against the
250
+`allow connections from` accepts [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to match against the
251
connection IP address.
252
253
## Prevent the double access.log
docs/agent-cloud.md
+21
-20
@@ -13,24 +13,24 @@ hosted web interface that gives you real-time visibility into your entire infras
13
There are two main ways to use your Agent(s) with Netdata Cloud. You can use both these methods simultaneously, or just
14
one, based on your needs:
15
16
-- Use Netdata Cloud's web interface for monitoring an entire infrastructure, with any number of Agents, in one
17
- centralized dashboard.
18
-- Use **Visited nodes** to quickly navigate between the dashboards of nodes you've recently visited.
16
+- Use Netdata Cloud's web interface for monitoring an entire infrastructure, with any number of Agents, in one
17
+ centralized dashboard.
18
+- Use **Visited nodes** to quickly navigate between the dashboards of nodes you've recently visited.
19
20
## Monitor an infrastructure with Netdata Cloud
21
22
We designed Netdata Cloud to help you see health and performance metrics, plus active alarms, in a single interface.
23
Here's what a small infrastructure might look like:
24
25
-
25
+
26
28
-[Read more about Netdata Cloud](https://learn.netdata.cloud/docs/cloud/) to better understand how it gives you real-time
27
+[Read more about Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) to better
28
+understand how it gives you real-time
29
visibility into your entire infrastructure, and why you might consider using it.
30
31
-Next, [get started in 5 minutes](https://learn.netdata.cloud/docs/cloud/get-started/), or read our [connection to Cloud
32
-reference](/claim/README.md) for a complete investigation of Cloud's security and encryption features, plus instructions
33
-for Docker containers.
31
+Next, [get started in 5 minutes](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx), or read our
32
+[connection to Cloud reference](https://github.com/netdata/netdata/blob/master/claim/README.md) for a complete
33
+investigation of Cloud's security and encryption features, plus instructions for Docker containers.
34
35
## Navigate between dashboards with Visited nodes
36
@@ -46,15 +46,13 @@ Netdata Cloud account, sign in with your preferred method.
46
Cloud redirects you back to your node's dashboard, which is now connected to your Netdata Cloud account. You can now see
47
the Visited nodes menu, which is populated by a single node.
48
49
-
49
+
50
51
If you previously went through the Cloud onboarding process to create a Space and War Room, you will also see these in
52
the Visited Nodes menu. You can click on your Space or any of your War Rooms to navigate to Netdata Cloud and continue
53
monitoring your infrastructure from there.
54
56
-
55
+
56
57
To add more Agents to your Visited nodes menu, visit them and sign in again. This process connects that node to your
58
Cloud account and further populates the menu.
@@ -62,16 +60,19 @@ Cloud account and further populates the menu.
60
Once you've added more than one node, you can use the menu to switch between various dashboards without remembering IP
61
addresses or hostnames or saving bookmarks for every node you want to monitor.
62
65
-
63
+
64
65
## What's next?
66
67
The Agent-Cloud integration is highly adaptable to the needs of any infrastructure or user. If you want to learn more
68
about how you might want to use or configure Cloud, we recommend the following:
69
73
-- Get an overview of Cloud's features by reading [Cloud documentation](https://learn.netdata.cloud/docs/cloud/).
74
-- Follow the 5-minute [get started with Cloud](https://learn.netdata.cloud/docs/cloud/get-started/) guide to finish
75
- onboarding and connect your first nodes.
76
-- Better understand how agents connect securely to the Cloud with [connect agent to Cloud](/claim/README.md) and [Agent-Cloud
77
- link](/aclk/README.md) documentation.
70
+- Get an overview of Cloud's features by
71
+ reading [Cloud documentation](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx).
72
+- Follow the
73
+ 5-minute [get started with Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx)
74
+ guide to finish
75
+ onboarding and connect your first nodes.
76
+- Better understand how agents connect securely to the Cloud
77
+ with [connect agent to Cloud](https://github.com/netdata/netdata/blob/master/claim/README.md) and
78
+ [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/aclk/README.md) documentation.
docs/anonymous-statistics.md
+4
-4
@@ -20,7 +20,7 @@ We use the statistics gathered from this information for two purposes:
20
21
Netdata collects usage information via two different channels:
22
23
-- **Agent dashboard**: We use the [PostHog JavaScript integration](https://posthog.com/docs/integrations/js-integration) (with sensitive event attributes overwritten to be anonymized) to send product usage events when you access an [Agent's dashboard](/web/gui/README.md).
23
+- **Agent dashboard**: We use the [PostHog JavaScript integration](https://posthog.com/docs/integrations/js-integration) (with sensitive event attributes overwritten to be anonymized) to send product usage events when you access an [Agent's dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md).
24
- **Agent backend**: The `netdata` daemon executes the [`anonymous-statistics.sh`](https://github.com/netdata/netdata/blob/6469cf92724644f5facf343e4bdd76ac0551a418/daemon/anonymous-statistics.sh.in) script when Netdata starts, stops cleanly, or fails.
25
26
You can opt-out from sending anonymous statistics to Netdata through three different [opt-out mechanisms](#opt-out).
@@ -65,7 +65,7 @@ Starting with v1.21, we additionally collect information about:
65
66
- Failures to build the dependencies required to use Cloud features.
67
- Unavailability of Cloud features in an agent.
68
-- Failures to connect to the Cloud in case the [connection process](/claim/README.md) has been completed. This includes error codes
68
+- Failures to connect to the Cloud in case the [connection process](https://github.com/netdata/netdata/blob/master/claim/README.md) has been completed. This includes error codes
69
to inform the Netdata team about the reason why the connection failed.
70
71
To see exactly what and how is collected, you can review the script template `daemon/anonymous-statistics.sh.in`. The
@@ -82,13 +82,13 @@ installation, including manual, offline, and macOS installations. Create the fil
82
.opt-out-from-anonymous-statistics` from your Netdata configuration directory.
83
84
**Pass the option `--disable-telemetry` to any of the installer scripts in the [installation
85
-docs](/packaging/installer/README.md).** You can append this option during the initial installation or a manual
85
+docs](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).** You can append this option during the initial installation or a manual
86
update. You can also export the environment variable `DISABLE_TELEMETRY` with a non-zero or non-empty value
87
(e.g: `export DISABLE_TELEMETRY=1`).
88
89
When using Docker, **set your `DISABLE_TELEMETRY` environment variable to `1`.** You can set this variable with the following
90
command: `export DISABLE_TELEMETRY=1`. When creating a container using Netdata's [Docker
91
-image](/packaging/docker/README.md#create-a-new-netdata-agent-container) for the first time, this variable will disable
91
+image](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md#create-a-new-netdata-agent-container) for the first time, this variable will disable
92
the anonymous statistics script inside of the container.
93
94
Each of these opt-out processes does the following:
docs/cloud/alerts-notifications/notifications.mdx
+17
-16
@@ -1,6 +1,8 @@
1
---
2
title: "Alert notifications"
3
-description: "Configure Netdata Cloud to send notifications to your team whenever any node on your infrastructure triggers a pre-configured or custom alert threshold."
3
+description: >-
4
+ "Configure Netdata Cloud to send notifications to your team whenever any node on your infrastructure
5
+ triggers a pre-configured or custom alert threshold."
6
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx"
7
sidebar_label: "Alert notifications"
8
learn_status: "Published"
@@ -108,26 +110,25 @@ the local Agent dashboard at `http://NODE:19999`.
110
111
Email alarm notifications show the following information:
112
111
-- The Space's name
112
-- The node's name
113
-- Alarm status: critical, warning, cleared
114
-- Previous alarm status
115
-- Time at which the alarm triggered
116
-- Chart context that triggered the alarm
117
-- Name and information about the triggered alarm
118
-- Alarm value
119
-- Total number of warning and critical alerts on that node
120
-- Threshold for triggering the given alarm state
121
-- Calculation or database lookups that Netdata uses to compute the value
122
-- Source of the alarm, including which file you can edit to configure this alarm on an individual node
113
+- The Space's name
114
+- The node's name
115
+- Alarm status: critical, warning, cleared
116
+- Previous alarm status
117
+- Time at which the alarm triggered
118
+- Chart context that triggered the alarm
119
+- Name and information about the triggered alarm
120
+- Alarm value
121
+- Total number of warning and critical alerts on that node
122
+- Threshold for triggering the given alarm state
123
+- Calculation or database lookups that Netdata uses to compute the value
124
+- Source of the alarm, including which file you can edit to configure this alarm on an individual node
125
126
Email notifications also feature a **Go to Node** button, which takes you directly to the offending chart for that node
127
within Cloud's embedded dashboards.
128
129
Here's an example email notification for the `ram_available` chart, which is in a critical state:
130
129
-
131
+
132
133
## What's next?
134
@@ -151,4 +152,4 @@ visualization of the health of your infrastructure.
152
- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
153
- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md)
154
- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
154
-- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
\ No newline at end of file
155
+- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
docs/cloud/alerts-notifications/smartboard.mdx
+8
-6
@@ -20,20 +20,22 @@ The Alerts view is available entirely for free to all users and for any number o
20
The Alerts view shows all active alerts in your War Room, including the alert's name, the most recent value, a
21
timestamp of when it became active, and the relevant node.
22
23
-You can use the checkboxes in the filter pane on the right side of the screen to filter the alerts displayed in the table
23
+You can use the checkboxes in the filter pane on the right side of the screen to filter the alerts displayed in the
24
+table
25
by Status, Class, Type & Componenet, Role, Operating System, or Node.
26
27
Click on any of the alert names to see the alert.
28
29
## View active alerts
30
30
-In the `Active` subtab, you can see exactly how many **critical** and **warning** alerts are active across your nodes.
31
+In the `Active` subtab, you can see exactly how many **critical** and **warning** alerts are active across your nodes.
32
32
-## View configured alerts
33
+## View configured alerts
34
34
-You can view all the configured alerts on all the agents that belong to a War Room in the `Alert Configurations` subtab.
35
-From within the Alerts view, you can click the `Alert Configurations` subtab to see a high level view of the states of
36
-the alerts on the nodes within this War Room and drill down to the node level where each alert is configured with their latest status.
35
+You can view all the configured alerts on all the agents that belong to a War Room in the `Alert Configurations` subtab.
36
+From within the Alerts view, you can click the `Alert Configurations` subtab to see a high level view of the states of
37
+the alerts on the nodes within this War Room and drill down to the node level where each alert is configured with their
38
+latest status.
39
40
41
docs/cloud/alerts-notifications/view-active-alerts.mdx
+33
-20
@@ -1,6 +1,8 @@
1
---
2
title: "View active alerts"
3
-description: "Track the health of your infrastructure in one place by taking advantage of the powerful health monitoring watchdog running on every node."
3
+description: >-
4
+ "Track the health of your infrastructure in one place by taking advantage of the powerful health monitoring
5
+ watchdog running on every node."
6
type: "how-to"
7
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx"
8
sidebar_label: "View active alerts"
@@ -17,23 +19,27 @@ infrastructure based on their configuration. Every node comes with hundreds of p
19
tested by Netdata's community of DevOps engineers and SREs, but you may want to customize existing alerts or create new
20
ones entirely.
21
20
-Read our doc on [health alerts](/docs/monitor/configure-alarms) to learn how to tweak existing alerts or create new
22
+Read our doc on [health alerts](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to
23
+learn how to tweak existing alerts or create new
24
health entities based on the specific needs of your infrastructure. By taking charge of alert configuration, you'll
25
ensure Netdata Cloud always delivers the most relevant alerts about the well-being of your nodes.
26
27
## View all active alerts
28
26
-The [Alerts Smartboard](/docs/cloud/alerts-notifications/smartboard) provides a high-level interface for viewing the
27
-number of critical or warning alerts and where they are in your infrastructure.
29
+The [Alerts Smartboard](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.mdx)
30
+provides a high-level interface for viewing the number of critical or warning alerts and where they are in your
31
+infrastructure.
32
29
-
33
+
34
35
Click on the **Alerts** tab in any War Room to open the Smartboard. Alternatively, click on any of the alert badges in
33
-the [Nodes view](/docs/cloud/visualize/nodes) to jump to the Alerts Smartboard.
36
+the [Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) to jump to the Alerts
37
+Smartboard.
38
35
-From here, filter active alerts using the **critical** or **warning** boxes, or hover over a box in the [nodes
36
-map](/docs/cloud/alerts-notifications/smartboard#nodes-map) to see a popup node-specific alert information.
39
+From here, filter active alerts using the **critical** or **warning** boxes, or hover over a box in
40
+the [nodes map](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.mdx#nodes-map)
41
+to see a
42
+popup node-specific alert information.
43
44
## View alerts in context with charts
45
@@ -41,23 +47,30 @@ If you click on any of the alerts, either in a nodes map popup or the alerts tab
47
single-node dashboard and scrolls to the relevant chart. Netdata Cloud also draws a highlight and the value at the
48
moment your node triggered this alert.
49
44
-
50
+
51
47
-You can then [select this area](/docs/dashboard/interact-charts#select) with `Alt/⌘ + mouse selection` to highlight the
48
-alerted timeframe while you explore other charts for root cause analysis.
52
+You can
53
+then [select this area](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx#select)
54
+with `Alt/⌘ + mouse selection` to highlight the alerted timeframe while you explore other charts for root cause
55
+analysis.
56
50
-Or, select the area and run [Metric Correlations](/docs/cloud/insights/metric-correlations) to filter the single-node
57
+Or, select the area and
58
+run [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to
59
+filter the single-node
60
dashboard to only those charts most likely to be connected to the alert.
61
62
## What's next?
63
55
-Learn more about the features of the Smartboard in its [reference](/docs/cloud/alerts-notifications/smartboard) doc. To
56
-stay notified of active alerts, enable [centralized alert notifications](/docs/cloud/alerts-notifications/notifications)
64
+Learn more about the features of the Smartboard in
65
+its [reference](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.mdx)
66
+doc. To stay notified of active alerts,
67
+enable [centralized alert notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
68
from Netdata Cloud.
69
59
-If you're through with setting up alerts, it might be time to [invite your
60
-team](/docs/cloud/manage/invite-your-team).
70
+If you're through with setting up alerts, it might be time
71
+to [invite your team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md).
72
62
-Check out our recommendations on organizing and using [Spaces](/docs/cloud/spaces) and [War
63
-Rooms](/docs/cloud/war-rooms) to streamline your processes once you find an alert in Netdata Cloud.
73
+Check out our recommendations on organizing and
74
+using [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md) and
75
+[War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md) to streamline your processes once
76
+you find an alert in Netdata Cloud.
docs/cloud/beta-architecture/new-architecture.md
+1
-1
@@ -19,7 +19,7 @@ that you have specifically requested. Features that will be developed on the new
19
## Enabling the new architecture
20
21
To enable the new architecture, first ensure that you have installed the latest Netdata version following
22
-[our guide](https://learn.netdata.cloud/docs/get-started/). Then, you or your administrator will need to retrieve the Space IDs
22
+[our guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx). Then, you or your administrator will need to retrieve the Space IDs
23
within Netdata Cloud by clicking `Manage Space` in the left pane, selecting the `Space` tab, and copying the value in the `Space Id` field.
24
You can then send an email to [beta@Netdata.cloud](mailto:beta@netdata.cloud) requesting to be included in our beta testers, and include
25
in the body of the email a list of Space IDs for any space you would like to have whitelisted for the update. If you received an email
docs/cloud/cloud.mdx
+1
-1
@@ -18,7 +18,7 @@ and metadata are streamed to Netdata Cloud, then proxied to your browser, with a
18
privacy <RiExternalLinkLine className="inline-block" />](https://netdata.cloud/privacy/).
19
20
21
-Read [_What is Netdata?_](/docs/overview/what-is-netdata) for details about how Netdata and Netdata Cloud work together
21
+Read [_What is Netdata?_](https://github.com/netdata/netdata/blob/master/docs/overview/what-is-netdata.md) for details about how Netdata and Netdata Cloud work together
22
and how they're different from other monitoring solutions, or the
23
[FAQ <RiExternalLinkLine className="inline-block" />](https://community.netdata.cloud/tags/c/general/29/faq) for answers to common questions.
24
docs/cloud/data-privacy.mdx
+1
-1
@@ -12,7 +12,7 @@ learn_rel_path: "Concepts"
12
you. This is why **we don't store any metric data in Netdata Cloud**.
13
14
Your local installations of the Netdata Agent form the basis for the Netdata Cloud. All the data that you see in the web browser when using Netdata Cloud, is actually streamed directly from the Netdata Agent to the Netdata Cloud dashboard.
15
-The data passes through our systems, but it isn't stored. You can learn more about [the Agent's security design](https://learn.netdata.cloud/docs/agent/netdata-security) in the Agent documentation.
15
+The data passes through our systems, but it isn't stored. You can learn more about [the Agent's security design](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md) in the Agent documentation.
16
17
However, to be able to offer the stunning visualizations and advanced functionality of Netdata Cloud, it does store a limited number of _metadata_.
18
docs/cloud/get-started.mdx
+54
-30
@@ -1,6 +1,8 @@
1
---
2
title: "Get started with Netdata Cloud"
3
-description: "Ready to get real-time visibility into your entire infrastructure? This guide will help you get started on Netdata Cloud."
3
+description: >-
4
+ "Ready to get real-time visibility into your entire infrastructure? This guide will help you get started on
5
+ Netdata Cloud."
6
image: "/img/seo/cloud_get-started.png"
7
custom_edit_url: "https://github.com/netdata/learn/blob/master/docs/cloud/get-started.mdx"
8
---
@@ -14,15 +16,16 @@ the onboarding process, such as setting up your Space and War Room and connectin
16
## Before you start
17
18
Before you get started with Netdata Cloud, you should have the open-source Netdata monitoring agent installed. See our
17
-[installation guide](/docs/get-started) for details.
19
+[installation guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) for details.
20
21
If you already have the Netdata agent running on your node(s), make sure to update it to v1.32 or higher. Read the
20
-[updating documentation](/docs/agent/packaging/installer/update/) for information on how to update based on the method
21
-you used to install Netdata on that node.
22
+[updating documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md) for information
23
+on how to update based on the method you used to install Netdata on that node.
24
25
## Begin the onboarding process
26
25
-Get started by signing in to Netdata. Read the [sign in](/docs/cloud/manage/sign-in) doc for details on the
27
+Get started by signing in to Netdata. Read
28
+the [sign in](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.mdx) doc for details on the
29
authentication methods we use.
30
31
<Link to="https://app.netdata.cloud" className="group">
@@ -32,33 +35,45 @@ authentication methods we use.
35
</button>
36
</Link>
37
35
-Once signed in with your preferred method, a General [War Room](/docs/cloud/war-rooms) and a [Space](/docs/cloud/spaces)
36
-named for your login email are automatically created. You can configure more Spaces and War Rooms to help you you organize your team
37
-and the many systems that make up your infrastructure. For example, you can put product and infrastructure SRE teams in separate
38
-Spaces, and then use War Rooms to group nodes by their service (`nginx`), purpose (`webservers`), or physical location (`IAD`).
38
+Once signed in with your preferred method, a
39
+General [War Room](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md) and
40
+a [Space](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
41
+named for your login email are automatically created. You can configure more Spaces and War Rooms to help you you
42
+organize your team
43
+and the many systems that make up your infrastructure. For example, you can put product and infrastructure SRE teams in
44
+separate
45
+Spaces, and then use War Rooms to group nodes by their service (`nginx`), purpose (`webservers`), or physical
46
+location (`IAD`).
47
48
Don't worry! You can always add more Spaces and War Rooms later if you decide to reorganize how you use Netdata Cloud.
49
50
## Connect your nodes
51
44
-From within the created War Rooms, Netdata Cloud prompts you to [connect](/docs/agent/claim) your nodes to Netdata Cloud. Non-admin
45
-users can users can select from existing nodes already connected to the space or select an admin from a provided list to connect node.
46
-You can connect any node running Netdata, whether it's a physical or virtual machine, a Docker container, IoT device, and more.
47
-
48
-The connection process securely connects any node to Netdata Cloud using the [Agent-Cloud link](/docs/agent/aclk). By
49
-connecting a node, you prove you have write and administrative access to that node. Connecting to Cloud also prevents any third party
52
+From within the created War Rooms, Netdata Cloud prompts you
53
+to [connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your nodes to Netdata Cloud. Non-admin
54
+users can users can select from existing nodes already connected to the space or select an admin from a provided list to
55
+connect node.
56
+You can connect any node running Netdata, whether it's a physical or virtual machine, a Docker container, IoT device,
57
+and more.
58
+
59
+The connection process securely connects any node to Netdata Cloud using
60
+the [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/aclk/README.md). By
61
+connecting a node, you prove you have write and administrative access to that node. Connecting to Cloud also prevents
62
+any third party
63
from connecting a node that you control. Keep in mind:
64
52
-- _You can only connect any given node in a single Space_. You can, however, add that connected node to multiple War Rooms
65
+- _You can only connect any given node in a single Space_. You can, however, add that connected node to multiple War
66
+ Rooms
67
within that one Space.
68
- You must repeat the connection process on every node you want to add to Netdata Cloud.
69
70
<Callout type="notice">
71
72
**Netdata Cloud ensures your data privacy by not storing metrics data from your nodes**. See our statement on Netdata
59
-Cloud [data privacy](/docs/agent/aclk/#data-privacy) for details on the data that's streamed from your nodes and the
60
-[connecting to cloud](/docs/agent/claim) doc for details about why we implemented the connection process and the encryption methods
61
-we use to secure your data in transit.
73
+Cloud [data privacy](https://github.com/netdata/netdata/blob/master/aclk/README.md/#data-privacy) for details on the
74
+data that's streamed from your nodes and the
75
+[connecting to cloud](https://github.com/netdata/netdata/blob/master/claim/README.md) doc for details about why we
76
+implemented the connection process and the encryption methods we use to secure your data in transit.
77
78
</Callout>
79
@@ -66,23 +81,27 @@ To connect a node, select which War Rooms you want to add this node to with the
81
Netdata Cloud into your node's terminal.
82
83
Hit **Enter**. The script should return `Agent was successfully claimed.`. If the claiming script returns errors, or if
69
-you don't see the node in your Space after 60 seconds, see the [troubleshooting
70
-information](/docs/agent/claim#troubleshooting).
84
+you don't see the node in your Space after 60 seconds, see
85
+the [troubleshooting information](https://github.com/netdata/netdata/blob/master/claim/README.md#troubleshooting).
86
87
Repeat this process with every node you want to add to Netdata Cloud during onboarding. You can also add more nodes once
73
-you've finished onboarding by clicking the **Connect Nodes** button in the [Space management
74
-area](/docs/cloud/spaces/#manage-spaces).
88
+you've finished onboarding by clicking the **Connect Nodes** button in
89
+the [Space management area](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md/#manage-spaces).
90
91
### Alternatives and other operating systems
92
93
**Docker**: You can execute the claiming script Netdata running as a Docker container, or attach the claiming script
79
-when creating the container for the first time, such as when you're spinning up ephemeral containers. See the [connect an agent running in Docker](/docs/agent/claim#connect-an-agent-running-in-docker) documentation for details.
94
+when creating the container for the first time, such as when you're spinning up ephemeral containers. See
95
+the [connect an agent running in Docker](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-an-agent-running-in-docker)
96
+documentation for details.
97
98
**Without root privileges**: If you want to connect an agent without using root privileges, see our [connect
82
-documentation](/docs/agent/claim#connect-an-agent-without-root-privileges).
99
+documentation](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-an-agent-without-root-privileges).
100
101
**With a proxy**: If your node uses a proxy to connect to the internet, you need to configure the node's proxy settings.
85
-See our [connect through a proxy](/docs/agent/claim#connect-through-a-proxy) doc for details.
102
+See
103
+our [connect through a proxy](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-through-a-proxy)
104
+doc for details.
105
106
## Add bookmarks to essential resources
107
@@ -99,11 +118,16 @@ short description for your team's reference.
118
119
## What's next?
120
102
-You finish onboarding by [inviting members of your team](/docs/cloud/manage/invite-your-team) to your Space. You
121
+You finish onboarding
122
+by [inviting members of your team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md)
123
+to your Space. You
124
can also invite them later. At this point, you're ready to use Cloud.
125
105
-Next, learn about the organization and interfaces behind [Spaces](/docs/cloud/spaces) and [War
106
-Rooms](/docs/cloud/war-rooms).
126
+Next, learn about the organization and interfaces
127
+behind [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
128
+and [War
129
+Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md).
130
108
-If you're ready to explore, check out how to use the [Overview dashboard](/docs/cloud/visualize/overview), which is the
131
+If you're ready to explore, check out how to use
132
+the [Overview dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), which is the
133
default view for each new War Room you create.
docs/cloud/insights/anomaly-advisor.mdx
+2
-2
@@ -32,9 +32,9 @@ To enable ML on your Netdata Agent, you need to edit the `[ml]` section in your
32
33
At a minimum you just need to set `enabled = yes` to enable ML with default params. More details about configuration can be found in the [Netdata Agent ML docs](https://learn.netdata.cloud/docs/agent/ml#configuration).
34
35
-**Note**: Follow [this guide](https://learn.netdata.cloud/guides/step-by-step/step-04) if you are unfamiliar with making configuration changes in Netdata.
35
+**Note**: Follow [this guide](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-04.md) if you are unfamiliar with making configuration changes in Netdata.
36
37
-When you have finished your configuration, restart Netdata with a command like `sudo systemctl restart netdata` for the config changes to take effect. You can find more info on restarting Netdata [here](https://learn.netdata.cloud/docs/configure/start-stop-restart).
37
+When you have finished your configuration, restart Netdata with a command like `sudo systemctl restart netdata` for the config changes to take effect. You can find more info on restarting Netdata [here](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
38
39
After a brief delay, you should see the number of `trained` dimensions start to increase on the "dimensions" chart of the "Anomaly Detection" menu on the Overview page. By default the `minimum num samples to train = 3600` parameter means at least 1 hour of data is required to train initial models, but you could set this to `900` if you want to train initial models quicker but on less data. Over time, they will retrain on up to `maximum num samples to train = 14400` (4 hours by default), but you could increase this is you wanted to train on more data.
40
docs/cloud/insights/metric-correlations.md
+2
-2
@@ -53,7 +53,7 @@ Behind the scenes, Netdata will aggregate the raw data as needed such that arbit
53
54
Netdata is different from typical observability agents since, in addition to just collecting raw metric values, it will by default also assign an "[Anomaly Bit](/docs/agent/ml#anomaly-bit)" related to each collected metric each second. This bit will be 0 for "normal" and 1 for "anomalous". This means that each metric also natively has an "[Anomaly Rate](/docs/agent/ml#anomaly-rate)" associated with it and, as such, MC can be run against the raw metric values or their corresponding anomaly rates.
55
56
-**Note**: Read more [here](https://learn.netdata.cloud/guides/monitor/anomaly-detection) to learn more about the native anomaly detection features within netdata.
56
+**Note**: Read more [here](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection.md) to learn more about the native anomaly detection features within netdata.
57
58
- `Metrics` - Run MC on the raw metric values.
59
- `Anomaly Rate` - Run MC on the corresponding anomaly rate for each metric.
@@ -84,4 +84,4 @@ Should you still want to, disabling nodes for Metric Correlation on the agent is
84
85
## What's next?
86
87
-You can read more about all the ML powered capabilities of Netdata [here](https://learn.netdata.cloud/guides/monitor/anomaly-detection). If you aren't yet familiar with the power of Netdata Cloud's visualization features, check out the [Nodes view](/docs/cloud/visualize/nodes) and learn how to [build new dashboards](/docs/cloud/visualize/dashboards).
87
+You can read more about all the ML powered capabilities of Netdata [here](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection.md). If you aren't yet familiar with the power of Netdata Cloud's visualization features, check out the [Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) and learn how to [build new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
docs/cloud/manage/invite-your-team.md
+13
-11
@@ -1,6 +1,8 @@
1
---
2
title: "Invite your team"
3
-description: "Invite your entire SRE, DevOPs, or ITOps team to Netdata Cloud to give everyone insights into your infrastructure from a single pane of glass."
3
+description: >-
4
+ "Invite your entire SRE, DevOPs, or ITOps team to Netdata Cloud to give everyone insights into your
5
+ infrastructure from a single pane of glass."
6
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md"
7
sidebar_label: "Invite your team"
8
learn_status: "Published"
@@ -8,10 +10,10 @@ learn_topic_type: "Tasks"
10
learn_rel_path: "Operations"
11
---
12
11
-Invite new users to your Space by clicking on **Invite Users** in the [Space](/docs/cloud/spaces) management area.
13
+Invite new users to your Space by clicking on **Invite Users** in
14
+the [Space](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md) management area.
15
13
-
16
+
17
18
Enter the email addresses for the users you want to invite to your Space. You can enter any number of email addresses,
19
separated by a comma, to send multiple invitations at once.
@@ -19,17 +21,17 @@ separated by a comma, to send multiple invitations at once.
21
Next, choose the War Rooms you want to invite these users to. Once logged in, these users are not restricted only to
22
these War Rooms. They can be invited to others, or join any that are public.
23
22
-Click the **Send** button to send an email invitation, which will prompt them to [sign up](/docs/cloud/manage/sign-in)
23
-and join your Space.
24
+Click the **Send** button to send an email invitation, which will prompt them
25
+to [sign up](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.mdx) and join your Space.
26
25
-
27
+
28
29
Any unaccepted invitations remain under **Invitations awaiting response**. These invitations can be rescinded at any
30
time by clicking the trash can icon.
31
32
## What's next?
33
33
-If your team members have trouble signing in, direct them to the [sign in guide](/docs/cloud/manage/sign-in). Once your
34
-team is onboarded to Netdata Cloud, they can view shared assets, such as [new
35
-dashboards](https://learn.netdata.cloud/docs/cloud/visualize/dashboards).
34
+If your team members have trouble signing in, direct them to
35
+the [sign in guide](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.mdx). Once your
36
+team is onboarded to Netdata Cloud, they can view shared assets, such
37
+as [new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
docs/cloud/manage/sign-in.mdx
+3
-3
@@ -35,7 +35,7 @@ If you don't have a Netdata Cloud account yet you won't need to worry about it.
35
After your account is created and you sign in to Netdata, you first are asked to agree to Netdata Cloud's [Privacy
36
Policy](https://www.netdata.cloud/privacy/) and [Terms of Use](https://www.netdata.cloud/terms/). Once you agree with these you are directed
37
through the Netdata Cloud onboarding process, which is explained in the [Netdata Cloud
38
-quickstart](/docs/cloud/get-started).
38
+quickstart](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
39
40
### Troubleshooting
41
@@ -84,5 +84,5 @@ It is not currently possible to link an account created with `user@example.com`
84
85
## What's next?
86
87
-If you haven't already onboarded to Netdata Cloud and connected your first nodes, visit the [get started
88
-guide](/docs/cloud/get-started).
87
+If you haven't already onboarded to Netdata Cloud and connected your first nodes, visit
88
+the [get started guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
docs/cloud/spaces.md
+11
-6
@@ -1,6 +1,8 @@
1
---
2
title: "Spaces"
3
-description: " Organize your infrastructure monitoring on Netdata Cloud by creating Spaces, then groupingyour Agent-monitored nodes. "
3
+description: >-
4
+ "Organize your infrastructure monitoring on Netdata Cloud by creating Spaces, then groupingyour
5
+ Agent-monitored nodes."
6
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md"
7
sidebar_label: "Spaces"
8
learn_status: "Published"
@@ -27,8 +29,9 @@ The other consideration for the number of Spaces you use to organize your Netdat
29
complexity of your organization.
30
31
For small team and infrastructures we recommend sticking to a single Space so that you can keep all your nodes and their
30
-respective metrics in one place. You can then use multiple [War Rooms](/docs/cloud/war-rooms) to further organize your
31
-infrastructure monitoring.
32
+respective metrics in one place. You can then use
33
+multiple [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
34
+to further organize your infrastructure monitoring.
35
36
Enterprises may want to create multiple Spaces for each of their larger teams, particularly if those teams have
37
different responsibilities or parts of the overall infrastructure to monitor. For example, you might have one SRE team
@@ -57,9 +60,10 @@ will open a side tab in which you can:
60
2. _Edit the War Rooms*_, click on the **War rooms** tab to add or remove War Rooms.
61
62
3. _Connect nodes*_, click on **Nodes** tab. Copy the claiming script to your node and run it. See the
60
- [connect to Cloud doc](/docs/agent/claim) for details.
63
+ [connect to Cloud doc](https://github.com/netdata/netdata/blob/master/claim/README.md) for details.
64
62
-4. _Manage the users*_, click on **Users**. The [invitation doc](/docs/cloud/manage/invite-your-team)
65
+4. _Manage the users*_, click on **Users**.
66
+ The [invitation doc](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md)
67
details the invitation process.
68
69
5. _Manage notification setting*_, click on **Notifications** tab to turn off/on notification methods.
@@ -83,4 +87,5 @@ Netdata admin users now have the ability to remove obsolete nodes from a space.
87
88
## What's next?
89
86
-Once you configured your Spaces, it's time to set up your [War Rooms](/docs/cloud/war-rooms).
90
+Once you configured your Spaces, it's time to set up
91
+your [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md).
docs/cloud/visualize/dashboards.md
+8
-5
@@ -1,6 +1,8 @@
1
---
2
title: "Build new dashboards"
3
-description: "Design new dashboards that target your infrastructure's unique needs and share them with your team for targeted visual anomaly detection or incident response."
3
+description: >-
4
+ "Design new dashboards that target your infrastructure's unique needs and share them with your team for
5
+ targeted visual anomaly detection or incident response."
6
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md"
7
sidebar_label: "Build new dashboards"
8
learn_status: "Published"
@@ -24,7 +26,7 @@ In the modal, give your new dashboard a name, and click **+ Add**.
26
27
Click the **Add Chart** button to add your first chart card. From the dropdown, select either *All Nodes** or a specific
28
node. If you select **All Nodes**, you will add a [composite chart](/docs/cloud/visualize/overview#composite-charts) to
27
-your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
29
+your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
30
31
The **Add Text** button creates a new card with user-defined text, which you can use to describe or document a
32
particular dashboard's meaning and purpose.
@@ -46,8 +48,8 @@ node. If you select **All Nodes**, you will add a [composite chart](/docs/cloud/
48
your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
49
50
The charts you add to any dashboard are fully interactive, just like the charts in an Agent dashboard or a single node's
49
-dashboard in Cloud. Zoom in and out, highlight timeframes, and more. See our [Agent dashboard
50
-docs](https://learn.netdata.cloud/docs/agent/web#using-charts) for all the shortcuts.
51
+dashboard in Cloud. Zoom in and out, highlight timeframes, and more. See our
52
+[Agent dashboard docs](https://learn.netdata.cloud/docs/agent/web#using-charts) for all the shortcuts.
53
54
Charts also synchronize as you interact with them, even across contexts _or_ nodes.
55
@@ -114,6 +116,7 @@ Because of the visual complexity of individual charts, dashboards require a mini
116
117
## What's next?
118
117
-Once you've designed a dashboard or two, make sure to [invite your team](/docs/cloud/manage/invite-your-team) if
119
+Once you've designed a dashboard or two, make sure
120
+to [invite your team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md) if
121
you haven't already. You can add these new users to the same War Room to let them see the same dashboards without any
122
effort.
docs/cloud/visualize/interact-new-charts.md
+101
-64
@@ -1,6 +1,8 @@
1
---
2
title: "Interact with charts"
3
-description: "Learn how to get the most out of Netdata's charts. These charts will help you make sense of all the metrics at your disposal, helping you troubleshoot with real-time, per-second metric data"
3
+description: >-
4
+ "Learn how to get the most out of Netdata's charts. These charts will help you make sense of all the
5
+ metrics at your disposal, helping you troubleshoot with real-time, per-second metric data"
6
type: "how-to"
7
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md"
8
sidebar_label: "Interact with charts"
@@ -10,65 +12,85 @@ learn_rel_path: "Operations/Visualizations"
12
---
13
14
> ⚠️ This new version of charts is currently **only** available on Netdata Cloud. We didn't want to keep this valuable
13
-> feature from you, so after we get this into your hands on the Cloud, we will collect and implement your feedback. Together, we will be able to provide the best possible version of charts on the Netdata Agent dashboard, as quickly as possible.
15
+> feature from you, so after we get this into your hands on the Cloud, we will collect and implement your feedback.
16
+> Together, we will be able to provide the best possible version of charts on the Netdata Agent dashboard, as quickly as
17
+> possible.
18
15
-Netdata excels in collecting, storing, and organizing metrics in out-of-the-box dashboards.
16
-To make sense of all the metrics, Netdata offers an enhanced version of charts that update every second.
19
+Netdata excels in collecting, storing, and organizing metrics in out-of-the-box dashboards.
20
+To make sense of all the metrics, Netdata offers an enhanced version of charts that update every second.
21
22
These charts provide a lot of useful information, so that you can:
23
20
-- Enjoy the high-resolution, granular metrics collected by Netdata
21
-- Explore visualization with more options such as _line_, _stacked_ and _area_ types (other types like _bar_, _pie_ and _gauges_ are to be added shortly)
22
-- Examine all the metrics by hovering over them with your cursor
23
-- Use intuitive tooling and shortcuts to pan, zoom or highlight your charts
24
-- On highlight, ease access to [Metric Correlations](/docs/cloud/insights/metric-correlations) to see other metrics with similar patterns
25
-- Have the dimensions sorted based on name or value
26
-- View information about the chart, its plugin, context, and type
27
-- Get the chart status and possible errors. On top, reload functionality
28
-
29
-These charts will available on [Overview tab](/docs/cloud/visualize/overview), Single Node view and on your [Custom Dashboards](/docs/cloud/visualize/dashboards).
24
+- Enjoy the high-resolution, granular metrics collected by Netdata
25
+- Explore visualization with more options such as _line_, _stacked_ and _area_ types (other types like _bar_, _pie_ and
26
+ _gauges_ are to be added shortly)
27
+- Examine all the metrics by hovering over them with your cursor
28
+- Use intuitive tooling and shortcuts to pan, zoom or highlight your charts
29
+- On highlight, ease access
30
+ to [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to
31
+ see other metrics with similar patterns
32
+- Have the dimensions sorted based on name or value
33
+- View information about the chart, its plugin, context, and type
34
+- Get the chart status and possible errors. On top, reload functionality
35
+
36
+These charts will available
37
+on [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), Single Node view and
38
+on your [Custom Dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
39
40
## Overview
41
33
-Have a look at the can see the overall look and feel of the charts for both with a composite chart from the [Overview tab](/docs/cloud/visualize/overview) and a simple chart from the single node view:
42
+Have a look at the can see the overall look and feel of the charts for both with a composite chart from
43
+the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) and a simple chart
44
+from the single node view:
45
46
47
48
With a quick glance you have immediate information available at your disposal:
49
39
-- Chart title and units
40
-- Action bars
41
-- Chart area
42
-- Legend with dimensions
50
+- Chart title and units
51
+- Action bars
52
+- Chart area
53
+- Legend with dimensions
54
55
## Play, Pause and Reset
56
46
-Your charts are controlled using the available [Time controls](/docs/dashboard/visualization-date-and-time-controls#time-controls). Besides these, when interacting with the chart you can also activate these controls by:
57
+Your charts are controlled using the
58
+available [Time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx#time-controls).
59
+Besides these, when interacting with the chart you can also activate these controls by:
60
48
-- hovering over any chart to temporarily pause it - this momentarily switches time control to Pause, so that you can hover over a specific timeframe. When moving out of the chart time control will go back to Play (if it was it's previous state)
49
-- clicking on the chart to lock it - this enables the Pause option on the time controls, to the current timeframe. This is if you want to jump to a different chart to look for possible correlations.
50
-- double clicking to release a previously locked chart - move the time control back to Play
61
+- hovering over any chart to temporarily pause it - this momentarily switches time control to Pause, so that you can
62
+ hover over a specific timeframe. When moving out of the chart time control will go back to Play (if it was it's
63
+ previous state)
64
+- clicking on the chart to lock it - this enables the Pause option on the time controls, to the current timeframe. This
65
+ is if you want to jump to a different chart to look for possible correlations.
66
+- double clicking to release a previously locked chart - move the time control back to Play
67
52
- 
68
+ 
69
70
| Interaction | Keyboard/mouse | Touchpad/touchscreen | Time control |
55
-| :---------------- | :------------- | :------------------- | :-------------------- |
71
+|:------------------|:---------------|:---------------------|:----------------------|
72
| **Pause** a chart | `hover` | `n/a` | Temporarily **Pause** |
73
| **Stop** a chart | `click` | `tap` | **Pause** |
74
| **Reset** a chart | `double click` | `n/a` | **Play** |
75
60
-Note: These interactions are available when the default "Pan" action is used. Other actions are accessible via the [Exploration action bar](#exploration-action-bar).
76
+Note: These interactions are available when the default "Pan" action is used. Other actions are accessible via
77
+the [Exploration action bar](#exploration-action-bar).
78
79
## Title and chart action bar
80
64
-When you start interacting with a chart, you'll notice valuable information on the top bar. You will see information from the chart title to a chart action bar.
81
+When you start interacting with a chart, you'll notice valuable information on the top bar. You will see information
82
+from the chart title to a chart action bar.
83
84
The elements that you can find on this top bar are:
85
68
-- Netdata icon: this indicates that data is continuously being updated, this happens if [Time controls](/docs/dashboard/visualization-date-and-time-controls#time-controls) are in Play or Force Play mode
69
-- Chart status icon: indicates the status of the chart. Possible values are: Loading, Timeout, Error or No data
70
-- Chart title: on the chart title you can see the title together with the metric being displayed, as well as the unit of measurement
71
-- Chart action bar: here you'll have access to chart info, change chart types, enables fullscreen mode, and the ability to add the chart to a custom dashboard
86
+- Netdata icon: this indicates that data is continuously being updated, this happens
87
+ if [Time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx#time-controls)
88
+ are in Play or Force Play mode
89
+- Chart status icon: indicates the status of the chart. Possible values are: Loading, Timeout, Error or No data
90
+- Chart title: on the chart title you can see the title together with the metric being displayed, as well as the unit of
91
+ measurement
92
+- Chart action bar: here you'll have access to chart info, change chart types, enables fullscreen mode, and the ability
93
+ to add the chart to a custom dashboard
94
95
96
@@ -76,48 +98,58 @@ The elements that you can find on this top bar are:
98
99
On this bar you have access to immediate actions over the chart, the available actions are:
100
79
-- Chart info: you will be able to get more information relevant to the chart you are interacting with
80
-- Chart type: change the chart type from _line_, _stacked_ or _area_
81
-- Enter fullscreen mode: allows you expand the current chart to the full size of your screen
82
-- Add chart to dashboard: This allows you to add the chart to an existing custom dashboard or directly create a new one that includes the chart.
101
+- Chart info: you will be able to get more information relevant to the chart you are interacting with
102
+- Chart type: change the chart type from _line_, _stacked_ or _area_
103
+- Enter fullscreen mode: allows you expand the current chart to the full size of your screen
104
+- Add chart to dashboard: This allows you to add the chart to an existing custom dashboard or directly create a new one
105
+ that includes the chart.
106
107
<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/65ac4fc8-3d8d-4617-8234-dbb9b31b4264" width="40%" height="40%" />
108
109
## Exploration action bar
110
88
-When exploring the chart you will see a second action bar. This action bar is there to support you on this task. The available actions that you can see are:
111
+When exploring the chart you will see a second action bar. This action bar is there to support you on this task. The
112
+available actions that you can see are:
113
90
-- Pan
91
-- Highlight
92
-- Horizontal and Vertical zooms
93
-- In-context zoom in and out
114
+- Pan
115
+- Highlight
116
+- Horizontal and Vertical zooms
117
+- In-context zoom in and out
118
119
<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/0417ad66-fcf6-42d5-9a24-e9392ec51f87" width="40%" height="40%" />
120
121
### Pan
122
99
-Drag your mouse/finger to the right to pan backward through time, or drag to the left to pan forward in time. Think of it like pushing the current timeframe off the screen to see what came before or after.
123
+Drag your mouse/finger to the right to pan backward through time, or drag to the left to pan forward in time. Think of
124
+it like pushing the current timeframe off the screen to see what came before or after.
125
126
| Interaction | Keyboard | Mouse | Touchpad/touchscreen |
102
-| :---------- | :------- | :------------- | :------------------- |
127
+|:------------|:---------|:---------------|:---------------------|
128
| **Pan** | `n/a` | `click + drag` | `touch drag` |
129
130
### Highlight
131
107
-Selecting timeframes is useful when you see an interesting spike or change in a chart and want to investigate further, from looking at the same period of time on other charts/sections or triggering actions to help you troubleshoot with an in-context action bar to help you troubleshoot (currently only available on
108
- Single Node view). The available actions:
132
+Selecting timeframes is useful when you see an interesting spike or change in a chart and want to investigate further,
133
+from looking at the same period of time on other charts/sections or triggering actions to help you troubleshoot with an
134
+in-context action bar to help you troubleshoot (currently only available on
135
+Single Node view). The available actions:
136
+
137
+-
138
+
139
+run [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
140
110
-- run [Metric Correlations](/docs/cloud/insights/metric-correlations)
111
-- zoom in on the selected timeframe
141
+- zoom in on the selected timeframe
142
113
-[Metric Correlations](/docs/cloud/insights/metric-correlations) will only be available if you respect the timeframe selection limitations. The selected duration pill together with the button state helps visualize this.
143
+[Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
144
+will only be available if you respect the timeframe selection limitations. The selected duration pill together with the
145
+button state helps visualize this.
146
147
<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/2ffc157d-0f0f-402e-80bb-5ffa8a2091d5" width="50%" height="50%" />
148
149
<p/>
150
151
| Interaction | Keyboard/mouse | Touchpad/touchscreen |
120
-| :--------------------------------- | :------------------------------------------------------- | :------------------- |
152
+|:-----------------------------------|:---------------------------------------------------------|:---------------------|
153
| **Highlight** a specific timeframe | `Alt + mouse selection` or `⌘ + mouse selection` (macOS) | `n/a` |
154
155
### Zoom
@@ -127,13 +159,14 @@ of an anomaly or outage. Zooming out lets you see metrics within the larger cont
159
week, which is useful in understanding what "normal" looks like, or to identify long-term trends, like a slow creep in
160
memory usage.
161
130
-The actions above are _normal_ vertical zoom actions. We also provide an horizontal zoom action that helps you focus on a
162
+The actions above are _normal_ vertical zoom actions. We also provide an horizontal zoom action that helps you focus on
163
+a
164
specific Y-axis area to further investigate a spike or dive on your charts.
165
166
167
168
| Interaction | Keyboard/mouse | Touchpad/touchscreen |
136
-| :----------------------------------------- | :----------------------------------- | :--------------------------------------------------- |
169
+|:-------------------------------------------|:-------------------------------------|:-----------------------------------------------------|
170
| **Zoom** in or out | `Shift + mouse scrollwheel` | `two-finger pinch` <br />`Shift + two-finger scroll` |
171
| **Zoom** to a specific timeframe | `Shift + mouse vertical selection` | `n/a` |
172
| **Horizontal Zoom** a specific Y-axis area | `Shift + mouse horizontal selection` | `n/a` |
@@ -146,8 +179,8 @@ You also have two direct action buttons on the exploration action bar for in-con
179
180
The bottom legend of the chart where you can see the dimensions of the chart can now be ordered by:
181
149
-- Dimension name (Ascending or Descending)
150
-- Dimension value (Ascending or Descending)
182
+- Dimension name (Ascending or Descending)
183
+- Dimension value (Ascending or Descending)
184
185
<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/d3031c35-37bc-46c1-bcf9-be29dea0b476" width="50%" height="50%" />
186
@@ -157,29 +190,33 @@ Hiding dimensions simplifies the chart and can help you better discover exactly
190
behaving strangely.
191
192
| Interaction | Keyboard/mouse | Touchpad/touchscreen |
160
-| :------------------------------------- | :-------------- | :------------------- |
193
+|:---------------------------------------|:----------------|:---------------------|
194
| **Show one** dimension and hide others | `click` | `tap` |
195
| **Toggle (show/hide)** one dimension | `Shift + click` | `n/a` |
196
197
### Resize
198
166
-To resize the chart, click-and-drag the icon on the bottom-right corner of any chart. To restore the chart to its original height,
199
+To resize the chart, click-and-drag the icon on the bottom-right corner of any chart. To restore the chart to its
200
+original height,
201
double-click the same icon.
202
203
204
205
## What's next?
206
173
-We recommend you read up on the differences between [chart dimensions, contexts, and
174
-families](/docs/dashboard/dimensions-contexts-families) to strengthen your understanding of how Netdata organizes its
175
-dashboards. Another valuable way to interact with charts is to use the [date and time controls](/docs/dashboard/visualization-date-and-time-controls), which helps you visualize specific moments of historical metrics.
207
+We recommend you read up on the differences
208
+between [chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
209
+to strengthen your understanding of how Netdata organizes its dashboards. Another valuable way to interact with charts
210
+is to use
211
+the [date and time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx),
212
+which helps you visualize specific moments of historical metrics.
213
214
### Further reading & related information
215
179
-- Dashboard
180
- - [How the dashboard works](/docs/dashboard/how-dashboard-works)
181
- - [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families)
182
- - [Date and Time controls](/docs/dashboard/visualization-date-and-time-controls)
183
- - [Customize the standard dashboard](/docs/dashboard/customize)
184
- - [Metric Correlations](/docs/cloud/insights/metric-correlations)
185
- - [Netdata Agent - Interact with charts](/docs/dashboard/interact-charts)
216
+- Dashboard
217
+ - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)
218
+ - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
219
+ - [Date and Time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx)
220
+ - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)
221
+ - [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
222
+ - [Netdata Agent - Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
docs/cloud/visualize/nodes.md
+7
-7
@@ -19,12 +19,12 @@ single row, first featuring that node's alarm status (yellow for warnings, red f
19
system, some essential information about the node, followed by columns of user-defined key metrics represented in
20
real-time charts.
21
22
-Use the [Overview](/docs/cloud/visualize/overview) for monitoring an infrastructure in real time using
22
+Use the [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) for monitoring an infrastructure in real time using
23
composite charts and Netdata's familiar dashboard UI.
24
25
-Check the [War Room docs](/docs/cloud/war-rooms) for details on the utility bar, which contains the [node
26
-filter](/docs/cloud/war-rooms#node-filter) and the [timeframe
27
-selector](/docs/cloud/war-rooms#play-pause-force-play-and-timeframe-selector).
25
+Check the [War Room docs](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md) for details on the utility bar, which contains the [node
26
+filter](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md#node-filter) and the [timeframe
27
+selector](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md#play-pause-force-play-and-timeframe-selector).
28
29
## Add and customize metrics columns
30
@@ -39,15 +39,15 @@ These customizations appear for anyone else with access to that War Room.
39
## See more metrics in Netdata Cloud
40
41
If you want to add more metrics to your War Rooms and they don't show up when you add new metrics to Nodes, you likely
42
-need to configure those nodes to collect from additional data sources. See our [collectors doc](/docs/collect/enable-configure)
42
+need to configure those nodes to collect from additional data sources. See our [collectors doc](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
43
to learn how to use dozens of pre-installed collectors that can instantly collect from your favorite services and applications.
44
45
If you want to see up to 30 days of historical metrics in Cloud (and more on individual node dashboards), read our guide
46
-on [long-term storage of historical metrics](/guides/longer-metrics-storage). Also, see our
46
+on [long-term storage of historical metrics](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md). Also, see our
47
[calculator](/docs/store/change-metrics-storage#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
48
for finding the disk and RAM you need to store metrics for a certain period of time.
49
50
## What's next?
51
52
Now that you know how to view your nodes at a glance, learn how to [track active
53
-alarms](/docs/cloud/alerts-notifications/view-active-alerts) with the Alerts Smartboard.
53
+alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx) with the Alerts Smartboard.
docs/cloud/visualize/overview.md
+78
-48
@@ -1,6 +1,8 @@
1
---
2
title: "Home, Overview and Single Node view"
3
-description: "The Home tab automatically presents relevant information of your War Room, the Overview uses composite charts from all the nodes in a given War Room and Single Node view provides a look at a specific Node"
3
+description: >-
4
+ "The Home tab automatically presents relevant information of your War Room, the Overview uses composite
5
+ charts from all the nodes in a given War Room and Single Node view provides a look at a specific Node"
6
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md"
7
sidebar_label: "Home, Overview and Single Node view"
8
learn_status: "Published"
@@ -12,13 +14,14 @@ learn_rel_path: "Operations/Visualizations"
14
15
The Home tab provides a predefined dashboard of relevant information about entities in the War Room.
16
15
-This tab will
16
-automatically present summarized information in an easily digestible display. You can see information about your
17
+This tab will
18
+automatically present summarized information in an easily digestible display. You can see information about your
19
nodes, data collection and retention stats, alerts, users and dashboards.
20
21
## Overview
22
21
-The Overview tab is another great way to monitor infrastructure using Netdata Cloud. While the interface might look similar to local
23
+The Overview tab is another great way to monitor infrastructure using Netdata Cloud. While the interface might look
24
+similar to local
25
dashboards served by an Agent Overview uses **composite charts**.
26
These charts display real-time aggregated metrics from all the nodes (or a filtered selection) in a given War Room.
27
@@ -27,12 +30,16 @@ anomalies, then drill down by grouping metrics by node and jumping to single-nod
30
31
## Single Node view
32
30
-The Single Node view dashboard engine is the same as the Overview, meaning that it also uses **composite charts**, and displays real-time aggregated metrics from a specific node.
33
+The Single Node view dashboard engine is the same as the Overview, meaning that it also uses **composite charts**, and
34
+displays real-time aggregated metrics from a specific node.
35
32
-As mentioned above, the interface is similar to local dashboards served by an Agent but this dashboard also uses **composite charts** which, in the case of a single node, will aggregate
33
-multiple chart _instances_ belonging to a context into a single chart. For example, on `disk.io` context it will get into a single chart an aggregated view of each disk the node has.
36
+As mentioned above, the interface is similar to local dashboards served by an Agent but this dashboard also uses *
37
+*composite charts** which, in the case of a single node, will aggregate
38
+multiple chart _instances_ belonging to a context into a single chart. For example, on `disk.io` context it will get
39
+into a single chart an aggregated view of each disk the node has.
40
35
-Further tools provided in composite chart [definiton bar](/docs/cloud/visualize/overview#definition-bar) will allow you to explore in more detail what is happening on each _instance_.
41
+Further tools provided in composite chart [definiton bar](/docs/cloud/visualize/overview#definition-bar) will allow you
42
+to explore in more detail what is happening on each _instance_.
43
44
## Before you get started
45
@@ -40,7 +47,8 @@ Only nodes with v1.25.0-127 or later of the the [open-source Netdata](https://gi
47
agent can contribute to composite charts. If your node(s) use an earlier version of Netdata, you will see them marked as
48
**needs upgrade** in various dropdowns.
49
43
-See our [update docs](/docs/agent/packaging/installer/update) for the preferred update method based on how you installed
50
+See our [update docs](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md) for the preferred
51
+update method based on how you installed
52
Netdata.
53
54
## Composite charts
@@ -51,52 +59,64 @@ Room.
59
## Definition bar
60
61
Each composite chart has a definition bar to provide information about the following:
62
+
63
* Grouping option
64
* Aggregate function to be applied in case multiple data sources exist
65
* Instances
66
* Nodes
58
-* Dimensions, and
67
+* Dimensions, and
68
* Aggregate function over time to be applied if one point in the chart consists of multiple data points aggregated
69
70
### Group by dimension, node, or chart
71
72
Click on the **dimension** dropdown to change how a composite chart groups metrics.
73
65
-The default option is by _dimension_, so that each line/area in the visualization is the aggregation of a single dimension.
66
-This provides a per dimension view of the data from all the nodes in the War Room, taking into account filtering criteria if defined.
74
+The default option is by _dimension_, so that each line/area in the visualization is the aggregation of a single
75
+dimension.
76
+This provides a per dimension view of the data from all the nodes in the War Room, taking into account filtering
77
+criteria if defined.
78
68
-A composite chart grouped by _node_ visualizes a single metric across contributing nodes. If the composite chart has five
69
-contributing nodes, there will be five lines/areas. This is typically an absolute value of the sum of the dimensions over each node but there
79
+A composite chart grouped by _node_ visualizes a single metric across contributing nodes. If the composite chart has
80
+five
81
+contributing nodes, there will be five lines/areas. This is typically an absolute value of the sum of the dimensions
82
+over each node but there
83
are some opinionated-but-valuable exceptions where a specific dimension is selected.
71
-Grouping by nodes allows you to quickly understand which nodes in your infrastructure are experiencing anomalous behavior.
84
+Grouping by nodes allows you to quickly understand which nodes in your infrastructure are experiencing anomalous
85
+behavior.
86
73
-A composite chart grouped by _instance_ visualizes each instance of one software or hardware on a node and displays these as a separate dimension. By grouping the
74
-`disk.io` chart by _instance_, you can visualize the activity of each disk on each node that contributes to the composite
87
+A composite chart grouped by _instance_ visualizes each instance of one software or hardware on a node and displays
88
+these as a separate dimension. By grouping the
89
+`disk.io` chart by _instance_, you can visualize the activity of each disk on each node that contributes to the
90
+composite
91
chart.
92
77
-Another very pertinent example is composite charts over contexts related to cgroups (VMs and containers). You have the means to change the default group by or apply filtering to
78
-get a better view into what data your are trying to analyze. For example, if you change the group by to _instance_ you get a view with the data of all the instances (cgroups) that
79
-contribute to that chart. Then you can use further filtering tools to focus the data that is important to you and even save the result to your own dashboards.
93
+Another very pertinent example is composite charts over contexts related to cgroups (VMs and containers). You have the
94
+means to change the default group by or apply filtering to
95
+get a better view into what data your are trying to analyze. For example, if you change the group by to _instance_ you
96
+get a view with the data of all the instances (cgroups) that
97
+contribute to that chart. Then you can use further filtering tools to focus the data that is important to you and even
98
+save the result to your own dashboards.
99
100
101
102
### Aggregate functions over data sources
103
85
-Each chart uses an opinionated-but-valuable default aggregate function over the data sources. For example, the `system.cpu` chart shows the
104
+Each chart uses an opinionated-but-valuable default aggregate function over the data sources. For example,
105
+the `system.cpu` chart shows the
106
average for each dimension from every contributing chart, while the `net.net` chart shows the sum for each dimension
107
from every contributing chart, which can also come from multiple networking interfaces.
108
109
The following aggregate functions are available for each selected dimension:
110
91
-- **Average**: Displays the average value from contributing nodes. If a composite chart has 5 nodes with the following
92
- values for the `out` dimension—`-2.1`, `-5.5`, `-10.2`, `-15`, `-0.1`—the composite chart displays a
93
- value of `−6.58`.
94
-- **Sum**: Displays the sum of contributed values. Using the same nodes, dimension, and values as above, the composite
95
- chart displays a metric value of `-32.9`.
96
-- **Min**: Displays a minimum value. For dimensions with positive values, the min is the value closest to zero. For
97
- charts with negative values, the min is the value with the largest magnitude.
98
-- **Max**: Displays a maximum value. For dimensions with positive values, the max is the value with the largest
99
- magnitude. For charts with negative values, the max is the value closet to zero.
111
+- **Average**: Displays the average value from contributing nodes. If a composite chart has 5 nodes with the following
112
+ values for the `out` dimension—`-2.1`, `-5.5`, `-10.2`, `-15`, `-0.1`—the composite chart displays a
113
+ value of `−6.58`.
114
+- **Sum**: Displays the sum of contributed values. Using the same nodes, dimension, and values as above, the composite
115
+ chart displays a metric value of `-32.9`.
116
+- **Min**: Displays a minimum value. For dimensions with positive values, the min is the value closest to zero. For
117
+ charts with negative values, the min is the value with the largest magnitude.
118
+- **Max**: Displays a maximum value. For dimensions with positive values, the max is the value with the largest
119
+ magnitude. For charts with negative values, the max is the value closet to zero.
120
121
### Dimensions
122
@@ -105,13 +125,15 @@ number of dimensions available on that context.
125
126
### Instances
127
108
-Click on **X Instances** to display a dropdown of instances and nodes contributing to that composite chart. Each line in the
128
+Click on **X Instances** to display a dropdown of instances and nodes contributing to that composite chart. Each line in
129
+the
130
dropdown displays an instance name and the associated node's hostname.
131
132
### Nodes
133
134
Click on **X Nodes** to display a dropdown of nodes contributing to that composite chart. Each line displays a hostname
114
-to help you identify which nodes contribute to a chart. You can also use this component to filter nodes directly on the chart.
135
+to help you identify which nodes contribute to a chart. You can also use this component to filter nodes directly on the
136
+chart.
137
138
If one or more nodes can't contribute to a given chart, the definition bar shows a warning symbol plus the number of
139
affected nodes, then lists them in the dropdown along with the associated error. Nodes might return errors because of
@@ -119,8 +141,10 @@ networking issues, a stopped `netdata` service, or because that node does not ha
141
142
### Aggregate functions over time
143
122
-When the granularity of the data collected is higher than the plotted points on the chart an aggregation function over time
123
-is applied. By default the aggregation applied is _average_ but the user can choose different options from the following:
144
+When the granularity of the data collected is higher than the plotted points on the chart an aggregation function over
145
+time
146
+is applied. By default the aggregation applied is _average_ but the user can choose different options from the
147
+following:
148
149
* Min
150
* Max
@@ -138,13 +162,15 @@ is applied. By default the aggregation applied is _average_ but the user can cho
162
163
:::info
164
141
-- `*` For **Trimmed Median and Mean** you can choose the percentage of data tha you want to focus on: 1%, 2%, 3%, 5%, 10%, 15%, 20% and 25%.
142
-- `**` For **Percentile** you can specify the percentile you want to focus on: 25th, 50th, 75th, 80th, 90th, 95th, 97th, 98th and 99th.
165
+- `*` For **Trimmed Median and Mean** you can choose the percentage of data tha you want to focus on: 1%, 2%, 3%, 5%,
166
+ 10%, 15%, 20% and 25%.
167
+- `**` For **Percentile** you can specify the percentile you want to focus on: 25th, 50th, 75th, 80th, 90th, 95th, 97th,
168
+ 98th and 99th.
169
170
:::
171
146
-
147
-For more details on each, you can refer to our Agent's HTTP API details on [Data Queries - Data Grouping](/docs/agent/web/api/queries#data-grouping).
172
+For more details on each, you can refer to our Agent's HTTP API details
173
+on [Data Queries - Data Grouping](/docs/agent/web/api/queries#data-grouping).
174
175
### Reset to defaults
176
@@ -164,7 +190,8 @@ src="https://user-images.githubusercontent.com/1153921/95762109-1d219300-0c62-11
190
node you're interested in.
191
192
The single-node dashboard opens in a new tab. From there, you can continue to troubleshoot or run [Metric
167
-Correlations](/docs/cloud/insights/metric-correlations) for faster root cause analysis.
193
+Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) for faster root
194
+cause analysis.
195
196
## Add composite charts to a dashboard
197
@@ -175,8 +202,9 @@ entering the name and clicking **New Dashboard**.
202
## Interacting with composite charts: pan, zoom, and resize
203
204
You can interact with composite charts as you would with other Netdata charts. You can use the controls beneath each
178
-chart to pan, zoom, or resize the chart, or use various combinations of the keyboard and mouse. See the [chart
179
-interaction doc](/docs/dashboard/interact-charts) for details.
205
+chart to pan, zoom, or resize the chart, or use various combinations of the keyboard and mouse. See
206
+the [chart interaction doc](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx) for
207
+details.
208
209
## Menu
210
@@ -191,7 +219,8 @@ One difference between the Overview's menu and those found in single-node dashbo
219
the Overview condenses multiple services, families, or instances into single sections, sub-menus, and associated charts.
220
221
For services, let's say you have two concurrent jobs with the [web_log
194
-collector](/docs/agent/collectors/go.d.plugin/modules/weblog), one for Apache and another for Nginx. A single-node or
222
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md), one for Apache and another for
223
+Nginx. A single-node or
224
local dashboard shows two section, **web_log apache** and **web_log nginx**, whereas the Overview condenses these into a
225
single **web_log** section containing composite charts from both jobs.
226
@@ -201,7 +230,7 @@ chart. The utility bar should show that there are 8 charts from 2 nodes contribu
230
231
This action applies to disks, network devices, and other metric types that involve multiple instances of a piece of
232
hardware or software. The Overview currently does not display metrics from filesystems. Read more about [families and
204
-instances](/docs/dashboard/dimensions-contexts-families)
233
+instances](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
234
235
## Persistence of composite chart settings
236
@@ -211,10 +240,11 @@ colleagues by having them copy-paste it into their browser.
240
241
## What's next?
242
214
-For another way to view an infrastructure from a high level, see the [Nodes view](/docs/cloud/visualize/nodes).
243
+For another way to view an infrastructure from a high level, see
244
+the [Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md).
245
216
-If you need a refresher on how Netdata's charts work, see our doc on [interacting with
217
-charts](/docs/dashboard/interact-charts).
246
+If you need a refresher on how Netdata's charts work, see our doc
247
+on [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx).
248
219
-Or, get more granular with configuring how you monitor your infrastructure by [building new
220
-dashboards](/docs/cloud/visualize/dashboards).
249
+Or, get more granular with configuring how you monitor your infrastructure
250
+by [building new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
docs/cloud/war-rooms.md
+44
-29
@@ -1,6 +1,8 @@
1
---
2
title: "War Rooms"
3
-description: " Netdata Cloud uses War Rooms to group related nodes and create insightful compositedashboards based on their aggregate health and performance."
3
+description: >-
4
+ "Netdata Cloud uses War Rooms to group related nodes and create insightful compositedashboards based on
5
+ their aggregate health and performance."
6
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md"
7
sidebar_label: "War Rooms"
8
learn_status: "Published"
@@ -24,30 +26,41 @@ your nodes into more War Rooms. Every War Room has its own dashboards, navigatio
26
Every War Rooms provides multiple views. Each view focus on a particular area/subject of the nodes which you monitor in
27
this War Rooms. Let's explore what view you have available:
28
27
-- The default view for any War Room is the [Home tab](/docs/cloud/visualize/overview#home), which give you an overview
29
+- The default view for any War Room is
30
+ the [Home tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#home), which give you
31
+ an overview
32
of this space. Here you can see the number of Nodes claimed, data retention statics, user particate, alerts and more
33
30
-- The second and most important view is the [Overview tab](/docs/cloud/visualize/overview#overview) which uses composite
34
+- The second and most important view is
35
+ the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#overview) which
36
+ uses composite
37
charts to display real-time metrics from every available node in a given War Room.
38
33
-- The [Nodes tab](/docs/cloud/visualize/nodes) gives you the ability to see the status (offline or online), host details
39
+- The [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) gives you the ability to
40
+ see the status (offline or online), host details
41
, alarm status and also a short overview of some key metrics from all your nodes at a glance.
42
36
-- [Kubernetes tab](/docs/cloud/visualize/kubernetes) is a logical grouping of charts regards to your Kubernetes clusters.
43
+- [Kubernetes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) is a logical
44
+ grouping of charts regards to your Kubernetes clusters.
45
It contains a subset of the charts available in the _Overview tab_
46
39
-- The [Dashboards tab](/docs/cloud/visualize/dashboards) gives you the ability to have tailored made views of
40
- specific/targeted interfaces for your infrastructure using any number of charts from any number of nodes.
47
+-
48
+
49
+The [Dashboards tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)
50
+gives you the ability to have tailored made views of
51
+specific/targeted interfaces for your infrastructure using any number of charts from any number of nodes.
52
53
- The **Alerts tab** provides you with an overview for all the active alerts you receive for the nodes in this War Room,
54
you can also see alla the alerts that are configured to be triggered in any given moment.
55
45
-- The **Anomalies tab** is dedicated to the [Anomaly Advisor](/docs/cloud/insights/anomaly-advisor) tool
56
+- The **Anomalies tab** is dedicated to
57
+ the [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx) tool
58
59
### Non static tabs
60
49
-If you open a [new dashboard](/docs/cloud/visualize/dashboards), jump to a single-node dashboard, or navigate to a dedicated
50
-alert page they will open in a new War Room tab.
61
+If you open
62
+a [new dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md),
63
+jump to a single-node dashboard, or navigate to a dedicated alert page they will open in a new War Room tab.
64
65
Tabs can be rearranged with drag-and-drop or closed with the **X** button. Open tabs persist between sessions, so you
66
can always come right back to your preferred setup.
@@ -55,7 +68,9 @@ can always come right back to your preferred setup.
68
### Play, pause, force play, and timeframe selector
69
70
A War Room has three different states: playing, paused, and force playing. The default playing state refreshes charts
58
-every second as long as the browser tab is in focus. [Interacting with a chart](/docs/dashboard/interact-charts) pauses
71
+every second as long as the browser tab is in
72
+focus. [Interacting with a chart](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
73
+pauses
74
the War Room. Once the tab loses focus, charts pause automatically.
75
76
The top navigation bar features a play/pause button to quickly change the state, and a dropdown to select **Force Play**
@@ -72,7 +87,6 @@ node. Click **Clear** to remove any changes and apply the default 15-minute time
87
88
The fields beneath the calendar display the beginning and ending timestamps your selected timeframe.
89
75
-
90
### Node filter
91
92
The node filter allows you to quickly filter the nodes visualized in a War Room's views. It appears on all views, but
@@ -80,7 +94,6 @@ not on single-node dashboards.
94
95
96
83
-
97
## War Room organization
98
99
We recommend a few strategies for organizing your War Rooms.
@@ -97,10 +110,10 @@ health and performance of your organization's essential services.
110
111
**Incident response**: You can also create new War Rooms as one of the first steps in your incident response process.
112
For example, you have a user-facing web app that relies on Apache Pulsar for a message queue, and one of your nodes
100
-using the [Pulsar collector](/docs/agent/collectors/go.d.plugin/modules/pulsar) begins reporting a suspiciously low
101
-messages rate. You can create a War Room called `$year-$month-$day-pulsar-rate`, add all your Pulsar nodes in addition
102
-to nodes they connect to, and begin diagnosing the root cause in a War Room optimized for getting to resolution as fast
103
-as possible.
113
+using the [Pulsar collector](https://github.com/netdata/go.d.plugin/blob/master/modules/pulsar/README.md) begins
114
+reporting a suspiciously low messages rate. You can create a War Room called `$year-$month-$day-pulsar-rate`, add all
115
+your Pulsar nodes in addition to nodes they connect to, and begin diagnosing the root cause in a War Room optimized for
116
+getting to resolution as fast as possible.
117
118
## Add War Rooms
119
@@ -114,34 +127,36 @@ can join public War Rooms, but can only join private War Rooms with an invitatio
127
128
All the users and nodes involved in a particular space can potential be part of a War Room.
129
117
-Any user can change simple settings of a War room, like the name or the users participating in it. Click on the gear
130
+Any user can change simple settings of a War room, like the name or the users participating in it. Click on the gear
131
icon of the War Room's name in the top of the page to do that. A sidebar will open with options for this War Room:
132
133
1. To _change a War Room's name, description, or public/private status_, click on **War Room** tab of the sidebar.
134
122
-2. To _include an existing node_ to a War Room or _connect a new node*_ click on **Nodes** tab of the sidebar. Choose any
123
-connected node you want to add to this War Room by clicking on the checkbox next to its hostname, then click **+ Add**
124
-at the top of the panel.
135
+2. To _include an existing node_ to a War Room or _connect a new node*_ click on **Nodes** tab of the sidebar. Choose
136
+ any
137
+ connected node you want to add to this War Room by clicking on the checkbox next to its hostname, then click **+ Add
138
+ **
139
+ at the top of the panel.
140
126
-3. To _add existing users to a War Room_, click on **Add Users**. See our [invite doc](/docs/cloud/manage/invite-your-team)
127
-for details on inviting new users to your Space in Netdata Cloud.
141
+3. To _add existing users to a War Room_, click on **Add Users**. See
142
+ our [invite doc](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md)
143
+ for details on inviting new users to your Space in Netdata Cloud.
144
145
:::note
130
- \* This action requires admin rights for this space
146
+\* This action requires admin rights for this space
147
:::
148
149
### More actions
150
151
To _view or remove nodes_ in a War Room, click on **Nodes view**. To remove a node from the current War Room, click on
136
-the **🗑** icon.
152
+the **🗑** icon.
153
154
:::info
139
- Removing a node from a War Room does not remove it from your Space.
155
+Removing a node from a War Room does not remove it from your Space.
156
:::
157
142
-
143
-
158
## What's next?
159
160
Once you've figured out an organizational structure that works for your team, learn more about how you can use Netdata
147
-Cloud to monitor distributed nodes using [real-time composite charts](/docs/cloud/visualize/overview).
161
+Cloud to monitor distributed nodes
162
+using [real-time composite charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md).
docs/collect/application-metrics.md
+18
-18
@@ -15,7 +15,7 @@ web servers, databases, message brokers, email servers, search platforms, and mu
15
pre-installed with every Netdata Agent and usually require zero configuration. Netdata also collects and visualizes
16
resource utilization per application on Linux systems using `apps.plugin`.
17
18
-[**apps.plugin**](/collectors/apps.plugin/README.md) looks at the Linux process tree every second, much like `top` or
18
+[**apps.plugin**](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) looks at the Linux process tree every second, much like `top` or
19
`ps fax`, and collects resource utilization information on every running process. By reading the process tree, Netdata
20
shows CPU, disk, networking, processes, and eBPF for every application or Linux user. Unlike `top` or `ps fax`, Netdata
21
adds a layer of meaningful visualization on top of the process tree metrics, such as grouping applications into useful
@@ -24,43 +24,43 @@ charts under **Users**, and per-user group charts under **User Groups**.
24
25
Our most popular application collectors:
26
27
-- [Prometheus endpoints](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus): Gathers
27
+- [Prometheus endpoints](https://github.com/netdata/go.d.plugin/blob/master/modules/prometheus/README.md): Gathers
28
metrics from one or more Prometheus endpoints that use the OpenMetrics exposition format. Auto-detects more than 600
29
endpoints.
30
-- [Web server logs (Apache, NGINX)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/):
30
+- [Web server logs (Apache, NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md):
31
Tail access logs and provide very detailed web server performance statistics. This module is able to parse 200k+
32
rows in less than half a second.
33
-- [MySQL](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql/): Collect database global,
33
+- [MySQL](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md): Collect database global,
34
replication, and per-user statistics.
35
-- [Redis](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/redis): Monitor database status by
35
+- [Redis](https://github.com/netdata/go.d.plugin/blob/master/modules/redis/README.md): Monitor database status by
36
reading the server's response to the `INFO` command.
37
-- [Apache](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/apache/): Collect Apache web server
37
+- [Apache](https://github.com/netdata/go.d.plugin/blob/master/modules/apache/README.md): Collect Apache web server
38
performance metrics via the `server-status?auto` endpoint.
39
-- [Nginx](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx/): Monitor web server status
39
+- [Nginx](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md): Monitor web server status
40
information by gathering metrics via `ngx_http_stub_status_module`.
41
-- [Postgres](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/postgres): Collect database health
41
+- [Postgres](https://github.com/netdata/go.d.plugin/blob/master/modules/postgres/README.md): Collect database health
42
and performance metrics.
43
-- [ElasticSearch](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/elasticsearch): Collect search
43
+- [ElasticSearch](https://github.com/netdata/go.d.plugin/blob/master/modules/elasticsearch/README.md): Collect search
44
engine performance and health statistics. Optionally collects per-index metrics.
45
-- [PHP-FPM](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/phpfpm/): Collect application summary
45
+- [PHP-FPM](https://github.com/netdata/go.d.plugin/blob/master/modules/phpfpm/README.md): Collect application summary
46
and processes health metrics by scraping the status page (`/status?full`).
47
48
-Our [supported collectors list](/collectors/COLLECTORS.md#service-and-application-collectors) shows all Netdata's
48
+Our [supported collectors list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md#service-and-application-collectors) shows all Netdata's
49
application metrics collectors, including those for containers/k8s clusters.
50
51
## Collect metrics from applications running on Windows
52
53
Netdata is fully capable of collecting and visualizing metrics from applications running on Windows systems. The only
54
-caveat is that you must [install Netdata](/docs/get-started.mdx) on a separate system or a compatible VM because there
54
+caveat is that you must [install Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) on a separate system or a compatible VM because there
55
is no native Windows version of the Netdata Agent.
56
57
Once you have Netdata running on that separate system, you can follow the [enable and configure
58
-doc](/docs/collect/enable-configure.md) to tell the collector to look for exposed metrics on the Windows system's IP
58
+doc](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) to tell the collector to look for exposed metrics on the Windows system's IP
59
address or hostname, plus the applicable port.
60
61
For example, you have a MySQL database with a root password of `my-secret-pw` running on a Windows system with the IP
62
address 203.0.113.0. you can configure the [MySQL
63
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql) to look at `203.0.113.0:3306`:
63
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md) to look at `203.0.113.0:3306`:
64
65
```yml
66
jobs:
@@ -69,16 +69,16 @@ jobs:
69
```
70
71
This same logic applies to any application in our [supported collectors
72
-list](/collectors/COLLECTORS.md#service-and-application-collectors) that can run on Windows.
72
+list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md#service-and-application-collectors) that can run on Windows.
73
74
## What's next?
75
76
-If you haven't yet seen the [supported collectors list](/collectors/COLLECTORS.md) give it a once-over for any
76
+If you haven't yet seen the [supported collectors list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) give it a once-over for any
77
additional applications you may want to monitor using Netdata's native collectors, or the [generic Prometheus
78
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus).
78
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/prometheus/README.md).
79
80
Collecting all the available metrics on your nodes, and across your entire infrastructure, is just one piece of the
81
puzzle. Next, learn more about Netdata's famous real-time visualizations by [seeing an overview of your
82
-infrastructure](/docs/visualize/overview-infrastructure.md) using Netdata Cloud.
82
+infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) using Netdata Cloud.
83
84
docs/collect/container-metrics.md
+19
-19
@@ -13,35 +13,35 @@ learn_rel_path: "Concepts"
13
Thanks to close integration with Linux cgroups and the virtual files it maintains under `/sys/fs/cgroup`, Netdata can
14
monitor the health, status, and resource utilization of many different types of Linux containers.
15
16
-Netdata uses [cgroups.plugin](/collectors/cgroups.plugin/README.md) to poll `/sys/fs/cgroup` and convert the raw data
16
+Netdata uses [cgroups.plugin](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md) to poll `/sys/fs/cgroup` and convert the raw data
17
into human-readable metrics and meaningful visualizations. Through cgroups, Netdata is compatible with **all Linux
18
containers**, such as Docker, LXC, LXD, Libvirt, systemd-nspawn, and more. Read more about [Docker-specific
19
monitoring](#collect-docker-metrics) below.
20
21
Netdata also has robust **Kubernetes monitoring** support thanks to a
22
-[Helmchart](/packaging/installer/methods/kubernetes.md) to automate deployment, collectors for k8s agent services, and
22
+[Helmchart](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md) to automate deployment, collectors for k8s agent services, and
23
robust [service discovery](https://github.com/netdata/agent-service-discovery/#service-discovery) to monitor the
24
services running inside of pods in your k8s cluster. Read more about [Kubernetes
25
monitoring](#collect-kubernetes-metrics) below.
26
27
A handful of additional collectors gather metrics from container-related services, such as
28
-[dockerd](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/docker/) or [Docker
29
-Engine](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/docker_engine/). You can find all
28
+[dockerd](https://github.com/netdata/go.d.plugin/blob/master/modules/docker/README.md) or [Docker
29
+Engine](https://github.com/netdata/go.d.plugin/blob/master/modules/docker_engine/README.md). You can find all
30
container collectors in our supported collectors list under the
31
-[containers/VMs](/collectors/COLLECTORS.md#containers-and-vms) and
32
-[Kubernetes](/collectors/COLLECTORS.md#containers-and-vms) headings.
31
+[containers/VMs](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md#containers-and-vms) and
32
+[Kubernetes](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md#containers-and-vms) headings.
33
34
## Collect Docker metrics
35
36
Netdata has robust Docker monitoring thanks to the aforementioned
37
-[cgroups.plugin](/collectors/cgroups.plugin/README.md). By polling cgroups every second, Netdata can produce meaningful
37
+[cgroups.plugin](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md). By polling cgroups every second, Netdata can produce meaningful
38
visualizations about the CPU, memory, disk, and network utilization of all running containers on the host system with
39
zero configuration.
40
41
Netdata also collects metrics from applications running inside of Docker containers. For example, if you create a MySQL
42
database container using `docker run --name some-mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag`, it exposes
43
metrics on port 3306. You can configure the [MySQL
44
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql) to look at `127.0.0.0:3306` for
44
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md) to look at `127.0.0.0:3306` for
45
MySQL metrics:
46
47
```yml
@@ -51,18 +51,18 @@ jobs:
51
```
52
53
Netdata then collects metrics from the container itself, but also dozens [MySQL-specific
54
-metrics](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql#charts) as well.
54
+metrics](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md#charts) as well.
55
56
### Collect metrics from applications running in Docker containers
57
58
You could use this technique to monitor an entire infrastructure of Docker containers. The same [enable and
59
-configure](/docs/collect/enable-configure.md) procedures apply whether an application runs on the host system or inside
59
+configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) procedures apply whether an application runs on the host system or inside
60
a container. You may need to configure the target endpoint if it's not the application's default.
61
62
-Netdata can even [run in a Docker container](/packaging/docker/README.md) itself, and then collect metrics about the
62
+Netdata can even [run in a Docker container](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md) itself, and then collect metrics about the
63
host system, its own container with cgroups, and any applications you want to monitor.
64
65
-See our [application metrics doc](/docs/collect/application-metrics.md) for details about Netdata's application metrics
65
+See our [application metrics doc](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md) for details about Netdata's application metrics
66
collection capabilities.
67
68
## Collect Kubernetes metrics
@@ -77,26 +77,26 @@ your k8s infrastructure.
77
configuration files for [compatible
78
applications](https://github.com/netdata/helmchart#service-discovery-and-supported-services) and any endpoints
79
covered by our [generic Prometheus
80
- collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus). With these
80
+ collector](https://github.com/netdata/go.d.plugin/blob/master/modules/prometheus/README.md). With these
81
configuration files, Netdata collects metrics from any compatible applications as they run _inside_ of a pod.
82
Service discovery happens without manual intervention as pods are created, destroyed, or moved between nodes.
83
-- A [Kubelet collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubelet), which runs
83
+- A [Kubelet collector](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubelet/README.md), which runs
84
on each node in a k8s cluster to monitor the number of pods/containers, the volume of operations on each container,
85
and more.
86
-- A [kube-proxy collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubeproxy), which
86
+- A [kube-proxy collector](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubeproxy/README.md), which
87
also runs on each node and monitors latency and the volume of HTTP requests to the proxy.
88
-- A [cgroups collector](/collectors/cgroups.plugin/README.md), which collects CPU, memory, and bandwidth metrics for
88
+- A [cgroups collector](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md), which collects CPU, memory, and bandwidth metrics for
89
each container running on your k8s cluster.
90
91
For a holistic view of Netdata's Kubernetes monitoring capabilities, see our guide: [_Monitor a Kubernetes (k8s) cluster
92
-with Netdata_](https://learn.netdata.cloud/guides/monitor/kubernetes-k8s-netdata).
92
+with Netdata_](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/kubernetes-k8s-netdata.md).
93
94
## What's next?
95
96
Netdata is capable of collecting metrics from hundreds of applications, such as web servers, databases, messaging
97
-brokers, and more. See more in the [application metrics doc](/docs/collect/application-metrics.md).
97
+brokers, and more. See more in the [application metrics doc](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md).
98
99
If you already have all the information you need about collecting metrics, move into Netdata's meaningful visualizations
100
-with [seeing an overview of your infrastructure](/docs/visualize/overview-infrastructure.md) using Netdata Cloud.
100
+with [seeing an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) using Netdata Cloud.
101
102
docs/collect/enable-configure.md
+10
-10
@@ -12,7 +12,7 @@ learn_rel_path: "Setup"
12
13
When Netdata starts up, each collector searches for exposed metrics on the default endpoint established by that service
14
or application's standard installation procedure. For example, the [Nginx
15
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) searches at
15
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md) searches at
16
`http://127.0.0.1/stub_status` for exposed metrics in the correct format. If an Nginx web server is running and exposes
17
metrics on that endpoint, the collector begins gathering them.
18
@@ -24,7 +24,7 @@ enable or configure a collector to gather all available metrics from your system
24
You can enable/disable collectors individually, or enable/disable entire orchestrators, using their configuration files.
25
For example, you can change the behavior of the Go orchestrator, or any of its collectors, by editing `go.d.conf`.
26
27
-Use `edit-config` from your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) to open
27
+Use `edit-config` from your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) to open
28
the orchestrator primary configuration file:
29
30
```bash
@@ -37,14 +37,14 @@ enable/disable it with `yes` and `no` settings. Uncomment any line you change to
37
start.
38
39
After you make your changes, restart the Agent with `sudo systemctl restart netdata`, or the [appropriate
40
-method](/docs/configure/start-stop-restart.md) for your system.
40
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
41
42
## Configure a collector
43
44
-First, [find the collector](/collectors/COLLECTORS.md) you want to edit and open its documentation. Some software has
44
+First, [find the collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) you want to edit and open its documentation. Some software has
45
collectors written in multiple languages. In these cases, you should always pick the collector written in Go.
46
47
-Use `edit-config` from your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) to open a
47
+Use `edit-config` from your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) to open a
48
collector's configuration file. For example, edit the Nginx collector with the following:
49
50
```bash
@@ -57,16 +57,16 @@ configure that collector. Uncomment any line you change to ensure the collector'
57
read it on start.
58
59
After you make your changes, restart the Agent with `sudo systemctl restart netdata`, or the [appropriate
60
-method](/docs/configure/start-stop-restart.md) for your system.
60
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
61
62
## What's next?
63
64
-Read high-level overviews on how Netdata collects [system metrics](/docs/collect/system-metrics.md), [container
65
-metrics](/docs/collect/container-metrics.md), and [application metrics](/docs/collect/application-metrics.md).
64
+Read high-level overviews on how Netdata collects [system metrics](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md), [container
65
+metrics](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md), and [application metrics](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md).
66
67
If you're already collecting all metrics from your systems, containers, and applications, it's time to move into
68
-Netdata's visualization features. [See an overview of your infrastructure](/docs/visualize/overview-infrastructure.md)
68
+Netdata's visualization features. [See an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md)
69
using Netdata Cloud, or learn how to [interact with dashboards and
70
-charts](/docs/visualize/interact-dashboards-charts.md).
70
+charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md).
71
72
docs/collect/how-collectors-work.md
+14
-14
@@ -14,7 +14,7 @@ When Netdata starts, and with zero configuration, it auto-detects thousands of d
14
per-second metrics.
15
16
Netdata can immediately collect metrics from these endpoints thanks to 300+ **collectors**, which all come pre-installed
17
-when you [install Netdata](/docs/get-started.mdx).
17
+when you [install Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
18
19
Every collector has two primary jobs:
20
@@ -23,15 +23,15 @@ Every collector has two primary jobs:
23
24
If the collector finds compatible metrics exposed on the configured endpoint, it begins a per-second collection job. The
25
Netdata Agent gathers these metrics, sends them to the [database engine for
26
-storage](/docs/store/change-metrics-storage.md), and immediately [visualizes them
27
-meaningfully](/docs/visualize/interact-dashboards-charts.md) on dashboards.
26
+storage](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md), and immediately [visualizes them
27
+meaningfully](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) on dashboards.
28
29
Each collector comes with a pre-defined configuration that matches the default setup for that application. This endpoint
30
can be a URL and port, a socket, a file, a web page, and more.
31
32
-For example, the [Nginx collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) searches
32
+For example, the [Nginx collector](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md) searches
33
at `http://127.0.0.1/stub_status`, which is the default endpoint for exposing Nginx metrics. The [web log collector for
34
-Nginx or Apache](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog) searches at
34
+Nginx or Apache](https://github.com/netdata/go.d.plugin/blob/master/README.mdmodules/weblog) searches at
35
`/var/log/nginx/access.log` and `/var/log/apache2/access.log`, respectively, both of which are standard locations for
36
access log files on Linux systems.
37
@@ -39,15 +39,15 @@ The endpoint is user-configurable, as are many other specifics of what a given c
39
40
## What can Netdata collect?
41
42
-To quickly find your answer, see our [list of supported collectors](/collectors/COLLECTORS.md).
42
+To quickly find your answer, see our [list of supported collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
43
44
Generally, Netdata's collectors can be grouped into three types:
45
46
-- [Systems](/docs/collect/system-metrics.md): Monitor CPU, memory, disk, networking, systemd, eBPF, and much more.
46
+- [Systems](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md): Monitor CPU, memory, disk, networking, systemd, eBPF, and much more.
47
Every metric exposed by `/proc`, `/sys`, and other Linux kernel sources.
48
-- [Containers](/docs/collect/container-metrics.md): Gather metrics from container agents, like `dockerd` or `kubectl`,
48
+- [Containers](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md): Gather metrics from container agents, like `dockerd` or `kubectl`,
49
along with the resource usage of containers and the applications they run.
50
-- [Applications](/docs/collect/application-metrics.md): Collect per-second metrics from web servers, databases, logs,
50
+- [Applications](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md): Collect per-second metrics from web servers, databases, logs,
51
message brokers, APM tools, email servers, and much more.
52
53
## Collector architecture and terminology
@@ -60,11 +60,11 @@ terms related to collecting metrics.
60
- **Modules** are a type of collector.
61
- **Orchestrators** are external plugins that run and manage one or more modules. They run as independent processes.
62
The Go orchestrator is in active development.
63
- - [go.d.plugin](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/): An orchestrator for data
63
+ - [go.d.plugin](https://github.com/netdata/go.d.plugin/blob/master/README.md): An orchestrator for data
64
collection modules written in `go`.
65
- - [python.d.plugin](/collectors/python.d.plugin/README.md): An orchestrator for data collection modules written in
65
+ - [python.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md): An orchestrator for data collection modules written in
66
`python` v2/v3.
67
- - [charts.d.plugin](/collectors/charts.d.plugin/README.md): An orchestrator for data collection modules written in
67
+ - [charts.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/README.md): An orchestrator for data collection modules written in
68
`bash` v4+.
69
- **External plugins** gather metrics from external processes, such as a webserver or database, and run as independent
70
processes that communicate with the Netdata daemon via pipes.
@@ -73,10 +73,10 @@ terms related to collecting metrics.
73
74
## What's next?
75
76
-[Enable or configure a collector](/docs/collect/enable-configure.md) if the default settings are not compatible with
76
+[Enable or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) if the default settings are not compatible with
77
your infrastructure.
78
79
-See our [collectors reference](/collectors/REFERENCE.md) for detailed information on Netdata's collector architecture,
79
+See our [collectors reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) for detailed information on Netdata's collector architecture,
80
troubleshooting a collector, developing a custom collector, and more.
81
82
docs/collect/system-metrics.md
+13
-13
@@ -11,53 +11,53 @@ learn_rel_path: "Concepts"
11
# Collect system metrics with Netdata
12
13
Netdata collects thousands of metrics directly from the operating systems of physical and virtual systems, IoT/edge
14
-devices, and [containers](/docs/collect/container-metrics.md) with zero configuration.
14
+devices, and [containers](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md) with zero configuration.
15
16
To gather system metrics, Netdata uses roughly a dozen plugins, each of which has one or more collectors for very
17
specific metrics exposed by the host. The system metrics Netdata users interact with most for health monitoring and
18
performance troubleshooting are collected and visualized by `proc.plugin`, `cgroups.plugin`, and `ebpf.plugin`.
19
20
-[**proc.plugin**](/collectors/proc.plugin/README.md) gathers metrics from the `/proc` and `/sys` folders in Linux
20
+[**proc.plugin**](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md) gathers metrics from the `/proc` and `/sys` folders in Linux
21
systems, along with a few other endpoints, and is responsible for the bulk of the system metrics collected and
22
visualized by Netdata. It collects CPU, memory, disks, load, networking, mount points, and more with zero configuration.
23
It even allows Netdata to monitor its own resource utilization!
24
25
-[**cgroups.plugin**](/collectors/cgroups.plugin/README.md) collects rich metrics about containers and virtual machines
25
+[**cgroups.plugin**](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md) collects rich metrics about containers and virtual machines
26
using the virtual files under `/sys/fs/cgroup`. By reading cgroups, Netdata can instantly collect resource utilization
27
metrics for systemd services, all containers (Docker, LXC, LXD, Libvirt, systemd-nspawn), and more. Learn more in the
28
-[collecting container metrics](/docs/collect/container-metrics.md) doc.
28
+[collecting container metrics](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md) doc.
29
30
-[**ebpf.plugin**](/collectors/ebpf.plugin/README.md): Netdata's extended Berkeley Packet Filter (eBPF) collector
30
+[**ebpf.plugin**](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md): Netdata's extended Berkeley Packet Filter (eBPF) collector
31
monitors Linux kernel-level metrics for file descriptors, virtual filesystem IO, and process management. You can use our
32
eBPF collector to analyze how and when a process accesses files, when it makes system calls, whether it leaks memory or
33
creating zombie processes, and more.
34
35
While the above plugins and associated collectors are the most important for system metrics, there are many others. You
36
-can find all system collectors in our [supported collectors list](/collectors/COLLECTORS.md#system-collectors).
36
+can find all system collectors in our [supported collectors list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md#system-collectors).
37
38
## Collect Windows system metrics
39
40
Netdata is also capable of monitoring Windows systems. The [WMI
41
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/wmi) integrates with
41
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md) integrates with
42
[windows_exporter](https://github.com/prometheus-community/windows_exporter), a small Go-based binary that you can run
43
on Windows systems. The WMI collector then gathers metrics from an endpoint created by windows_exporter, for more
44
-details see [the requirements](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/wmi#requirements).
44
+details see [the requirements](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#requirements).
45
46
Next, [configure the WMI
47
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/wmi#configuration) to point to the URL
47
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#configuration) to point to the URL
48
and port of your exposed endpoint. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
49
-method](/docs/configure/start-stop-restart.md) for your system. You'll start seeing Windows system metrics, such as CPU
49
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. You'll start seeing Windows system metrics, such as CPU
50
utilization, memory, bandwidth per NIC, number of processes, and much more.
51
52
For information about collecting metrics from applications _running on Windows systems_, see the [application metrics
53
-doc](/docs/collect/application-metrics.md#collect-metrics-from-applications-running-on-windows).
53
+doc](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md#collect-metrics-from-applications-running-on-windows).
54
55
## What's next?
56
57
-Because there's some overlap between system metrics and [container metrics](/docs/collect/container-metrics.md), you
57
+Because there's some overlap between system metrics and [container metrics](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md), you
58
should investigate Netdata's container compatibility if you use them heavily in your infrastructure.
59
60
-If you don't use containers, skip ahead to collecting [application metrics](/docs/collect/application-metrics.md) with
60
+If you don't use containers, skip ahead to collecting [application metrics](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md) with
61
Netdata.
62
63
docs/configure/common-changes.md
+80
-46
@@ -14,19 +14,24 @@ The Netdata Agent requires no configuration upon installation to collect thousan
14
systems, containers, and applications, but there are hundreds of settings to tweak if you want to exercise more control
15
over your monitoring platform.
16
17
-This document assumes familiarity with using [`edit-config`](/docs/configure/nodes.md) from the Netdata config
17
+This document assumes familiarity with
18
+using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) from the Netdata config
19
directory.
20
21
## Change dashboards and visualizations
22
22
-The Netdata Agent's [local dashboard](/web/gui/README.md), accessible at `http://NODE:19999` is highly configurable. If
23
-you use Netdata Cloud for [infrastructure monitoring](/docs/quickstart/infrastructure.md), you will see many of these
23
+The Netdata Agent's [local dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md), accessible
24
+at `http://NODE:19999` is highly configurable. If
25
+you use Netdata Cloud
26
+for [infrastructure monitoring](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you
27
+will see many of these
28
changes reflected in those visualizations due to the way Netdata Cloud proxies metric data and metadata to your browser.
29
30
### Increase the long-term metrics retention period
31
28
-Increase the values for the `page cache size` and `dbengine multihost disk space` settings in the [`[global]`
29
-section](/daemon/config/README.md#global-section-options) of `netdata.conf`.
32
+Increase the values for the `page cache size` and `dbengine multihost disk space` settings in
33
+the [`[global]`section](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#global-section-options)
34
+of `netdata.conf`.
35
36
```conf
37
[global]
@@ -34,13 +39,17 @@ section](/daemon/config/README.md#global-section-options) of `netdata.conf`.
39
dbengine multihost disk space = 4096 # 4GiB of disk space for metrics storage
40
```
41
37
-Read our doc on [increasing long-term metrics storage](/docs/store/change-metrics-storage.md) for details, including a
38
-[calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
42
+Read our doc
43
+on [increasing long-term metrics storage](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md)
44
+for details, including a
45
+[calculator](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
46
to help you determine the exact settings for your desired retention period.
47
48
### Reduce the data collection frequency
49
43
-Change `update every` in the [`[global]` section](/daemon/config/README.md#global-section-options) of `netdata.conf` so
50
+Change `update every` in
51
+the [`[global]` section](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#global-section-options)
52
+of `netdata.conf` so
53
that it is greater than `1`. An `update every` of `5` means the Netdata Agent enforces a _minimum_ collection frequency
54
of 5 seconds.
55
@@ -51,12 +60,15 @@ of 5 seconds.
60
61
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
62
`python.d.conf` or `charts.d.conf` files, or in individual collector configuration files. If the `update
54
-every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See the [enable
55
-or configure a collector](/docs/collect/enable-configure.md) doc for details.
63
+every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See
64
+the [enable or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
65
+doc for details.
66
67
### Disable a collector or plugin
68
59
-Turn off entire plugins in the [`[plugins]` section](/daemon/config/README.md#plugins-section-options) of
69
+Turn off entire plugins in
70
+the [`[plugins]` section](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#plugins-section-options)
71
+of
72
`netdata.conf`.
73
74
To disable specific collectors, open `go.d.conf`, `python.d.conf` or `charts.d.conf` and find the line
@@ -81,17 +93,20 @@ sudo ./edit-config health.d/example-alarm.conf
93
94
Or, append your new alarm to an existing file by editing a relevant existing file in the `health.d/` directory.
95
84
-Read more about [configuring alarms](/docs/monitor/configure-alarms.md) to get started, and see the [health monitoring
85
-reference](/health/REFERENCE.md) for a full listing of options available in health entities.
96
+Read more about [configuring alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to
97
+get started, and see
98
+the [health monitoring reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) for a full listing
99
+of options available in health entities.
100
101
### Configure a specific alarm
102
103
Tweak existing alarms by editing files in the `health.d/` directory. For example, edit `health.d/cpu.conf` to change how
104
the Agent responds to anomalies related to CPU utilization.
105
92
-To see which configuration file you need to edit to configure a specific alarm, [view your active
93
-alarms](/docs/monitor/view-active-alarms.md) in Netdata Cloud or the local Agent dashboard and look for the **source**
94
-line. For example, it might read `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`.
106
+To see which configuration file you need to edit to configure a specific
107
+alarm, [view your active alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) in
108
+Netdata Cloud or the local Agent dashboard and look for the **source** line. For example, it might
109
+read `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`.
110
111
Because the source path contains `health.d/cpu.conf`, run `sudo edit-config health.d/cpu.conf` to configure that alarm.
112
@@ -110,13 +125,16 @@ template: disk_fill_rate
125
126
### Turn of all alarms and notifications
127
113
-Set `enabled` to `no` in the [`[health]` section](/daemon/config/README.md#health-section-options) section of
128
+Set `enabled` to `no` in
129
+the [`[health]` section](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#health-section-options)
130
+section of
131
`netdata.conf`.
132
133
### Enable alarm notifications
134
135
Open `health_alarm_notify.conf` for editing. First, read the [enabling
119
-notifications](/docs/monitor/enable-notifications.md#netdata-agent) doc for an example of the process using Slack, then
136
+notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md#netdata-agent) doc
137
+for an example of the process using Slack, then
138
click on the link to your preferred notification method to find documentation for that specific endpoint.
139
140
## Improve node security
@@ -124,14 +142,17 @@ click on the link to your preferred notification method to find documentation fo
142
While the Netdata Agent is both [open and secure by design](https://www.netdata.cloud/blog/netdata-agent-dashboard/), we
143
recommend every user take some action to administer and secure their nodes.
144
127
-Learn more about a few of the following changes in the [node security doc](/docs/configure/secure-nodes.md).
145
+Learn more about a few of the following changes in
146
+the [node security doc](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md).
147
148
### Disable the local Agent dashboard (`http://NODE:19999`)
149
150
If you use Netdata Cloud to visualize metrics, stream metrics to a parent node, or otherwise don't need the local Agent
151
dashboard, disabling it reduces the Agent's resource utilization and improves security.
152
134
-Change the `mode` setting to `none` in the [`[web]` section](/web/server/README.md#configuration) of `netdata.conf`.
153
+Change the `mode` setting to `none` in
154
+the [`[web]` section](https://github.com/netdata/netdata/blob/master/web/server/README.md#configuration)
155
+of `netdata.conf`.
156
157
```conf
158
[web]
@@ -140,11 +161,12 @@ Change the `mode` setting to `none` in the [`[web]` section](/web/server/README.
161
162
### Use access lists to restrict access to specific assets
163
143
-Allow access from only specific IP addresses, ranges of IP addresses, or hostnames using [access
144
-lists](/web/server/README.md#access-lists) and [simple patterns](/libnetdata/simple_pattern/README.md).
164
+Allow access from only specific IP addresses, ranges of IP addresses, or hostnames
165
+using [access lists](https://github.com/netdata/netdata/blob/master/web/server/README.md#access-lists)
166
+and [simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md).
167
168
See a quickstart to access lists in the [node security
147
-doc](/docs/configure/secure-nodes.md#restrict-access-to-the-local-dashboard).
169
+doc](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md#restrict-access-to-the-local-dashboard).
170
171
### Stop sending anonymous statistics to Google Analytics
172
@@ -155,7 +177,8 @@ the statistics script.
177
sudo touch .opt-out-from-anonymous-statistics
178
```
179
158
-Learn more about [why we collect anonymous statistics](/docs/anonymous-statistics.md).
180
+Learn more
181
+about [why we collect anonymous statistics](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md).
182
183
### Change the IP address/port Netdata listens to
184
@@ -166,26 +189,30 @@ Change the `default port` setting in the `[web]` section to a port other than `1
189
default port = 39999
190
```
191
169
-Use the `bind to` setting to the ports other assets, such as the [running `netdata.conf`
170
-configuration](/docs/configure/nodes.md#see-an-agents-running-configuration), API, or streaming requests listen to.
192
+Use the `bind to` setting to the ports other assets, such as
193
+the [running `netdata.conf` configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#see-an-agents-running-configuration),
194
+API, or streaming requests listen to.
195
196
## Reduce resource usage
197
174
-Read our [performance optimization guide](/docs/guides/configure/performance.md) for a long list of specific changes
198
+Read
199
+our [performance optimization guide](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md)
200
+for a long list of specific changes
201
that can reduce the Netdata Agent's CPU/memory footprint and IO requirements.
202
203
## Organize nodes with host labels
204
205
Beginning with v1.20, Netdata accepts user-defined **host labels**. These labels are sent during streaming, exporting,
206
and as metadata to Netdata Cloud, and help you organize the metrics coming from complex infrastructure. Host labels are
181
-defined in the section `[host labels]`.
207
+defined in the section `[host labels]`.
208
183
-For a quick introduction, read the [host label guide](/docs/guides/using-host-labels.md).
209
+For a quick introduction, read
210
+the [host label guide](https://github.com/netdata/netdata/blob/master/docs/guides/using-host-labels.md).
211
185
-The following restrictions apply to host label names:
186
-
187
-- Names cannot start with `_`, but it can be present in other parts of the name.
188
-- Names only accept alphabet letters, numbers, dots, and dashes.
212
+The following restrictions apply to host label names:
213
+
214
+- Names cannot start with `_`, but it can be present in other parts of the name.
215
+- Names only accept alphabet letters, numbers, dots, and dashes.
216
217
The policy for values is more flexible, but you can not use exclamation marks (`!`), whitespaces (` `), single quotes
218
(`'`), double quotes (`"`), or asterisks (`*`), because they are used to compare label values in health alarms and
@@ -193,26 +220,33 @@ templates.
220
221
## What's next?
222
196
-If you haven't already, learn how to [secure your nodes](/docs/configure/secure-nodes.md).
223
+If you haven't already, learn how
224
+to [secure your nodes](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md).
225
198
-As mentioned at the top, there are plenty of other
226
+As mentioned at the top, there are plenty of other
227
228
You can also take what you've learned about node configuration to tweak the Agent's behavior or enable new features:
229
202
-- [Enable new collectors](/docs/collect/enable-configure.md) or tweak their behavior.
203
-- [Configure existing health alarms](/docs/monitor/configure-alarms.md) or create new ones.
204
-- [Enable notifications](/docs/monitor/enable-notifications.md) to receive updates about the health of your
230
+- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak
231
+ their behavior.
232
+- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
233
+ create new ones.
234
+- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive
235
+ updates about the health of your
236
infrastructure.
206
-- Change [the long-term metrics retention period](/docs/store/change-metrics-storage.md) using the database engine.
237
+-
238
+
239
+Change [the long-term metrics retention period](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md)
240
+using the database engine.
241
242
### Related reference documentation
243
210
-- [Netdata Agent · Daemon](/health/README.md)
211
-- [Netdata Agent · Daemon configuration](/daemon/config/README.md)
212
-- [Netdata Agent · Web server](/web/server/README.md)
213
-- [Netdata Agent · Local Agent dashboard](/web/gui/README.md)
214
-- [Netdata Agent · Health monitoring](/health/REFERENCE.md)
215
-- [Netdata Agent · Notifications](/health/notifications/README.md)
216
-- [Netdata Agent · Simple patterns](/libnetdata/simple_pattern/README.md)
244
+- [Netdata Agent · Daemon](https://github.com/netdata/netdata/blob/master/health/README.md)
245
+- [Netdata Agent · Daemon configuration](https://github.com/netdata/netdata/blob/master/daemon/config/README.md)
246
+- [Netdata Agent · Web server](https://github.com/netdata/netdata/blob/master/web/server/README.md)
247
+- [Netdata Agent · Local Agent dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md)
248
+- [Netdata Agent · Health monitoring](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md)
249
+- [Netdata Agent · Notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md)
250
+- [Netdata Agent · Simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md)
251
252
[](<>)
docs/configure/nodes.md
+24
-24
@@ -23,7 +23,7 @@ anomaly, or change in infrastructure affects how their Agents should perform.
23
## The Netdata config directory
24
25
On most Linux systems, using our [recommended one-line
26
-installation](/docs/get-started.mdx#install-on-linux-with-one-line-installer), the **Netdata config
26
+installation](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx#install-on-linux-with-one-line-installer), the **Netdata config
27
directory** is `/etc/netdata/`. The config directory contains several configuration files with the `.conf` extension, a
28
few directories, and a shell script named `edit-config`.
29
@@ -41,23 +41,23 @@ these files in your own Netdata config directory, as the next section describes
41
exist.
42
43
- `netdata.conf` is the main configuration file. This is where you'll find most configuration options. Read descriptions
44
- for each in the [daemon config](/daemon/config/README.md) doc.
44
+ for each in the [daemon config](https://github.com/netdata/netdata/blob/master/daemon/config/README.md) doc.
45
- `edit-config` is a shell script used for [editing configuration files](#use-edit-config-to-edit-configuration-files).
46
- Various configuration files ending in `.conf` for [configuring plugins or
47
- collectors](/docs/collect/enable-configure.md#enable-a-collector-or-its-orchestrator) behave. Examples: `go.d.conf`,
47
+ collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md#enable-a-collector-or-its-orchestrator) behave. Examples: `go.d.conf`,
48
`python.d.conf`, and `ebpf.d.conf`.
49
- Various directories ending in `.d`, which contain other configuration files, each ending in `.conf`, for [configuring
50
- specific collectors](/docs/collect/enable-configure.md#configure-a-collector).
50
+ specific collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md#configure-a-collector).
51
- `apps_groups.conf` is a configuration file for changing how applications/processes are grouped when viewing the
52
- **Application** charts from [`apps.plugin`](/collectors/apps.plugin/README.md) or
53
- [`ebpf.plugin`](/collectors/ebpf.plugin/README.md).
54
-- `health.d/` is a directory that contains [health configuration files](/docs/monitor/configure-alarms.md).
55
-- `health_alarm_notify.conf` enables and configures [alarm notifications](/docs/monitor/enable-notifications.md).
56
-- `statsd.d/` is a directory for configuring Netdata's [statsd collector](/collectors/statsd.plugin/README.md).
57
-- `stream.conf` configures [parent-child streaming](/streaming/README.md) between separate nodes running the Agent.
52
+ **Application** charts from [`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) or
53
+ [`ebpf.plugin`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
54
+- `health.d/` is a directory that contains [health configuration files](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
55
+- `health_alarm_notify.conf` enables and configures [alarm notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
56
+- `statsd.d/` is a directory for configuring Netdata's [statsd collector](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md).
57
+- `stream.conf` configures [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) between separate nodes running the Agent.
58
- `.environment` is a hidden file that describes the environment in which the Netdata Agent is installed, including the
59
- `PATH` and any installation options. Useful for [reinstalling](/packaging/installer/REINSTALL.md) or
60
- [uninstalling](/packaging/installer/UNINSTALL.md) the Agent.
59
+ `PATH` and any installation options. Useful for [reinstalling](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md) or
60
+ [uninstalling](https://github.com/netdata/netdata/blob/master/packaging/installer/UNINSTALL.md) the Agent.
61
62
The Netdata config directory also contains one symlink:
63
@@ -67,7 +67,7 @@ The Netdata config directory also contains one symlink:
67
68
## Configure a Netdata docker container
69
70
-See [configure agent containers](/packaging/docker/README.md#configure-agent-containers).
70
+See [configure agent containers](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md#configure-agent-containers).
71
72
## Use `edit-config` to edit configuration files
73
@@ -107,7 +107,7 @@ method for `edit-config` to write into the config directory. Use your `$EDITOR`,
107
> defaulted to `vim` or `nano`. Use `export EDITOR=` to change this temporarily, or edit your shell configuration file
108
> to change to permanently.
109
110
-After you make your changes, you need to [restart the Agent](/docs/configure/start-stop-restart.md) with `sudo systemctl
110
+After you make your changes, you need to [restart the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl
111
restart netdata` or the appropriate method for your system.
112
113
Here's an example of editing the node's hostname, which appears in both the local dashboard and in Netdata Cloud.
@@ -149,26 +149,26 @@ curl -o /etc/netdata/netdata.conf http://NODE:19999/netdata.conf
149
150
## What's next?
151
152
-Learn more about [starting, stopping, or restarting](/docs/configure/start-stop-restart.md) the Netdata daemon to apply
152
+Learn more about [starting, stopping, or restarting](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) the Netdata daemon to apply
153
configuration changes.
154
155
-Apply some [common configuration changes](/docs/configure/common-changes.md) to quickly tweak the Agent's behavior.
155
+Apply some [common configuration changes](https://github.com/netdata/netdata/blob/master/docs/configure/common-changes.md) to quickly tweak the Agent's behavior.
156
157
-[Add security to your node](/docs/configure/secure-nodes.md) with what you've learned about the Netdata config directory
157
+[Add security to your node](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md) with what you've learned about the Netdata config directory
158
and `edit-config`. We put together a few security best practices based on how you use the Netdata.
159
160
You can also take what you've learned about node configuration to enable or enhance features:
161
162
-- [Enable new collectors](/docs/collect/enable-configure.md) or tweak their behavior.
163
-- [Configure existing health alarms](/docs/monitor/configure-alarms.md) or create new ones.
164
-- [Enable notifications](/docs/monitor/enable-notifications.md) to receive updates about the health of your
162
+- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak their behavior.
163
+- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or create new ones.
164
+- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive updates about the health of your
165
infrastructure.
166
-- Change [the long-term metrics retention period](/docs/store/change-metrics-storage.md) using the database engine.
166
+- Change [the long-term metrics retention period](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) using the database engine.
167
168
### Related reference documentation
169
170
-- [Netdata Agent · Daemon](/daemon/README.md)
171
-- [Netdata Agent · Health monitoring](/health/README.md)
172
-- [Netdata Agent · Notifications](/health/notifications/README.md)
170
+- [Netdata Agent · Daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md)
171
+- [Netdata Agent · Health monitoring](https://github.com/netdata/netdata/blob/master/health/README.md)
172
+- [Netdata Agent · Notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md)
173
174
[](<>)
docs/configure/secure-nodes.md
+15
-15
@@ -15,13 +15,13 @@ internet at large, anyone can access the dashboard and your node's metrics at `h
15
so that the local dashboard was immediately accessible to users, and so that we don't dictate how professionals set up
16
and secure their infrastructures.
17
18
-Despite this design decision, your [data](/docs/netdata-security.md#your-data-is-safe-with-netdata) and your
19
-[systems](/docs/netdata-security.md#your-systems-are-safe-with-netdata) are safe with Netdata. Netdata is read-only,
18
+Despite this design decision, your [data](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md#your-data-is-safe-with-netdata) and your
19
+[systems](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md#your-systems-are-safe-with-netdata) are safe with Netdata. Netdata is read-only,
20
cannot do anything other than present metrics, and runs without special/`sudo` privileges. Also, the local dashboard
21
only exposes chart metadata and metric values, not raw data.
22
23
While Netdata is secure by design, we believe you should [protect your
24
-nodes](/docs/netdata-security.md#why-netdata-should-be-protected). If left accessible to the internet at large, the
24
+nodes](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md#why-netdata-should-be-protected). If left accessible to the internet at large, the
25
local dashboard could reveal sensitive information about your infrastructure. For example, an attacker can view which
26
applications you run (databases, webservers, and so on), or see every user account on a node.
27
@@ -41,7 +41,7 @@ that align with your goals and your organization's standards.
41
This is the _recommended method for those who have connected their nodes to Netdata Cloud_ and prefer viewing real-time
42
metrics using the War Room Overview, Nodes view, and Cloud dashboards.
43
44
-You can disable the local dashboard (and API) but retain the encrypted Agent-Cloud link ([ACLK](/aclk/README.md)) that
44
+You can disable the local dashboard (and API) but retain the encrypted Agent-Cloud link ([ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md)) that
45
allows you to stream metrics on demand from your nodes via the Netdata Cloud interface. This change mitigates all
46
concerns about revealing metrics and system design to the internet at large, while keeping all the functionality you
47
need to view metrics and troubleshoot issues with Netdata Cloud.
@@ -54,17 +54,17 @@ static-threaded` setting, and change it to `none`.
54
mode = none
55
```
56
57
-Save and close the editor, then [restart your Agent](/docs/configure/start-stop-restart.md) using `sudo systemctl
57
+Save and close the editor, then [restart your Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) using `sudo systemctl
58
restart netdata`. If you try to visit the local dashboard to `http://NODE:19999` again, the connection will fail because
59
that node no longer serves its local dashboard.
60
61
-> See the [configuration basics doc](/docs/configure/nodes.md) for details on how to find `netdata.conf` and use
61
+> See the [configuration basics doc](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) for details on how to find `netdata.conf` and use
62
> `edit-config`.
63
64
## Restrict access to the local dashboard
65
66
If you want to keep using the local dashboard, but don't want it exposed to the internet, you can restrict access with
67
-[access lists](/web/server/README.md#access-lists). This method also fully retains the ability to stream metrics
67
+[access lists](https://github.com/netdata/netdata/blob/master/web/server/README.md#access-lists). This method also fully retains the ability to stream metrics
68
on-demand through Netdata Cloud.
69
70
The `allow connections from` setting helps you allow only certain IP addresses or FQDN/hostnames, such as a trusted
@@ -72,7 +72,7 @@ static IP, only `localhost`, or connections from behind a management LAN.
72
73
By default, this setting is `localhost *`. This setting allows connections from `localhost` in addition to _all_
74
connections, using the `*` wildcard. You can change this setting using Netdata's [simple
75
-patterns](/libnetdata/simple_pattern/README.md).
75
+patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md).
76
77
```conf
78
[web]
@@ -99,8 +99,8 @@ The `allow connections from` setting is global and restricts access to the dashb
99
allow management from = localhost
100
```
101
102
-See the [web server](/web/server/README.md#access-lists) docs for additional details about access lists. You can take
103
-access lists one step further by [enabling SSL](/web/server/README.md#enabling-tls-support) to encrypt data from local
102
+See the [web server](https://github.com/netdata/netdata/blob/master/web/server/README.md#access-lists) docs for additional details about access lists. You can take
103
+access lists one step further by [enabling SSL](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support) to encrypt data from local
104
dashboard in transit. The connection to Netdata Cloud is always secured with TLS.
105
106
## Use a reverse proxy
@@ -110,18 +110,18 @@ local dashboard and Netdata Cloud dashboards. You can use a reverse proxy to pas
110
enable HTTPS to encrypt metadata and metric values in transit.
111
112
We recommend Nginx, as it's what we use for our [demo server](https://london.my-netdata.io/), and we have a guide
113
-dedicated to [running Netdata behind Nginx](/docs/Running-behind-nginx.md).
113
+dedicated to [running Netdata behind Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md).
114
115
-We also have guides for [Apache](/docs/Running-behind-apache.md), [Lighttpd](/docs/Running-behind-lighttpd.md),
116
-[HAProxy](/docs/Running-behind-haproxy.md), and [Caddy](/docs/Running-behind-caddy.md).
115
+We also have guides for [Apache](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md), [Lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md),
116
+[HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md), and [Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md).
117
118
## What's next?
119
120
-Read about [Netdata's security design](/docs/netdata-security.md) and our [blog
120
+Read about [Netdata's security design](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md) and our [blog
121
post](https://www.netdata.cloud/blog/netdata-agent-dashboard/) about why the local Agent dashboard is both open and
122
secure by design.
123
124
-Next up, learn about [collectors](/docs/collect/how-collectors-work.md) to ensure you're gathering every essential
124
+Next up, learn about [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) to ensure you're gathering every essential
125
metric about your node, its applications, and your infrastructure at large.
126
127
[](<>)
docs/configure/start-stop-restart.md
+9
-9
@@ -10,7 +10,7 @@ learn_rel_path: "Operations"
10
11
# Start, stop, or restart the Netdata Agent
12
13
-When you install the Netdata Agent, the [daemon](/daemon/README.md) is configured to start at boot and stop and
13
+When you install the Netdata Agent, the [daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md) is configured to start at boot and stop and
14
restart/shutdown.
15
16
You will most often need to _restart_ the Agent to load new or editing configuration files. [Health
@@ -44,7 +44,7 @@ If you start the daemon this way, close it with `sudo killall netdata`.
44
45
## Using `netdatacli`
46
47
-The Netdata Agent also comes with a [CLI tool](/cli/README.md) capable of performing shutdowns. Start the Agent back up
47
+The Netdata Agent also comes with a [CLI tool](https://github.com/netdata/netdata/blob/master/cli/README.md) capable of performing shutdowns. Start the Agent back up
48
using your preferred method listed above.
49
50
```bash
@@ -84,19 +84,19 @@ again with `service netdata start`, or the appropriate method for your system.
84
85
## What's next?
86
87
-Learn more about [securing the Netdata Agent](/docs/configure/secure-nodes.md).
87
+Learn more about [securing the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md).
88
89
You can also use the restart/reload methods described above to enable new features:
90
91
-- [Enable new collectors](/docs/collect/enable-configure.md) or tweak their behavior.
92
-- [Configure existing health alarms](/docs/monitor/configure-alarms.md) or create new ones.
93
-- [Enable notifications](/docs/monitor/enable-notifications.md) to receive updates about the health of your
91
+- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak their behavior.
92
+- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or create new ones.
93
+- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive updates about the health of your
94
infrastructure.
95
-- Change [the long-term metrics retention period](/docs/store/change-metrics-storage.md) using the database engine.
95
+- Change [the long-term metrics retention period](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) using the database engine.
96
97
### Related reference documentation
98
99
-- [Netdata Agent · Daemon](/daemon/README.md)
100
-- [Netdata Agent · Netdata CLI](/cli/README.md)
99
+- [Netdata Agent · Daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md)
100
+- [Netdata Agent · Netdata CLI](https://github.com/netdata/netdata/blob/master/cli/README.md)
101
102
[](<>)
docs/contributing/contributing-documentation.md
+4
-4
@@ -18,7 +18,7 @@ The Netdata team aggregates and publishes all documentation at [learn.netdata.cl
18
## Before you get started
19
20
Anyone interested in contributing to documentation should first read the [Netdata style
21
-guide](/docs/contributing/style-guide.md) and the [Netdata Community Code of Conduct](https://learn.netdata.cloud/contribute/code-of-conduct).
21
+guide](https://github.com/netdata/netdata/blob/master/docs/contributing/style-guide.md) and the [Netdata Community Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
22
23
Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read the [Mastering
24
Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on creating
@@ -40,7 +40,7 @@ Netdata's documentation is separated into four sections.
40
- Published under the **Reference** section in the Netdata Learn sidebar.
41
- **Netdata Cloud reference**: Reference documentation for the closed-source Netdata Cloud web application.
42
- Stored in a private GitHub repository and not editable by the community.
43
- - Published at [`https://learn.netdata.cloud/docs/cloud`](https://learn.netdata.cloud/docs/cloud).
43
+ - Published at [`https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx`](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx).
44
- **Guides**: Solutions-based articles for users who want instructions on completing a specific complex task using the
45
Netdata Agent and/or Netdata Cloud.
46
- Stored in the [`/docs/guides` folder](https://github.com/netdata/netdata/tree/master/docs/guides) within the
@@ -59,7 +59,7 @@ fixes to a single document, such as fixing a typo or clarifying a confusing sent
59
60
Click on the **Edit this page** button on any published document on [Netdata Learn](https://learn.netdata.cloud). Each
61
page has two of these buttons: One beneath the table of contents, and another at the end of the document, which take you
62
-to GitHub's code editor. Make your suggested changes, keeping [Netdata style guide](/docs/contributing/style-guide.md)
62
+to GitHub's code editor. Make your suggested changes, keeping [Netdata style guide](https://github.com/netdata/netdata/blob/master/docs/contributing/style-guide.md)
63
in mind, and use *Preview changes** button to ensure your Markdown syntax works as expected.
64
65
Under the **Commit changes** header, write descriptive title for your requested change. Click the **Commit changes**
@@ -86,7 +86,7 @@ git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git
86
```
87
88
Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping the
89
-[Netdata style guide](/docs/contributing/style-guide.md) in mind. Add, commit, and push changes to your fork. When
89
+[Netdata style guide](https://github.com/netdata/netdata/blob/master/docs/contributing/style-guide.md) in mind. Add, commit, and push changes to your fork. When
90
you're finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull
91
request based on the changes you made in the new branch of your fork.
92
docs/contributing/style-guide.md
+52
-49
@@ -67,8 +67,8 @@ Netdata is a global company in every sense, with employees, contributors, and us
67
communicate in a way that is clear and easily understood by everyone.
68
69
Here are some guidelines, pointers, and questions to be aware of as you write to ensure your writing is universal. Some
70
-of these are expanded into individual sections in the [language, grammar, and
71
-mechanics](#language-grammar-and-mechanics) section below.
70
+of these are expanded into individual sections in
71
+the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
72
73
- Would this language make sense to someone who doesn't work here?
74
- Could someone quickly scan this document and understand the material?
@@ -97,8 +97,8 @@ mechanics](#language-grammar-and-mechanics) section below.
97
98
To ensure Netdata's writing is clear, concise, and universal, we have established standards for language, grammar, and
99
certain writing mechanics. However, if you're writing about Netdata for an external publication, such as a guest blog
100
-post, follow that publication's style guide or standards, while keeping the [preferred spelling of Netdata
101
-terms](#netdata-specific-terms) in mind.
100
+post, follow that publication's style guide or standards, while keeping
101
+the [preferred spelling of Netdata terms](#netdata-specific-terms) in mind.
102
103
### Active voice
104
@@ -106,31 +106,32 @@ Active voice is more concise and easier to understand compared to passive voice.
106
the sentence is action. In passive voice, the subject is acted upon. A famous example of passive voice is the phrase
107
"mistakes were made."
108
109
-| | |
110
-|-----------------|---------------------------------------------------------------------------------------------|
111
-| Not recommended | When an alarm is triggered by a metric, a notification is sent by Netdata. |
112
-| **Recommended** | When a metric triggers an alarm, Netdata sends a notification to your preferred endpoint. |
109
+| | |
110
+|-----------------|-------------------------------------------------------------------------------------------|
111
+| Not recommended | When an alarm is triggered by a metric, a notification is sent by Netdata. |
112
+| **Recommended** | When a metric triggers an alarm, Netdata sends a notification to your preferred endpoint. |
113
114
### Second person
115
116
-Use the second person ("you") to give instructions or "talk" directly to users.
116
+Use the second person ("you") to give instructions or "talk" directly to users.
117
118
In these situations, avoid "we," "I," "let's," and "us," particularly in documentation. The "you" pronoun can also be
119
-implied, depending on your sentence structure.
119
+implied, depending on your sentence structure.
120
121
One valid exception is when a member of the Netdata team or community wants to write about said team or community.
122
123
-| | |
124
-|--------------------------------|-------------------------------------------------------------------------------------------|
125
-| Not recommended | To install Netdata, we should try the one-line installer... |
126
-| **Recommended** | To install Netdata, you should try the one-line installer... |
127
-| **Recommended**, implied "you" | To install Netdata, try the one-line installer... |
123
+| | |
124
+|--------------------------------|--------------------------------------------------------------|
125
+| Not recommended | To install Netdata, we should try the one-line installer... |
126
+| **Recommended** | To install Netdata, you should try the one-line installer... |
127
+| **Recommended**, implied "you" | To install Netdata, try the one-line installer... |
128
129
### "Easy" or "simple"
130
131
-Using words that imply the complexity of a task or feature goes against our policy of [universal
132
-communication](#universal-communication). If you claim that a task is easy and the reader struggles to complete it, you
133
-may inadvertently discourage them.
131
+Using words that imply the complexity of a task or feature goes against our policy
132
+of [universal communication](#universal-communication). If you claim that a task is easy and the reader struggles to
133
+complete it, you
134
+may inadvertently discourage them.
135
136
However, if you give users two options and want to relay that one option is genuinely less complex than another, be
137
specific about how and why.
@@ -163,11 +164,11 @@ See the [word list](#word-list) for spellings of specific words.
164
Follow the general [English standards](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for
165
capitalization. In summary:
166
166
-- Capitalize the first word of every new sentence.
167
-- Don't use uppercase for emphasis. (Netdata is the BEST!)
168
-- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
169
- Docker, Apache, NGINX)
170
-- Avoid camel case (NetData) or all caps (NETDATA).
167
+- Capitalize the first word of every new sentence.
168
+- Don't use uppercase for emphasis. (Netdata is the BEST!)
169
+- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
170
+ Docker, Apache, NGINX)
171
+- Avoid camel case (NetData) or all caps (NETDATA).
172
173
Whenever you refer to the company Netdata, Inc., or the open-source monitoring agent the company develops, capitalize
174
**Netdata**.
@@ -244,10 +245,10 @@ must reflect the _current state of [production](https://app.netdata.cloud).
245
Every link should clearly state its destination. Don't use words like "here" to describe where a link will take your
246
reader.
247
247
-| | |
248
-|-----------------|-------------------------------------------------------------------------------------------|
249
-| Not recommended | To install Netdata, click [here](/packaging/installer/README.md). |
250
-| **Recommended** | To install Netdata, read the [installation instructions](/packaging/installer/README.md). |
248
+| | |
249
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|
250
+| Not recommended | To install Netdata, click [here](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
251
+| **Recommended** | To install Netdata, read the [installation instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
252
253
Use links as often as required to provide necessary context. Blog posts and guides require less hyperlinks than
254
documentation. See the section on [linking between documentation](#linking-between-documentation) for guidance on the
@@ -268,7 +269,7 @@ and desired audience.
269
## Technical/Linux standards
270
271
Configuration or maintenance of the Netdata Agent requires some system administration skills, such as navigating
271
-directories, editing files, or starting/stopping/restarting services. Certain processes
272
+directories, editing files, or starting/stopping/restarting services. Certain processes
273
274
### Switching Linux users
275
@@ -302,16 +303,17 @@ Netdata Agent installation will have commands under the same paths. When applica
303
path, providing a recommendation or instructions on how to view the running configuration, which includes the correct
304
paths.
305
305
-For example, the [configuration](/docs/configure/nodes.md) doc first teaches users how to find the Netdata config
306
+For example, the [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) doc first
307
+teaches users how to find the Netdata config
308
directory and navigate to it, then runs commands from the `/etc/netdata` path so that the instructions are more
309
universal.
310
311
Don't include full paths, beginning from the system's root (`/`), as these might not work on certain systems.
312
311
-| | |
312
-|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
313
-| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
314
-| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
313
+| | |
314
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
315
+| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
316
+| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
317
318
### `sudo`
319
@@ -371,8 +373,8 @@ Some documents, like the Ansible guide and others in the `/docs/guides` folder,
373
this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of the path to the document in question. End
374
the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
375
374
-For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
375
-Ansible](https://learn.netdata.cloud/guides/deploy/ansible).
376
+For example, here is the frontmatter for the guide
377
+about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
378
379
```markdown
380
<!--
@@ -387,8 +389,8 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/depl
389
...
390
```
391
390
-Questions about frontmatter in documentation? [Ask on our community
391
-forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
392
+Questions about frontmatter in
393
+documentation? [Ask on our community forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
394
395
### Linking between documentation
396
@@ -397,7 +399,8 @@ Documentation should link to relevant pages whenever it's relevant and provides
399
Links should always reference the full path to the document, beginning at the root of the Netdata Agent repository
400
(`/`), and ending with the `.md` file extension. Avoid relative links or traversing up directories using `../`.
401
400
-For example, if you want to link to our node configuration document, link to `/docs/configure/nodes.md`. To reference
402
+For example, if you want to link to our node configuration document, link
403
+to `https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md`. To reference
404
the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`.
405
406
### References to UI elements
@@ -421,7 +424,7 @@ In Markdown, use the standard image syntax, `![]()`, and place the alt text betw
424
using our logo:
425
426
```markdown
424
-
427
+
428
```
429
430
Reference in-product text, code samples, and terminal output with actual text content, not screen captures or other
@@ -458,8 +461,8 @@ inline char *health_stock_config_dir(void) {
461
}
462
```
463
461
-Prism also supports titles and line highlighting. See the [Docusaurus
462
-documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
464
+Prism also supports titles and line highlighting. See
465
+the [Docusaurus documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
466
467
## Word list
468
@@ -469,24 +472,24 @@ The following tables describe the standard spelling, capitalization, and usage o
472
473
| Term | Definition |
474
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
472
-| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](/claim/README.md). The claimed node will then appear in your Space and any War Rooms you added it to. |
475
+| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](https://github.com/netdata/netdata/blob/master/claim/README.md). The claimed node will then appear in your Space and any War Rooms you added it to. |
476
| **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use _netdata_ or _NetData_. <br /><br />In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write _Learn more about enabling alarm notifications on your preferred platforms_ instead of _Netdata sends alarm notifications to your preferred platforms_. |
477
| **Netdata Agent** | The free and open source [monitoring agent](https://github.com/netdata/netdata) that you can install on all of your distributed systems, whether they're physical, virtual, containerized, ephemeral, and more. The Agent monitors systems running Linux, Docker, Kubernetes, macOS, FreeBSD, and more, and collects metrics from hundreds of popular services and applications. |
478
| **Netdata Cloud** | The web application hosted at [https://app.netdata.cloud](https://app.netdata.cloud) that helps you monitor an entire infrastructure of distributed systems in real time. <br /><br />Never use _Cloud_ without the preceding _Netdata_ to avoid ambiguity. |
476
-| **Netdata community** | Contributors to any of Netdata's [open-source projects](https://learn.netdata.cloud/contribute/projects), members of the [community forum](https://community.netdata.cloud/). |
479
+| **Netdata community** | Contributors to any of Netdata's [open-source projects](https://github.com/netdata/learn/blob/master/contribute/projects.mdx), members of the [community forum](https://community.netdata.cloud/). |
480
| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
481
| **node** | A system on which the Netdata Agent is installed. The system can be physical, virtual, in a Docker container, and more. Depending on your infrastructure, you may have one, dozens, or hundreds of nodes. Some nodes are _ephemeral_, in that they're created/destroyed automatically by an orchestrator service. |
482
| **Space** | The highest level container within Netdata Cloud for a user to organize their team members and nodes within their infrastructure. A Space likely represents an entire organization or a large team. <br /><br />_Space_ is always capitalized. |
480
-| **unreachable node** | A connected node with a disrupted [Agent-Cloud link](/aclk/README.md). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. |
483
+| **unreachable node** | A connected node with a disrupted [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/aclk/README.md). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. |
484
| **visited node** | A node which has had its Agent dashboard directly visited by a user. A list of these is maintained on a per-user basis. |
485
| **War Room** | A smaller grouping of nodes where users can view key metrics in real-time and monitor the health of many nodes with their alarm status. War Rooms can be used to organize nodes in any way that makes sense for your infrastructure, such as by a service, purpose, physical location, and more. <br /><br />_War Room_ is always capitalized. |
486
487
### Other technical terms
488
486
-| Term | Definition |
487
-|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
488
-| **filesystem** | Use instead of _file system_. |
489
-| **preconfigured** | The concept that many of Netdata's features come with sane defaults that users don't need to configure to find [immediate value](/docs/overview/why-netdata.md#simple-to-deploy). |
490
-| **real time**/**real-time** | Use _real time_ as a noun phrase, most often with _in_: _Netdata collects metrics in real time_. Use _real-time_ as an adjective: _Netdata collects real-time metrics from hundreds of supported applications and services. |
489
+| Term | Definition |
490
+|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
491
+| **filesystem** | Use instead of _file system_. |
492
+| **preconfigured** | The concept that many of Netdata's features come with sane defaults that users don't need to configure to find [immediate value](https://github.com/netdata/netdata/blob/master/docs/overview/why-netdata.md#simple-to-deploy). |
493
+| **real time**/**real-time** | Use _real time_ as a noun phrase, most often with _in_: _Netdata collects metrics in real time_. Use _real-time_ as an adjective: _Netdata collects real-time metrics from hundreds of supported applications and services. |
494
495
docs/dashboard/customize.mdx
+14
-12
@@ -1,8 +1,10 @@
1
---
2
title: "Customize the standard dashboard"
3
-description: "Netdata's preconfigured dashboard offers many customization options, such as choosing when charts are updated, your preferred theme, and custom text to document processes, and more."
3
+description: >-
4
+ "Netdata's preconfigured dashboard offers many customization options, such as choosing when
5
+ charts are updated, your preferred theme, and custom text to document processes, and more."
6
type: "how-to"
5
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/customize.mdx"
7
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx"
8
sidebar_label: "Customize the standard dashboard"
9
learn_status: "Published"
10
learn_topic_type: "Tasks"
@@ -11,7 +13,7 @@ learn_rel_path: "Operations"
13
14
# Customize the standard dashboard
15
14
-While the [Netdata dashboard](/docs/dashboard/how-dashboard-works.mdx) comes preconfigured with hundreds of charts and
16
+While the [Netdata dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx) comes preconfigured with hundreds of charts and
17
thousands of metrics, you may want to alter your experience based on a particular use case or preferences.
18
19
## Dashboard settings
@@ -28,7 +30,7 @@ Here are a few popular settings:
30
31
### Change chart legend position
32
31
-Find this setting under the **Visual** tab. By default, Netdata places the [legend of dimensions](/docs/dashboard/dimensions-contexts-families.mdx#dimension) _below_ charts.
33
+Find this setting under the **Visual** tab. By default, Netdata places the [legend of dimensions](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx#dimension) _below_ charts.
34
Click this toggle to move the legend to the _right_ of charts.
35
36
@@ -71,7 +73,7 @@ Edit the file with customizations to the `title`, `icon`, and `info` fields. Rep
73
icon from [Font Awesome](https://fontawesome.com/cheatsheet) to customize the icons that appear throughout the
74
dashboard.
75
74
-Save the file, then navigate to your [Netdata config directory](/docs/configure/nodes.md) to edit `netdata.conf`. Add
76
+Save the file, then navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) to edit `netdata.conf`. Add
77
the following line to the `[web]` section to tell Netdata where to find your custom configuration.
78
79
```conf
@@ -84,14 +86,14 @@ Reload your browser tab to see your custom configuration.
86
## What's next?
87
88
If you're keen on continuing to customize your Netdata experience, check out our docs on [building new custom
87
-dashboards](/web/gui/custom/README.md) with HTML, CSS, and JavaScript.
89
+dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) with HTML, CSS, and JavaScript.
90
91
### Further reading & related information
92
93
- Dashboard
92
- - [How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)
93
- - [Interact with charts](/docs/dashboard/interact-charts.mdx)
94
- - [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx)
95
- - [Select timeframes to visualize](/docs/dashboard/visualization-date-and-time-controls.mdx)
96
- - [Import, export, and print a snapshot](/docs/dashboard/import-export-print-snapshot.mdx)
97
- - **[Customize the standard dashboard](/docs/dashboard/customize.mdx)**
94
+ - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)
95
+ - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
96
+ - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
97
+ - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx)
98
+ - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx)
99
+ - **[Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)**
docs/dashboard/dimensions-contexts-families.mdx
+19
-17
@@ -1,8 +1,10 @@
1
---
2
title: "Chart dimensions, contexts, and families"
3
-description: "Netdata organizes charts into dimensions, contexts, and families to automatically and meaningfully organize thousands of metrics into interactive charts."
3
+description: >-
4
+ "Netdata organizes charts into dimensions, contexts, and families to automatically
5
+ and meaningfully organize thousands of metrics into interactive charts."
6
type: "explanation"
5
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/dimensions-contexts-families.mdx"
7
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx"
8
sidebar_label: "Chart dimensions, contexts, and families"
9
learn_status: "Published"
10
learn_topic_type: "Concepts"
@@ -11,14 +13,14 @@ learn_rel_path: "Concepts"
13
14
# Chart dimensions, contexts, and families
15
14
-While Netdata's charts require no configuration and are [easy to interact with](/docs/dashboard/interact-charts.mdx),
16
+While Netdata's charts require no configuration and are [easy to interact with](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx),
17
they have a lot of underlying complexity. To meaningfully organize charts out of the box based on what's happening in
18
your nodes, Netdata uses the concepts of **dimensions**, **contexts**, and **families**.
19
20
Understanding how these work will help you more easily navigate the dashboard, [write new
19
-alarms](/docs/monitor/configure-alarms.md), or play around with the [API](/web/api/README.md).
21
+alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or play around with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
22
21
-For a refresher on the anatomy of a chart, see [dashboards and charts](/docs/dashboard/how-dashboard-works.mdx).
23
+For a refresher on the anatomy of a chart, see [dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx).
24
25
## Dimension
26
@@ -40,7 +42,7 @@ dimensions](https://user-images.githubusercontent.com/1153921/114207816-a5cb7400
42
The chart shows 13 unique dimensions, such as `httpd` for the CPU utilization for web servers, `kernel` for anything
43
related to the Linux kernel, and so on. In your dashboard, these specific dimensions will almost certainly be different.
44
43
-Dimensions can be [hidden](/docs/dashboard/interact-charts.mdx#show-and-hide-dimensions) to help you focus your
45
+Dimensions can be [hidden](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx#show-and-hide-dimensions) to help you focus your
46
attention.
47
48
## Context
@@ -54,8 +56,8 @@ whereas anything after the `.` is specified either by the chart's developer or b
56
57
By default, a chart's type affects where it fits in the menu, while its family creates submenus.
58
57
-Netdata also relies on contexts for [alarm configuration](/docs/monitor/configure-alarms.md) (the [`on`
58
-line](/health/REFERENCE.md#alarm-line-on)).
59
+Netdata also relies on contexts for [alarm configuration](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) (the [`on`
60
+line](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-on)).
61
62
## Family
63
@@ -83,18 +85,18 @@ names:
85
## What's next?
86
87
With an understanding of a chart's dimensions, context, and family, you're now ready to dig even deeper into Netdata's
86
-dashboard. We recommend looking into [using the timeframe selector](/docs/dashboard/visualization-date-and-time-controls.mdx).
88
+dashboard. We recommend looking into [using the timeframe selector](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx).
89
88
-If you feel comfortable with the [dashboard](/docs/dashboard/how-dashboard-works.mdx) and interacting with charts, we
89
-recommend learning about [configuration](/docs/configure/nodes.md). While Netdata doesn't _require_ a complicated setup
90
+If you feel comfortable with the [dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx) and interacting with charts, we
91
+recommend learning about [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md). While Netdata doesn't _require_ a complicated setup
92
process or a query language to create charts, there are a lot of ways to tweak the experience to match your needs.
93
94
### Further reading & related information
95
96
- Dashboard
95
- - [How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)
96
- - [Interact with charts](/docs/dashboard/interact-charts.mdx)
97
- - **[Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx)**
98
- - [Select timeframes to visualize](/docs/dashboard/visualization-date-and-time-controls.mdx)
99
- - [Import, export, and print a snapshot](/docs/dashboard/import-export-print-snapshot.mdx)
100
- - [Customize the standard dashboard](/docs/dashboard/customize.mdx)
97
+ - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)
98
+ - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
99
+ - **[Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)**
100
+ - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx)
101
+ - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx)
102
+ - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)
docs/dashboard/how-dashboard-works.mdx
+24
-22
@@ -1,8 +1,10 @@
1
---
2
title: "How the dashboard works"
3
-description: "Learn how to navigate Netdata's preconfigured dashboard to get started exploring, visualizing, and troubleshooting in real time."
3
+description: >-
4
+ "Learn how to navigate Netdata's preconfigured dashboard to get started
5
+ exploring, visualizing, and troubleshooting in real time."
6
type: "explanation"
5
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/how-dashboard-works.mdx"
7
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx"
8
sidebar_label: "How the dashboard works"
9
learn_status: "Published"
10
learn_topic_type: "Concepts"
@@ -14,7 +16,7 @@ learn_rel_path: "Concepts"
16
Because Netdata is a monitoring and _troubleshooting_ platform, a dashboard with real-time, meaningful, and
17
context-aware charts is essential.
18
17
-As soon as you [install Netdata](/docs/get-started.mdx), it autodetects hardware, OS, containers, services, and
19
+As soon as you [install Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx), it autodetects hardware, OS, containers, services, and
20
applications running on your node and builds a dashboard on a single, scrollable webpage. This page features hundreds of
21
charts, which are preconfigured to save you time from learning a query language, all stacked on top of one another. This
22
vertical rhythm is designed to encourage exploration and help you visually identify connections between the metrics
@@ -31,7 +33,7 @@ Access Netdata's dashboard by navigating to `http://NODE:19999` in your browser,
33
35
34
-Many features of the internal web server that serves the dashboard are [configurable](/web/server/README.md), including
36
+Many features of the internal web server that serves the dashboard are [configurable](https://github.com/netdata/netdata/blob/master/web/server/README.md), including
37
the listen port, enforced TLS, and even disabling the dashboard altogether.
38
39
## Sections and menus
@@ -52,12 +54,12 @@ submenus](https://user-images.githubusercontent.com/1153921/80832425-7c528600-8b
54
55
## Charts
56
55
-Every **chart** in the Netdata dashboard is [fully interactive](/docs/dashboard/interact-charts.mdx). Netdata
57
+Every **chart** in the Netdata dashboard is [fully interactive](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx). Netdata
58
synchronizes your interactions to help you understand exactly how a node behaved in any timeframe, whether that's
59
seconds or days.
60
61
A chart is an individual, interactive, always-updating graphic displaying one or more collected/calculated metrics,
60
-which are generated by [collectors](/docs/collect/how-collectors-work.md).
62
+which are generated by [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md).
63
64
@@ -74,7 +76,7 @@ like pushing the current timeframe off the screen to see what came before or aft
76
77
To zoom, press and hold `Shift`, then use your mouse's scroll wheel, or a two-finger pinch if you're using a touchpad.
78
77
-See [interact with charts](/docs/dashboard/interact-charts.mdx) for all the possible ways to interact with the charts on
79
+See [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx) for all the possible ways to interact with the charts on
80
your dashboard.
81
82
## Alarms
@@ -82,7 +84,7 @@ your dashboard.
84
Many of the preconfigured charts on the Netdata dashboard also come with preconfigured alarms. Netdata sends three
85
primary alarm states via alarms: `CLEAR`, `WARNING`, and `CRITICAL`. If an alarm moves from a `CLEAR` state to either
86
`WARNING` or `CRITICAL`, Netdata creates a notification to let you know exactly what's going on. There are [other alarm
85
-states](/health/REFERENCE.md#alarm-statuses) as well.
87
+states](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-statuses) as well.
88
89
The easiest way to see alarms is by clicking on the alarm icon 
@@ -92,25 +94,25 @@ active alarm, and the **Log** tab shows a historical record of exactly when alar
94
96
95
-Learn more about [viewing active alarms](/docs/monitor/view-active-alarms.md), [configuring
96
-alarms](/docs/monitor/configure-alarms.md), or [enabling a new notification
97
-method](/docs/monitor/enable-notifications.md).
97
+Learn more about [viewing active alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md), [configuring
98
+alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or [enabling a new notification
99
+method](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
100
101
## What's next?
102
101
-Learn more about [interacting with charts](/docs/dashboard/interact-charts.mdx) to quickly pan through time, zoom, and
103
+Learn more about [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx) to quickly pan through time, zoom, and
104
show/hide dimensions to best understand the state of your node in any timeframe. A complete understanding of [chart
103
-dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx) will also help with how Netdata
104
-organizes its dashboard and operates [alarms](/docs/monitor/configure-alarms.md).
105
+dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx) will also help with how Netdata
106
+organizes its dashboard and operates [alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
107
108
### Further reading & related information
109
110
- Dashboard
109
- - **[How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)**
110
- - [Interact with charts](/docs/dashboard/interact-charts.mdx)
111
- - [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx)
112
- - [Select timeframes to visualize](/docs/dashboard/visualization-date-and-time-controls.mdx)
113
- - [Import, export, and print a snapshot](/docs/dashboard/import-export-print-snapshot.mdx)
114
- - [Customize the standard dashboard](/docs/dashboard/customize.mdx)
115
-- [HTTP API](/web/api/README.md)
116
-- [Custom dashboards](/web/gui/custom/README.md)
111
+ - **[How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)**
112
+ - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
113
+ - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
114
+ - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx)
115
+ - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx)
116
+ - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)
117
+- [HTTP API](https://github.com/netdata/netdata/blob/master/web/api/README.md)
118
+- [Custom dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md)
docs/dashboard/import-export-print-snapshot.mdx
+14
-11
@@ -1,8 +1,11 @@
1
---
2
title: "Import, export, and print a snapshot"
3
-description: "Snapshots can be incredibly useful for diagnosing anomalies after they've already happened, and are interoperable with any other node running Netdata."
3
+description: >-
4
+ "Snapshots can be incredibly useful for diagnosing anomalies after
5
+ they've already happened, and are interoperable with any other node
6
+ running Netdata."
7
type: "how-to"
5
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/import-export-print-snapshot.mdx"
8
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx"
9
sidebar_label: "Import, export, and print a snapshot"
10
learn_status: "Published"
11
learn_topic_type: "Tasks"
@@ -16,7 +19,7 @@ node running Netdata. Or, you can create a print-ready version of your dashboard
19
paper.
20
21
Snapshots can be incredibly useful for diagnosing anomalies after they've already happened. Let's say Netdata triggered a warning alarm while you were asleep. In the morning, you can [select the
19
-timeframe](/docs/dashboard/visualization-date-and-time-controls.mdx) when the alarm triggered, export a snapshot, and send it to a
22
+timeframe](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx) when the alarm triggered, export a snapshot, and send it to a
23
24
colleague for further analysis.
25
@@ -73,15 +76,15 @@ Netdata opens a browser print dialog for you to save to PDF or print.
76
## What's next?
77
78
Now that you understand snapshots, now is a good time to delve deeper into some of the dashboard's lesser-known
76
-features, such as [customization](/docs/dashboard/customize.mdx) or [building new, custom
77
-dashboards](/web/gui/custom/README.md).
79
+features, such as [customization](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx) or [building new, custom
80
+dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md).
81
82
### Further reading & related information
83
84
- Dashboard
82
- - [How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)
83
- - [Interact with charts](/docs/dashboard/interact-charts.mdx)
84
- - [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx)
85
- - [Select timeframes to visualize](/docs/dashboard/visualization-date-and-time-controls.mdx)
86
- - **[Import, export, and print a snapshot](/docs/dashboard/import-export-print-snapshot.mdx)**
87
- - [Customize the standard dashboard](/docs/dashboard/customize.mdx)
\ No newline at end of file
85
+ - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)
86
+ - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
87
+ - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
88
+ - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx)
89
+ - **[Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx)**
90
+ - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)
\ No newline at end of file
docs/dashboard/interact-charts.mdx
+12
-12
@@ -11,7 +11,7 @@ learn_rel_path: "Operations"
11
12
# Interact with charts
13
14
-> ⚠️ There is a new version of charts that is currently **only** available on [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/visualize/interact-new-charts). We didn't
14
+> ⚠️ There is a new version of charts that is currently **only** available on [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md). We didn't
15
> want to keep this valuable feature from you, so after we get this into your hands on the Cloud, we will collect and implement your feedback to make sure we are providing the best possible version of the feature on the Netdata Agent dashboard as quickly as possible.
16
17
While charts that update every second with new metrics are helpful for understanding the immediate state of a node, deep
@@ -176,26 +176,26 @@ jobs:
176
177
### Future Work
178
179
-We already have [configurable host labels](https://learn.netdata.cloud/guides/using-host-labels) as well, which currently can’t be used to filter or group your metrics. We intend to provide the same capabilities described here with host labels, among other capabilities on other areas of the app as well
179
+We already have [configurable host labels](https://github.com/netdata/netdata/blob/master/docs/guides/using-host-labels.md) as well, which currently can’t be used to filter or group your metrics. We intend to provide the same capabilities described here with host labels, among other capabilities on other areas of the app as well
180
181
## What's next?
182
183
We recommend you read up on the differences between [chart dimensions, contexts, and
184
-families](/docs/dashboard/dimensions-contexts-families.mdx) to complete your understanding of how Netdata organizes its
184
+families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx) to complete your understanding of how Netdata organizes its
185
dashboards. Another valuable way to interact with charts is to use the [timeframe
186
-selector](/docs/dashboard/visualization-date-and-time-controls.mdx), which helps you visualize specific moments of historical metrics.
186
+selector](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx), which helps you visualize specific moments of historical metrics.
187
188
-If you feel comfortable with the [dashboard](/docs/dashboard/how-dashboard-works.mdx) and interacting with charts, we
189
-recommend moving on to learning about [configuration](/docs/configure/nodes.md). While Netdata doesn't _require_ a
188
+If you feel comfortable with the [dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx) and interacting with charts, we
189
+recommend moving on to learning about [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md). While Netdata doesn't _require_ a
190
complicated setup process or a query language to create charts, there are a lot of ways to tweak the experience to match
191
your needs.
192
193
### Further reading & related information
194
195
- Dashboard
196
- - [How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)
197
- - [Netdata Cloud · Interact with new charts](https://learn.netdata.cloud/docs/cloud/visualize/interact-new-charts)
198
- - [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx)
199
- - [Select timeframes to visualize](/docs/dashboard/visualization-date-and-time-controls.mdx)
200
- - [Import, export, and print a snapshot](/docs/dashboard/import-export-print-snapshot.mdx)
201
- - [Customize the standard dashboard](/docs/dashboard/customize.mdx)
196
+ - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)
197
+ - [Netdata Cloud · Interact with new charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
198
+ - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
199
+ - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx)
200
+ - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx)
201
+ - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)
docs/dashboard/reference-web-server.mdx
+10
-10
@@ -16,7 +16,7 @@ This web server respects the `keep-alive` HTTP header to serve multiple HTTP req
16
17
## Configuration
18
19
-From within your Netdata config directory (typically `/etc/netdata`), [use `edit-config`](/docs/configure/nodes.md) to
19
+From within your Netdata config directory (typically `/etc/netdata`), [use `edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) to
20
open `netdata.conf`.
21
22
```
@@ -33,8 +33,8 @@ Scroll down to the `[web]` section to find the following settings.
33
| `ssl certificate` | `/etc/netdata/ssl/cert.pem` | Declare the location of an SSL certificate to [enable HTTPS](#enable-httpstls-support). |
34
| `tls version` | `1.3` | Choose which TLS version to use. While all versions are allowed (`1` or `1.0`, `1.1`, `1.2` and `1.3`), we recommend `1.3` for the most secure encryption. If left blank, Netdata uses the highest available protocol version on your system. |
35
| `tls ciphers` | `none` | Choose which TLS cipher to use. Options include `TLS_AES_256_GCM_SHA384`, `TLS_CHACHA20_POLY1305_SHA256`, and `TLS_AES_128_GCM_SHA256`. If left blank, Netdata uses the default cipher list for that protocol provided by your TLS implementation. |
36
-| `ses max window` | `15` | See [single exponential smoothing](/web/api/queries/ses/README.md). |
37
-| `des max window` | `15` | See [double exponential smoothing](/web/api/queries/des/README.md). |
36
+| `ses max window` | `15` | See [single exponential smoothing](https://github.com/netdata/netdata/blob/master/web/api/queries/ses/README.md). |
37
+| `des max window` | `15` | See [double exponential smoothing](https://github.com/netdata/netdata/blob/master/web/api/queries/des/README.md). |
38
| `mode` | `static-threaded` | Turns on (`static-threaded` or off (`none`) the static-threaded web server. See the [example](#disable-the-web-server) to turn off the web server and disable the dashboard. |
39
| `listen backlog` | `4096` | The port backlog. Check `man 2 listen`. |
40
| `default port` | `19999` | The listen port for the static web server. |
@@ -42,10 +42,10 @@ Scroll down to the `[web]` section to find the following settings.
42
| `web files group` | `netdata` | If this is set, Netdata will check if the file is owned by this group and refuse to serve the file if it's not. |
43
| `disconnect idle clients after seconds` | `60` | The time in seconds to disconnect web clients after being totally idle. |
44
| `timeout for first request` | `60` | How long to wait for a client to send a request before closing the socket. Prevents slow request attacks. |
45
-| `accept a streaming request every seconds` | `0` | Can be used to set a limit on how often a parent node will accept streaming requests from child nodes in a [streaming and replication setup](/streaming/README.md). |
46
-| `respect do not track policy` | `no` | If set to `yes`, Netdata will respect the user's browser preferences for [Do Not Track](https://www.eff.org/issues/do-not-track) (DNT) and storing cookies. If DNT is _enabled_ in the browser, and this option is set to `yes`, users will not be able to sign in to Netdata Cloud via their local Agent dashboard, and their node will not connect to any [registry](/registry/README.md). For certain browsers, users must disable DNT and change this option to `yes` for full functionality. |
45
+| `accept a streaming request every seconds` | `0` | Can be used to set a limit on how often a parent node will accept streaming requests from child nodes in a [streaming and replication setup](https://github.com/netdata/netdata/blob/master/streaming/README.md). |
46
+| `respect do not track policy` | `no` | If set to `yes`, Netdata will respect the user's browser preferences for [Do Not Track](https://www.eff.org/issues/do-not-track) (DNT) and storing cookies. If DNT is _enabled_ in the browser, and this option is set to `yes`, users will not be able to sign in to Netdata Cloud via their local Agent dashboard, and their node will not connect to any [registry](https://github.com/netdata/netdata/blob/master/registry/README.md). For certain browsers, users must disable DNT and change this option to `yes` for full functionality. |
47
| `x-frame-options response header` | ` ` | Avoid [clickjacking attacks](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options), by ensuring that the content is not embedded into other sites. |
48
-| `allow connections from` | `localhost *` | Declare which IP addresses or full-qualified domain names (FQDNs) are allowed to connect to the web server, including the [dashboard](/docs/dashboard/interact-charts.mdx) or [HTTP API](/web/api/README.md). This is a global setting with higher priority to any of the ones below. |
48
+| `allow connections from` | `localhost *` | Declare which IP addresses or full-qualified domain names (FQDNs) are allowed to connect to the web server, including the [dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx) or [HTTP API](https://github.com/netdata/netdata/blob/master/web/api/README.md). This is a global setting with higher priority to any of the ones below. |
49
| `allow connections by dns` | `heuristic` | See the [access list examples](#access-lists) for details on using `allow` settings. |
50
| `allow dashboard from` | `localhost *` | |
51
| `allow dashboard by dns` | `heuristic` | |
@@ -62,7 +62,7 @@ Scroll down to the `[web]` section to find the following settings.
62
| `gzip compression level` | `3` | Valid settings are 1 (fastest) to 9 (best ratio). |
63
| `web server threads` | ` ` | How many processor threads the web server is allowed. The default is system-specific, the minimum of `6` or the number of CPU cores. |
64
| `web server max sockets` | ` ` | Available sockets. The default is system-specific, automatically adjusted to 50% of the max number of open files Netdata is allowed to use (via `/etc/security/limits.conf` or systemd), to allow enough file descriptors to be available for data collection. |
65
-| `custom dashboard_info.js` | ` ` | Specifies the location of a custom `dashboard.js` file. See [customizing the standard dashboard](/docs/dashboard/customize.mdx#customize-the-standard-dashboard) for details. |
65
+| `custom dashboard_info.js` | ` ` | Specifies the location of a custom `dashboard.js` file. See [customizing the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx#customize-the-standard-dashboard) for details. |
66
67
## Examples
68
@@ -102,7 +102,7 @@ Using the above, Netdata will bind to:
102
- IPv4 127.0.0.1 at port 19999 (port was used from `default port`). Only the UI (dashboard) and the read API will be accessible on this port. Both HTTP and HTTPS requests will be accepted.
103
- IPv4 10.1.1.1 at port 19998. The management API and `netdata.conf` will be accessible on this port.
104
- All the IPs `hostname` resolves to (both IPv4 and IPv6 depending on the resolved IPs) at port 19997. Only badges will be accessible on this port.
105
-- All IPv6 IPs at port 19996. Only metric streaming requests from other Netdata agents will be accepted on this port. Only encrypted streams will be allowed (i.e. child nodes also need to be [configured for TLS](/streaming/README.md).
105
+- All IPv6 IPs at port 19996. Only metric streaming requests from other Netdata agents will be accepted on this port. Only encrypted streams will be allowed (i.e. child nodes also need to be [configured for TLS](https://github.com/netdata/netdata/blob/master/streaming/README.md).
106
- All the IPs `localhost` resolves to (both IPv4 and IPv6 depending the resolved IPs) at port 19996. This port will only accept registry API requests.
107
- All IPv4 and IPv6 IPs at port `http` as set in `/etc/services`. Only the UI (dashboard) and the read API will be accessible on this port.
108
- Unix domain socket `/run/netdata/netdata.sock`. All requests are serviceable on this socket. Note that in some OSs like Fedora, every service sees a different `/tmp`, so don't create a Unix socket under `/tmp`. `/run` or `/var/run` is suggested.
@@ -189,7 +189,7 @@ Example:
189
bind to = *=dashboard|registry|badges|management|streaming|netdata.conf^SSL=force
190
```
191
192
-For information how to configure the child to use TLS, check [securing the communication](/streaming/README.md#securing-streaming-communications) in the streaming documentation. There you will find additional details on the expected behavior for client and server nodes, when their respective TLS options are enabled.
192
+For information how to configure the child to use TLS, check [securing the communication](https://github.com/netdata/netdata/blob/master/streaming/README.md#securing-streaming-communications) in the streaming documentation. There you will find additional details on the expected behavior for client and server nodes, when their respective TLS options are enabled.
193
194
When we define the use of SSL in a Netdata agent for different ports, Netdata will apply the behavior specified on each port. For example, using the configuration line below:
195
@@ -245,7 +245,7 @@ Netdata supports access lists in `netdata.conf`:
245
- `allow netdata.conf from` checks the IP to allow `http://netdata.host:19999/netdata.conf`.
246
The IPs listed are all the private IPv4 addresses, including link local IPv6 addresses. Keep in mind that connections to Netdata API ports are filtered by `allow connections from`. So, IPs allowed by `allow netdata.conf from` should also be allowed by `allow connections from`.
247
248
-- `allow management from` checks the IPs to allow API management calls. Management via the API is currently supported for [health](/web/api/health/README.md#health-management-api)
248
+- `allow management from` checks the IPs to allow API management calls. Management via the API is currently supported for [health](https://github.com/netdata/netdata/blob/master/web/api/health/README.md#health-management-api)
249
250
In order to check the FQDN of the connection without opening the Netdata agent to DNS-spoofing, a reverse-dns record
251
must be setup for the connecting host. At connection time the reverse-dns of the peer IP address is resolved, and
docs/dashboard/visualization-date-and-time-controls.mdx
+9
-9
@@ -15,7 +15,7 @@ learn_rel_path: "Concepts"
15
16
### Pick timeframes to visualize
17
18
-While [panning through time and zooming in/out](/docs/dashboard/interact-charts.mdx) from charts it is helpful when
18
+While [panning through time and zooming in/out](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx) from charts it is helpful when
19
you're looking a recent history, or want to do granular troubleshooting, what if you want to see metrics from 6 hours
20
ago? Or 6 days?
21
@@ -103,23 +103,23 @@ beyond stored historical metrics, you'll see this message:
103
105
106
-At any time, [configure the internal TSDB's storage capacity](/docs/store/change-metrics-storage.md) to expand your
106
+At any time, [configure the internal TSDB's storage capacity](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) to expand your
107
depth of historical metrics.
108
109
## What's next?
110
111
One useful next step after selecting a timeframe is [exporting the
112
-metrics](/docs/dashboard/import-export-print-snapshot.mdx) into a snapshot file, which can then be shared and imported
112
+metrics](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx) into a snapshot file, which can then be shared and imported
113
into any other Netdata dashboard.
114
115
-There are also many ways to [customize](/docs/dashboard/customize.mdx) the standard dashboard experience, from changing
115
+There are also many ways to [customize](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx) the standard dashboard experience, from changing
116
the theme to editing the text that accompanies every section of charts.
117
118
## Further reading & related information
119
120
- Dashboard
121
- - [How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)
122
- - [Interact with charts](/docs/dashboard/interact-charts.mdx)
123
- - [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families.mdx)
124
- - [Import, export, and print a snapshot](/docs/dashboard/import-export-print-snapshot.mdx)
125
- - [Customize the standard dashboard](/docs/dashboard/customize.mdx)
121
+ - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)
122
+ - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
123
+ - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
124
+ - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx)
125
+ - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)
docs/export/enable-connector.md
+25
-19
@@ -11,19 +11,21 @@ learn_rel_path: "Setup"
11
# Enable an exporting connector
12
13
Now that you found the right connector for your [external time-series
14
-database](/docs/export/external-databases.md#supported-databases), you can now enable the exporting engine and the
14
+database](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md#supported-databases), you can now enable the exporting engine and the
15
connector itself. We'll walk through the process of enabling the exporting engine itself, followed by two examples using
16
the OpenTSDB and Graphite connectors.
17
18
> When you enable the exporting engine and a connector, the Netdata Agent exports metrics _beginning from the time you
19
-> restart its process_, not the entire [database of long-term metrics](/docs/store/change-metrics-storage.md).
19
+> restart its process_, not the entire
20
+> [database of long-term metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).
21
22
Once you understand the process of enabling a connector, you can translate that knowledge to any other connector.
23
24
## Enable the exporting engine
25
25
-Use `edit-config` from your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) to open
26
-`exporting.conf`:
26
+Use `edit-config` from your
27
+[Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory)
28
+to open `exporting.conf`:
29
30
```bash
31
sudo ./edit-config exporting.conf
@@ -51,14 +53,16 @@ Use the following configuration as a starting point. Copy and paste it into `exp
53
Replace `my_opentsdb_http_instance` with an instance name of your choice, and change the `destination` setting to the IP
54
address or hostname of your OpenTSDB database.
55
54
-Restart your Agent with `sudo systemctl restart netdata`, or the [appropriate
55
-method](/docs/configure/start-stop-restart.md) for your system, to begin exporting to your OpenTSDB database. The
56
+Restart your Agent with `sudo systemctl restart netdata`, or
57
+the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin exporting to your OpenTSDB
58
+database. The
59
Netdata Agent exports metrics _beginning from the time the process starts_, and because it exports as metrics are
60
collected, you should start seeing data in your external database after only a few seconds.
61
62
Any further configuration is optional, based on your needs and the configuration of your OpenTSDB database. See the
60
-[OpenTSDB connector doc](/exporting/opentsdb/README.md) and [exporting engine
61
-reference](/exporting/README.md#configuration) for details.
63
+[OpenTSDB connector doc](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md)
64
+and [exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md#configuration) for
65
+details.
66
67
## Example: Enable the Graphite connector
68
@@ -73,27 +77,29 @@ Use the following configuration as a starting point. Copy and paste it into `exp
77
Replace `my_graphite_instance` with an instance name of your choice, and change the `destination` setting to the IP
78
address or hostname of your Graphite-supported database.
79
76
-Restart your Agent with `sudo systemctl restart netdata`, or the [appropriate
77
-method](/docs/configure/start-stop-restart.md) for your system, to begin exporting to your Graphite-supported database.
80
+Restart your Agent with `sudo systemctl restart netdata`, or
81
+the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin exporting to your
82
+Graphite-supported database.
83
Because the Agent exports metrics as they're collected, you should start seeing data in your external database after
84
only a few seconds.
85
86
Any further configuration is optional, based on your needs and the configuration of your Graphite-supported database.
82
-See [exporting engine reference](/exporting/README.md#configuration) for details.
87
+See [exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md#configuration) for
88
+details.
89
90
## What's next?
91
86
-If you want to further configure your exporting connectors, see the [exporting engine
87
-reference](/exporting/README.md#configuration).
92
+If you want to further configure your exporting connectors, see
93
+the [exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md#configuration).
94
89
-For a comprehensive example of using the Graphite connector, read our guide: [_Export and visualize Netdata metrics in
90
-Graphite_](/docs/guides/export/export-netdata-metrics-graphite.md). Or, start [using host
91
-labels](/docs/guides/using-host-labels.md) on exported metrics.
95
+For a comprehensive example of using the Graphite connector, read our guide:
96
+[_Export and visualize Netdata metrics in Graphite_](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md). Or, start
97
+[using host labels](https://github.com/netdata/netdata/blob/master/docs/guides/using-host-labels.md) on exported metrics.
98
99
### Related reference documentation
100
95
-- [Exporting engine reference](/exporting/README.md)
96
-- [OpenTSDB connector](/exporting/opentsdb/README.md)
97
-- [Graphite connector](/exporting/graphite/README.md)
101
+- [Exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md)
102
+- [OpenTSDB connector](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md)
103
+- [Graphite connector](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md)
104
105
docs/export/external-databases.md
+46
-46
@@ -11,7 +11,7 @@ learn_rel_path: "Concepts"
11
# Export metrics to external time-series databases
12
13
Netdata allows you to export metrics to external time-series databases with the [exporting
14
-engine](/exporting/README.md). This system uses a number of **connectors** to initiate connections to [more than
14
+engine](https://github.com/netdata/netdata/blob/master/exporting/README.md). This system uses a number of **connectors** to initiate connections to [more than
15
thirty](#supported-databases) supported databases, including InfluxDB, Prometheus, Graphite, ElasticSearch, and much
16
more.
17
@@ -22,55 +22,55 @@ Based on your needs and resources you allocated to your external time-series dat
22
that metrics are exported or export only certain charts with filtering. You can also choose whether metrics are exported
23
as-collected, a normalized average, or the sum/volume of metrics values over the configured interval.
24
25
-Exporting is an important part of Netdata's effort to be [interoperable](/docs/overview/netdata-monitoring-stack.md)
25
+Exporting is an important part of Netdata's effort to be [interoperable](https://github.com/netdata/netdata/blob/master/docs/overview/netdata-monitoring-stack.md)
26
with other monitoring software. You can use an external time-series database for long-term metrics retention, further
27
analysis, or correlation with other tools, such as application tracing.
28
29
## Supported databases
30
31
Netdata supports exporting metrics to the following databases through several
32
-[connectors](/exporting/README.md#features). Once you find the connector that works for your database, open its
33
-documentation and the [enabling a connector](/docs/export/enable-connector.md) doc for details on enabling it.
34
-
35
-- **AppOptics**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
36
-- **AWS Kinesis**: [AWS Kinesis Data Streams](/exporting/aws_kinesis/README.md)
37
-- **Azure Data Explorer**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
38
-- **Azure Event Hubs**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
39
-- **Blueflood**: [Graphite](/exporting/graphite/README.md)
40
-- **Chronix**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
41
-- **Cortex**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
42
-- **CrateDB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
43
-- **ElasticSearch**: [Graphite](/exporting/graphite/README.md), [Prometheus remote
44
- write](/exporting/prometheus/remote_write/README.md)
45
-- **Gnocchi**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
46
-- **Google BigQuery**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
47
-- **Google Cloud Pub/Sub**: [Google Cloud Pub/Sub Service](/exporting/pubsub/README.md)
48
-- **Graphite**: [Graphite](/exporting/graphite/README.md), [Prometheus remote
49
- write](/exporting/prometheus/remote_write/README.md)
50
-- **InfluxDB**: [Graphite](/exporting/graphite/README.md), [Prometheus remote
51
- write](/exporting/prometheus/remote_write/README.md)
52
-- **IRONdb**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
53
-- **JSON**: [JSON document databases](/exporting/json/README.md)
54
-- **Kafka**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
55
-- **KairosDB**: [Graphite](/exporting/graphite/README.md), [OpenTSDB](/exporting/opentsdb/README.md)
56
-- **M3DB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
57
-- **MetricFire**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
58
-- **MongoDB**: [MongoDB](/exporting/mongodb/README.md)
59
-- **New Relic**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
60
-- **OpenTSDB**: [OpenTSDB](/exporting/opentsdb/README.md), [Prometheus remote
61
- write](/exporting/prometheus/remote_write/README.md)
62
-- **PostgreSQL**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
32
+[connectors](https://github.com/netdata/netdata/blob/master/exporting/README.md#features). Once you find the connector that works for your database, open its
33
+documentation and the [enabling a connector](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md) doc for details on enabling it.
34
+
35
+- **AppOptics**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
36
+- **AWS Kinesis**: [AWS Kinesis Data Streams](https://github.com/netdata/netdata/blob/master/exporting/aws_kinesis/README.md)
37
+- **Azure Data Explorer**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
38
+- **Azure Event Hubs**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
39
+- **Blueflood**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md)
40
+- **Chronix**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
41
+- **Cortex**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
42
+- **CrateDB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
43
+- **ElasticSearch**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [Prometheus remote
44
+ write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
45
+- **Gnocchi**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
46
+- **Google BigQuery**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
47
+- **Google Cloud Pub/Sub**: [Google Cloud Pub/Sub Service](https://github.com/netdata/netdata/blob/master/exporting/pubsub/README.md)
48
+- **Graphite**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [Prometheus remote
49
+ write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
50
+- **InfluxDB**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [Prometheus remote
51
+ write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
52
+- **IRONdb**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
53
+- **JSON**: [JSON document databases](https://github.com/netdata/netdata/blob/master/exporting/json/README.md)
54
+- **Kafka**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
55
+- **KairosDB**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [OpenTSDB](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md)
56
+- **M3DB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
57
+- **MetricFire**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
58
+- **MongoDB**: [MongoDB](https://github.com/netdata/netdata/blob/master/exporting/mongodb/README.md)
59
+- **New Relic**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
60
+- **OpenTSDB**: [OpenTSDB](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md), [Prometheus remote
61
+ write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
62
+- **PostgreSQL**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
63
via [PostgreSQL Prometheus Adapter](https://github.com/CrunchyData/postgresql-prometheus-adapter)
64
-- **Prometheus**: [Prometheus scraper](/exporting/prometheus/README.md)
65
-- **TimescaleDB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md),
66
- [netdata-timescale-relay](/exporting/TIMESCALE.md)
67
-- **QuasarDB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
68
-- **SignalFx**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
69
-- **Splunk**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
70
-- **TiKV**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
71
-- **Thanos**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
72
-- **VictoriaMetrics**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
73
-- **Wavefront**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
64
+- **Prometheus**: [Prometheus scraper](https://github.com/netdata/netdata/blob/master/exporting/prometheus/README.md)
65
+- **TimescaleDB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md),
66
+ [netdata-timescale-relay](https://github.com/netdata/netdata/blob/master/exporting/TIMESCALE.md)
67
+- **QuasarDB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
68
+- **SignalFx**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
69
+- **Splunk**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
70
+- **TiKV**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
71
+- **Thanos**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
72
+- **VictoriaMetrics**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
73
+- **Wavefront**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md)
74
75
Can't find your preferred external time-series database? Ask our [community](https://community.netdata.cloud/) for
76
solutions, or file an [issue on
@@ -78,16 +78,16 @@ GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cne
78
79
## What's next?
80
81
-We recommend you read our document on [enabling a connector](/docs/export/enable-connector.md) to learn about the
81
+We recommend you read our document on [enabling a connector](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md) to learn about the
82
process and discover important configuration options. If you would rather skip ahead, click on any of the above links to
83
connectors for their reference documentation, which outline any prerequisites to install for that connector, along with
84
connector-specific configuration options.
85
86
Read about one possible use case for exporting metrics in our guide: [_Export and visualize Netdata metrics in
87
-Graphite_](/docs/guides/export/export-netdata-metrics-graphite.md).
87
+Graphite_](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md).
88
89
### Related reference documentation
90
91
-- [Exporting engine reference](/exporting/README.md)
91
+- [Exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md)
92
93
docs/get-started.mdx
+5
-4
@@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
16
Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from
17
any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.
18
19
-Together with [Netdata Cloud](https://learn.netdata.cloud/docs/cloud), you can monitor your entire infrastructure in
19
+Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can monitor your entire infrastructure in
20
real time and troubleshoot problems that threaten the health of your nodes.
21
22
Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. It
@@ -108,13 +108,14 @@ to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/da
108
### Configuration
109
110
Discover the recommended way to [configure Netdata's settings or behavior](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) using our built-in
111
-`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).
111
+`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores
112
+metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).
113
114
### Data collection
115
116
If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should
116
-learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md).
117
-If there's a [supported collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
117
+learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md). If there's a [supported
118
+collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
119
or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
120
121
### Alarms & notifications
docs/getting-started/introduction.md
+8
-8
@@ -71,12 +71,12 @@ Netdata works with tons of applications, notifications platforms, and other time
71
72
- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
73
immediately visualize them into meaningful charts designed for troubleshooting. See [everything we
74
- support](https://learn.netdata.cloud/docs/agent/collectors/collectors).
74
+ support](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
75
- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
76
- platform](https://learn.netdata.cloud/docs/monitor/enable-notifications) to inform you of anomalies just seconds
76
+ platform](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to inform you of anomalies just seconds
77
after they affect your node.
78
- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
79
- Cloud-based databases](https://learn.netdata.cloud/docs/export/external-databases) for best-in-class
79
+ Cloud-based databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) for best-in-class
80
interoperability.
81
82
@@ -113,7 +113,7 @@ While Netdata Cloud offers a centralized method of monitoring your Agents, your
113
114
## Community
115
116
-Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://learn.netdata.cloud/contribute/code-of-conduct).
116
+Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
117
118
Find most of the Netdata team in our [community forums](https://community.netdata.cloud). It's the best place to
119
ask questions, find resources, and engage with passionate professionals. The team is also available and active in our [Discord](https://discord.com/invite/mPZ6WZKKG2) too.
@@ -133,18 +133,18 @@ You can also find Netdata on:
133
134
Contributions are the lifeblood of open-source projects. While we continue to invest in and improve Netdata, we need help to democratize monitoring!
135
136
-- Read our [Contributing Guide](https://learn.netdata.cloud/contribute/handbook), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums!
136
+- Read our [Contributing Guide](https://github.com/netdata/.github/blob/main/CONTRIBUTING.md), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums!
137
- We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9)
138
- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=%5BBug%5D%3A+).
139
- View our [Security Policy](https://github.com/netdata/netdata/security/policy).
140
141
-Package maintainers should read the guide on [building Netdata from source](/packaging/installer/methods/source.md) for
141
+Package maintainers should read the guide on [building Netdata from source](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md) for
142
instructions on building each Netdata component from source and preparing a package.
143
144
## License
145
146
-The Netdata Agent is an open source project distributed under [GPLv3+](/LICENSE). Netdata re-distributes other open-source tools and libraries. Please check the
147
-[third party licenses](/REDISTRIBUTED.md).
146
+The Netdata Agent is an open source project distributed under [GPLv3+](https://github.com/netdata/netdata/blob/master/LICENSE). Netdata re-distributes other open-source tools and libraries. Please check the
147
+[third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).
148
149
## Is it any good?
150
docs/guidelines.md
+6
-6
@@ -281,7 +281,7 @@ Here you can see how the metadata are parsed and create a markdown file in learn
281
### Before you get started
282
283
Anyone interested in contributing to documentation should first read the [Netdata style guide](#styling-guide) further
284
-down below and the [Netdata Community Code of Conduct](/contribute/code-of-conduct).
284
+down below and the [Netdata Community Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
285
286
Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read
287
the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on
@@ -324,7 +324,7 @@ git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git
324
```
325
326
Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping
327
-the [Netdata style guide](/contribute/style-guide) in mind. Add, commit, and push changes to your fork. When you're
327
+the [Netdata style guide](https://github.com/netdata/netdata/blob/master/docs/contributing/style-guide.md) in mind. Add, commit, and push changes to your fork. When you're
328
finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull request
329
based on the changes you made in the new branch of your fork.
330
@@ -680,8 +680,8 @@ reader.
680
681
| | |
682
| --------------- | ------------------------------------------------------------------------------------------ |
683
-| Not recommended | To install Netdata, click [here](/docs/agent/packaging/installer). |
684
-| **Recommended** | To install Netdata, read the [installation instructions](/docs/agent/packaging/installer). |
683
+| Not recommended | To install Netdata, click [here](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
684
+| **Recommended** | To install Netdata, read the [installation instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
685
686
Use links as often as required to provide necessary context. Blog posts and guides require less hyperlinks than
687
documentation. See the section on [linking between documentation](#linking-between-documentation) for guidance on the
@@ -732,7 +732,7 @@ Netdata Agent installation will have commands under the same paths. When applica
732
path, providing a recommendation or instructions on how to view the running configuration, which includes the correct
733
paths.
734
735
-For example, the [configuration](/docs/configure/nodes) doc first teaches users how to find the Netdata config directory
735
+For example, the [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) doc first teaches users how to find the Netdata config directory
736
and navigate to it, then runs commands from the `/etc/netdata` path so that the instructions are more universal.
737
738
Don't include full paths, beginning from the system's root (`/`), as these might not work on certain systems.
@@ -741,7 +741,7 @@ Don't include full paths, beginning from the system's root (`/`), as these might
741
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
742
| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
743
| **
744
-Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](/docs/configure/nodes#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
744
+Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
745
746
#### `sudo`
747
docs/guides/collect-apache-nginx-web-logs.md
+5
-5
@@ -16,7 +16,7 @@ You can use the [LTSV log format](http://ltsv.org/), track TLS and cipher usage,
16
ever. In one test on a system with SSD storage, the collector consistently parsed the logs for 200,000 requests in
17
200ms, using ~30% of a single core.
18
19
-The [web_log](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/) collector is currently compatible
19
+The [web_log](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md) collector is currently compatible
20
with [Nginx](https://nginx.org/en/) and [Apache](https://httpd.apache.org/).
21
22
This guide will walk you through using the new Go-based web log collector to turn the logs these web servers
@@ -90,7 +90,7 @@ jobs:
90
```
91
92
Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
93
-method](/docs/configure/start-stop-restart.md) for your system. Netdata should pick up your web server's access log and
93
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. Netdata should pick up your web server's access log and
94
begin showing real-time charts!
95
96
### Custom log formats and fields
@@ -99,7 +99,7 @@ The web log collector is capable of parsing custom Nginx and Apache log formats
99
leave that topic for a separate guide.
100
101
We do have [extensive
102
-documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/#custom-log-format) on how
102
+documentation](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md#custom-log-format) on how
103
to build custom parsing for Nginx and Apache logs.
104
105
## Tweak web log collector alarms
@@ -117,11 +117,11 @@ You can also edit this file directly with `edit-config`:
117
```
118
119
For more information about editing the defaults or writing new alarm entities, see our [health monitoring
120
-documentation](/health/README.md).
120
+documentation](https://github.com/netdata/netdata/blob/master/health/README.md).
121
122
## What's next?
123
124
-Now that you have web log collection up and running, we recommend you take a look at the collector's [documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/) for some ideas of how you can turn these rather "boring" logs into powerful real-time tools for keeping your servers happy.
124
+Now that you have web log collection up and running, we recommend you take a look at the collector's [documentation](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md) for some ideas of how you can turn these rather "boring" logs into powerful real-time tools for keeping your servers happy.
125
126
Don't forget to give GitHub user [Wing924](https://github.com/Wing924) a big 👍 for his hard work in starting up the Go
127
refactoring effort.
docs/guides/collect-unbound-metrics.md
+2
-2
@@ -55,7 +55,7 @@ You may not need to do any more configuration to have Netdata collect your Unbou
55
56
If you followed the steps above to enable `remote-control` and make your Unbound files readable by Netdata, that should
57
be enough. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
58
-method](/docs/configure/start-stop-restart.md) for your system. You should see Unbound metrics in your Netdata
58
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. You should see Unbound metrics in your Netdata
59
dashboard!
60
61
@@ -100,7 +100,7 @@ Netdata will attempt to read `unbound.conf` to get the appropriate `address`, `c
100
`tls_key` parameters.
101
102
Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
103
-method](/docs/configure/start-stop-restart.md) for your system.
103
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
104
105
### Manual setup for a remote Unbound server
106
docs/guides/configure/performance.md
+17
-17
@@ -18,7 +18,7 @@ threads. Despite collecting 100,000 metrics every second, the Agent still only u
18
single core.
19
20
But not everyone has such powerful systems at their disposal. For example, you might run the Agent on a cloud VM with
21
-only 512 MiB of RAM, or an IoT device like a [Raspberry Pi](/docs/guides/monitor/pi-hole-raspberry-pi.md). In these
21
+only 512 MiB of RAM, or an IoT device like a [Raspberry Pi](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/pi-hole-raspberry-pi.md). In these
22
cases, reducing Netdata's footprint beyond its already diminutive size can pay big dividends, giving your services more
23
horsepower while still monitoring the health and the performance of the node, OS, hardware, and applications.
24
@@ -33,7 +33,7 @@ enabled, since we want you to experience the full thing.
33
- Familiarity with configuring the Netdata Agent with `edit-config`.
34
35
If you're not familiar with how to configure the Netdata Agent, read our [node configuration
36
-doc](/docs/configure/nodes.md) before continuing with this guide. This guide assumes familiarity with the Netdata config
36
+doc](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) before continuing with this guide. This guide assumes familiarity with the Netdata config
37
directory, using `edit-config`, and the process of uncommenting/editing various settings in `netdata.conf` and other
38
configuration files.
39
@@ -43,11 +43,11 @@ Netdata's performance is primarily affected by **data collection/retention** and
43
44
You can configure almost all aspects of data collection/retention, and certain aspects of clients accessing data. For
45
example, you can't control how many users might be viewing a local Agent dashboard, [viewing an
46
-infrastructure](/docs/visualize/overview-infrastructure.md) in real-time with Netdata Cloud, or running [Metric
47
-Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations).
46
+infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) in real-time with Netdata Cloud, or running [Metric
47
+Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md).
48
49
The Netdata Agent runs with the lowest possible [process scheduling
50
-policy](/daemon/README.md#netdata-process-scheduling-policy), which is `nice 19`, and uses the `idle` process scheduler.
50
+policy](https://github.com/netdata/netdata/blob/master/daemon/README.md#netdata-process-scheduling-policy), which is `nice 19`, and uses the `idle` process scheduler.
51
Together, these settings ensure that the Agent only gets CPU resources when the node has CPU resources to space. If the
52
node reaches 100% CPU utilization, the Agent is stopped first to ensure your applications get any available resources.
53
In addition, under heavy load, collectors that require disk I/O may stop and show gaps in charts.
@@ -80,10 +80,10 @@ seconds, respectively.
80
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
81
`python.d.conf`, or `charts.d.conf` files, or in individual collector configuration files. If the `update
82
every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See the [enable
83
-or configure a collector](/docs/collect/enable-configure.md) doc for details.
83
+or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) doc for details.
84
85
To reduce the frequency of an [internal
86
-plugin/collector](/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), open `netdata.conf` and
86
+plugin/collector](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), open `netdata.conf` and
87
find the appropriate section. For example, to reduce the frequency of the `apps` plugin, which collects and visualizes
88
metrics on application resource utilization:
89
@@ -92,7 +92,7 @@ metrics on application resource utilization:
92
update every = 5
93
```
94
95
-To [configure an individual collector](/docs/collect/enable-configure.md), open its specific configuration file with
95
+To [configure an individual collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md), open its specific configuration file with
96
`edit-config` and look for the `update_every` setting. For example, to reduce the frequency of the `nginx` collector,
97
run `sudo ./edit-config go.d/nginx.conf`:
98
@@ -104,7 +104,7 @@ update_every: 10
104
## Disable unneeded plugins or collectors
105
106
If you know that you don't need an [entire plugin or a specific
107
-collector](/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), you can disable any of them.
107
+collector](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), you can disable any of them.
108
Keep in mind that if a plugin/collector has nothing to do, it simply shuts down and does not consume system resources.
109
You will only improve the Agent's performance by disabling plugins/collectors that are actively collecting metrics.
110
@@ -139,7 +139,7 @@ modules:
139
140
## Lower memory usage for metrics retention
141
142
-Reduce the disk space that the [database engine](/database/engine/README.md) uses to retain metrics by editing
142
+Reduce the disk space that the [database engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md) uses to retain metrics by editing
143
the `dbengine multihost disk space` option in `netdata.conf`. The default value is `256`, but can be set to a minimum of
144
`64`. By reducing the disk space allocation, Netdata also needs to store less metadata in the node's memory.
145
@@ -147,7 +147,7 @@ The `page cache size` option also directly impacts Netdata's memory usage, but h
147
148
Reducing the value of `dbengine multihost disk space` does slim down Netdata's resource usage, but it also reduces how
149
long Netdata retains metrics. Find the right balance of performance and metrics retention by using the [dbengine
150
-calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics).
150
+calculator](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics).
151
152
All the settings are found in the `[global]` section of `netdata.conf`:
153
@@ -187,11 +187,11 @@ with the following:
187
188
## Run Netdata behind Nginx
189
190
-A dedicated web server like Nginx provides far more robustness than the Agent's internal [web server](/web/README.md).
190
+A dedicated web server like Nginx provides far more robustness than the Agent's internal [web server](https://github.com/netdata/netdata/blob/master/web/README.md).
191
Nginx can handle more concurrent connections, reuse idle connections, and use fast gzip compression to reduce payloads.
192
193
For details on installing Nginx as a proxy for the local Agent dashboard, see our [Nginx
194
-doc](/docs/Running-behind-nginx.md).
194
+doc](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md).
195
196
After you complete Nginx setup according to the doc linked above, we recommend setting `keepalive` to `1024`, and using
197
gzip compression with the following options in the `location /` block:
@@ -264,14 +264,14 @@ On the child nodes you should add to `netdata.conf` the following:
264
265
We hope this guide helped you better understand how to optimize the performance of the Netdata Agent.
266
267
-Now that your Agent is running smoothly, we recommend you [secure your nodes](/docs/configure/nodes.md) if you haven't
267
+Now that your Agent is running smoothly, we recommend you [secure your nodes](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) if you haven't
268
already.
269
270
Next, dive into some of Netdata's more complex features, such as configuring its health watchdog or exporting metrics to
271
an external time-series database.
272
273
-- [Interact with dashboards and charts](/docs/visualize/interact-dashboards-charts.md)
274
-- [Configure health alarms](/docs/monitor/configure-alarms.md)
275
-- [Export metrics to external time-series databases](/docs/export/external-databases.md)
273
+- [Interact with dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md)
274
+- [Configure health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md)
275
+- [Export metrics to external time-series databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md)
276
277
[](<>)
docs/guides/deploy/ansible.md
+9
-9
@@ -11,7 +11,7 @@ learn_rel_path: "Installation"
11
12
# Deploy Netdata with Ansible
13
14
-Netdata's [one-line kickstart](/docs/get-started.mdx) is zero-configuration, highly adaptable, and compatible with tons
14
+Netdata's [one-line kickstart](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) is zero-configuration, highly adaptable, and compatible with tons
15
of different operating systems and Linux distributions. You can use it on bare metal, VMs, containers, and everything
16
in-between.
17
@@ -105,8 +105,8 @@ two different SSH keys supplied by AWS.
105
### Edit the `vars/main.yml` file
106
107
In order to connect your node(s) to your Space in Netdata Cloud, and see all their metrics in real-time in [composite
108
-charts](/docs/visualize/overview-infrastructure.md) or perform [Metric
109
-Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations), you need to set the `claim_token`
108
+charts](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) or perform [Metric
109
+Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md), you need to set the `claim_token`
110
and `claim_room` variables.
111
112
To find your `claim_token` and `claim_room`, go to Netdata Cloud, then click on your Space's name in the top navigation,
@@ -131,7 +131,7 @@ hostname of the node, the playbook disables that local dashboard by setting `web
131
security boost by not allowing any unwanted access to the local dashboard.
132
133
You can read more about this decision, or other ways you might lock down the local dashboard, in our [node security
134
-doc](https://learn.netdata.cloud/docs/configure/secure-nodes).
134
+doc](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md).
135
136
> Curious about why Netdata's dashboard is open by default? Read our [blog
137
> post](https://www.netdata.cloud/blog/netdata-agent-dashboard/) on that zero-configuration design decision.
@@ -166,11 +166,11 @@ want to do with Netdata, so use those categories to dive in.
166
167
Some of the best places to start:
168
169
-- [Enable or configure a collector](/docs/collect/enable-configure.md)
170
-- [Supported collectors list](/collectors/COLLECTORS.md)
171
-- [See an overview of your infrastructure](/docs/visualize/overview-infrastructure.md)
172
-- [Interact with dashboards and charts](/docs/visualize/interact-dashboards-charts.md)
173
-- [Change how long Netdata stores metrics](/docs/store/change-metrics-storage.md)
169
+- [Enable or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
170
+- [Supported collectors list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md)
171
+- [See an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md)
172
+- [Interact with dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md)
173
+- [Change how long Netdata stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md)
174
175
We're looking for more deployment and configuration management strategies, whether via Ansible or other
176
provisioning/infrastructure as code software, such as Chef or Puppet, in our [community
docs/guides/export/export-netdata-metrics-graphite.md
+21
-23
@@ -13,9 +13,10 @@ action on these metrics, you may need to develop a stack of monitoring tools tha
13
anomalies and discover root causes faster.
14
15
We designed Netdata with interoperability in mind. The Agent collects thousands of metrics every second, and then what
16
-you do with them is up to you. You can [store metrics in the database engine](/docs/guides/longer-metrics-storage.md),
17
-or send them to another time series database for long-term storage or further analysis using Netdata's [exporting
18
-engine](/docs/export/external-databases.md).
16
+you do with them is up to you. You
17
+can [store metrics in the database engine](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md),
18
+or send them to another time series database for long-term storage or further analysis using
19
+Netdata's [exporting engine](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md).
20
21
In this guide, we'll show you how to export Netdata metrics to [Graphite](https://graphiteapp.org/) for long-term
22
storage and further analysis. Graphite is a free open-source software (FOSS) tool that collects graphs numeric
@@ -29,7 +30,8 @@ Let's get started.
30
31
## Install the Netdata Agent
32
32
-If you don't have the Netdata Agent installed already, visit the [installation guide](/packaging/installer/README.md)
33
+If you don't have the Netdata Agent installed already, visit
34
+the [installation guide](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md)
35
for the recommended instructions for your system. In most cases, you can use the one-line installation script:
36
37
<OneLineInstallWget/>
@@ -63,8 +65,7 @@ docker run -d \
65
Open your browser and navigate to `http://NODE`, to see the Graphite interface. Nothing yet, but we'll fix that soon
66
enough.
67
66
-
68
+
69
70
## Enable the Graphite exporting connector
71
@@ -115,7 +116,8 @@ the port accordingly.
116
```
117
118
We'll not worry about the rest of the settings for now. Restart the Agent using `sudo systemctl restart netdata`, or the
118
-[appropriate method](/docs/configure/start-stop-restart.md) for your system, to spin up the exporting engine.
119
+[appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your
120
+system, to spin up the exporting engine.
121
122
## See and organize Netdata metrics in Graphite
123
@@ -125,8 +127,7 @@ metrics. You can also navigate directly to `http://NODE/dashboard`.
127
Let's switch the interface to help you understand which metrics Netdata is exporting to Graphite. Click on **Dashboard**
128
and **Configure UI**, then choose the **Tree** option. Refresh your browser to change the UI.
129
128
-
130
+
131
132
You should now see a tree of available contexts, including one that matches the hostname of the Agent exporting metrics.
133
In this example, the Agent's hostname is `arcturus`.
@@ -138,46 +139,43 @@ in the dashboard. Add a few other system CPU charts to flesh things out.
139
Next, let's combine one or two of these charts. Click and drag one chart onto the other, and wait until the green **Drop
140
to merge** dialog appears. Release to merge the charts.
141
141
-
142
+
143
144
Finally, save your dashboard. Click **Dashboard**, then **Save As**, then choose a name. Your dashboard is now saved.
145
146
Of course, this is just the beginning of the customization you can do with Graphite. You can change the time range,
147
share your dashboard with others, or use the composer to customize the size and appearance of specific charts. Learn
148
-more about adding, modifying, and combining graphs in the [Graphite
149
-docs](https://graphite.readthedocs.io/en/latest/dashboard.html).
148
+more about adding, modifying, and combining graphs in
149
+the [Graphite docs](https://graphite.readthedocs.io/en/latest/dashboard.html).
150
151
## Monitor the exporting engine
152
153
As soon as the exporting engine begins, Netdata begins reporting metrics about the system's health and performance.
154
155
-
155
+
156
157
You can use these charts to verify that Netdata is properly exporting metrics to Graphite. You can even add these
158
exporting charts to your Graphite dashboard!
159
160
### Add exporting charts to Netdata Cloud
161
163
-You can also show these exporting engine metrics on Netdata Cloud. If you don't have an account already, go [sign
164
-in](https://app.netdata.cloud) and get started for free. If you need some help along the way, read the [get started with
165
-Cloud guide](https://learn.netdata.cloud/docs/cloud/get-started).
162
+You can also show these exporting engine metrics on Netdata Cloud. If you don't have an account already,
163
+go [sign in](https://app.netdata.cloud) and get started for free. If you need some help along the way, read
164
+the [get started with Cloud guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
165
166
Add more metrics to a War Room's Nodes view by clicking on the **Add metric** button, then typing `exporting` into the
167
context field. Choose the exporting contexts you want to add, then click **Add**. You'll see these charts alongside any
168
others you've customized in Netdata Cloud.
169
171
-
170
+
171
172
## What's next?
173
174
What you do with your exported metrics is entirely up to you, but as you might have seen in the Graphite connector
175
configuration block, there are many other ways to tweak and customize which metrics you export to Graphite and how
178
-often.
176
+often.
177
180
-For full details about each configuration option and what it does, see the [exporting reference
181
-guide](/exporting/README.md).
178
+For full details about each configuration option and what it does, see
179
+the [exporting reference guide](https://github.com/netdata/netdata/blob/master/exporting/README.md).
180
181
docs/guides/monitor-cockroachdb.md
+20
-23
@@ -6,8 +6,9 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/moni
6
# Monitor CockroachDB metrics with Netdata
7
8
[CockroachDB](https://github.com/cockroachdb/cockroach) is an open-source project that brings SQL databases into
9
-scalable, disaster-resilient cloud deployments. Thanks to a [new CockroachDB
10
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/) released in
9
+scalable, disaster-resilient cloud deployments. Thanks to
10
+a [new CockroachDB collector](https://github.com/netdata/go.d.plugin/blob/master/modules/cockroachdb/README.md)
11
+released in
12
[v1.20](https://blog.netdata.cloud/posts/release-1.20/), you can now monitor any number of CockroachDB databases with
13
maximum granularity using Netdata. Collect more than 50 unique metrics and put them on interactive visualizations
14
designed for better visual anomaly detection.
@@ -19,9 +20,9 @@ Let's dive in and walk through the process of monitoring CockroachDB metrics wit
20
21
## What's in this guide
22
22
-- [Configure the CockroachDB collector](#configure-the-cockroachdb-collector)
23
- - [Manual setup for a local CockroachDB database](#manual-setup-for-a-local-cockroachdb-database)
24
-- [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms)
23
+- [Configure the CockroachDB collector](#configure-the-cockroachdb-collector)
24
+ - [Manual setup for a local CockroachDB database](#manual-setup-for-a-local-cockroachdb-database)
25
+- [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms)
26
27
## Configure the CockroachDB collector
28
@@ -31,7 +32,7 @@ display them on the dashboard.
32
33
If your CockroachDB instance is accessible through `http://localhost:8080/` or `http://127.0.0.1:8080`, your setup is
34
complete. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
34
-method](/docs/configure/start-stop-restart.md) for your system, and refresh your browser. You should see CockroachDB
35
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, and refresh your browser. You should see CockroachDB
36
metrics in your Netdata dashboard!
37
38
<figure>
@@ -59,8 +60,8 @@ edit, or create a new job with any of the parameters listed above in the file. B
60
required, and everything else is optional.
61
62
For a production cluster, you'll use either an IP address or the system's hostname. Be sure that your remote system
62
-allows TCP communication on port 8080, or whichever port you have configured CockroachDB's [Admin
63
-UI](https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint) to listen on.
63
+allows TCP communication on port 8080, or whichever port you have configured CockroachDB's
64
+[Admin UI](https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint) to listen on.
65
66
```yaml
67
# [ JOBS ]
@@ -80,7 +81,7 @@ jobs:
81
- name: remote
82
url: https://203.0.113.0:8080/_status/vars
83
tls_skip_verify: yes # If your certificate is self-signed
83
-
84
+
85
- name: remote_hostname
86
url: https://cockroachdb.example.com:8080/_status/vars
87
tls_skip_verify: yes # If your certificate is self-signed
@@ -109,28 +110,24 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et
110
```
111
112
For more information about editing the defaults or writing new alarm entities, see our health monitoring [quickstart
112
-guide](/health/QUICKSTART.md).
113
+guide](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md).
114
115
## What's next?
116
117
Now that you're collecting metrics from your CockroachDB databases, let us know how it's working for you! There's always
118
room for improvement or refinement based on real-world use cases. Feel free to [file an
118
-issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) with your
119
+issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) with
120
+your
121
thoughts.
122
123
Also, be sure to check out these useful resources:
124
123
-- [Netdata's CockroachDB
124
- documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/)
125
-- [Netdata's CockroachDB
126
- configuration](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/cockroachdb.conf)
127
-- [Netdata's CockroachDB
128
- alarms](https://github.com/netdata/netdata/blob/29d9b5e51603792ee27ef5a21f1de0ba8e130158/health/health.d/cockroachdb.conf)
129
-- [CockroachDB homepage](https://www.cockroachlabs.com/product/)
130
-- [CockroachDB documentation](https://www.cockroachlabs.com/docs/stable/)
131
-- [`_status/vars` endpoint
132
- docs](https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint)
133
-- [Monitor CockroachDB with
134
- Prometheus](https://www.cockroachlabs.com/docs/stable/monitor-cockroachdb-with-prometheus.html)
125
+- [Netdata's CockroachDB documentation](https://github.com/netdata/go.d.plugin/blob/master/modules/cockroachdb/README.md)
126
+- [Netdata's CockroachDB configuration](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/cockroachdb.conf)
127
+- [Netdata's CockroachDB alarms](https://github.com/netdata/netdata/blob/29d9b5e51603792ee27ef5a21f1de0ba8e130158/health/health.d/cockroachdb.conf)
128
+- [CockroachDB homepage](https://www.cockroachlabs.com/product/)
129
+- [CockroachDB documentation](https://www.cockroachlabs.com/docs/stable/)
130
+- [`_status/vars` endpoint docs](https://www.cockroachlabs.com/docs/stable/monitoring-and-alerting.html#prometheus-endpoint)
131
+- [Monitor CockroachDB with Prometheus](https://www.cockroachlabs.com/docs/stable/monitor-cockroachdb-with-prometheus.html)
132
133
docs/guides/monitor-hadoop-cluster.md
+4
-4
@@ -23,8 +23,8 @@ alternative, like the guide available from
23
24
For more specifics on the collection modules used in this guide, read the respective pages in our documentation:
25
26
-- [HDFS](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/hdfs)
27
-- [Zookeeper](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/zookeeper)
26
+- [HDFS](https://github.com/netdata/go.d.plugin/blob/master/modules/hdfs/README.md)
27
+- [Zookeeper](https://github.com/netdata/go.d.plugin/blob/master/modules/zookeeper/README.md)
28
29
## Set up your HDFS and Zookeeper installations
30
@@ -160,7 +160,7 @@ jobs:
160
address : 203.0.113.10:2182
161
```
162
163
-Finally, [restart Netdata](/docs/configure/start-stop-restart.md).
163
+Finally, [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
164
165
```sh
166
sudo systemctl restart netdata
@@ -185,7 +185,7 @@ sudo /etc/netdata/edit-config health.d/zookeeper.conf
185
```
186
187
For more information about editing the defaults or writing new alarm entities, see our [health monitoring
188
-documentation](/health/README.md).
188
+documentation](https://github.com/netdata/netdata/blob/master/health/README.md).
189
190
## What's next?
191
docs/guides/monitor/anomaly-detection-python.md
+18
-18
@@ -23,7 +23,7 @@ library](https://github.com/yzhao062/pyod/tree/master), which periodically runs
23
quantify how anomalous certain charts are.
24
25
All these metrics and alarms are available for centralized monitoring in [Netdata Cloud](https://app.netdata.cloud). If
26
-you choose to sign up for Netdata Cloud and [connect your nodes](/claim/README.md), you will have the ability to run
26
+you choose to sign up for Netdata Cloud and [connect your nodes](https://github.com/netdata/netdata/blob/master/claim/README.md), you will have the ability to run
27
tailored anomaly detection on every node in your infrastructure, regardless of its purpose or workload.
28
29
In this guide, you'll learn how to set up the anomalies collector to instantly detect anomalies in an Nginx web server
@@ -35,9 +35,9 @@ server](https://user-images.githubusercontent.com/1153921/103586700-da5b0a00-4ea
35
36
## Prerequisites
37
38
-- A node running the Netdata Agent. If you don't yet have that, [get Netdata](/docs/get-started.mdx).
38
+- A node running the Netdata Agent. If you don't yet have that, [get Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
39
- A Netdata Cloud account. [Sign up](https://app.netdata.cloud) if you don't have one already.
40
-- Familiarity with configuring the Netdata Agent with [`edit-config`](/docs/configure/nodes.md).
40
+- Familiarity with configuring the Netdata Agent with [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
41
- _Optional_: An Nginx web server running on the same node to follow the example configuration steps.
42
43
## Install required Python packages
@@ -65,7 +65,7 @@ Use `exit` to become your normal user again.
65
66
## Enable the anomalies collector
67
68
-Navigate to your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) and use `edit-config`
68
+Navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) and use `edit-config`
69
to open the `python.d.conf` file.
70
71
```bash
@@ -79,8 +79,8 @@ yourself if it doesn't already exist. Either way, the final result should look l
79
anomalies: yes
80
```
81
82
-[Restart the Agent](/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata`, or the [appropriate
83
-method](/docs/configure/start-stop-restart.md) for your system, to start up the anomalies collector. By default, the
82
+[Restart the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata`, or the [appropriate
83
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to start up the anomalies collector. By default, the
84
model training process runs every 30 minutes, and uses the previous 4 hours of metrics to establish a baseline for
85
health and performance across the default included charts.
86
@@ -105,7 +105,7 @@ involve tweaking the behavior of the ML training itself.
105
- `train_every_n`: How often to train the ML models.
106
- `train_n_secs`: The number of historical observations to train each model on. The default is 4 hours, but if your node
107
doesn't have historical metrics going back that far, consider [changing the metrics retention
108
- policy](/docs/store/change-metrics-storage.md) or reducing this window.
108
+ policy](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) or reducing this window.
109
- `custom_models`: A way to define custom models that you want anomaly probabilities for, including multi-node or
110
streaming setups.
111
@@ -119,8 +119,8 @@ involve tweaking the behavior of the ML training itself.
119
120
As mentioned above, this guide uses an Nginx web server to demonstrate how the anomalies collector works. You must
121
configure the collector to monitor charts from the
122
-[Nginx](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) and [web
123
-log](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog) collectors.
122
+[Nginx](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md) and [web
123
+log](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md) collectors.
124
125
`charts_regex` allows for some basic regex, such as wildcards (`*`) to match all contexts with a certain pattern. For
126
example, `system\..*` matches with any chart with a context that begins with `system.`, and ends in any number of other
@@ -163,27 +163,27 @@ volume of requests/responses, not, for example, which type of 4xx response a use
163
dimensions](https://user-images.githubusercontent.com/1153921/102820642-d69f9180-4392-11eb-91c5-d3d166d40105.png)
164
165
Apply the ideas behind the collector's regex and exclude settings to any other
166
-[system](/docs/collect/system-metrics.md), [container](/docs/collect/container-metrics.md), or
167
-[application](/docs/collect/application-metrics.md) metrics you want to detect anomalies for.
166
+[system](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md), [container](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md), or
167
+[application](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md) metrics you want to detect anomalies for.
168
169
## What's next?
170
171
Now that you know how to set up unsupervised anomaly detection in the Netdata Agent, using an Nginx web server as an
172
example, it's time to apply that knowledge to other mission-critical parts of your infrastructure. If you're not sure
173
-what to monitor next, check out our list of [collectors](/collectors/COLLECTORS.md) to see what kind of metrics Netdata
173
+what to monitor next, check out our list of [collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) to see what kind of metrics Netdata
174
can collect from your systems, containers, and applications.
175
176
-Keep on moving to [part 2](/docs/guides/monitor/visualize-monitor-anomalies.md), which covers the charts and alarms
176
+Keep on moving to [part 2](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/visualize-monitor-anomalies.md), which covers the charts and alarms
177
Netdata creates for unsupervised anomaly detection.
178
179
For a different troubleshooting experience, try out the [Metric
180
-Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations) feature in Netdata Cloud. Metric
180
+Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) feature in Netdata Cloud. Metric
181
Correlations helps you perform faster root cause analysis by narrowing a dashboard to only the charts most likely to be
182
related to an anomaly.
183
184
### Related reference documentation
185
186
-- [Netdata Agent · Anomalies collector](/collectors/python.d.plugin/anomalies/README.md)
187
-- [Netdata Agent · Nginx collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx)
188
-- [Netdata Agent · web log collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog)
189
-- [Netdata Cloud · Metric Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations)
186
+- [Netdata Agent · Anomalies collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md)
187
+- [Netdata Agent · Nginx collector](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md)
188
+- [Netdata Agent · web log collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md)
189
+- [Netdata Cloud · Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
docs/guides/monitor/anomaly-detection.md
+8
-8
@@ -14,7 +14,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/moni
14
15
As of [`v1.32.0`](https://github.com/netdata/netdata/releases/tag/v1.32.0), Netdata comes with some ML powered [anomaly detection](https://en.wikipedia.org/wiki/Anomaly_detection) capabilities built into it and available to use out of the box, with zero configuration required (ML was enabled by default in `v1.35.0-29-nightly` in [this PR](https://github.com/netdata/netdata/pull/13158), previously it required a one line config change).
16
17
-This means that in addition to collecting raw value metrics, the Netdata agent will also produce an [`anomaly-bit`](https://learn.netdata.cloud/docs/agent/ml#anomaly-bit---100--anomalous-0--normal) every second which will be `100` when recent raw metric values are considered anomalous by Netdata and `0` when they look normal. Once we aggregate beyond one second intervals this aggregated `anomaly-bit` becomes an ["anomaly rate"](https://learn.netdata.cloud/docs/agent/ml#anomaly-rate---averageanomaly-bit).
17
+This means that in addition to collecting raw value metrics, the Netdata agent will also produce an [`anomaly-bit`](https://github.com/netdata/netdata/blob/master/ml/README.md#anomaly-bit---100--anomalous-0--normal) every second which will be `100` when recent raw metric values are considered anomalous by Netdata and `0` when they look normal. Once we aggregate beyond one second intervals this aggregated `anomaly-bit` becomes an ["anomaly rate"](https://github.com/netdata/netdata/blob/master/ml/README.md#anomaly-rate---averageanomaly-bit).
18
19
To be as concrete as possible, the below api call shows how to access the raw anomaly bit of the `system.cpu` chart from the [london.my-netdata.io](https://london.my-netdata.io) Netdata demo server. Passing `options=anomaly-bit` returns the anomaly bit instead of the raw metric value.
20
@@ -22,19 +22,19 @@ To be as concrete as possible, the below api call shows how to access the raw an
22
https://london.my-netdata.io/api/v1/data?chart=system.cpu&options=anomaly-bit
23
```
24
25
-If we aggregate the above to just 1 point by adding `points=1` we get an "[Anomaly Rate](https://learn.netdata.cloud/docs/agent/ml#anomaly-rate---averageanomaly-bit)":
25
+If we aggregate the above to just 1 point by adding `points=1` we get an "[Anomaly Rate](https://github.com/netdata/netdata/blob/master/ml/README.md#anomaly-rate---averageanomaly-bit)":
26
27
```
28
https://london.my-netdata.io/api/v1/data?chart=system.cpu&options=anomaly-bit&points=1
29
```
30
31
-The fundamentals of Netdata's anomaly detection approach and implementation are covered in lots more detail in the [agent ML documentation](https://learn.netdata.cloud/docs/agent/ml).
31
+The fundamentals of Netdata's anomaly detection approach and implementation are covered in lots more detail in the [agent ML documentation](https://github.com/netdata/netdata/blob/master/ml/README.md).
32
33
This guide will explain how to get started using these ML based anomaly detection capabilities within Netdata.
34
35
## Anomaly Advisor
36
37
-The [Anomaly Advisor](https://learn.netdata.cloud/docs/cloud/insights/anomaly-advisor) is the flagship anomaly detection feature within Netdata. In the "Anomalies" tab of Netdata you will see an overall "Anomaly Rate" chart that aggregates node level anomaly rate for all nodes in a space. The aim of this chart is to make it easy to quickly spot periods of time where the overall "[node anomaly rate](https://learn.netdata.cloud/docs/agent/ml#node-anomaly-rate)" is elevated in some unusual way and for what node or nodes this relates to.
37
+The [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx) is the flagship anomaly detection feature within Netdata. In the "Anomalies" tab of Netdata you will see an overall "Anomaly Rate" chart that aggregates node level anomaly rate for all nodes in a space. The aim of this chart is to make it easy to quickly spot periods of time where the overall "[node anomaly rate](https://github.com/netdata/netdata/blob/master/ml/README.md#node-anomaly-rate)" is elevated in some unusual way and for what node or nodes this relates to.
38
39
40
@@ -44,7 +44,7 @@ Once an area on the Anomaly Rate chart is highlighted netdata will append a "hea
44
45
## Embedded Anomaly Rate Charts
46
47
-Charts in both the [Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview) and [single node dashboard](https://learn.netdata.cloud/docs/cloud/visualize/overview#jump-to-single-node-dashboards) tabs also expose the underlying anomaly rates for each dimension so users can easily see if the raw metrics are considered anomalous or not by Netdata.
47
+Charts in both the [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) and [single node dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#jump-to-single-node-dashboards) tabs also expose the underlying anomaly rates for each dimension so users can easily see if the raw metrics are considered anomalous or not by Netdata.
48
49
Pressing the anomalies icon (next to the information icon in the chart header) will expand the anomaly rate chart to make it easy to see how the anomaly rate for any individual dimension corresponds to the raw underlying data. In the example below we can see that the spike in `system.pgpgio|in` corresponded in the anomaly rate for that dimension jumping to 100% for a small period of time until the spike passed.
50
@@ -65,9 +65,9 @@ You can see some example ML based alert configurations below:
65
66
Check out the resources below to learn more about how Netdata is approaching ML:
67
68
-- [Agent ML documentation](https://learn.netdata.cloud/docs/agent/ml).
69
-- [Anomaly Advisor documentation](https://learn.netdata.cloud/docs/cloud/insights/anomaly-advisor).
70
-- [Metric Correlations documentation](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations).
68
+- [Agent ML documentation](https://github.com/netdata/netdata/blob/master/ml/README.md).
69
+- [Anomaly Advisor documentation](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx).
70
+- [Metric Correlations documentation](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md).
71
- Anomaly Advisor [launch blog post](https://www.netdata.cloud/blog/introducing-anomaly-advisor-unsupervised-anomaly-detection-in-netdata/).
72
- Netdata Approach to ML [blog post](https://www.netdata.cloud/blog/our-approach-to-machine-learning/).
73
- `areal/ml` related [GitHub Discussions](https://github.com/netdata/netdata/discussions?discussions_q=label%3Aarea%2Fml).
docs/guides/monitor/dimension-templates.md
+21
-16
@@ -8,24 +8,27 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/moni
8
Your ability to monitor the health of your systems and applications relies on your ability to create and maintain
9
the best set of alarms for your particular needs.
10
11
-In v1.18 of Netdata, we introduced **dimension templates** for alarms, which simplifies the process of writing [alarm
12
-entities](/health/REFERENCE.md#health-entity-reference) for charts with many dimensions.
11
+In v1.18 of Netdata, we introduced **dimension templates** for alarms, which simplifies the process of
12
+writing [alarm entities](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#health-entity-reference) for
13
+charts with many dimensions.
14
15
Dimension templates can condense many individual entities into one—no more copy-pasting one entity and changing the
16
`alarm`/`template` and `lookup` lines for each dimension you'd like to monitor.
17
18
They are, however, an advanced health monitoring feature. For more basic instructions on creating your first alarm,
18
-check out our [health monitoring documentation](/health/README.md), which also includes
19
-[examples](/health/REFERENCE.md#example-alarms).
19
+check out our [health monitoring documentation](https://github.com/netdata/netdata/blob/master/health/README.md), which also includes
20
+[examples](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#example-alarms).
21
22
## The fundamentals of `foreach`
23
23
-Our dimension templates update creates a new `foreach` parameter to the existing [`lookup`
24
-line](/health/REFERENCE.md#alarm-line-lookup). This is where the magic happens.
24
+Our dimension templates update creates a new `foreach` parameter to the
25
+existing [`lookup` line](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-lookup). This
26
+is where the magic happens.
27
28
You use the `foreach` parameter to specify which dimensions you want to monitor with this single alarm. You can separate
27
-them with a comma (`,`) or a pipe (`|`). You can also use a [Netdata simple pattern](/libnetdata/simple_pattern/README.md)
28
-to create many alarms with a regex-like syntax.
29
+them with a comma (`,`) or a pipe (`|`). You can also use
30
+a [Netdata simple pattern](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to create
31
+many alarms with a regex-like syntax.
32
33
The `foreach` parameter _has_ to be the last parameter in your `lookup` line, and if you have both `of` and `foreach` in
34
the same `lookup` line, Netdata will ignore the `of` parameter and use `foreach` instead.
@@ -95,7 +98,7 @@ Let's look at some other examples of how `foreach` works so you can best apply i
98
In the last example, we used `foreach system,user,nice` to create three distinct alarms using dimension templates. But
99
what if you want to quickly create alarms for _all_ the dimensions of a given chart?
100
98
-Use a [simple pattern](/libnetdata/simple_pattern/README.md)! One example of a simple pattern is a single wildcard
101
+Use a [simple pattern](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md)! One example of a simple pattern is a single wildcard
102
(`*`).
103
104
Instead of monitoring system CPU usage, let's monitor per-application CPU usage using the `apps.cpu` chart. Passing a
@@ -113,14 +116,15 @@ lookup: average -10m percentage foreach *
116
This entity will now create alarms for every dimension in the `apps.cpu` chart. Given that most `apps.cpu` charts have
117
10 or more dimensions, using the wildcard ensures you catch every CPU-hogging process.
118
116
-To learn more about how to use simple patterns with dimension templates, see our [simple patterns
117
-documentation](/libnetdata/simple_pattern/README.md).
119
+To learn more about how to use simple patterns with dimension templates, see
120
+our [simple patterns documentation](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md).
121
122
## Using `foreach` with alarm templates
123
121
-Dimension templates also work with [alarm templates](/health/REFERENCE.md#alarm-line-alarm-or-template). Alarm
122
-templates help you create alarms for all the charts with a given context—for example, all the cores of your system's
123
-CPU.
124
+Dimension templates also work
125
+with [alarm templates](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-alarm-or-template).
126
+Alarm templates help you create alarms for all the charts with a given context—for example, all the cores of your
127
+system's CPU.
128
129
By combining the two, you can create dozens of individual alarms with a single template entity. Here's how you would
130
create alarms for the `system`, `user`, and `nice` dimensions for every chart in the `cpu.cpu` context—or, in other
@@ -170,7 +174,8 @@ alarms that will help you better monitor the health of your systems.
174
175
Or, at the very least, simplify your configuration files.
176
173
-For information about other advanced features in Netdata's health monitoring toolkit, check out our [health
174
-documentation](/health/README.md). And if you have some cool alarms you built using dimension templates,
177
+For information about other advanced features in Netdata's health monitoring toolkit, check out
178
+our [health documentation](https://github.com/netdata/netdata/blob/master/health/README.md). And if you have some cool
179
+alarms you built using dimension templates,
180
181
docs/guides/monitor/kubernetes-k8s-netdata.md
+14
-14
@@ -46,7 +46,7 @@ To follow this tutorial, you need:
46
- A free Netdata Cloud account. [Sign up](https://app.netdata.cloud/sign-up?cloudRoute=/spaces) if you don't have one
47
already.
48
- A working cluster running Kubernetes v1.9 or newer, with a Netdata deployment and connected parent/child nodes. See
49
- our [Kubernetes deployment process](/packaging/installer/methods/kubernetes.md) for details on deployment and
49
+ our [Kubernetes deployment process](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md) for details on deployment and
50
conneting to Cloud.
51
- The [`kubectl`](https://kubernetes.io/docs/reference/kubectl/overview/) command line tool, within [one minor version
52
difference](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin) of your cluster, on an
@@ -104,7 +104,7 @@ To get started, [sign in](https://app.netdata.cloud/sign-in?cloudRoute=/spaces)
104
to the War Room you connected your cluster to, if not **General**.
105
106
Netdata Cloud is already visualizing your Kubernetes metrics, streamed in real-time from each node, in the
107
-[Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview):
107
+[Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md):
108
109
@@ -126,8 +126,8 @@ cluster](https://user-images.githubusercontent.com/1153921/109042169-19c8fa00-76
126
For example, the chart above shows a spike in the CPU utilization from `rabbitmq` every minute or so, along with a
127
baseline CPU utilization of 10-15% across the cluster.
128
129
-Read about the [Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview) and some best practices on [viewing
130
-an overview of your infrastructure](/docs/visualize/overview-infrastructure.md) for details on using composite charts to
129
+Read about the [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) and some best practices on [viewing
130
+an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) for details on using composite charts to
131
drill down into per-node performance metrics.
132
133
## Pod and container metrics
@@ -154,7 +154,7 @@ Let's explore the most colorful box by hovering over it.
154
container](https://user-images.githubusercontent.com/1153921/109049544-a8417980-7695-11eb-80a7-109b4a645a27.png)
155
156
The **Context** tab shows `rabbitmq-5bb66bb6c9-6xr5b` as the container's image name, which means this container is
157
-running a [RabbitMQ](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/rabbitmq) workload.
157
+running a [RabbitMQ](https://github.com/netdata/go.d.plugin/blob/master/modules/rabbitmq/README.md) workload.
158
159
Click the **Metrics** tab to see real-time metrics from that container. Unsurprisingly, it shows a spike in CPU
160
utilization at regular intervals.
@@ -173,7 +173,7 @@ different namespaces.
173
175
176
-Each composite chart has a [definition bar](https://learn.netdata.cloud/docs/cloud/visualize/overview#definition-bar)
176
+Each composite chart has a [definition bar](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#definition-bar)
177
for complete customization. For example, grouping the top chart by `k8s_container_name` reveals new information.
178
179
@@ -183,20 +183,20 @@ for complete customization. For example, grouping the top chart by `k8s_containe
183
Netdata has a [service discovery plugin](https://github.com/netdata/agent-service-discovery), which discovers and
184
creates configuration files for [compatible
185
services](https://github.com/netdata/helmchart#service-discovery-and-supported-services) and any endpoints covered by
186
-our [generic Prometheus collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus).
186
+our [generic Prometheus collector](https://github.com/netdata/go.d.plugin/blob/master/modules/prometheus/README.md).
187
Netdata uses these files to collect metrics from any compatible application as they run _inside_ of a pod. Service
188
discovery happens without manual intervention as pods are created, destroyed, or moved between nodes.
189
190
Service metrics show up on the Overview as well, beneath the **Kubernetes** section, and are labeled according to the
191
service in question. For example, the **RabbitMQ** section has numerous charts from the [`rabbitmq`
192
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/rabbitmq):
192
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/rabbitmq/README.md):
193
194
196
197
> The robot-shop cluster has more supported services, such as MySQL, which are not visible with zero configuration. This
198
> is usually because of services running on non-default ports, using non-default names, or required passwords. Read up
199
-> on [configuring service discovery](/packaging/installer/methods/kubernetes.md#configure-service-discovery) to collect
199
+> on [configuring service discovery](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md#configure-service-discovery) to collect
200
> more service metrics.
201
202
Service metrics are essential to infrastructure monitoring, as they're the best indicator of the end-user experience,
@@ -210,7 +210,7 @@ Netdata also automatically collects metrics from two essential Kubernetes proces
210
211
The **k8s kubelet** section visualizes metrics from the Kubernetes agent responsible for managing every pod on a given
212
node. This also happens without any configuration thanks to the [kubelet
213
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubelet).
213
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubelet/README.md).
214
215
Monitoring each node's kubelet can be invaluable when diagnosing issues with your Kubernetes cluster. For example, you
216
can see if the number of running containers/pods has dropped, which could signal a fault or crash in a particular
@@ -226,7 +226,7 @@ configuration-related errors, and the actual vs. desired numbers of volumes, plu
226
The **k8s kube-proxy** section displays metrics about the network proxy that runs on each node in your Kubernetes
227
cluster. kube-proxy lets pods communicate with each other and accept sessions from outside your cluster. Its metrics are
228
collected by the [kube-proxy
229
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubeproxy).
229
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubeproxy/README.md).
230
231
With Netdata, you can monitor how often your k8s proxies are syncing proxy rules between nodes. Dramatic changes in
232
these figures could indicate an anomaly in your cluster that's worthy of further investigation.
@@ -246,9 +246,9 @@ clusters of all sizes.
246
- [Netdata Helm chart](https://github.com/netdata/helmchart)
247
- [Netdata service discovery](https://github.com/netdata/agent-service-discovery)
248
- [Netdata Agent · `kubelet`
249
- collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubelet)
249
+ collector](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubelet/README.md)
250
- [Netdata Agent · `kube-proxy`
251
- collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/k8s_kubeproxy)
252
-- [Netdata Agent · `cgroups.plugin`](/collectors/cgroups.plugin/README.md)
251
+ collector](https://github.com/netdata/go.d.plugin/blob/master/modules/k8s_kubeproxy/README.md)
252
+- [Netdata Agent · `cgroups.plugin`](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md)
253
254
docs/guides/monitor/lamp-stack.md
+21
-21
@@ -58,7 +58,7 @@ To follow this tutorial, you need:
58
## Install the Netdata Agent
59
60
If you don't have the free, open-source Netdata monitoring agent installed on your node yet, get started with a [single
61
-kickstart command](/docs/get-started.mdx):
61
+kickstart command](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx):
62
63
<OneLineInstallWget/>
64
@@ -68,15 +68,15 @@ replacing `NODE` with the hostname or IP address of your system.
68
69
## Enable hardware and Linux system monitoring
70
71
-There's nothing you need to do to enable [system monitoring](/docs/collect/system-metrics.md) and Linux monitoring with
71
+There's nothing you need to do to enable [system monitoring](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md) and Linux monitoring with
72
the Netdata Agent, which autodetects metrics from CPUs, memory, disks, networking devices, and Linux processes like
73
systemd without any configuration. If you're using containers, Netdata automatically collects resource utilization
74
-metrics from each using the [cgroups data collector](/collectors/cgroups.plugin/README.md).
74
+metrics from each using the [cgroups data collector](https://github.com/netdata/netdata/blob/master/collectors/cgroups.plugin/README.md).
75
76
## Enable Apache monitoring
77
78
Let's begin by configuring Apache to work with Netdata's [Apache data
79
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/apache).
79
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/apache/README.md).
80
81
Actually, there's nothing for you to do to enable Apache monitoring with Netdata.
82
@@ -87,7 +87,7 @@ metrics](https://httpd.apache.org/docs/2.4/mod/mod_status.html), which is just _
87
## Enable web log monitoring
88
89
The Netdata Agent also comes with a [web log
90
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog), which reads Apache's access
90
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md), which reads Apache's access
91
log file, processes each line, and converts them into per-second metrics. On Debian systems, it reads the file at
92
`/var/log/apache2/access.log`.
93
@@ -100,7 +100,7 @@ monitoring.
100
101
Because your MySQL database is password-protected, you do need to tell MySQL to allow the `netdata` user to connect to
102
without a password. Netdata's [MySQL data
103
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql) collects metrics in _read-only_
103
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md) collects metrics in _read-only_
104
mode, without being able to alter or affect operations in any way.
105
106
First, log into the MySQL shell. Then, run the following three commands, one at a time:
@@ -112,15 +112,15 @@ FLUSH PRIVILEGES;
112
```
113
114
Run `sudo systemctl restart netdata`, or the [appropriate alternative for your
115
-system](/docs/configure/start-stop-restart.md), to collect dozens of metrics every second for robust MySQL monitoring.
115
+system](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md), to collect dozens of metrics every second for robust MySQL monitoring.
116
117
## Enable PHP monitoring
118
119
Unlike Apache or MySQL, PHP isn't a service that you can monitor directly, unless you instrument a PHP-based application
120
-with [StatsD](/collectors/statsd.plugin/README.md).
120
+with [StatsD](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md).
121
122
However, if you use [PHP-FPM](https://php-fpm.org/) in your LAMP stack, you can monitor that process with our [PHP-FPM
123
-data collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/phpfpm).
123
+data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/phpfpm/README.md).
124
125
Open your PHP-FPM configuration for editing, replacing `7.4` with your version of PHP:
126
@@ -166,12 +166,12 @@ If the Netdata Agent isn't already open in your browser, open a new tab and navi
166
167
> If you [signed up](https://app.netdata.cloud/sign-up?cloudRoute=/spaces) for Netdata Cloud earlier, you can also view
168
> the exact same LAMP stack metrics there, plus additional features, like drag-and-drop custom dashboards. Be sure to
169
-> [connecting your node](/claim/README.md) to start streaming metrics to your browser through Netdata Cloud.
169
+> [connecting your node](https://github.com/netdata/netdata/blob/master/claim/README.md) to start streaming metrics to your browser through Netdata Cloud.
170
171
Netdata automatically organizes all metrics and charts onto a single page for easy navigation. Peek at gauges to see
172
overall system performance, then scroll down to see more. Click-and-drag with your mouse to pan _all_ charts back and
173
forth through different time intervals, or hold `SHIFT` and use the scrollwheel (or two-finger scroll) to zoom in and
174
-out. Check out our doc on [interacting with charts](/docs/visualize/interact-dashboards-charts.md) for all the details.
174
+out. Check out our doc on [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) for all the details.
175
176
@@ -205,15 +205,15 @@ Here's a quick reference for what charts you might want to focus on after settin
205
The Netdata Agent comes with hundreds of pre-configured alarms to help you keep tabs on your system, including 19 alarms
206
designed for smarter LAMP stack monitoring.
207
208
-Click the 🔔 icon in the top navigation to [see active alarms](/docs/monitor/view-active-alarms.md). The **Active** tabs
208
+Click the 🔔 icon in the top navigation to [see active alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md). The **Active** tabs
209
shows any alarms currently triggered, while the **All** tab displays a list of _every_ pre-configured alarm. The
210
211
213
214
-[Tweak alarms](/docs/monitor/configure-alarms.md) based on your infrastructure monitoring needs, and to see these alarms
214
+[Tweak alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) based on your infrastructure monitoring needs, and to see these alarms
215
in other places, like your inbox or a Slack channel, [enable a notification
216
-method](/docs/monitor/enable-notifications.md).
216
+method](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
217
218
## What's next?
219
@@ -223,7 +223,7 @@ services. The per-second metrics granularity means you have the most accurate in
223
any LAMP-related issues.
224
225
Another powerful way to monitor the availability of a LAMP stack is the [`httpcheck`
226
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/httpcheck), which pings a web server at
226
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/httpcheck/README.md), which pings a web server at
227
a regular interval and tells you whether if and how quickly it's responding. The `response_match` option also lets you
228
monitor when the web server's response isn't what you expect it to be, which might happen if PHP-FPM crashes, for
229
example.
@@ -233,14 +233,14 @@ we're not covering it here, but it _does_ work in a single-node setup. Just don'
233
node crashed.
234
235
If you're planning on managing more than one node, or want to take advantage of advanced features, like finding the
236
-source of issues faster with [Metric Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations),
236
+source of issues faster with [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md),
237
[sign up](https://app.netdata.cloud/sign-up?cloudRoute=/spaces) for a free Netdata Cloud account.
238
239
### Related reference documentation
240
241
-- [Netdata Agent · Get started](/docs/get-started.mdx)
242
-- [Netdata Agent · Apache data collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/apache)
243
-- [Netdata Agent · Web log collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog)
244
-- [Netdata Agent · MySQL data collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql)
245
-- [Netdata Agent · PHP-FPM data collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/phpfpm)
241
+- [Netdata Agent · Get started](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx)
242
+- [Netdata Agent · Apache data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/apache/README.md)
243
+- [Netdata Agent · Web log collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md)
244
+- [Netdata Agent · MySQL data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md)
245
+- [Netdata Agent · PHP-FPM data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/phpfpm/README.md)
246
docs/guides/monitor/pi-hole-raspberry-pi.md
+13
-13
@@ -79,7 +79,7 @@ service](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi
79
finished setting up Pi-hole at this point.
80
81
As far as configuring Netdata to monitor Pi-hole metrics, there's nothing you actually need to do. Netdata's [Pi-hole
82
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/pihole) will autodetect the new service
82
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/pihole/README.md) will autodetect the new service
83
running on your Raspberry Pi and immediately start collecting metrics every second.
84
85
Restart Netdata with `sudo systemctl restart netdata`, which will then recognize that Pi-hole is running and start a
@@ -98,15 +98,15 @@ part of your system might affect another.
98
100
101
-If you're completely new to Netdata, look at our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for a
102
-walkthrough of all its features. For a more expedited tour, see the [get started guide](/docs/get-started.mdx).
101
+If you're completely new to Netdata, look at our [step-by-step guide](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-00.md) for a
102
+walkthrough of all its features. For a more expedited tour, see the [get started guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
103
104
### Enable temperature sensor monitoring
105
106
You need to manually enable Netdata's built-in [temperature sensor
107
-collector](https://learn.netdata.cloud/docs/agent/collectors/charts.d.plugin/sensors) to start collecting metrics.
107
+collector](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/sensors/README.md) to start collecting metrics.
108
109
-> Netdata uses a few plugins to manage its [collectors](/collectors/REFERENCE.md), each using a different language: Go,
109
+> Netdata uses a few plugins to manage its [collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md), each using a different language: Go,
110
> Python, Node.js, and Bash. While our Go collectors are undergoing the most active development, we still support the
111
> other languages. In this case, you need to enable a temperature sensor collector that's written in Bash.
112
@@ -124,7 +124,7 @@ Raspberry Pi temperature sensor monitoring.
124
### Storing historical metrics on your Raspberry Pi
125
126
By default, Netdata allocates 256 MiB in disk space to store historical metrics inside the [database
127
-engine](/database/engine/README.md). On the Raspberry Pi used for this guide, Netdata collects 1,500 metrics every
127
+engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md). On the Raspberry Pi used for this guide, Netdata collects 1,500 metrics every
128
second, which equates to storing 3.5 days worth of historical metrics.
129
130
You can increase this allocation by editing `netdata.conf` and increasing the `dbengine multihost disk space` setting to
@@ -136,8 +136,8 @@ more than 256.
136
```
137
138
Use our [database sizing
139
-calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
140
-and [guide on storing historical metrics](/docs/guides/longer-metrics-storage.md) to help you determine the right
139
+calculator](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
140
+and [guide on storing historical metrics](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md) to help you determine the right
141
setting for your Raspberry Pi.
142
143
## What's next?
@@ -146,12 +146,12 @@ Now that you're monitoring Pi-hole and your Raspberry Pi with Netdata, you can e
146
configure Netdata to more specific goals.
147
148
Most importantly, you can always install additional services and instantly collect metrics from many of them with our
149
-[300+ integrations](/collectors/COLLECTORS.md).
149
+[300+ integrations](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
150
151
-- [Optimize performance](/docs/guides/configure/performance.md) using tweaks developed for IoT devices.
152
-- [Stream Raspberry Pi metrics](/streaming/README.md) to a parent host for easy access or longer-term storage.
153
-- [Tweak alarms](/health/QUICKSTART.md) for either Pi-hole or the health of your Raspberry Pi.
154
-- [Export metrics to external databases](/exporting/README.md) with the exporting engine.
151
+- [Optimize performance](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md) using tweaks developed for IoT devices.
152
+- [Stream Raspberry Pi metrics](https://github.com/netdata/netdata/blob/master/streaming/README.md) to a parent host for easy access or longer-term storage.
153
+- [Tweak alarms](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md) for either Pi-hole or the health of your Raspberry Pi.
154
+- [Export metrics to external databases](https://github.com/netdata/netdata/blob/master/exporting/README.md) with the exporting engine.
155
156
Or, head over to [our guides](https://learn.netdata.cloud/guides/) for even more experiments and insights into
157
troubleshooting the health of your systems and services.
docs/guides/monitor/process.md
+121
-110
@@ -23,38 +23,46 @@ SQL queries or know a bunch of arbitrary command-line flags.
23
24
With Netdata's process monitoring, you can:
25
26
-- Benchmark/optimize performance of standard applications, like web servers or databases
27
-- Benchmark/optimize performance of custom applications
28
-- Troubleshoot CPU/memory/disk utilization issues (why is my system's CPU spiking right now?)
29
-- Perform granular capacity planning based on the specific needs of your infrastructure
30
-- Search for leaking file descriptors
31
-- Investigate zombie processes
26
+- Benchmark/optimize performance of standard applications, like web servers or databases
27
+- Benchmark/optimize performance of custom applications
28
+- Troubleshoot CPU/memory/disk utilization issues (why is my system's CPU spiking right now?)
29
+- Perform granular capacity planning based on the specific needs of your infrastructure
30
+- Search for leaking file descriptors
31
+- Investigate zombie processes
32
33
... and much more. Let's get started.
34
35
## Prerequisites
36
37
-- One or more Linux nodes running [Netdata](/docs/get-started.mdx). If you need more time to understand Netdata before
38
- following this guide, see the [infrastructure](/docs/quickstart/infrastructure.md) or
39
- [single-node](/docs/quickstart/single-node.md) monitoring quickstarts.
40
-- A general understanding of how to [configure the Netdata Agent](/docs/configure/nodes.md) using `edit-config`.
41
-- A Netdata Cloud account. [Sign up](https://app.netdata.cloud) if you don't have one already.
37
+- One or more Linux nodes running [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx). If you
38
+ need more time to understand Netdata before
39
+ following this guide, see
40
+ the [infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) or
41
+ [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) monitoring quickstarts.
42
+- A general understanding of how
43
+ to [configure the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md)
44
+ using `edit-config`.
45
+- A Netdata Cloud account. [Sign up](https://app.netdata.cloud) if you don't have one already.
46
47
## How does Netdata do process monitoring?
48
45
-The Netdata Agent already knows to look for hundreds of [standard applications that we support via
46
-collectors](/collectors/COLLECTORS.md), and groups them based on their purpose. Let's say you want to monitor a MySQL
49
+The Netdata Agent already knows to look for hundreds
50
+of [standard applications that we support via collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md),
51
+and groups them based on their
52
+purpose. Let's say you want to monitor a MySQL
53
database using its process. The Netdata Agent already knows to look for processes with the string `mysqld` in their
54
name, along with a few others, and puts them into the `sql` group. This `sql` group then becomes a dimension in all
55
process-specific charts.
56
57
The process and groups settings are used by two unique and powerful collectors.
58
53
-[**`apps.plugin`**](/collectors/apps.plugin/README.md) looks at the Linux process tree every second, much like `top` or
59
+[**`apps.plugin`**](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) looks at the Linux
60
+process tree every second, much like `top` or
61
`ps fax`, and collects resource utilization information on every running process. It then automatically adds a layer of
62
meaningful visualization on top of these metrics, and creates per-process/application charts.
63
57
-[**`ebpf.plugin`**](/collectors/ebpf.plugin/README.md): Netdata's extended Berkeley Packet Filter (eBPF) collector
64
+[**`ebpf.plugin`**](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md): Netdata's extended
65
+Berkeley Packet Filter (eBPF) collector
66
monitors Linux kernel-level metrics for file descriptors, virtual filesystem IO, and process management, and then hands
67
process-specific metrics over to `apps.plugin` for visualization. The eBPF collector also collects and visualizes
68
metrics on an _event frequency_, which means it captures every kernel interaction, and not just the volume of
@@ -65,55 +73,55 @@ interaction at every second in time. That's even more precise than Netdata's sta
73
With these collectors working in parallel, Netdata visualizes the following per-second metrics for _any_ process on your
74
Linux systems:
75
68
-- CPU utilization (`apps.cpu`)
69
- - Total CPU usage
70
- - User/system CPU usage (`apps.cpu_user`/`apps.cpu_system`)
71
-- Disk I/O
72
- - Physical reads/writes (`apps.preads`/`apps.pwrites`)
73
- - Logical reads/writes (`apps.lreads`/`apps.lwrites`)
74
- - Open unique files (if a file is found open multiple times, it is counted just once, `apps.files`)
75
-- Memory
76
- - Real Memory Used (non-shared, `apps.mem`)
77
- - Virtual Memory Allocated (`apps.vmem`)
78
- - Minor page faults (i.e. memory activity, `apps.minor_faults`)
79
-- Processes
80
- - Threads running (`apps.threads`)
81
- - Processes running (`apps.processes`)
82
- - Carried over uptime (since the last Netdata Agent restart, `apps.uptime`)
83
- - Minimum uptime (`apps.uptime_min`)
84
- - Average uptime (`apps.uptime_average`)
85
- - Maximum uptime (`apps.uptime_max`)
86
- - Pipes open (`apps.pipes`)
87
-- Swap memory
88
- - Swap memory used (`apps.swap`)
89
- - Major page faults (i.e. swap activity, `apps.major_faults`)
90
-- Network
91
- - Sockets open (`apps.sockets`)
92
-- eBPF file
93
- - Number of calls to open files. (`apps.file_open`)
94
- - Number of files closed. (`apps.file_closed`)
95
- - Number of calls to open files that returned errors.
96
- - Number of calls to close files that returned errors.
97
-- eBPF syscall
98
- - Number of calls to delete files. (`apps.file_deleted`)
99
- - Number of calls to `vfs_write`. (`apps.vfs_write_call`)
100
- - Number of calls to `vfs_read`. (`apps.vfs_read_call`)
101
- - Number of bytes written with `vfs_write`. (`apps.vfs_write_bytes`)
102
- - Number of bytes read with `vfs_read`. (`apps.vfs_read_bytes`)
103
- - Number of calls to write a file that returned errors.
104
- - Number of calls to read a file that returned errors.
105
-- eBPF process
106
- - Number of process created with `do_fork`. (`apps.process_create`)
107
- - Number of threads created with `do_fork` or `__x86_64_sys_clone`, depending on your system's kernel version. (`apps.thread_create`)
108
- - Number of times that a process called `do_exit`. (`apps.task_close`)
109
-- eBPF net
110
- - Number of bytes sent. (`apps.bandwidth_sent`)
111
- - Number of bytes received. (`apps.bandwidth_recv`)
76
+- CPU utilization (`apps.cpu`)
77
+ - Total CPU usage
78
+ - User/system CPU usage (`apps.cpu_user`/`apps.cpu_system`)
79
+- Disk I/O
80
+ - Physical reads/writes (`apps.preads`/`apps.pwrites`)
81
+ - Logical reads/writes (`apps.lreads`/`apps.lwrites`)
82
+ - Open unique files (if a file is found open multiple times, it is counted just once, `apps.files`)
83
+- Memory
84
+ - Real Memory Used (non-shared, `apps.mem`)
85
+ - Virtual Memory Allocated (`apps.vmem`)
86
+ - Minor page faults (i.e. memory activity, `apps.minor_faults`)
87
+- Processes
88
+ - Threads running (`apps.threads`)
89
+ - Processes running (`apps.processes`)
90
+ - Carried over uptime (since the last Netdata Agent restart, `apps.uptime`)
91
+ - Minimum uptime (`apps.uptime_min`)
92
+ - Average uptime (`apps.uptime_average`)
93
+ - Maximum uptime (`apps.uptime_max`)
94
+ - Pipes open (`apps.pipes`)
95
+- Swap memory
96
+ - Swap memory used (`apps.swap`)
97
+ - Major page faults (i.e. swap activity, `apps.major_faults`)
98
+- Network
99
+ - Sockets open (`apps.sockets`)
100
+- eBPF file
101
+ - Number of calls to open files. (`apps.file_open`)
102
+ - Number of files closed. (`apps.file_closed`)
103
+ - Number of calls to open files that returned errors.
104
+ - Number of calls to close files that returned errors.
105
+- eBPF syscall
106
+ - Number of calls to delete files. (`apps.file_deleted`)
107
+ - Number of calls to `vfs_write`. (`apps.vfs_write_call`)
108
+ - Number of calls to `vfs_read`. (`apps.vfs_read_call`)
109
+ - Number of bytes written with `vfs_write`. (`apps.vfs_write_bytes`)
110
+ - Number of bytes read with `vfs_read`. (`apps.vfs_read_bytes`)
111
+ - Number of calls to write a file that returned errors.
112
+ - Number of calls to read a file that returned errors.
113
+- eBPF process
114
+ - Number of process created with `do_fork`. (`apps.process_create`)
115
+ - Number of threads created with `do_fork` or `__x86_64_sys_clone`, depending on your system's kernel
116
+ version. (`apps.thread_create`)
117
+ - Number of times that a process called `do_exit`. (`apps.task_close`)
118
+- eBPF net
119
+ - Number of bytes sent. (`apps.bandwidth_sent`)
120
+ - Number of bytes received. (`apps.bandwidth_recv`)
121
122
As an example, here's the per-process CPU utilization chart, including a `sql` group/dimension.
123
115
-
124
+
125
126
## Configure the Netdata Agent to recognize a specific process
127
@@ -123,7 +131,8 @@ aware of hundreds of processes, and collects metrics from them automatically.
131
But, if you want to change the grouping behavior, add an application that isn't yet supported in the Netdata Agent, or
132
monitor a custom application, you need to edit the `apps_groups.conf` configuration file.
133
126
-Navigate to your [Netdata config directory](/docs/configure/nodes.md) and use `edit-config` to edit the file.
134
+Navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) and
135
+use `edit-config` to edit the file.
136
137
```bash
138
cd /etc/netdata # Replace this with your Netdata config directory if not at /etc/netdata.
@@ -138,7 +147,8 @@ others, and groups them into `sql`. That makes sense, since all these processes
147
sql: mysqld* mariad* postgres* postmaster* oracle_* ora_* sqlservr
148
```
149
141
-These groups are then reflected as [dimensions](/web/README.md#dimensions) within Netdata's charts.
150
+These groups are then reflected as [dimensions](https://github.com/netdata/netdata/blob/master/web/README.md#dimensions)
151
+within Netdata's charts.
152
153
@@ -153,12 +163,13 @@ shouldn't need to configure it to discover them.
163
164
However, if you're using multiple applications that the Netdata Agent groups together you may want to separate them for
165
more precise monitoring. If you're not running any other types of SQL databases on that node, you don't need to change
156
-the grouping, since you know that any MySQL is the only process contributing to the `sql` group.
166
+the grouping, since you know that any MySQL is the only process contributing to the `sql` group.
167
168
Let's say you're using both MySQL and PostgreSQL databases on a single node, and want to monitor their processes
159
-independently. Open the `apps_groups.conf` file as explained in the [section
160
-above](#configure-the-netdata-agent-to-recognize-a-specific-process) and scroll down until you find the `database
161
-servers` section. Create new groups for MySQL and PostgreSQL, and move their process queries into the unique groups.
169
+independently. Open the `apps_groups.conf` file as explained in
170
+the [section above](#configure-the-netdata-agent-to-recognize-a-specific-process) and scroll down until you find
171
+the `database servers` section. Create new groups for MySQL and PostgreSQL, and move their process queries into the
172
+unique groups.
173
174
```conf
175
# -----------------------------------------------------------------------------
@@ -169,17 +180,18 @@ postgres: postgres*
180
sql: mariad* postmaster* oracle_* ora_* sqlservr
181
```
182
172
-Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
173
-method](/docs/configure/start-stop-restart.md) for your system, to start collecting utilization metrics from your
174
-application. Time to [visualize your process metrics](#visualize-process-metrics).
183
+Restart Netdata with `sudo systemctl restart netdata`, or
184
+the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to start collecting utilization metrics
185
+from your application. Time to [visualize your process metrics](#visualize-process-metrics).
186
187
### Custom applications
188
189
Let's assume you have an application that runs on the process `custom-app`. To monitor eBPF metrics for that application
190
separate from any others, you need to create a new group in `apps_groups.conf` and associate that process name with it.
191
181
-Open the `apps_groups.conf` file as explained in the [section
182
-above](#configure-the-netdata-agent-to-recognize-a-specific-process). Scroll down to `# NETDATA processes accounting`.
192
+Open the `apps_groups.conf` file as explained in
193
+the [section above](#configure-the-netdata-agent-to-recognize-a-specific-process). Scroll down
194
+to `# NETDATA processes accounting`.
195
Above that, paste in the following text, which creates a new `custom-app` group with the `custom-app` process. Replace
196
`custom-app` with the name of your application's Linux process. `apps_groups.conf` should now look like this:
197
@@ -195,26 +207,25 @@ custom-app: custom-app
207
...
208
```
209
198
-Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
199
-method](/docs/configure/start-stop-restart.md) for your system, to start collecting utilization metrics from your
200
-application.
210
+Restart Netdata with `sudo systemctl restart netdata`, or
211
+the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to start collecting utilization metrics
212
+from your application.
213
214
## Visualize process metrics
215
216
Now that you're collecting metrics for your process, you'll want to visualize them using Netdata's real-time,
205
-interactive charts. Find these visualizations in the same section regardless of whether you use [Netdata
206
-Cloud](https://app.netdata.cloud) for infrastructure monitoring, or single-node monitoring with the local Agent's
207
-dashboard at `http://localhost:19999`.
217
+interactive charts. Find these visualizations in the same section regardless of whether you
218
+use [Netdata Cloud](https://app.netdata.cloud) for infrastructure monitoring, or single-node monitoring with the local
219
+Agent's dashboard at `http://localhost:19999`.
220
209
-If you need a refresher on all the available per-process charts, see the [above
210
-list](#per-process-metrics-and-charts-in-netdata).
221
+If you need a refresher on all the available per-process charts, see
222
+the [above list](#per-process-metrics-and-charts-in-netdata).
223
224
### Using Netdata's application collector (`apps.plugin`)
225
226
`apps.plugin` puts all of its charts under the **Applications** section of any Netdata dashboard.
227
216
-
228
+
229
230
Let's continue with the MySQL example. We can create a [test
231
database](https://www.digitalocean.com/community/tutorials/how-to-measure-mysql-query-performance-with-mysqlslap) in
@@ -223,11 +234,9 @@ MySQL to generate load on the `mysql` process.
234
`apps.plugin` immediately collects and visualizes this activity `apps.cpu` chart, which shows an increase in CPU
235
utilization from the `sql` group. There is a parallel increase in `apps.pwrites`, which visualizes writes to disk.
236
226
-
237
+
238
229
-
239
+
240
241
Next, the `mysqlslap` utility queries the database to provide some benchmarking load on the MySQL database. It won't
242
look exactly like a production database executing lots of user queries, but it gives you an idea into the possibility of
@@ -240,8 +249,7 @@ sudo mysqlslap --user=sysadmin --password --host=localhost --concurrency=50 --i
249
The following per-process disk utilization charts show spikes under the `sql` group at the same time `mysqlslap` was run
250
numerous times, with slightly different concurrency and query options.
251
243
-
252
+
253
254
> 💡 Click on any dimension below a chart in Netdata Cloud (or to the right of a chart on a local Agent dashboard), to
255
> visualize only that dimension. This can be particularly useful in process monitoring to separate one process'
@@ -256,8 +264,7 @@ For example, running the above workload shows the entire "story" how MySQL inter
264
processes/threads to handle a large number of SQL queries, then subsequently close the tasks as each query returns the
265
relevant data.
266
259
-
267
+
268
269
`ebpf.plugin` visualizes additional eBPF metrics, which are system-wide and not per-process, under the **eBPF** section.
270
@@ -267,35 +274,39 @@ Now that you have `apps_groups.conf` configured correctly, and know where to fin
274
Netdata's ecosystem, you can precisely monitor the health and performance of any process on your node using per-second
275
metrics.
276
270
-For even more in-depth troubleshooting, see our guide on [monitoring and debugging applications with
271
-eBPF](/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md).
277
+For even more in-depth troubleshooting, see our guide
278
+on [monitoring and debugging applications with eBPF](https://github.com/netdata/netdata/blob/master/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md).
279
273
-If the process you're monitoring also has a [supported collector](/collectors/COLLECTORS.md), now is a great time to set
280
+If the process you're monitoring also has
281
+a [supported collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md), now is a great time to
282
+set
283
that up if it wasn't autodetected. With both process utilization and application-specific metrics, you should have every
275
-piece of data needed to discover the root cause of an incident. See our [collector
276
-setup](/docs/collect/enable-configure.md) doc for details.
284
+piece of data needed to discover the root cause of an incident. See
285
+our [collector setup](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) doc for details.
286
278
-[Create new dashboards](/docs/visualize/create-dashboards.md) in Netdata Cloud using charts from `apps.plugin`,
287
+[Create new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) in Netdata
288
+Cloud using charts from `apps.plugin`,
289
`ebpf.plugin`, and application-specific collectors to build targeted dashboards for monitoring key processes across your
290
infrastructure.
291
282
-Try running [Metric Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations) on a node that's
283
-running the process(es) you're monitoring. Even if nothing is going wrong at the moment, Netdata Cloud's embedded
284
-intelligence helps you better understand how a MySQL database, for example, might influence a system's volume of memory
285
-page faults. And when an incident is afoot, use Metric Correlations to reduce mean time to resolution (MTTR) and
286
-cognitive load.
287
-
288
-If you want more specific metrics from your custom application, check out Netdata's [statsd
289
-support](/collectors/statsd.plugin/README.md). With statd, you can send detailed metrics from your application to
290
-Netdata and visualize them with per-second granularity. Netdata's statsd collector works with dozens of [statsd server
291
-implementations](https://github.com/etsy/statsd/wiki#client-implementations), which work with most application
292
+Try
293
+running [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
294
+on a node that's running the process(es) you're monitoring. Even if nothing is going wrong at the moment, Netdata
295
+Cloud's embedded intelligence helps you better understand how a MySQL database, for example, might influence a system's
296
+volume of memory page faults. And when an incident is afoot, use Metric Correlations to reduce mean time to resolution (
297
+MTTR) and cognitive load.
298
+
299
+If you want more specific metrics from your custom application, check out
300
+Netdata's [statsd support](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md). With statd, you can send detailed metrics from your
301
+application to Netdata and visualize them with per-second granularity. Netdata's statsd collector works with dozens of
302
+[statsd server implementations](https://github.com/etsy/statsd/wiki#client-implementations), which work with most application
303
frameworks.
304
305
### Related reference documentation
306
296
-- [Netdata Agent · `apps.plugin`](/collectors/apps.plugin/README.md)
297
-- [Netdata Agent · `ebpf.plugin`](/collectors/ebpf.plugin/README.md)
298
-- [Netdata Agent · Dashboards](/web/README.md#dimensions)
299
-- [Netdata Agent · MySQL collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql)
307
+- [Netdata Agent · `apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md)
308
+- [Netdata Agent · `ebpf.plugin`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md)
309
+- [Netdata Agent · Dashboards](https://github.com/netdata/netdata/blob/master/web/README.md#dimensions)
310
+- [Netdata Agent · MySQL collector](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md)
311
312
docs/guides/monitor/raspberry-pi-anomaly-detection.md
+11
-11
@@ -12,7 +12,7 @@ We love IoT and edge at Netdata, we also love machine learning. Even better if w
12
of monitoring increasingly complex systems.
13
14
We recently explored what might be involved in enabling our Python-based [anomalies
15
-collector](/collectors/python.d.plugin/anomalies/README.md) on a Raspberry Pi. To our delight, it's actually quite
15
+collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md) on a Raspberry Pi. To our delight, it's actually quite
16
straightforward!
17
18
Read on to learn all the steps and enable unsupervised anomaly detection on your on Raspberry Pi(s).
@@ -23,14 +23,14 @@ Read on to learn all the steps and enable unsupervised anomaly detection on your
23
24
- A Raspberry Pi running Raspbian, which we'll call a _node_.
25
- The [open-source Netdata](https://github.com/netdata/netdata) monitoring agent. If you don't have it installed on your
26
- node yet, [get started now](/docs/get-started.mdx).
26
+ node yet, [get started now](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
27
28
## Install dependencies
29
30
First make sure Netdata is using Python 3 when it runs Python-based data collectors.
31
32
-Next, open `netdata.conf` using [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files)
33
-from within the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory). Scroll down to the
32
+Next, open `netdata.conf` using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files)
33
+from within the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). Scroll down to the
34
`[plugin:python.d]` section to pass in the `-ppython3` command option.
35
36
```conf
@@ -59,7 +59,7 @@ LLVM_CONFIG=llvm-config-9 pip3 install --user llvmlite numpy==1.20.1 netdata-pan
59
60
## Enable the anomalies collector
61
62
-Now you're ready to enable the collector and [restart Netdata](/docs/configure/start-stop-restart.md).
62
+Now you're ready to enable the collector and [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
63
64
```bash
65
sudo ./edit-config python.d.conf
@@ -82,7 +82,7 @@ centralized cloud somewhere) is the resource utilization impact of running a mon
82
83
With the default configuration, the anomalies collector uses about 6.5% of CPU at each run. During the retraining step,
84
CPU utilization jumps to between 20-30% for a few seconds, but you can [configure
85
-retraining](/collectors/python.d.plugin/anomalies/README.md#configuration) to happen less often if you wish.
85
+retraining](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md#configuration) to happen less often if you wish.
86
87
@@ -108,18 +108,18 @@ looks like a potentially useful addition to enable unsupervised anomaly detectio
108
See our two-part guide series for a more complete picture of configuring the anomalies collector, plus some best
109
practices on using the charts it automatically generates:
110
111
-- [_Detect anomalies in systems and applications_](/docs/guides/monitor/anomaly-detection-python.md)
112
-- [_Monitor and visualize anomalies with Netdata_](/docs/guides/monitor/visualize-monitor-anomalies.md)
111
+- [_Detect anomalies in systems and applications_](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection-python.md)
112
+- [_Monitor and visualize anomalies with Netdata_](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/visualize-monitor-anomalies.md)
113
114
If you're using your Raspberry Pi for other purposes, like blocking ads/trackers with Pi-hole, check out our companions
115
-Pi guide: [_Monitor Pi-hole (and a Raspberry Pi) with Netdata_](/docs/guides/monitor/pi-hole-raspberry-pi.md).
115
+Pi guide: [_Monitor Pi-hole (and a Raspberry Pi) with Netdata_](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/pi-hole-raspberry-pi.md).
116
117
Once you've had a chance to give unsupervised anomaly detection a go, share your use cases and let us know of any
118
feedback on our [community forum](https://community.netdata.cloud/t/anomalies-collector-feedback-megathread/767).
119
120
### Related reference documentation
121
122
-- [Netdata Agent · Get Netdata](/docs/get-started.mdx)
123
-- [Netdata Agent · Anomalies collector](/collectors/python.d.plugin/anomalies/README.md)
122
+- [Netdata Agent · Get Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx)
123
+- [Netdata Agent · Anomalies collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md)
124
125
docs/guides/monitor/statsd.md
+7
-7
@@ -22,7 +22,7 @@ In general, the process for creating a StatsD collector can be summarized in 2 s
22
23
- Run an experiment by sending StatsD metrics to Netdata, without any prior configuration. This will create a chart per metric (called private charts) and will help you verify that everything works as expected from the application side of things.
24
- Make sure to reload the dashboard tab **after** you start sending data to Netdata.
25
-- Create a configuration file for your app using [edit-config](/docs/configure/nodes.md): `sudo ./edit-config
25
+- Create a configuration file for your app using [edit-config](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md): `sudo ./edit-config
26
statsd.d/myapp.conf`
27
- Each app will have it's own section in the right-hand menu.
28
@@ -30,7 +30,7 @@ Now, let's see the above process in detail.
30
31
## Prerequisites
32
33
-- A node with the [Netdata](/docs/get-started.mdx) installed.
33
+- A node with the [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) installed.
34
- An application to instrument. For this guide, that will be [k6](https://k6.io/docs/getting-started/installation).
35
36
## Understanding the metrics
@@ -63,7 +63,7 @@ Here are some examples of default private charts. You can see that the histogram
63
64
## Create a new StatsD configuration file
65
66
-Start by creating a new configuration file under the `statsd.d/` folder in the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory). Use [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) to create a new file called `k6.conf`.
66
+Start by creating a new configuration file under the `statsd.d/` folder in the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). Use [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) to create a new file called `k6.conf`.
67
68
```bash=
69
sudo ./edit-config statsd.d/k6.conf
@@ -104,7 +104,7 @@ Families and context are additional ways to group metrics. Families control the
104
105
Context is a second way to group metrics, when the metrics are of the same nature but different origin. In our case, if we ran several different load testing experiments side-by-side, we could define the same app, but different context (e.g `http_requests.experiment1`, `http_requests.experiment2`).
106
107
-Find more details about family and context in our [documentation](/web/README.md#families).
107
+Find more details about family and context in our [documentation](https://github.com/netdata/netdata/blob/master/web/README.md#families).
108
109
### Dimension
110
@@ -115,7 +115,7 @@ Now, having decided on how we are going to group the charts, we need to define h
115
116
The dimension option has this syntax: `dimension = [pattern] METRIC NAME TYPE MULTIPLIER DIVIDER OPTIONS`
117
118
-- **pattern**: A keyword that tells the StatsD server the `METRIC` string is actually a [simple pattern].(/libnetdata/simple_pattern/README.md). We don't simple patterns in the example, but if we wanted to visualize all the `http_req` metrics, we could have a single dimension: `dimension = pattern 'k6.http_req*' last 1 1`. Find detailed examples with patterns in our [documentation](/collectors/statsd.plugin/README.md#dimension-patterns).
118
+- **pattern**: A keyword that tells the StatsD server the `METRIC` string is actually a [simple pattern].(/libnetdata/simple_pattern/README.md). We don't simple patterns in the example, but if we wanted to visualize all the `http_req` metrics, we could have a single dimension: `dimension = pattern 'k6.http_req*' last 1 1`. Find detailed examples with patterns in our [documentation](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md#dimension-patterns).
119
- **METRIC** The id of the metric as it comes from the client. You can easily find this in the private charts above, for example: `k6.http_req_connecting`.
120
- **NAME**: The name of the dimension. You can use the dictionary to expand this to something more human-readable.
121
- **TYPE**:
@@ -212,7 +212,7 @@ Following the above steps, we append to the `k6.conf` that we defined above, the
212
213
> Take note that Netdata will report the rate for metrics and counters, even if k6 or another application sends an _absolute_ number. For example, k6 sends absolute HTTP requests with `http_reqs`, but Netdat visualizes that in `requests/second`.
214
215
-To enable this StatsD configuration, [restart Netdata](/docs/configure/start-stop-restart.md).
215
+To enable this StatsD configuration, [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
216
217
## Final touches
218
@@ -293,6 +293,6 @@ Netdata allows you easily visualize any StatsD metric without any configuration,
293
294
### Related reference documentation
295
296
-- [Netdata Agent · StatsD](/collectors/statsd.plugin/README.md)
296
+- [Netdata Agent · StatsD](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md)
297
298
docs/guides/monitor/stop-notifications-alarms.md
+6
-6
@@ -13,7 +13,7 @@ relevant if you run Netdata on your laptop or a small virtual server. If they're
13
to real issues with health and performance.
14
15
Silencing individual alarms is an excellent solution for situations where you're not interested in seeing a specific
16
-alarm but don't want to disable a [notification system](/health/notifications/README.md) entirely.
16
+alarm but don't want to disable a [notification system](https://github.com/netdata/netdata/blob/master/health/notifications/README.md) entirely.
17
18
## Find the alarm configuration file
19
@@ -34,7 +34,7 @@ In the `source` row, you see that this chart is getting its configuration from
34
the file you need to edit if you want to silence this alarm.
35
36
For more information about editing or referencing health configuration files on your system, see the [health
37
-quickstart](/health/QUICKSTART.md#edit-health-configuration-files).
37
+quickstart](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#edit-health-configuration-files).
38
39
## Edit the file to enable silencing
40
@@ -70,7 +70,7 @@ To silence this alarm, change `sysadmin` to `silent`.
70
to: silent
71
```
72
73
-Use one of the available [methods](/health/QUICKSTART.md#reload-health-configuration) to reload your health configuration
73
+Use one of the available [methods](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#reload-health-configuration) to reload your health configuration
74
and ensure you get no more notifications about that alarm**.
75
76
You can add `to: silent` to any alarm you'd rather not bother you with notifications.
@@ -80,12 +80,12 @@ You can add `to: silent` to any alarm you'd rather not bother you with notificat
80
You should now know the fundamentals behind silencing any individual alarm in Netdata.
81
82
To learn about _all_ of Netdata's health configuration possibilities, visit the [health reference
83
-guide](/health/REFERENCE.md), or check out other [tutorials on health monitoring](/health/README.md#guides).
83
+guide](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or check out other [tutorials on health monitoring](https://github.com/netdata/netdata/blob/master/health/README.md#guides).
84
85
Or, take better control over how you get notified about alarms via the [notification
86
-system](/health/notifications/README.md).
86
+system](https://github.com/netdata/netdata/blob/master/health/notifications/README.md).
87
88
-You can also use Netdata's [Health Management API](/web/api/health/README.md#health-management-api) to control health
88
+You can also use Netdata's [Health Management API](https://github.com/netdata/netdata/blob/master/web/api/health/README.md#health-management-api) to control health
89
checks and notifications while Netdata runs. With this API, you can disable health checks during a maintenance window or
90
backup process, for example.
91
docs/guides/monitor/visualize-monitor-anomalies.md
+14
-14
@@ -10,7 +10,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/moni
10
11
Welcome to part 2 of our series of guides on using _unsupervised anomaly detection_ to detect issues with your systems,
12
containers, and applications using the open-source Netdata Agent. For an introduction to detecting anomalies and
13
-monitoring associated metrics, see [part 1](/docs/guides/monitor/anomaly-detection-python.md), which covers prerequisites and
13
+monitoring associated metrics, see [part 1](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection-python.md), which covers prerequisites and
14
configuration basics.
15
16
With anomaly detection in the Netdata Agent set up, you will now want to visualize and monitor which charts have
@@ -48,8 +48,8 @@ analysis (RCA).
48
49
The anomalies collector creates two "classes" of alarms for each chart captured by the `charts_regex` setting. All these
50
alarms are preconfigured based on your [configuration in
51
-`anomalies.conf`](/docs/guides/monitor/anomaly-detection-python.md#configure-the-anomalies-collector). With the `charts_regex`
52
-and `charts_to_exclude` settings from [part 1](/docs/guides/monitor/anomaly-detection-python.md) of this guide series, the
51
+`anomalies.conf`](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection-python.md#configure-the-anomalies-collector). With the `charts_regex`
52
+and `charts_to_exclude` settings from [part 1](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection-python.md) of this guide series, the
53
Netdata Agent creates 32 alarms driven by unsupervised anomaly detection.
54
55
The first class triggers warning alarms when the average anomaly probability for a given chart has stayed above 50% for
@@ -69,17 +69,17 @@ there's a full-blown incident, depending on what application/service you're usin
69
further investigation.
70
71
As you use the anomalies collector, you may find that the default settings provide too many or too few genuine alarms.
72
-In this case, [configure the alarm](/docs/monitor/configure-alarms.md) with `sudo ./edit-config
72
+In this case, [configure the alarm](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) with `sudo ./edit-config
73
health.d/anomalies.conf`. Take a look at the `lookup` line syntax in the [health
74
-reference](/health/REFERENCE.md#alarm-line-lookup) to understand how the anomalies collector automatically creates
74
+reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-lookup) to understand how the anomalies collector automatically creates
75
alarms for any dimension on the `anomalies_local.probability` and `anomalies_local.anomaly` charts.
76
77
## Visualize anomalies in charts
78
79
In either [Netdata Cloud](https://app.netdata.cloud) or the local Agent dashboard at `http://NODE:19999`, click on the
80
-**Anomalies** [section](/web/gui/README.md#sections) to see the pair of anomaly detection charts, which are
80
+**Anomalies** [section](https://github.com/netdata/netdata/blob/master/web/gui/README.md#sections) to see the pair of anomaly detection charts, which are
81
preconfigured to visualize per-second anomaly metrics based on your [configuration in
82
-`anomalies.conf`](/docs/guides/monitor/anomaly-detection-python.md#configure-the-anomalies-collector).
82
+`anomalies.conf`](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection-python.md#configure-the-anomalies-collector).
83
84
These charts have the contexts `anomalies.probability` and `anomalies.anomaly`. Together, these charts
85
create meaningful visualizations for immediately recognizing not only that something is going wrong on your node, but
@@ -88,7 +88,7 @@ give context as to where to look next.
88
The `anomalies_local.probability` chart shows the probability that the latest observed data is anomalous, based on the
89
trained model. The `anomalies_local.anomaly` chart visualizes 0→1 predictions based on whether the latest observed
90
data is anomalous based on the trained model. Both charts share the same dimensions, which you configured via
91
-`charts_regex` and `charts_to_exclude` in [part 1](/docs/guides/monitor/anomaly-detection-python.md).
91
+`charts_regex` and `charts_to_exclude` in [part 1](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection-python.md).
92
93
In other words, the `probability` chart shows the amplitude of the anomaly, whereas the `anomaly` chart provides quick
94
yes/no context.
@@ -108,7 +108,7 @@ dimensions that immediately shot to 100% anomaly probability, and remained there
108
## Build an anomaly detection dashboard
109
110
[Netdata Cloud](https://app.netdata.cloud) features a drag-and-drop [dashboard
111
-editor](/docs/visualize/create-dashboards.md) that helps you create entirely new dashboards with charts targeted for
111
+editor](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) that helps you create entirely new dashboards with charts targeted for
112
your specific applications.
113
114
For example, here's a dashboard designed for visualizing anomalies present in an Nginx web server, including
@@ -119,12 +119,12 @@ dashboard](https://user-images.githubusercontent.com/1153921/104226915-c6188f00-
119
120
Use the anomaly charts for instant visual identification of potential anomalies, and then Nginx-specific charts, in the
121
right column, to validate whether the probability and anomaly counters are showing a valid incident worth further
122
-investigation using [Metric Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations) to narrow
122
+investigation using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to narrow
123
the dashboard into only the charts relevant to what you're seeing from the anomalies collector.
124
125
## What's next?
126
127
-Between this guide and [part 1](/docs/guides/monitor/anomaly-detection-python.md), which covered setup and configuration, you
127
+Between this guide and [part 1](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection-python.md), which covered setup and configuration, you
128
now have a fundamental understanding of how unsupervised anomaly detection in Netdata works, from root cause to alarms
129
to preconfigured or custom dashboards.
130
@@ -132,11 +132,11 @@ We'd love to hear your feedback on the anomalies collector. Hop over to the [com
132
forum](https://community.netdata.cloud/t/anomalies-collector-feedback-megathread/767), and let us know if you're already getting value from
133
unsupervised anomaly detection, or would like to see something added to it. You might even post a custom configuration
134
that works well for monitoring some other popular application, like MySQL, PostgreSQL, Redis, or anything else we
135
-[support through collectors](/collectors/COLLECTORS.md).
135
+[support through collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
136
137
### Related reference documentation
138
139
-- [Netdata Agent · Anomalies collector](/collectors/python.d.plugin/anomalies/README.md)
140
-- [Netdata Cloud · Build new dashboards](https://learn.netdata.cloud/docs/cloud/visualize/dashboards)
139
+- [Netdata Agent · Anomalies collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md)
140
+- [Netdata Cloud · Build new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)
141
142
docs/guides/python-collector.md
+9
-9
@@ -10,9 +10,9 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/pyth
10
11
# Develop a custom data collector in Python
12
13
-The Netdata Agent uses [data collectors](/docs/collect/how-collectors-work.md) to fetch metrics from hundreds of system,
13
+The Netdata Agent uses [data collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) to fetch metrics from hundreds of system,
14
container, and service endpoints. While the Netdata team and community has built [powerful
15
-collectors](/collectors/COLLECTORS.md) for most system, container, and service/application endpoints, there are plenty
15
+collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for most system, container, and service/application endpoints, there are plenty
16
of custom applications that can't be monitored by default.
17
18
## Problem
@@ -29,7 +29,7 @@ covered here, or use the included examples for collecting and organizing either
29
## What you need to get started
30
31
- A physical or virtual Linux system, which we'll call a _node_.
32
-- A working installation of the free and open-source [Netdata](/docs/get-started.mdx) monitoring agent.
32
+- A working installation of the free and open-source [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) monitoring agent.
33
34
## Jobs and elements of a Python collector
35
@@ -90,7 +90,7 @@ context, charttype]`, where:
90
that is `A.B`, with `A` being the name of the collector, and `B` being the name of the specific metric.
91
- `charttype`: Either `line`, `area`, or `stacked`. If null line is the default value.
92
93
-You can read more about `family` and `context` in the [web dashboard](/web/README.md#families) doc.
93
+You can read more about `family` and `context` in the [web dashboard](https://github.com/netdata/netdata/blob/master/web/README.md#families) doc.
94
95
Once the chart has been defined, you should define the dimensions of the chart. Dimensions are basically the metrics to
96
be represented in this chart and each chart can have more than one dimension. In order to define the dimensions, the
@@ -166,7 +166,7 @@ class Service(UrlService):
166
167
In our use-case, we use the `SimpleService` framework, since there is no framework class that suits our needs.
168
169
-You can read more about the [framework classes](/collectors/python.d.plugin/README.md#how-to-write-a-new-module) from
169
+You can read more about the [framework classes](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#how-to-write-a-new-module) from
170
the Netdata documentation.
171
172
## An example collector using weather station data
@@ -348,7 +348,7 @@ ORDER = [
348
]
349
```
350
351
-[Restart Netdata](/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see the new humidity
351
+[Restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see the new humidity
352
chart:
353
354
@@ -405,7 +405,7 @@ ORDER = [
405
]
406
```
407
408
-[Restart Netdata](/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see the new
408
+[Restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see the new
409
min/max/average temperature chart with multiple dimensions:
410
411
@@ -459,7 +459,7 @@ variables and inform the user about the defaults. For example, take a look at th
459
[GitHub](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/example/example.conf).
460
461
You can read more about the configuration file on the [`python.d.plugin`
462
-documentation](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin).
462
+documentation](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md).
463
464
## What's next?
465
@@ -470,7 +470,7 @@ Now you are ready to start developing our Netdata python Collector and share it
470
- If you need help while developing your collector, join our [Netdata
471
Community](https://community.netdata.cloud/c/agent-development/9) to chat about it.
472
- Follow the
473
- [checklist](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin#pull-request-checklist-for-python-plugins)
473
+ [checklist](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#pull-request-checklist-for-python-plugins)
474
to contribute the collector to the Netdata Agent [repository](https://github.com/netdata/netdata).
475
- Check out the [example](https://github.com/netdata/netdata/tree/master/collectors/python.d.plugin/example) Python
476
collector, which is a minimal example collector you could also use as a starting point. Once comfortable with that,
docs/guides/step-by-step/step-00.md
+3
-3
@@ -18,7 +18,7 @@ completely new to Netdata, or have never tried health monitoring/performance tro
18
guide is perfect for you.
19
20
If you have monitoring experience, or would rather get straight into configuring Netdata to your needs, you can jump
21
-straight into code and configurations with our [getting started guide](/docs/get-started.mdx).
21
+straight into code and configurations with our [getting started guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
22
23
> This guide contains instructions for Netdata installed on a Linux system. Many of the instructions will work on
24
> other supported operating systems, like FreeBSD and macOS, but we can't make any guarantees.
@@ -44,7 +44,7 @@ The easiest way to install Netdata on a Linux system is our `kickstart.sh` one-l
44
and let it take care of the rest.
45
46
This script will install Netdata from source, keep it up to date with nightly releases, connects to the Netdata
47
-[registry](/registry/README.md), and sends [_anonymous statistics_](/docs/anonymous-statistics.md) about how you use
47
+[registry](https://github.com/netdata/netdata/blob/master/registry/README.md), and sends [_anonymous statistics_](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md) about how you use
48
Netdata. We use this information to better understand how we can improve the Netdata experience for all our users.
49
50
To install Netdata, run the following as your normal user:
@@ -60,7 +60,7 @@ Once finished, you'll have Netdata installed, and you'll be set up to get _night
60
improvements, and bugfixes.
61
62
If this method doesn't work for you, or you want to use a different process, visit our [installation
63
-documentation](/packaging/installer/README.md) for details.
63
+documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) for details.
64
65
## Netdata fundamentals
66
docs/guides/step-by-step/step-01.md
+1
-1
@@ -139,7 +139,7 @@ easy!
139
We'll cover this quickly, as you're probably eager to get on with using Netdata itself.
140
141
We don't want to lock you in to using Netdata by itself, and forever. By supporting [archiving to
142
-external databases](/exporting/README.md) like Graphite, Prometheus, OpenTSDB, MongoDB, and others, you can use Netdata _in
142
+external databases](https://github.com/netdata/netdata/blob/master/exporting/README.md) like Graphite, Prometheus, OpenTSDB, MongoDB, and others, you can use Netdata _in
143
conjunction_ with software that might seem like our competitors.
144
145
We don't want to "wage war" with another monitoring solution, whether it's commercial, open-source, or anything in
docs/guides/step-by-step/step-02.md
+4
-4
@@ -11,7 +11,7 @@ working with the dashboard directly.
11
12
This step-by-step guide assumes you've already installed Netdata on a system of yours. If you haven't yet, hop back over
13
to ["step 0"](step-00.md#before-we-get-started) for information about our one-line installer script. Or, view the
14
-[installation docs](/packaging/installer/README.md) to learn more. Once you have Netdata installed, you can hop back
14
+[installation docs](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) to learn more. Once you have Netdata installed, you can hop back
15
over here and dig in.
16
17
## What you'll learn in this step
@@ -56,7 +56,7 @@ what it's collecting. If you run Netdata on many different systems using differe
56
menus and submenus may look a little different for each one.
57
58
To learn more about menus, see our documentation about [navigating the standard
59
-dashboard](/web/gui/README.md#metrics-menus).
59
+dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md#metrics-menus).
60
61
> ❗ By default, Netdata only creates and displays charts if the metrics are _not zero_. So, you may be missing some
62
> charts, menus, and submenus if those charts have zero metrics. You can change this by changing the **Which dimensions
@@ -106,7 +106,7 @@ looking at its name or hovering over the chart's date.
106
It's important to understand these differences, as Netdata uses charts, dimensions, families, and contexts to create
107
health alarms and configure collectors. To read even more about the differences between all these elements of the
108
dashboard, and how they affect other parts of Netdata, read our [dashboards
109
-documentation](/web/README.md#charts-contexts-families).
109
+documentation](https://github.com/netdata/netdata/blob/master/web/README.md#charts-contexts-families).
110
111
## Interact with charts
112
@@ -148,7 +148,7 @@ chart to its original height, double-click the same icon.
148
150
151
-To learn more about other options and chart interactivity, read our [dashboard documentation](/web/README.md).
151
+To learn more about other options and chart interactivity, read our [dashboard documentation](https://github.com/netdata/netdata/blob/master/web/README.md).
152
153
## See raised alarms and the alarm log
154
docs/guides/step-by-step/step-03.md
+9
-6
@@ -14,7 +14,7 @@ You might be thinking, "So, now I have to remember all these IP addresses, and t
14
manually, to move from one system to another? Maybe I should just make a bunch of bookmarks. What's a few more tabs
15
on top of the hundred I have already?"
16
17
-We get it. That's why we built [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/), which connects many distributed
17
+We get it. That's why we built [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), which connects many distributed
18
agents for a seamless experience when monitoring an entire infrastructure of Netdata-monitored nodes.
19
20
28
-- [Get started with Netdata Cloud](#get-started-with-netdata-cloud)
29
-- [Navigate between dashboards with Visited Nodes](#navigate-between-dashboards-with-visited-nodes)
27
+- [Step 3. Monitor more than one system with Netdata](#step-3-monitor-more-than-one-system-with-netdata)
28
+ - [What you'll learn in this step](#what-youll-learn-in-this-step)
29
+ - [Why use Netdata Cloud?](#why-use-netdata-cloud)
30
+ - [Get started with Netdata Cloud](#get-started-with-netdata-cloud)
31
+ - [Navigate between dashboards with Visited Nodes](#navigate-between-dashboards-with-visited-nodes)
32
+ - [What's next?](#whats-next)
33
34
## Why use Netdata Cloud?
35
33
-Our [Cloud documentation](https://learn.netdata.cloud/docs/cloud/) does a good job (we think!) of explaining why Cloud
36
+Our [Cloud documentation](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) does a good job (we think!) of explaining why Cloud
37
gives you a ton of value at no cost:
38
39
> Netdata Cloud gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can run all your
@@ -44,7 +47,7 @@ features, new collectors for more applications, and improved UI, so will Cloud.
47
## Get started with Netdata Cloud
48
49
Signing in, onboarding, and connecting your first nodes only takes a few minutes, and we have a [Get started with
47
-Cloud](https://learn.netdata.cloud/docs/cloud/get-started) guide to help you walk through every step.
50
+Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) guide to help you walk through every step.
51
52
Or, if you're feeling confident, dive right in.
53
docs/guides/step-by-step/step-04.md
+4
-4
@@ -43,7 +43,7 @@ In the system represented by the screenshot, the line reads: `config directory =
43
`netdata.conf`, and all the other configuration files, can be found at `/etc/netdata`.
44
45
> For more details on where your Netdata config directory is, take a look at our [installation
46
-> instructions](/packaging/installer/README.md).
46
+> instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
47
48
For the rest of this guide, we'll assume you're editing files or running scripts from _within_ your **Netdata
49
configuration directory**.
@@ -96,7 +96,7 @@ section and give it the value of `1`.
96
```
97
98
Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
99
-method](/docs/configure/start-stop-restart.md) for your system.
99
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
100
101
Now, open up your browser and navigate to `http://HOST:19999/netdata.conf`. You'll see that Netdata has recognized
102
that our fake option isn't valid and added a notice that Netdata will ignore it.
@@ -124,8 +124,8 @@ Once you're done, restart Netdata and refresh the dashboard. Say hello to your r
124
netdata.conf](https://user-images.githubusercontent.com/1153921/80994808-1c065300-8df2-11ea-81af-d28dc3ba27c8.gif)
125
126
Netdata has dozens upon dozens of options you can change. To see them all, read our [daemon
127
-configuration](/daemon/config/README.md), or hop into our popular guide on [increasing long-term metrics
128
-storage](/docs/guides/longer-metrics-storage.md).
127
+configuration](https://github.com/netdata/netdata/blob/master/daemon/config/README.md), or hop into our popular guide on [increasing long-term metrics
128
+storage](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md).
129
130
## What's next?
131
docs/guides/step-by-step/step-05.md
+9
-10
@@ -32,8 +32,7 @@ The first chart you see on any Netdata dashboard is the `system.cpu` chart, whic
32
across all cores. To figure out which file you need to edit to tune this alarm, click the **Alarms** button at the top
33
of the dashboard, click on the **All** tab, and find the **system - cpu** alarm entity.
34
35
-
35
+
36
37
Look at the `source` row in the table. This means the `system.cpu` chart sources its health alarms from
38
`4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. To tune these alarms, you'll need to edit the alarm file at
@@ -70,10 +69,10 @@ the `warn` and `crit` lines to the values of your choosing. For example:
69
```
70
71
You _can_ restart Netdata with `sudo systemctl restart netdata`, to enable your tune, but you can also reload _only_ the
73
-health monitoring component using one of the available [methods](/health/QUICKSTART.md#reload-health-configuration).
72
+health monitoring component using one of the available [methods](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#reload-health-configuration).
73
74
You can also tune any other aspect of the default alarms. To better understand how each line in a health entity works,
76
-read our [health documentation](/health/README.md).
75
+read our [health documentation](https://github.com/netdata/netdata/blob/master/health/README.md).
76
77
### Silence an individual alarm
78
@@ -176,7 +175,7 @@ These lines will trigger a warning if that average RAM usage goes above 80%, and
175
176
> ❗ Most default Netdata alarms come with more complicated `warn` and `crit` lines. You may have noticed the line `warn:
177
> $this > (($status >= $WARNING) ? (75) : (85))` in one of the health entity examples above, which is an example of
179
-> using the [conditional operator for hysteresis](/health/REFERENCE.md#special-use-of-the-conditional-operator).
178
+> using the [conditional operator for hysteresis](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#special-use-of-the-conditional-operator).
179
> Hysteresis is used to keep Netdata from triggering a ton of alerts if the metric being tracked quickly goes above and
180
> then falls below the threshold. For this very simple example, we'll skip hysteresis, but recommend implementing it in
181
> your future health entities.
@@ -215,7 +214,7 @@ stress -m 1 --vm-bytes 8G --vm-keep
214
```
215
216
Netdata is capable of understanding much more complicated entities. To better understand how they work, read the [health
218
-documentation](/health/README.md), look at some [examples](/health/REFERENCE.md#example-alarms), and open the files
217
+documentation](https://github.com/netdata/netdata/blob/master/health/README.md), look at some [examples](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#example-alarms), and open the files
218
containing the default entities on your system.
219
220
## Enable Netdata's notification systems
@@ -224,7 +223,7 @@ Health alarms, while great on their own, are pretty useless without some way of
223
That's why Netdata comes with a notification system that supports more than a dozen services, such as email, Slack,
224
Discord, PagerDuty, Twilio, Amazon SNS, and much more.
225
227
-To see all the supported systems, visit our [notifications documentation](/health/notifications/README.md).
226
+To see all the supported systems, visit our [notifications documentation](https://github.com/netdata/netdata/blob/master/health/notifications/README.md).
227
228
We'll cover email and Slack notifications here, but with this knowledge you should be able to enable any other type of
229
notifications instead of or in addition to these.
@@ -330,9 +329,9 @@ applications.
329
To further configure your email or Slack notification setup, or to enable other notification systems, check out the
330
following documentation:
331
333
-- [Email notifications](/health/notifications/email/README.md)
334
-- [Slack notifications](/health/notifications/slack/README.md)
335
-- [Netdata's notification system](/health/notifications/README.md)
332
+- [Email notifications](https://github.com/netdata/netdata/blob/master/health/notifications/email/README.md)
333
+- [Slack notifications](https://github.com/netdata/netdata/blob/master/health/notifications/slack/README.md)
334
+- [Netdata's notification system](https://github.com/netdata/netdata/blob/master/health/notifications/README.md)
335
336
## What's next?
337
docs/guides/step-by-step/step-06.md
+5
-5
@@ -8,13 +8,13 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step
8
When Netdata _starts_, it auto-detects dozens of **data sources**, such as database servers, web servers, and more.
9
10
To auto-detect and collect metrics from a source you just installed, you need to restart Netdata using `sudo systemctl
11
-restart netdata`, or the [appropriate method](/docs/configure/start-stop-restart.md) for your system.
11
+restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
12
13
However, auto-detection only works if you installed the source using its standard installation
14
procedure. If Netdata isn't collecting metrics after a restart, your source probably isn't configured
15
correctly.
16
17
-Check out the [collectors that come pre-installed with Netdata](/collectors/COLLECTORS.md) to find the module for the
17
+Check out the [collectors that come pre-installed with Netdata](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) to find the module for the
18
source you want to monitor.
19
20
## What you'll learn in this step
@@ -37,8 +37,8 @@ are organized and manged by plugins. **Internal** plugins collect system metrics
37
non-system metrics, and **orchestrator** plugins group individual collectors together based on the programming language
38
they were built in.
39
40
-These modules are primarily written in [Go](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/) (`go.d`) and
41
-[Python](/collectors/python.d.plugin/README.md), although some use [Bash](/collectors/charts.d.plugin/README.md)
40
+These modules are primarily written in [Go](https://github.com/netdata/go.d.plugin/blob/master/README.md) (`go.d`) and
41
+[Python](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md), although some use [Bash](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/README.md)
42
(`charts.d`).
43
44
## Enable and disable plugins
@@ -100,7 +100,7 @@ Next, edit your `/etc/nginx/sites-enabled/default` file to include a `location`
100
```
101
102
Restart Netdata using `sudo systemctl restart netdata`, or the [appropriate
103
-method](/docs/configure/start-stop-restart.md) for your system, and Netdata will auto-detect metrics from your Nginx web
103
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, and Netdata will auto-detect metrics from your Nginx web
104
server!
105
106
While not necessary for most auto-detection and collection purposes, you can also configure the Nginx collector itself
docs/guides/step-by-step/step-07.md
+4
-4
@@ -9,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step
9
Welcome to the seventh step of the Netdata guide!
10
11
This step of the guide aims to get you more familiar with the features of the dashboard not previously mentioned in
12
-[step 2](/docs/guides/step-by-step/step-02.md).
12
+[step 2](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-02.md).
13
14
## What you'll learn in this step
15
@@ -53,9 +53,9 @@ You can always check if there is an update available from the **Update** area of
53
54
If an update is available, you'll see a modal similar to the one above.
55
56
-When you use the [automatic one-line installer script](/packaging/installer/README.md) attempt to update every day. If
57
-you choose to update it manually, there are [several well-documented methods](/packaging/installer/UPDATE.md) to achieve
58
-that. However, it is best practice for you to first go over the [changelog](/CHANGELOG.md).
56
+When you use the [automatic one-line installer script](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) attempt to update every day. If
57
+you choose to update it manually, there are [several well-documented methods](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md) to achieve
58
+that. However, it is best practice for you to first go over the [changelog](https://github.com/netdata/netdata/blob/master/CHANGELOG.md).
59
60
## Export and import a snapshot
61
docs/guides/step-by-step/step-08.md
+3
-3
@@ -145,7 +145,7 @@ charts on a single page.
145
### The chart unique ID (required)
146
147
You need to specify the unique ID of a chart to show it on your custom dashboard. If you forgot how to find the unique
148
-ID, head back over to [step 2](/docs/guides/step-by-step/step-02.md#understand-charts-dimensions-families-and-contexts)
148
+ID, head back over to [step 2](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-02.md#understand-charts-dimensions-families-and-contexts)
149
for a re-introduction.
150
151
You can then put this unique ID into a `<div>` element with the `data-netdata` attribute. Put this in the `<body>` of
@@ -385,11 +385,11 @@ In this guide, you learned the fundamentals of building a custom Netdata dashboa
385
charts to your `custom-dashboard.html`, change the charts that are already there, and size them according to your needs.
386
387
Of course, the custom dashboarding features covered here are just the beginning. Be sure to read up on our [custom
388
-dashboard documentation](/web/gui/custom/README.md) for details on how you can use other chart libraries, pull metrics
388
+dashboard documentation](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) for details on how you can use other chart libraries, pull metrics
389
from multiple Netdata agents, and choose which dimensions a given chart shows.
390
391
Next, you'll learn how to store long-term historical metrics in Netdata!
392
393
-[Next: Long-term metrics storage →](/docs/guides/step-by-step/step-09.md)
393
+[Next: Long-term metrics storage →](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-09.md)
394
395
docs/guides/step-by-step/step-09.md
+8
-8
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step
5
6
# Step 9. Long-term metrics storage
7
8
-By default, Netdata stores metrics in a custom database we call the [database engine](/database/engine/README.md), which
8
+By default, Netdata stores metrics in a custom database we call the [database engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md), which
9
stores recent metrics in your system's RAM and "spills" historical metrics to disk. By using both RAM and disk, the
10
database engine helps you store a much larger dataset than the amount of RAM your system has.
11
@@ -51,7 +51,7 @@ the database engine to use. The higher those values, the more metrics Netdata wi
51
512, respectively, the database engine should store about four day's worth of data on a system collecting 2,000 metrics
52
every second.
53
54
-[**See our database engine calculator**](/docs/store/change-metrics-storage.md) to help you correctly set `dbengine disk
54
+[**See our database engine calculator**](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) to help you correctly set `dbengine disk
55
space` based on your needs. The calculator gives an accurate estimate based on how many child nodes you have, how many
56
metrics your Agent collects, and more.
57
@@ -63,7 +63,7 @@ metrics your Agent collects, and more.
63
```
64
65
After you've made your changes, restart Netdata using `sudo systemctl restart netdata`, or the [appropriate
66
-method](/docs/configure/start-stop-restart.md) for your system.
66
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
67
68
To confirm the database engine is working, go to your Netdata dashboard and click on the **Netdata Monitoring** menu on
69
the right-hand side. You can find `dbengine` metrics after `queries`.
@@ -77,7 +77,7 @@ You can archive all the metrics collected by Netdata to **external databases**.
77
include Graphite, OpenTSDB, Prometheus, AWS Kinesis Data Streams, Google Cloud Pub/Sub, MongoDB, and the list is always
78
growing.
79
80
-As we said in [step 1](/docs/guides/step-by-step/step-01.md), we have only complimentary systems, not competitors! We're
80
+As we said in [step 1](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-01.md), we have only complimentary systems, not competitors! We're
81
happy to support these archiving methods and are always working to improve them.
82
83
A lot of Netdata users archive their metrics to one of these databases for long-term storage or further analysis. Since
@@ -117,7 +117,7 @@ use netdata
117
db.createCollection("netdata_metrics")
118
```
119
120
-Next, Netdata needs to be [reinstalled](/packaging/installer/REINSTALL.md) in order to detect that the required
120
+Next, Netdata needs to be [reinstalled](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md) in order to detect that the required
121
libraries to make this exporting connection exist. Since you most likely installed Netdata using the one-line installer
122
script, all you have to do is run that script again. Don't worry—any configuration changes you made along the way will
123
be retained!
@@ -140,14 +140,14 @@ Add the following section to the file:
140
```
141
142
Restart Netdata using `sudo systemctl restart netdata`, or the [appropriate
143
-method](/docs/configure/start-stop-restart.md) for your system, to enable the MongoDB exporting connector. Click on the
143
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to enable the MongoDB exporting connector. Click on the
144
**Netdata Monitoring** menu and check out the **exporting my mongo instance** sub-menu. You should start seeing these
145
charts fill up with data about the exporting process!
146
147
148
149
If you'd like to try connecting Netdata to another database, such as Prometheus or OpenTSDB, read our [exporting
150
-documentation](/exporting/README.md).
150
+documentation](https://github.com/netdata/netdata/blob/master/exporting/README.md).
151
152
## What's next?
153
@@ -157,6 +157,6 @@ metrics to MongoDB for long-term storage.
157
In the last step of this step-by-step guide, we'll put our sysadmin hat on and use Nginx to proxy traffic to and from
158
our Netdata dashboard.
159
160
-[Next: Set up a proxy →](/docs/guides/step-by-step/step-10.md)
160
+[Next: Set up a proxy →](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-10.md)
161
162
docs/guides/step-by-step/step-10.md
+3
-3
@@ -219,9 +219,9 @@ You're a real sysadmin now!
219
220
If you want to configure your Nginx proxy further, check out the following:
221
222
-- [Running Netdata behind Nginx](/docs/Running-behind-nginx.md)
223
-- [How to optimize Netdata's performance](/docs/guides/configure/performance.md)
224
-- [Enabling TLS on Netdata's dashboard](/web/server/README.md#enabling-tls-support)
222
+- [Running Netdata behind Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md)
223
+- [How to optimize Netdata's performance](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md)
224
+- [Enabling TLS on Netdata's dashboard](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support)
225
226
And... you're _almost_ done with the Netdata guide.
227
docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
+12
-12
@@ -9,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/trou
9
10
When trying to troubleshoot or debug a finicky application, there's no such thing as too much information. At Netdata,
11
we developed programs that connect to the [_extended Berkeley Packet Filter_ (eBPF) virtual
12
-machine](/collectors/ebpf.plugin/README.md) to help you see exactly how specific applications are interacting with the
12
+machine](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md) to help you see exactly how specific applications are interacting with the
13
Linux kernel. With these charts, you can root out bugs, discover optimizations, diagnose memory leaks, and much more.
14
15
This means you can see exactly how often, and in what volume, the application creates processes, opens files, writes to
@@ -26,7 +26,7 @@ To start troubleshooting an application with eBPF metrics, you need to ensure yo
26
displays those metrics independent from any other process.
27
28
You can use the `apps_groups.conf` file to configure which applications appear in charts generated by
29
-[`apps.plugin`](/collectors/apps.plugin/README.md). Once you edit this file and create a new group for the application
29
+[`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md). Once you edit this file and create a new group for the application
30
you want to monitor, you can see how it's interacting with the Linux kernel via real-time eBPF metrics.
31
32
Let's assume you have an application that runs on the process `custom-app`. To monitor eBPF metrics for that application
@@ -58,12 +58,12 @@ dev: custom-app
58
```
59
60
Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
61
-method](/docs/configure/start-stop-restart.md) for your system, to begin seeing metrics for this particular
61
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin seeing metrics for this particular
62
group+process. You can also add additional processes to the same group.
63
64
You can set up `apps_groups.conf` to more show more precise eBPF metrics for any application or service running on your
65
system, even if it's a standard package like Redis, Apache, or any other [application/service Netdata collects
66
-from](/collectors/COLLECTORS.md).
66
+from](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
67
68
```conf
69
# -----------------------------------------------------------------------------
@@ -107,7 +107,7 @@ Replace `entry` with `return`:
107
```
108
109
Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
110
-method](/docs/configure/start-stop-restart.md) for your system.
110
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
111
112
## Get familiar with per-application eBPF metrics and charts
113
@@ -119,7 +119,7 @@ Pay particular attention to the charts in the **ebpf file**, **ebpf syscall**, *
119
sub-sections. These charts are populated by low-level Linux kernel metrics thanks to eBPF, and showcase the volume of
120
calls to open/close files, call functions like `do_fork`, IO activity on the VFS, and much more.
121
122
-See the [eBPF collector documentation](/collectors/ebpf.plugin/README.md#integration-with-appsplugin) for the full list
122
+See the [eBPF collector documentation](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md#integration-with-appsplugin) for the full list
123
of per-application charts.
124
125
Let's show some examples of how you can first identify normal eBPF patterns, then use that knowledge to identify
@@ -236,17 +236,17 @@ same application on multiple systems and want to correlate how it performs on ea
236
findings with someone else on your team.
237
238
If you don't already have a Netdata Cloud account, go [sign in](https://app.netdata.cloud) and get started for free.
239
-Read the [get started with Cloud guide](https://learn.netdata.cloud/docs/cloud/get-started) for a walkthrough of
239
+Read the [get started with Cloud guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx) for a walkthrough of
240
connecting nodes to and other fundamentals.
241
242
Once you've added one or more nodes to a Space in Netdata Cloud, you can see aggregated eBPF metrics in the [Overview
243
-dashboard](/docs/visualize/overview-infrastructure.md) under the same **Applications** or **eBPF** sections that you
244
-find on the local Agent dashboard. Or, [create new dashboards](/docs/visualize/create-dashboards.md) using eBPF metrics
243
+dashboard](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) under the same **Applications** or **eBPF** sections that you
244
+find on the local Agent dashboard. Or, [create new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) using eBPF metrics
245
from any number of distributed nodes to see how your application interacts with multiple Linux kernels on multiple Linux
246
systems.
247
248
Now that you can see eBPF metrics in Netdata Cloud, you can [invite your
249
-team](https://learn.netdata.cloud/docs/cloud/manage/invite-your-team) and share your findings with others.
249
+team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md) and share your findings with others.
250
251
## What's next?
252
@@ -257,8 +257,8 @@ interacts with the Linux kernel.
257
If you're still trying to wrap your head around what we offer, be sure to read up on our accompanying documentation and
258
other resources on eBPF monitoring with Netdata:
259
260
-- [eBPF collector](/collectors/ebpf.plugin/README.md)
261
-- [eBPF's integration with `apps.plugin`](/collectors/apps.plugin/README.md#integration-with-ebpf)
260
+- [eBPF collector](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md)
261
+- [eBPF's integration with `apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md#integration-with-ebpf)
262
- [Linux eBPF monitoring with Netdata](https://www.netdata.cloud/blog/linux-ebpf-monitoring-with-netdata/)
263
264
The scenarios described above are just the beginning when it comes to troubleshooting with eBPF metrics. We're excited
docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
+2
-2
@@ -51,7 +51,7 @@ and you must do it manually, using the following steps:
51
:::note
52
53
In some cases a simple restart of the Agent can fix the issue.
54
-Read more about [Starting, Stopping and Restarting the Agent](/docs/configure/start-stop-restart.md).
54
+Read more about [Starting, Stopping and Restarting the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
55
56
:::
57
@@ -59,7 +59,7 @@ Read more about [Starting, Stopping and Restarting the Agent](/docs/configure/st
59
60
Make sure that you are using the latest version of Netdata if you are using the [Claiming script](https://learn.netdata.cloud/docs/agent/claim#claiming-script).
61
62
-With the introduction of our new architecture, Agents running versions lower than `v1.32.0` can face claiming problems, so we recommend you [update the Netdata Agent](https://learn.netdata.cloud/docs/agent/packaging/installer/update) to the latest stable version.
62
+With the introduction of our new architecture, Agents running versions lower than `v1.32.0` can face claiming problems, so we recommend you [update the Netdata Agent](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md) to the latest stable version.
63
64
## Network issues while connecting to the Cloud
65
docs/guides/using-host-labels.md
+14
-14
@@ -27,7 +27,7 @@ sudo ./edit-config netdata.conf
27
```
28
29
Create a new `[host labels]` section defining a new host label and its value for the system in question. Make sure not
30
-to violate any of the [host label naming rules](/docs/configure/common-changes.md#organize-nodes-with-host-labels).
30
+to violate any of the [host label naming rules](https://github.com/netdata/netdata/blob/master/docs/configure/common-changes.md#organize-nodes-with-host-labels).
31
32
```conf
33
[host labels]
@@ -101,9 +101,9 @@ child system. It's a vastly simplified way of accessing critical information abo
101
102
> ⚠️ Because automatic labels for child nodes are accessible via API calls, and contain sensitive information like
103
> kernel and operating system versions, you should secure streaming connections with SSL. See the [streaming
104
-> documentation](/streaming/README.md#securing-streaming-communications) for details. You may also want to use
105
-> [access lists](/web/server/README.md#access-lists) or [expose the API only to LAN/localhost
106
-> connections](/docs/netdata-security.md#expose-netdata-only-in-a-private-lan).
104
+> documentation](https://github.com/netdata/netdata/blob/master/streaming/README.md#securing-streaming-communications) for details. You may also want to use
105
+> [access lists](https://github.com/netdata/netdata/blob/master/web/server/README.md#access-lists) or [expose the API only to LAN/localhost
106
+> connections](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md#expose-netdata-only-in-a-private-lan).
107
108
You can also use `_is_parent`, `_is_child`, and any other host labels in both health entities and metrics
109
exporting. Speaking of which...
@@ -154,11 +154,11 @@ Or when ephemeral Docker nodes are involved:
154
```
155
156
Of course, there are many more possibilities for intuitively organizing your systems with host labels. See the [health
157
-documentation](/health/REFERENCE.md#alarm-line-host-labels) for more details, and then get creative!
157
+documentation](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-host-labels) for more details, and then get creative!
158
159
## Host labels in metrics exporting
160
161
-If you have enabled any metrics exporting via our experimental [exporters](/exporting/README.md), any new host
161
+If you have enabled any metrics exporting via our experimental [exporters](https://github.com/netdata/netdata/blob/master/exporting/README.md), any new host
162
labels you created manually are sent to the destination database alongside metrics. You can change this behavior by
163
editing `exporting.conf`, and you can even send automatically-generated labels on with exported metrics.
164
@@ -183,7 +183,7 @@ send automatic labels = yes
183
```
184
185
By applying labels to exported metrics, you can more easily parse historical metrics with the labels applied. To learn
186
-more about exporting, read the [documentation](/exporting/README.md).
186
+more about exporting, read the [documentation](https://github.com/netdata/netdata/blob/master/exporting/README.md).
187
188
## What's next?
189
@@ -195,15 +195,15 @@ the Netdata team first kicked off this work.
195
It should be noted that while the Netdata dashboard does not expose either user-configured or automatic host labels, API
196
queries _do_ showcase this information. As always, we recommend you secure Netdata
197
198
-- [Expose Netdata only in a private LAN](/docs/netdata-security.md#expose-netdata-only-in-a-private-lan)
199
-- [Enable TLS/SSL for web/API requests](/web/server/README.md#enabling-tls-support)
198
+- [Expose Netdata only in a private LAN](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md#expose-netdata-only-in-a-private-lan)
199
+- [Enable TLS/SSL for web/API requests](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support)
200
- Put Netdata behind a proxy
201
- [Use an authenticating web server in proxy
202
- mode](/docs/netdata-security.md#use-an-authenticating-web-server-in-proxy-mode)
203
- - [Nginx proxy](/docs/Running-behind-nginx.md)
204
- - [Apache proxy](/docs/Running-behind-apache.md)
205
- - [Lighttpd](/docs/Running-behind-lighttpd.md)
206
- - [Caddy](/docs/Running-behind-caddy.md)
202
+ mode](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md#use-an-authenticating-web-server-in-proxy-mode)
203
+ - [Nginx proxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md)
204
+ - [Apache proxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md)
205
+ - [Lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
206
+ - [Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md)
207
208
If you have issues or questions around using host labels, don't hesitate to [file an
209
issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) on GitHub. We're
docs/metrics-storage-management/enable-streaming.mdx
+17
-14
@@ -1,8 +1,11 @@
1
---
2
title: "Enable streaming between nodes"
3
-description: "With metrics streaming enabled, you can not only replicate metrics data into a second database, but also view dashboards and trigger alarm notifications for multiple nodes in parallel."
3
+description: >-
4
+ "With metrics streaming enabled, you can not only replicate metrics data
5
+ into a second database, but also view dashboards and trigger alarm notifications
6
+ for multiple nodes in parallel."
7
type: "how-to"
5
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/enable-streaming.mdx"
8
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.mdx"
9
sidebar_label: "Enable streaming between nodes"
10
learn_status: "Published"
11
learn_topic_type: "Tasks"
@@ -17,7 +20,7 @@ parent node, and both nodes retain metrics in their own databases.
20
To configure replication, you need two nodes, each running Netdata. First you'll first enable streaming on your parent
21
node, then enable streaming on your child node. When you're finished, you'll be able to see the child node's metrics in
22
the parent node's dashboard, quickly switch between the two dashboards, and be able to serve [alarm
20
-notifications](/docs/monitor/enable-notifications.md) from either or both nodes.
23
+notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) from either or both nodes.
24
25
## Enable streaming on the parent node
26
@@ -28,8 +31,8 @@ itself while initiating a streaming connection. Copy that into a separate text f
31
32
> Find out how to [install `uuidgen`](https://command-not-found.com/uuidgen) on your node if you don't already have it.
33
31
-Next, open `stream.conf` using [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files)
32
-from within the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory).
34
+Next, open `stream.conf` using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files)
35
+from within the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
36
37
```bash
38
cd /etc/netdata
@@ -53,7 +56,7 @@ simplified version of the configuration, minus the commented lines, looks like t
56
```
57
58
Save the file and close it, then restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
56
-method](/docs/configure/start-stop-restart.md) for your system.
59
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
60
61
## Enable streaming on the child node
62
@@ -74,7 +77,7 @@ looks like the following:
77
```
78
79
Save the file and close it, then restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
77
-method](/docs/configure/start-stop-restart.md) for your system.
80
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
81
82
## Enable TLS/SSL on streaming (optional)
83
@@ -94,7 +97,7 @@ sudo chown netdata:netdata /etc/netdata/ssl/cert.pem /etc/netdata/ssl/key.pem
97
98
Next, enforce TLS/SSL on the web server. Open `netdata.conf`, scroll down to the `[web]` section, and look for the `bind
99
to` setting. Add `^SSL=force` to turn on TLS/SSL. See the [web server
97
-reference](/web/server/README.md#enabling-tls-support) for other TLS/SSL options.
100
+reference](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support) for other TLS/SSL options.
101
102
```conf
103
[web]
@@ -114,7 +117,7 @@ self-signed certificates.
117
```
118
119
Restart both the parent and child nodes with `sudo systemctl restart netdata`, or the [appropriate
117
-method](/docs/configure/start-stop-restart.md) for your system, to stream encrypted metrics using TLS/SSL.
120
+method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to stream encrypted metrics using TLS/SSL.
121
122
## View streamed metrics in Netdata's dashboard
123
@@ -139,17 +142,17 @@ Now that you have a basic streaming setup with replication, you may want to twea
142
child database, disable the child dashboard, or enable SSL on the streaming connection between the parent and child.
143
144
See the [streaming reference
142
-doc](/docs/metrics-storage-management/reference-streaming.mdx#examples) for details about
145
+doc](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.mdx#examples) for details about
146
other possible configurations.
147
148
When using Netdata's default TSDB (`dbengine`), the parent node maintains separate, parallel databases for itself and
149
every child node streaming to it. Each instance is sized identically based on the `dbengine multihost disk space`
147
-setting in `netdata.conf`. See our doc on [changing metrics retention](/docs/store/change-metrics-storage.md) for
150
+setting in `netdata.conf`. See our doc on [changing metrics retention](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) for
151
details.
152
153
### Related information & further reading
154
155
- Streaming
153
- - [How Netdata streams metrics](/docs/metrics-storage-management/how-streaming-works.mdx)
154
- - **[Enable streaming between nodes](/docs/metrics-storage-management/enable-streaming.mdx)**
155
- - [Streaming reference](/docs/metrics-storage-management/reference-streaming.mdx)
156
+ - [How Netdata streams metrics](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx)
157
+ - **[Enable streaming between nodes](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.mdx)**
158
+ - [Streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.mdx)
docs/metrics-storage-management/how-streaming-works.mdx
+16
-13
@@ -1,8 +1,11 @@
1
---
2
title: "How metrics streaming works"
3
-description: "Netdata's real-time streaming allows you to replicate metrics data across multiple nodes, or centralize all your metrics data into a single time-series database (TSDB)."
3
+description: >-
4
+ "Netdata's real-time streaming allows you to replicate metrics data
5
+ across multiple nodes, or centralize all your metrics data into a single
6
+ time-series database (TSDB)."
7
type: "explanation"
5
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/how-streaming-works.mdx"
8
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx"
9
sidebar_label: "How metrics streaming works"
10
learn_status: "Published"
11
learn_topic_type: "Concepts"
@@ -16,13 +19,13 @@ replicate metrics data across multiple nodes, or centralize all your metrics dat
19
(TSDB).
20
21
When one node streams metrics to another, the node receiving metrics can visualize them on the
19
-[dashboard](/docs/visualize/interact-dashboards-charts.md), run health checks to [trigger
20
-alarms](/docs/monitor/view-active-alarms.md) and [send notifications](/docs/monitor/enable-notifications.md), and
21
-[export](/docs/export/external-databases.md) all metrics to an external TSDB. When Netdata streams metrics to another
22
+[dashboard](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md), run health checks to [trigger
23
+alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) and [send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md), and
24
+[export](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) all metrics to an external TSDB. When Netdata streams metrics to another
25
Netdata, the receiving one is able to perform everything a Netdata instance is capable of.
26
27
Streaming lets you decide exactly how you want to store and maintain metrics data. While we believe Netdata's
25
-[distributed architecture](/docs/store/distributed-data-architecture.md) is ideal for speed and scale, streaming
28
+[distributed architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) is ideal for speed and scale, streaming
29
provides centralization options for those who want to maintain only a single TSDB instance.
30
31
## Streaming basics
@@ -72,7 +75,7 @@ Here are a few example streaming configurations:
75
Parent nodes feature a **Replicated Nodes** section in the left-hand panel, which opens with the hamburger icon
76
77
in the top navigation. The parent node, plus any child nodes, appear here. Click on any of the hostnames to switch
75
-between parent and child dashboards, all served by the parent's [web server](/web/server/README.md).
78
+between parent and child dashboards, all served by the parent's [web server](https://github.com/netdata/netdata/blob/master/web/server/README.md).
79
80
@@ -83,14 +86,14 @@ Each child dashboard is also available directly at the following URL pattern:
86
## What's next?
87
88
Now that you understand the fundamentals of streaming metrics between nodes, go ahead and [enable
86
-streaming](/docs/metrics-storage-management/enable-streaming.mdx) using a simple `parent-child` relationship. For all
87
-the details, see the [streaming reference](/docs/metrics-storage-management/reference-streaming.mdx) doc.
89
+streaming](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.mdx) using a simple `parent-child` relationship. For all
90
+the details, see the [streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.mdx) doc.
91
89
-Take your streaming setup even further by [exporting metrics](/docs/export/external-databases.md) to an external TSDB.
92
+Take your streaming setup even further by [exporting metrics](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) to an external TSDB.
93
94
### Related information & further reading
95
96
- Streaming
94
- - **[How Netdata streams metrics](/docs/metrics-storage-management/how-streaming-works.mdx)**
95
- - [Enable streaming between nodes](/docs/metrics-storage-management/enable-streaming.mdx)
96
- - [Streaming reference](/docs/metrics-storage-management/reference-streaming.mdx)
\ No newline at end of file
97
+ - **[How Netdata streams metrics](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx)**
98
+ - [Enable streaming between nodes](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.mdx)
99
+ - [Streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.mdx)
\ No newline at end of file
docs/metrics-storage-management/reference-streaming.mdx
+14
-14
@@ -12,17 +12,17 @@ learn_rel_path: "References/Configuration"
12
# Streaming reference
13
14
Each node running Netdata can stream the metrics it collects, in real time, to another node. To learn more, read about
15
-[how streaming works](/docs/metrics-storage-management/how-streaming-works.mdx).
15
+[how streaming works](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx).
16
17
For a quickstart guide for enabling a simple `parent-child` streaming relationship, see our [stream metrics between
18
-nodes](/docs/metrics-storage-management/enable-streaming.mdx) doc. All other configuration options and scenarios are
18
+nodes](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.mdx) doc. All other configuration options and scenarios are
19
covered in the sections below.
20
21
## Configuration
22
23
There are two files responsible for configuring Netdata's streaming capabilities: `stream.conf` and `netdata.conf`.
24
25
-From within your Netdata config directory (typically `/etc/netdata`), [use `edit-config`](/docs/configure/nodes.md) to
25
+From within your Netdata config directory (typically `/etc/netdata`), [use `edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) to
26
open either `stream.conf` or `netdata.conf`.
27
28
```
@@ -57,7 +57,7 @@ node**. This file is automatically generated by Netdata the first time it is sta
57
| `api key` | ` ` | The `API_KEY` to use as the child node. |
58
| `timeout seconds` | `60` | The timeout to connect and send metrics to a parent. |
59
| `default port` | `19999` | The port to use if `destination` does not specify one. |
60
-| [`send charts matching`](#send-charts-matching) | `*` | A space-separated list of [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to filter which charts are streamed. [Read more →](#send-charts-matching) |
60
+| [`send charts matching`](#send-charts-matching) | `*` | A space-separated list of [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to filter which charts are streamed. [Read more →](#send-charts-matching) |
61
| `buffer size bytes` | `10485760` | The size of the buffer to use when sending metrics. The default `10485760` equals a buffer of 10MB, which is good for 60 seconds of data. Increase this if you expect latencies higher than that. The buffer is flushed on reconnect. |
62
| `reconnect delay seconds` | `5` | How long to wait until retrying to connect to the parent node. |
63
| `initial clock resync iterations` | `60` | Sync the clock of charts for how many seconds when starting. |
@@ -67,9 +67,9 @@ node**. This file is automatically generated by Netdata the first time it is sta
67
| Setting | Default | Description |
68
| :---------------------------------------------- | :------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
69
| `enabled` | `no` | Whether this API KEY enabled or disabled. |
70
-| [`allow from`](#allow-from) | `*` | A space-separated list of [Netdata simple patterns](/libnetdata/simple_pattern/README.md) matching the IPs of nodes that will stream metrics using this API key. [Read more →](#allow-from) |
70
+| [`allow from`](#allow-from) | `*` | A space-separated list of [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) matching the IPs of nodes that will stream metrics using this API key. [Read more →](#allow-from) |
71
| `default history` | `3600` | The default amount of child metrics history to retain when using the `save`, `map`, or `ram` memory modes. |
72
-| [`default memory mode`](#default-memory-mode) | `ram` | The [database](/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `map`, `save`, `ram`, or `none`. [Read more →](#default-memory-mode) |
72
+| [`default memory mode`](#default-memory-mode) | `ram` | The [database](https://github.com/netdata/netdata/blob/master/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `map`, `save`, `ram`, or `none`. [Read more →](#default-memory-mode) |
73
| `health enabled by default` | `auto` | Whether alarms and notifications should be enabled for nodes using this `API_KEY`. `auto` enables alarms when the child is connected. `yes` enables alarms always, and `no` disables alarms. |
74
| `default postpone alarms on connect seconds` | `60` | Postpone alarms and notifications for a period of time after the child connects. |
75
| `default proxy enabled` | ` ` | Route metrics through a proxy. |
@@ -98,7 +98,7 @@ To enable TCP streaming to a parent node at `203.0.113.0` on port `20000` and wi
98
99
#### `send charts matching`
100
101
-A space-separated list of [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to filter which charts are streamed.
101
+A space-separated list of [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to filter which charts are streamed.
102
103
The default is a single wildcard `*`, which streams all charts.
104
@@ -119,7 +119,7 @@ To send all but a few charts, use `!` to create a negative match. To send _all_
119
120
#### `allow from`
121
122
-A space-separated list of [Netdata simple patterns](/libnetdata/simple_pattern/README.md) matching the IPs of nodes that
122
+A space-separated list of [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) matching the IPs of nodes that
123
will stream metrics using this API key. The order is important, left to right, as the first positive or negative match is used.
124
125
The default is `*`, which accepts all requests including the `API_KEY`.
@@ -143,7 +143,7 @@ To allow all IPs starting with `10.*`, except `10.1.2.3`:
143
144
#### `default memory mode`
145
146
-The [database](/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `ram`,
146
+The [database](https://github.com/netdata/netdata/blob/master/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `ram`,
147
`save`, `map`, or `none`.
148
149
- `dbengine`: The default, recommended time-series database (TSDB) for Netdata. Stores recent metrics in memory, then
@@ -156,7 +156,7 @@ The [database](/database/README.md) to use for all nodes using this `API_KEY`. V
156
- `none`: No database.
157
158
When using `default memory mode = dbengine`, the parent node creates a separate instance of the TSDB to store metrics
159
-from child nodes. The [size of _each_ instance is configurable](/docs/store/change-metrics-storage.md) with the `page
159
+from child nodes. The [size of _each_ instance is configurable](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) with the `page
160
cache size` and `dbengine multihost disk space` settings in the `[global]` section in `netdata.conf`.
161
162
### `netdata.conf`
@@ -164,9 +164,9 @@ cache size` and `dbengine multihost disk space` settings in the `[global]` secti
164
| Setting | Default | Description |
165
| :----------------------------------------- | :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
166
| **`[global]` section** | | |
167
-| `memory mode` | `dbengine` | Determines the [database type](/database/README.md) to be used on that node. Other options settings include `none`, `ram`, `save`, and `map`. `none` disables the database at this host. This also disables alarms and notifications, as those can't run without a database. |
167
+| `memory mode` | `dbengine` | Determines the [database type](https://github.com/netdata/netdata/blob/master/database/README.md) to be used on that node. Other options settings include `none`, `ram`, `save`, and `map`. `none` disables the database at this host. This also disables alarms and notifications, as those can't run without a database. |
168
| **`[web]` section** | | |
169
-| `mode` | `static-threaded` | Determines the [web server](/web/server/README.md) type. The other option is `none`, which disables the dashboard, API, and registry. |
169
+| `mode` | `static-threaded` | Determines the [web server](https://github.com/netdata/netdata/blob/master/web/server/README.md) type. The other option is `none`, which disables the dashboard, API, and registry. |
170
| `accept a streaming request every seconds` | `0` | Set a limit on how often a parent node accepts streaming requests from child nodes. `0` equals no limit. If this is set, you may see `... too busy to accept new streaming request. Will be allowed in X secs` in Netdata's `error.log`. |
171
172
## Examples
@@ -195,7 +195,7 @@ default `dbengine` as specified by the `API_KEY`, and alarms are disabled.
195
### Securing streaming with TLS/SSL
196
197
Netdata does not activate TLS encryption by default. To encrypt streaming connections, you first need to [enable TLS
198
-support](/web/server/README.md#enabling-tls-support) on the parent. With encryption enabled on the receiving side, you
198
+support](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support) on the parent. With encryption enabled on the receiving side, you
199
need to instruct the child to use TLS/SSL as well. On the child's `stream.conf`, configure the destination as follows:
200
201
```
@@ -454,7 +454,7 @@ ERROR : STREAM_SENDER[CHILD HOSTNAME] : STREAM child HOSTNAME [send to PARENT HO
454
Chart data needs to be consistent between child and parent nodes. If there are differences between chart data on
455
a parent and a child, such as gaps in metrics collection, it most often means your child's `memory mode`
456
does not match the parent's. To learn more about the different ways Netdata can store metrics, and thus keep chart
457
-data consistent, read our [memory mode documentation](/database/README.md).
457
+data consistent, read our [memory mode documentation](https://github.com/netdata/netdata/blob/master/database/README.md).
458
459
### Forbidding access
460
docs/monitor/configure-alarms.md
+10
-10
@@ -14,19 +14,19 @@ Netdata's health watchdog is highly configurable, with support for dynamic thres
14
more. You can tweak any of the existing alarms based on your infrastructure's topology or specific monitoring needs, or
15
create new entities.
16
17
-You can use health alarms in conjunction with any of Netdata's [collectors](/docs/collect/how-collectors-work.md) (see
18
-the [supported collector list](/collectors/COLLECTORS.md)) to monitor the health of your systems, containers, and
17
+You can use health alarms in conjunction with any of Netdata's [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) (see
18
+the [supported collector list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md)) to monitor the health of your systems, containers, and
19
applications in real time.
20
21
While you can see active alarms both on the local dashboard and Netdata Cloud, all health alarms are configured _per
22
node_ via individual Netdata Agents. If you want to deploy a new alarm across your
23
-[infrastructure](/docs/quickstart/infrastructure.md), you must configure each node with the same health configuration
23
+[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you must configure each node with the same health configuration
24
files.
25
26
## Edit health configuration files
27
28
-All of Netdata's [health configuration files](/health/REFERENCE.md#health-configuration-files) are in Netdata's config
29
-directory, inside the `health.d/` directory. Navigate to your [Netdata config directory](/docs/configure/nodes.md) and
28
+All of Netdata's [health configuration files](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#health-configuration-files) are in Netdata's config
29
+directory, inside the `health.d/` directory. Navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) and
30
use `edit-config` to make changes to any of these files.
31
32
For example, to edit the `cpu.conf` health configuration file, run:
@@ -77,10 +77,10 @@ one line in a given health entity. To silence any single alarm, change the `to:`
77
While tuning existing alarms may work in some cases, you may need to write entirely new health entities based on how
78
your systems, containers, and applications work.
79
80
-Read Netdata's [health reference](/health/REFERENCE.md#health-entity-reference) for a full listing of the format,
80
+Read Netdata's [health reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#health-entity-reference) for a full listing of the format,
81
syntax, and functionality of health entities.
82
83
-To write a new health entity into a new file, navigate to your [Netdata config directory](/docs/configure/nodes.md),
83
+To write a new health entity into a new file, navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md),
84
then use `touch` to create a new file in the `health.d/` directory. Use `edit-config` to start editing the file.
85
86
As an example, let's create a `ram-usage.conf` file.
@@ -121,7 +121,7 @@ Let's look into each of the lines to see how they create a working health entity
121
- `every`: How often to perform the `lookup` calculation to decide whether or not to trigger this alarm.
122
- `warn`/`crit`: The value at which Netdata should trigger a warning or critical alarm. This example uses simple
123
syntax, but most pre-configured health entities use
124
- [hysteresis](/health/REFERENCE.md#special-use-of-the-conditional-operator) to avoid superfluous notifications.
124
+ [hysteresis](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#special-use-of-the-conditional-operator) to avoid superfluous notifications.
125
- `info`: A description of the alarm, which will appear in the dashboard and notifications.
126
127
In human-readable format:
@@ -144,9 +144,9 @@ without restarting all of Netdata, run `netdatacli reload-health` or `killall -U
144
## What's next?
145
146
With your health entities configured properly, it's time to [enable
147
-notifications](/docs/monitor/enable-notifications.md) to get notified whenever a node reaches a warning or critical
147
+notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to get notified whenever a node reaches a warning or critical
148
state.
149
150
-To build complex, dynamic alarms, read our guide on [dimension templates](/docs/guides/monitor/dimension-templates.md).
150
+To build complex, dynamic alarms, read our guide on [dimension templates](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/dimension-templates.md).
151
152
docs/monitor/enable-notifications.md
+36
-36
@@ -14,7 +14,7 @@ Netdata offers two ways to receive alarm notifications on external platforms. Th
14
parallel, which means you can enable both at the same time to send alarm notifications to any number of endpoints.
15
16
Both methods use a node's health alarms to generate the content of alarm notifications. Read the doc on [configuring
17
-alarms](/docs/monitor/configure-alarms.md) to change the preconfigured thresholds or to create tailored alarms for your
17
+alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to change the preconfigured thresholds or to create tailored alarms for your
18
infrastructure.
19
20
Netdata Cloud offers [centralized alarm notifications](#netdata-cloud) via email, which leverages the health status
@@ -30,7 +30,7 @@ response process.
30
## Netdata Cloud
31
32
Netdata Cloud's [centralized alarm
33
-notifications](https://learn.netdata.cloud/docs/cloud/alerts-notifications/notifications) is a zero-configuration way to
33
+notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx) is a zero-configuration way to
34
get notified when an anomaly or incident strikes any node or application in your infrastructure. The advantage of using
35
centralized alarm notifications from Netdata Cloud is that you don't have to worry about configuring each node in your
36
infrastructure.
@@ -45,13 +45,13 @@ choose what types of notifications to receive from each War Room.
45
47
48
-See the [centralized alarm notifications](https://learn.netdata.cloud/docs/cloud/alerts-notifications/notifications)
48
+See the [centralized alarm notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
49
reference doc for further details about what information is conveyed in an email notification, flood protection, and
50
more.
51
52
## Netdata Agent
53
54
-The Netdata Agent's [notification system](/health/notifications/README.md) runs on every node and dispatches
54
+The Netdata Agent's [notification system](https://github.com/netdata/netdata/blob/master/health/notifications/README.md) runs on every node and dispatches
55
notifications based on configured endpoints and roles. You can enable multiple endpoints on any one node _and_ use Agent
56
notifications in parallel with centralized alarm notifications in Netdata Cloud.
57
@@ -63,33 +63,33 @@ notification platform.
63
64
### Supported notification endpoints
65
66
-- [**alerta.io**](/health/notifications/alerta/README.md)
67
-- [**Amazon SNS**](/health/notifications/awssns/README.md)
68
-- [**Custom endpoint**](/health/notifications/custom/README.md)
69
-- [**Discord**](/health/notifications/discord/README.md)
70
-- [**Dynatrace**](/health/notifications/dynatrace/README.md)
71
-- [**Email**](/health/notifications/email/README.md)
72
-- [**Flock**](/health/notifications/flock/README.md)
73
-- [**Google Hangouts**](/health/notifications/hangouts/README.md)
74
-- [**Gotify**](/health/notifications/gotify/README.md)
75
-- [**IRC**](/health/notifications/irc/README.md)
76
-- [**Kavenegar**](/health/notifications/kavenegar/README.md)
77
-- [**Matrix**](/health/notifications/matrix/README.md)
78
-- [**Messagebird**](/health/notifications/messagebird/README.md)
79
-- [**Microsoft Teams**](/health/notifications/msteams/README.md)
80
-- [**Netdata Agent dashboard**](/health/notifications/web/README.md)
81
-- [**Opsgenie**](/health/notifications/opsgenie/README.md)
82
-- [**PagerDuty**](/health/notifications/pagerduty/README.md)
83
-- [**Prowl**](/health/notifications/prowl/README.md)
84
-- [**PushBullet**](/health/notifications/pushbullet/README.md)
85
-- [**PushOver**](/health/notifications/pushover/README.md)
86
-- [**Rocket.Chat**](/health/notifications/rocketchat/README.md)
87
-- [**Slack**](/health/notifications/slack/README.md)
88
-- [**SMS Server Tools 3**](/health/notifications/smstools3/README.md)
89
-- [**StackPulse**](/health/notifications/stackpulse/README.md)
90
-- [**Syslog**](/health/notifications/syslog/README.md)
91
-- [**Telegram**](/health/notifications/telegram/README.md)
92
-- [**Twilio**](/health/notifications/twilio/README.md)
66
+- [**alerta.io**](https://github.com/netdata/netdata/blob/master/health/notifications/alerta/README.md)
67
+- [**Amazon SNS**](https://github.com/netdata/netdata/blob/master/health/notifications/awssns/README.md)
68
+- [**Custom endpoint**](https://github.com/netdata/netdata/blob/master/health/notifications/custom/README.md)
69
+- [**Discord**](https://github.com/netdata/netdata/blob/master/health/notifications/discord/README.md)
70
+- [**Dynatrace**](https://github.com/netdata/netdata/blob/master/health/notifications/dynatrace/README.md)
71
+- [**Email**](https://github.com/netdata/netdata/blob/master/health/notifications/email/README.md)
72
+- [**Flock**](https://github.com/netdata/netdata/blob/master/health/notifications/flock/README.md)
73
+- [**Google Hangouts**](https://github.com/netdata/netdata/blob/master/health/notifications/hangouts/README.md)
74
+- [**Gotify**](https://github.com/netdata/netdata/blob/master/health/notifications/gotify/README.md)
75
+- [**IRC**](https://github.com/netdata/netdata/blob/master/health/notifications/irc/README.md)
76
+- [**Kavenegar**](https://github.com/netdata/netdata/blob/master/health/notifications/kavenegar/README.md)
77
+- [**Matrix**](https://github.com/netdata/netdata/blob/master/health/notifications/matrix/README.md)
78
+- [**Messagebird**](https://github.com/netdata/netdata/blob/master/health/notifications/messagebird/README.md)
79
+- [**Microsoft Teams**](https://github.com/netdata/netdata/blob/master/health/notifications/msteams/README.md)
80
+- [**Netdata Agent dashboard**](https://github.com/netdata/netdata/blob/master/health/notifications/web/README.md)
81
+- [**Opsgenie**](https://github.com/netdata/netdata/blob/master/health/notifications/opsgenie/README.md)
82
+- [**PagerDuty**](https://github.com/netdata/netdata/blob/master/health/notifications/pagerduty/README.md)
83
+- [**Prowl**](https://github.com/netdata/netdata/blob/master/health/notifications/prowl/README.md)
84
+- [**PushBullet**](https://github.com/netdata/netdata/blob/master/health/notifications/pushbullet/README.md)
85
+- [**PushOver**](https://github.com/netdata/netdata/blob/master/health/notifications/pushover/README.md)
86
+- [**Rocket.Chat**](https://github.com/netdata/netdata/blob/master/health/notifications/rocketchat/README.md)
87
+- [**Slack**](https://github.com/netdata/netdata/blob/master/health/notifications/slack/README.md)
88
+- [**SMS Server Tools 3**](https://github.com/netdata/netdata/blob/master/health/notifications/smstools3/README.md)
89
+- [**StackPulse**](https://github.com/netdata/netdata/blob/master/health/notifications/stackpulse/README.md)
90
+- [**Syslog**](https://github.com/netdata/netdata/blob/master/health/notifications/syslog/README.md)
91
+- [**Telegram**](https://github.com/netdata/netdata/blob/master/health/notifications/telegram/README.md)
92
+- [**Twilio**](https://github.com/netdata/netdata/blob/master/health/notifications/twilio/README.md)
93
94
### Enable Slack notifications
95
@@ -99,7 +99,7 @@ want to see alarm notifications from Netdata. Click the green **Add to Slack** b
99
100
On the following page, you'll receive a **Webhook URL**. That's what you'll need to configure Netdata, so keep it handy.
101
102
-Navigate to your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) and use `edit-config` to
102
+Navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) and use `edit-config` to
103
open the `health_alarm_notify.conf` file:
104
105
```bash
@@ -134,7 +134,7 @@ Next, run the `alarm-notify` script using the `test` option.
134
You should receive three notifications in your Slack channel for each health status change: `WARNING`, `CRITICAL`, and
135
`CLEAR`.
136
137
-See the [Agent Slack notifications](/health/notifications/slack/README.md) doc for more options and information.
137
+See the [Agent Slack notifications](https://github.com/netdata/netdata/blob/master/health/notifications/slack/README.md) doc for more options and information.
138
139
## What's next?
140
@@ -142,10 +142,10 @@ Now that you have health entities configured to your infrastructure's needs and
142
or incidents, your health monitoring setup is complete.
143
144
To make your dashboards most useful during root cause analysis, use Netdata's [distributed data
145
-architecture](/docs/store/distributed-data-architecture.md) for the best-in-class performance and scalability.
145
+architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) for the best-in-class performance and scalability.
146
147
### Related reference documentation
148
149
-- [Netdata Cloud · Alarm notifications](https://learn.netdata.cloud/docs/cloud/alerts-notifications/notifications)
150
-- [Netdata Agent · Notifications](/health/notifications/README.md)
149
+- [Netdata Cloud · Alarm notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
150
+- [Netdata Agent · Notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md)
151
docs/monitor/view-active-alarms.md
+4
-4
@@ -18,7 +18,7 @@ performance issue affects your node or the applications it runs.
18
A War Room's [alarms indicator](https://learn.netdata.cloud/docs/cloud/war-rooms#indicators) displays the number of
19
active `critical` (red) and `warning` (yellow) alerts for the nodes in this War Room. Click on either the critical or
20
warning badges to open a pre-filtered modal displaying only those types of [active
21
-alarms](https://learn.netdata.cloud/docs/cloud/alerts-notifications/view-active-alerts).
21
+alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx).
22
23
@@ -65,15 +65,15 @@ With the three icons beneath that and the **role** designation, you can:
65
3. Copy the code to embed the badge onto another web page using an `<embed>` element.
66
67
The table on the right-hand side displays information about the health entity that triggered the alarm, which you can
68
-use as a reference to [configure alarms](/docs/monitor/configure-alarms.md).
68
+use as a reference to [configure alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
69
70
## What's next?
71
72
With the information that appears on Netdata Cloud and the local dashboard about active alarms, you can [configure
73
-alarms](/docs/monitor/configure-alarms.md) to match your infrastructure's needs or your team's goals.
73
+alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to match your infrastructure's needs or your team's goals.
74
75
If you're happy with the pre-configured alarms, skip ahead to [enable
76
-notifications](/docs/monitor/enable-notifications.md) to use Netdata Cloud's centralized alarm notifications and/or
76
+notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to use Netdata Cloud's centralized alarm notifications and/or
77
per-node notifications to endpoints like Slack, PagerDuty, Twilio, and more.
78
79
docs/netdata-for-IoT.md
+14
-13
@@ -10,22 +10,23 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-for
10
> New to Netdata? Check its demo: **<https://my-netdata.io/>**
11
>
12
>[](https://registry.my-netdata.io/#netdata_registry)
14
->[](https://registry.my-netdata.io/#netdata_registry)
16
->[](https://registry.my-netdata.io/#netdata_registry)
13
+> Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=null&value_color=blue&precision=0&v41)](https://registry.my-netdata.io/#netdata_registry)
14
+> [](https://registry.my-netdata.io/#netdata_registry)
16
+> [](https://registry.my-netdata.io/#netdata_registry)
18
>
19
>[](https://registry.my-netdata.io/#netdata_registry)
21
->[](https://registry.my-netdata.io/#netdata_registry)
23
->[](https://registry.my-netdata.io/#netdata_registry)
20
+> Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&after=-86400&options=unaligned&group=incremental-sum&label=new%20users%20today&units=null&value_color=blue&precision=0&v40)](https://registry.my-netdata.io/#netdata_registry)
21
+> [](https://registry.my-netdata.io/#netdata_registry)
23
+> [](https://registry.my-netdata.io/#netdata_registry)
25
26
---
27
28
-Netdata is a [very efficient](/docs/guides/configure/performance.md) server performance monitoring solution. When running in server hardware, it can collect
28
+Netdata is a [very efficient](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md)
29
+server performance monitoring solution. When running in server hardware, it can collect
30
thousands of system and application metrics **per second** with just 1% CPU utilization of a single core. Its web server
31
responds to most data requests in about **half a millisecond** making its web dashboards spontaneous, amazingly fast!
32
@@ -43,8 +44,8 @@ provider so it can directly be used by google sheets, google charts, google widg
44
45
46
Although Netdata has been significantly optimized to lower the CPU and RAM resources it consumes, the plethora of data
46
-collection plugins may be inappropriate for weak IoT devices. Please follow the [Netdata Agent performance
47
-guide](/docs/guides/configure/performance.md)
47
+collection plugins may be inappropriate for weak IoT devices. Please follow
48
+the [Netdata Agent performance guide](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md)
49
50
## Monitoring RPi temperature
51
docs/netdata-security.md
+2
-2
@@ -200,12 +200,12 @@ Of course, there are many more methods you could use to protect Netdata:
200
201
### Registry or how to not send any information to a third party server
202
203
-The default configuration uses a public registry under registry.my-netdata.io (more information about the registry here: [mynetdata-menu-item](/registry/README.md) ). Please be aware that if you use that public registry, you submit the following information to a third party server:
203
+The default configuration uses a public registry under registry.my-netdata.io (more information about the registry here: [mynetdata-menu-item](https://github.com/netdata/netdata/blob/master/registry/README.md) ). Please be aware that if you use that public registry, you submit the following information to a third party server:
204
205
- The url where you open the web-ui in the browser (via http request referrer)
206
- The hostnames of the Netdata servers
207
208
-If sending this information to the central Netdata registry violates your security policies, you can configure Netdata to [run your own registry](/registry/README.md#run-your-own-registry).
208
+If sending this information to the central Netdata registry violates your security policies, you can configure Netdata to [run your own registry](https://github.com/netdata/netdata/blob/master/registry/README.md#run-your-own-registry).
209
210
### Opt-out of anonymous statistics
211
docs/overview/netdata-monitoring-stack.md
+4
-4
@@ -22,7 +22,7 @@ Here are a few ways to enrich your existing monitoring and troubleshooting stack
22
## Collect metrics from Prometheus endpoints
23
24
Netdata automatically detects 600 popular endpoints and collects per-second metrics from them via the [generic
25
-Prometheus collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus). This even
25
+Prometheus collector](https://github.com/netdata/go.d.plugin/blob/master/modules/prometheus/README.md). This even
26
includes support for Windows 10 via [`windows_exporter`](https://github.com/prometheus-community/windows_exporter).
27
28
This collector is installed and enabled on all Agent installations by default, so you don't need to waste time
@@ -35,8 +35,8 @@ troubleshoot anomalies.
35
Netdata can send its per-second metrics to external time-series databases, such as InfluxDB, Prometheus, Graphite,
36
TimescaleDB, ElasticSearch, AWS Kinesis Data Streams, Google Cloud Pub/Sub Service, and many others.
37
38
-To [export metrics to external time-series databases](/docs/export/external-databases.md), you configure an [exporting
39
-_connector_](/docs/export/enable-connector.md). These connectors support filtering and resampling for granular control
38
+To [export metrics to external time-series databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md), you configure an [exporting
39
+_connector_](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md). These connectors support filtering and resampling for granular control
40
over which metrics you export, and at what volume. You can export resampled metrics as collected, as averages, or the
41
sum of interpolated values based on your needs and other monitoring tools.
42
@@ -57,6 +57,6 @@ charts, or use Netdata's health watchdog to send notifications whenever an anoma
57
## What's next?
58
59
Whether you're using Netdata standalone or as part of a larger monitoring stack, the next step is the same: [**Get
60
-Netdata**](/docs/get-started.mdx).
60
+Netdata**](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
61
62
docs/overview/what-is-netdata.md
+24
-22
@@ -18,7 +18,8 @@ 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](/docs/get-started.mdx) Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more),
21
+You can [install](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) Netdata on most Linux
22
+distributions (Ubuntu, Debian, CentOS, and more),
23
container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with
24
no `sudo` required.
25
@@ -46,29 +47,30 @@ you're viewing the Netdata Cloud interface.
47
Netdata is designed to be both simple to use and flexible for every monitoring, visualization, and troubleshooting use
48
case:
49
49
-- **Collect**: Netdata collects all available metrics from your system and applications with 300+ collectors,
50
- Kubernetes service discovery, and in-depth container monitoring, all while using only 1% CPU and a few MB of RAM. It
51
- even collects metrics from Windows machines.
52
-- **Visualize**: The dashboard meaningfully presents charts to help you understand the relationships between your
53
- hardware, operating system, running apps/services, and the rest of your infrastructure. Add nodes to Netdata Cloud
54
- for a complete view of your infrastructure from a single pane of glass.
55
-- **Monitor**: Netdata's health watchdog uses hundreds of preconfigured alarms to notify you via Slack, email,
56
- PagerDuty and more when an anomaly strikes. Customize with dynamic thresholds, hysteresis, alarm templates, and
57
- role-based notifications.
58
-- **Troubleshoot**: 1s granularity helps you detect and analyze anomalies other monitoring platforms might have
59
- missed. Interactive visualizations reduce your reliance on the console, and historical metrics help you trace issues
60
- back to their root cause.
61
-- **Store**: Netdata's efficient database engine efficiently stores per-second metrics for days, weeks, or even
62
- months. Every distributed node stores metrics locally, simplifying deployment, slashing costs, and enriching
63
- Netdata's interactive dashboards.
64
-- **Export**: Integrate per-second metrics with other time-series databases like Graphite, Prometheus, InfluxDB,
65
- TimescaleDB, and more with Netdata's interoperable and extensible core.
66
-- **Stream**: Aggregate metrics from any number of distributed nodes in one place for in-depth analysis, including
67
- ephemeral nodes in a Kubernetes cluster.
50
+- **Collect**: Netdata collects all available metrics from your system and applications with 300+ collectors,
51
+ Kubernetes service discovery, and in-depth container monitoring, all while using only 1% CPU and a few MB of RAM. It
52
+ even collects metrics from Windows machines.
53
+- **Visualize**: The dashboard meaningfully presents charts to help you understand the relationships between your
54
+ hardware, operating system, running apps/services, and the rest of your infrastructure. Add nodes to Netdata Cloud
55
+ for a complete view of your infrastructure from a single pane of glass.
56
+- **Monitor**: Netdata's health watchdog uses hundreds of preconfigured alarms to notify you via Slack, email,
57
+ PagerDuty and more when an anomaly strikes. Customize with dynamic thresholds, hysteresis, alarm templates, and
58
+ role-based notifications.
59
+- **Troubleshoot**: 1s granularity helps you detect and analyze anomalies other monitoring platforms might have
60
+ missed. Interactive visualizations reduce your reliance on the console, and historical metrics help you trace issues
61
+ back to their root cause.
62
+- **Store**: Netdata's efficient database engine efficiently stores per-second metrics for days, weeks, or even
63
+ months. Every distributed node stores metrics locally, simplifying deployment, slashing costs, and enriching
64
+ Netdata's interactive dashboards.
65
+- **Export**: Integrate per-second metrics with other time-series databases like Graphite, Prometheus, InfluxDB,
66
+ TimescaleDB, and more with Netdata's interoperable and extensible core.
67
+- **Stream**: Aggregate metrics from any number of distributed nodes in one place for in-depth analysis, including
68
+ ephemeral nodes in a Kubernetes cluster.
69
70
## What's next?
71
71
-Learn more about [why you should use Netdata](/docs/overview/why-netdata.md), or [how Netdata works with your existing
72
-monitoring stack](/docs/overview/netdata-monitoring-stack.md).
72
+Learn more
73
+about [why you should use Netdata](https://github.com/netdata/netdata/blob/master/docs/overview/why-netdata.md),
74
+or [how Netdata works with your existing monitoring stack](https://github.com/netdata/netdata/blob/master/docs/overview/netdata-monitoring-stack.md).
75
76
docs/overview/why-netdata.md
+1
-1
@@ -58,6 +58,6 @@ open-source tools.
58
59
Whether you already have a monitoring stack you want to integrate Netdata into, or are building something from the
60
ground-up, you should read more on how Netdata can work either [standalone or as an interoperable part of a monitoring
61
-stack](/docs/overview/netdata-monitoring-stack.md).
61
+stack](https://github.com/netdata/netdata/blob/master/docs/overview/netdata-monitoring-stack.md).
62
63
docs/quickstart/infrastructure.md
+32
-32
@@ -12,7 +12,7 @@ nodes running the Netdata Agent. A node is any system in your infrastructure tha
12
physical or virtual machine (VM), container, cloud deployment, or edge/IoT device.
13
14
The Netdata Agent uses zero-configuration collectors to gather metrics from every application and container instantly,
15
-and uses Netdata's [distributed data architecture](/docs/store/distributed-data-architecture.md) to store metrics
15
+and uses Netdata's [distributed data architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) to store metrics
16
locally. Without a slow and troublesome centralized data lake for your infrastructure's metrics, you reduce the
17
resources you need to invest in, and the complexity of, monitoring your infrastructure.
18
@@ -27,12 +27,12 @@ your nodes to maximize the value you get from Netdata.
27
28
This quickstart assumes you've installed the Netdata Agent on more than one node in your infrastructure, and connected
29
those nodes to your Space in Netdata Cloud. If you haven't yet, see the [Netdata
30
-Cloud](https://learn.netdata.cloud/docs/cloud) docs for details on signing up for Netdata Cloud, installation, and
30
+Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) docs for details on signing up for Netdata Cloud, installation, and
31
connection process.
32
33
> If you want to monitor a Kubernetes cluster with Netdata, see our [k8s installation
34
-> doc](/packaging/installer/methods/kubernetes.md) for setup details, and then read our guide, [_Monitor a Kubernetes
35
-> cluster with Netdata_](/docs/guides/monitor/kubernetes-k8s-netdata.md).
34
+> doc](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md) for setup details, and then read our guide, [_Monitor a Kubernetes
35
+> cluster with Netdata_](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/kubernetes-k8s-netdata.md).
36
37
## Set up your Netdata Cloud experience
38
@@ -49,11 +49,11 @@ SRE team for the user-facing SaaS application, and a second IT team for managing
49
don't monitor the same nodes, they can work in separate Spaces and then further organize their nodes into War Rooms.
50
51
Next, set up War Rooms. Netdata Cloud creates dashboards and visualizations based on the nodes added to a given War
52
-Room. You can [organize War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms#war-room-organization) in any way
52
+Room. You can [organize War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md#war-room-organization) in any way
53
you want, such as by the application type, for end-to-end application monitoring, or as an incident response tool.
54
55
-Learn more about [Spaces](https://learn.netdata.cloud/docs/cloud/spaces) and [War
56
-Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms), including how to manage each, in their respective reference
55
+Learn more about [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md) and [War
56
+Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md), including how to manage each, in their respective reference
57
documentation.
58
59
### Invite your team
@@ -63,25 +63,25 @@ inviting others, you can better synchronize with your team or colleagues to unde
63
When something goes wrong, you'll be ready to collaboratively troubleshoot complex performance problems from a single
64
pane of glass.
65
66
-To [invite new users](https://learn.netdata.cloud/docs/cloud/manage/invite-your-team), click on **Invite Users** in the
66
+To [invite new users](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md), click on **Invite Users** in the
67
Space management Area. Choose which War Rooms to add this user to, then click **Send**.
68
69
If your team members have trouble signing in, direct them to the [Netdata Cloud sign
70
-in](https://learn.netdata.cloud/docs/cloud/manage/sign-in) doc.
70
+in](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.mdx) doc.
71
72
### See an overview of your infrastructure
73
74
The default way to visualize the health and performance of an infrastructure with Netdata Cloud is the
75
-[**Overview**](/docs/visualize/overview-infrastructure.md), which is the default interface of every War Room. The
75
+[**Overview**](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md), which is the default interface of every War Room. The
76
Overview features composite charts, which display aggregated metrics from every node in a given War Room. These metrics
77
are streamed on-demand from individual nodes and composited onto a single, familiar dashboard.
78
79
81
82
-Read more about the Overview in the [infrastructure overview](/docs/visualize/overview-infrastructure.md) doc.
82
+Read more about the Overview in the [infrastructure overview](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) doc.
83
84
-Netdata Cloud also features the [**Nodes view**](https://learn.netdata.cloud/docs/cloud/visualize/nodes), which you can
84
+Netdata Cloud also features the [**Nodes view**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md), which you can
85
use to configure and see a few key metrics from every node in the War Room, view health status, and more.
86
87
### Drill down to specific nodes
@@ -91,8 +91,8 @@ single-node dashboards in Netdata Cloud to drill down on specific issues, scrub
91
historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
92
93
Read about the process in the [infrastructure
94
-overview](/docs/visualize/overview-infrastructure.md#drill-down-with-single-node-dashboards) doc, then learn about [interacting with
95
-dashboards and charts](/docs/visualize/interact-dashboards-charts.md) to get the most from all of Netdata's real-time
94
+overview](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md#drill-down-with-single-node-dashboards) doc, then learn about [interacting with
95
+dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) to get the most from all of Netdata's real-time
96
metrics.
97
98
### Create new dashboards
@@ -104,7 +104,7 @@ from every node in your infrastructure on a single dashboard.
104
106
107
-Read more about [creating new dashboards](/docs/visualize/create-dashboards.md) for more details about the process and
107
+Read more about [creating new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) for more details about the process and
108
additional tips on best leveraging the feature to help you troubleshoot complex performance problems.
109
110
## Set up your nodes
@@ -131,25 +131,25 @@ cd /etc/netdata
131
sudo ./edit-config netdata.conf
132
```
133
134
-Our [configuration basics doc](/docs/configure/nodes.md) contains more information about `netdata.conf`, `edit-config`,
134
+Our [configuration basics doc](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) contains more information about `netdata.conf`, `edit-config`,
135
along with simple examples to get you familiar with editing your node's configuration.
136
137
-After you've learned the basics, you should [secure your infrastructure's nodes](/docs/configure/secure-nodes.md) using
137
+After you've learned the basics, you should [secure your infrastructure's nodes](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md) using
138
one of our recommended methods. These security best practices ensure no untrusted parties gain access to the metrics
139
collected on any of your nodes.
140
141
### Collect metrics from systems and applications
142
143
-Netdata has [300+ pre-installed collectors](/collectors/COLLECTORS.md) that gather thousands of metrics with zero
143
+Netdata has [300+ pre-installed collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) that gather thousands of metrics with zero
144
configuration. Collectors search each of your nodes in default locations and ports to find running applications and
145
gather as many metrics as they can without you having to configure them individually.
146
147
Most collectors work without configuration, but you should read up on [how collectors
148
-work](/docs/collect/how-collectors-work.md) and [how to enable/configure](/docs/collect/enable-configure.md) them so
148
+work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) and [how to enable/configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) them so
149
that you can see metrics from those applications in Netdata Cloud.
150
151
-In addition, find detailed information about which [system](/docs/collect/system-metrics.md),
152
-[container](/docs/collect/container-metrics.md), and [application](/docs/collect/application-metrics.md) metrics you can
151
+In addition, find detailed information about which [system](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md),
152
+[container](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md), and [application](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md) metrics you can
153
collect from across your infrastructure with Netdata.
154
155
## What's next?
@@ -158,28 +158,28 @@ Netdata has many features that help you monitor the health of your nodes and tro
158
Once you have a handle on configuration and are collecting all the right metrics, try out some of Netdata's other
159
infrastructure-focused features:
160
161
-- [See an overview of your infrastructure](/docs/visualize/overview-infrastructure.md) using Netdata Cloud's composite
161
+- [See an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) using Netdata Cloud's composite
162
charts and real-time visualizations.
163
-- [Create new dashboards](/docs/visualize/create-dashboards.md) from any number of nodes and metrics in Netdata Cloud.
163
+- [Create new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) from any number of nodes and metrics in Netdata Cloud.
164
165
To change how the Netdata Agent runs on each node, dig in to configuration files:
166
167
-- [Change how long nodes in your infrastructure retain metrics](/docs/store/change-metrics-storage.md) based on how
167
+- [Change how long nodes in your infrastructure retain metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) based on how
168
many metrics each node collects, your preferred retention period, and the resources you want to dedicate toward
169
long-term metrics retention.
170
-- [Create new alarms](/docs/monitor/configure-alarms.md), or tweak some of the pre-configured alarms, to stay on top
170
+- [Create new alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or tweak some of the pre-configured alarms, to stay on top
171
of anomalies.
172
-- [Enable notifications](/docs/monitor/enable-notifications.md) to Slack, PagerDuty, email, and 30+ other services.
173
-- [Export metrics](/docs/export/external-databases.md) to an external time-series database to use Netdata alongside
172
+- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to Slack, PagerDuty, email, and 30+ other services.
173
+- [Export metrics](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) to an external time-series database to use Netdata alongside
174
other monitoring and troubleshooting tools.
175
176
### Related reference documentation
177
178
-- [Netdata Cloud · Spaces](https://learn.netdata.cloud/docs/cloud/spaces)
179
-- [Netdata Cloud · War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms)
180
-- [Netdata Cloud · Invite your team](https://learn.netdata.cloud/docs/cloud/manage/invite-your-team)
178
+- [Netdata Cloud · Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
179
+- [Netdata Cloud · War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
180
+- [Netdata Cloud · Invite your team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md)
181
- [Netdata Cloud · Sign in or sign up with email, Google, or
182
- GitHub](https://learn.netdata.cloud/docs/cloud/manage/sign-in)
183
-- [Netdata Cloud · Nodes view](https://learn.netdata.cloud/docs/cloud/visualize/nodes)
182
+ GitHub](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.mdx)
183
+- [Netdata Cloud · Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
184
185
docs/quickstart/single-node.md
+12
-12
@@ -36,7 +36,7 @@ To see a node's dashboard in Netdata Cloud, [sign in](https://app.netdata.cloud)
36
dashboard](https://user-images.githubusercontent.com/1153921/87457036-9b678e00-c5bc-11ea-977d-ad561a73beef.png)
37
38
Once you've decided which dashboard you prefer, learn about [interacting with dashboards and
39
-charts](/docs/visualize/interact-dashboards-charts.md) to get the most from Netdata's real-time metrics.
39
+charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) to get the most from Netdata's real-time metrics.
40
41
## Configure your node
42
@@ -50,26 +50,26 @@ cd /etc/netdata
50
sudo ./edit-config netdata.conf
51
```
52
53
-Our [configuration basics doc](/docs/configure/nodes.md) contains more information about `netdata.conf`, `edit-config`,
53
+Our [configuration basics doc](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) contains more information about `netdata.conf`, `edit-config`,
54
along with simple examples to get you familiar with editing your node's configuration.
55
56
-After you've learned the basics, you should [secure your node](/docs/configure/secure-nodes.md) using one of our
56
+After you've learned the basics, you should [secure your node](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md) using one of our
57
recommended methods. These security best practices ensure no untrusted parties gain access to your dashboard or its
58
metrics.
59
60
## Collect metrics from your system and applications
61
62
-Netdata has [300+ pre-installed collectors](/collectors/COLLECTORS.md) that gather thousands of metrics with zero
62
+Netdata has [300+ pre-installed collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) that gather thousands of metrics with zero
63
configuration. Collectors search your node in default locations and ports to find running applications and gather as
64
many metrics as possible without you having to configure them individually.
65
66
These metrics enrich both the local and Netdata Cloud dashboards.
67
68
Most collectors work without configuration, but you should read up on [how collectors
69
-work](/docs/collect/how-collectors-work.md) and [how to enable/configure](/docs/collect/enable-configure.md) them.
69
+work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) and [how to enable/configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) them.
70
71
-In addition, find detailed information about which [system](/docs/collect/system-metrics.md),
72
-[container](/docs/collect/container-metrics.md), and [application](/docs/collect/application-metrics.md) metrics you can
71
+In addition, find detailed information about which [system](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md),
72
+[container](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md), and [application](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md) metrics you can
73
collect from across your infrastructure with Netdata.
74
75
## What's next?
@@ -78,15 +78,15 @@ Netdata has many features that help you monitor the health of your node and trou
78
Once you understand configuration, and are certain Netdata is collecting all the important metrics from your node, try
79
out some of Netdata's other visualization and health monitoring features:
80
81
-- [Build new dashboards](/docs/visualize/create-dashboards.md) to put disparate but relevant metrics onto a single
81
+- [Build new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) to put disparate but relevant metrics onto a single
82
interface.
83
-- [Create new alarms](/docs/monitor/configure-alarms.md), or tweak some of the pre-configured alarms, to stay on top
83
+- [Create new alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or tweak some of the pre-configured alarms, to stay on top
84
of anomalies.
85
-- [Enable notifications](/docs/monitor/enable-notifications.md) to Slack, PagerDuty, email, and 30+ other services.
86
-- [Change how long your node stores metrics](/docs/store/change-metrics-storage.md) based on how many metrics it
85
+- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to Slack, PagerDuty, email, and 30+ other services.
86
+- [Change how long your node stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) based on how many metrics it
87
collects, your preferred retention period, and the resources you want to dedicate toward long-term metrics
88
retention.
89
-- [Export metrics](/docs/export/external-databases.md) to an external time-series database to use Netdata alongside
89
+- [Export metrics](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) to an external time-series database to use Netdata alongside
90
other monitoring and troubleshooting tools.
91
92
docs/store/change-metrics-storage.md
+9
-9
@@ -10,7 +10,7 @@ learn_rel_path: "Setup"
10
11
# Change how long Netdata stores metrics
12
13
-The Netdata Agent uses a custom made time-series database (TSDB), named the [`dbengine`](/database/engine/README.md), to store metrics.
13
+The Netdata Agent uses a custom made time-series database (TSDB), named the [`dbengine`](https://github.com/netdata/netdata/blob/master/database/engine/README.md), to store metrics.
14
15
The default settings retain approximately two day's worth of metrics on a system collecting 2,000 metrics every second,
16
but the Netdata Agent is highly configurable if you want your nodes to store days, weeks, or months worth of per-second
@@ -43,7 +43,7 @@ if you want to store more metrics _specifically in memory_, you can increase the
43
44
:::tip
45
46
-We advise you to visit the [tiering mechanism](/database/engine/README.md#tiering) reference. This will help you
46
+We advise you to visit the [tiering mechanism](https://github.com/netdata/netdata/blob/master/database/engine/README.md#tiering) reference. This will help you
47
configure the Agent to retain metrics for longer periods.
48
49
:::
@@ -61,7 +61,7 @@ data retention according to your preferences.
61
## Edit `netdata.conf` with recommended database engine settings
62
63
Now that you have a recommended setting for your Agent's `dbengine`, open `netdata.conf` with
64
-[`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) and look for the `[db]`
64
+[`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) and look for the `[db]`
65
subsection. Change it to the recommended values you calculated from the calculator. For example:
66
67
```conf
@@ -80,23 +80,23 @@ subsection. Change it to the recommended values you calculated from the calculat
80
```
81
82
Save the file and restart the Agent with `sudo systemctl restart netdata`, or
83
-the [appropriate method](/docs/configure/start-stop-restart.md) for your system, to change the database engine's size.
83
+the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to change the database engine's size.
84
85
## What's next?
86
87
If you have multiple nodes with the Netdata Agent installed, you
88
-can [stream metrics](/docs/metrics-storage-management/how-streaming-works.mdx) from any number of _child_ nodes to a _
88
+can [stream metrics](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.mdx) from any number of _child_ nodes to a _
89
parent_ node and store metrics using a centralized time-series database. Streaming allows you to centralize your data,
90
run Agents as headless collectors, replicate data, and more.
91
92
Storing metrics with the database engine is completely interoperable
93
-with [exporting to other time-series databases](/docs/export/external-databases.md). With exporting, you can use the
94
-node's resources to surface metrics when [viewing dashboards](/docs/visualize/interact-dashboards-charts.md), while also
93
+with [exporting to other time-series databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md). With exporting, you can use the
94
+node's resources to surface metrics when [viewing dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md), while also
95
archiving metrics elsewhere for further analysis, visualization, or correlation with other tools.
96
97
### Related reference documentation
98
99
-- [Netdata Agent · Database engine](/database/engine/README.md)
100
-- [Netdata Agent · Database engine configuration option](/daemon/config/README.md#[db]-section-options)
99
+- [Netdata Agent · Database engine](https://github.com/netdata/netdata/blob/master/database/engine/README.md)
100
+- [Netdata Agent · Database engine configuration option](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#[db]-section-options)
101
102
docs/store/distributed-data-architecture.md
+7
-7
@@ -14,7 +14,7 @@ Netdata uses a distributed data architecture to help you collect and store per-s
14
Every node in your infrastructure, whether it's one or a thousand, stores the metrics it collects.
15
16
Netdata Cloud bridges the gap between many distributed databases by _centralizing the interface_ you use to query and
17
-visualize your nodes' metrics. When you [look at charts in Netdata Cloud](/docs/visualize/interact-dashboards-charts.md)
17
+visualize your nodes' metrics. When you [look at charts in Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md)
18
, the metrics values are queried directly from that node's database and securely streamed to Netdata Cloud, which
19
proxies them to your browser.
20
@@ -22,7 +22,7 @@ Netdata's distributed data architecture has a number of benefits:
22
23
- **Performance**: Every query to a node's database takes only a few milliseconds to complete for responsiveness when
24
viewing dashboards or using features
25
- like [Metric Correlations](https://learn.netdata.cloud/docs/cloud/insights/metric-correlations).
25
+ like [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md).
26
- **Scalability**: As your infrastructure scales, install the Netdata Agent on every new node to immediately add it to
27
your monitoring solution without adding cost or complexity.
28
- **1-second granularity**: Without an expensive centralized data lake, you can store all of your nodes' per-second
@@ -57,17 +57,17 @@ of the Netdata Agent, without affecting disk space or memory requirements.
57
Any node running the Netdata Agent can store long-term metrics for any retention period, given you allocate the
58
appropriate amount of RAM and disk space.
59
60
-Read our document on changing [how long Netdata stores metrics](/docs/store/change-metrics-storage.md) on your nodes for
60
+Read our document on changing [how long Netdata stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) on your nodes for
61
details.
62
63
-You can also stream between nodes using [streaming](/streaming/README.md), allowing to replicate databases and create
63
+You can also stream between nodes using [streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md), allowing to replicate databases and create
64
your own centralized data lake of metrics, if you choose to do so.
65
66
While a distributed data architecture is the default when monitoring infrastructure with Netdata, you can also configure
67
its behavior based on your needs or the type of infrastructure you manage.
68
69
To archive metrics to an external time-series database, such as InfluxDB, Graphite, OpenTSDB, Elasticsearch,
70
-TimescaleDB, and many others, see details on [integrating Netdata via exporting](/docs/export/external-databases.md).
70
+TimescaleDB, and many others, see details on [integrating Netdata via exporting](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md).
71
72
When you use the database engine to store your metrics, you can always perform a quick backup of a node's
73
`/var/cache/netdata/dbengine/` folder using the tool of your choice.
@@ -76,7 +76,7 @@ When you use the database engine to store your metrics, you can always perform a
76
77
Netdata Cloud does not store metric values.
78
79
-To enable certain features, such as [viewing active alarms](/docs/monitor/view-active-alarms.md)
79
+To enable certain features, such as [viewing active alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md)
80
or [filtering by hostname/service](https://learn.netdata.cloud/docs/cloud/war-rooms#node-filter), Netdata Cloud does
81
store configured alarms, their status, and a list of active collectors.
82
@@ -85,7 +85,7 @@ Netdata does not and never will sell your personal data or data about your deplo
85
## What's next?
86
87
You can configure the Netdata Agent to store days, weeks, or months worth of distributed, per-second data by
88
-[configuring the database engine](/docs/store/change-metrics-storage.md). Use our calculator to determine the system
88
+[configuring the database engine](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md). Use our calculator to determine the system
89
resources required to retain your desired amount of metrics, and expand or contract the database by editing a single
90
setting.
91
docs/visualize/create-dashboards.md
+11
-6
@@ -14,16 +14,18 @@ In the War Room you want to monitor with this dashboard, click on your War Room'
14
Add** button next to **Dashboards**. In the panel, give your new dashboard a name, and click **+ Add**.
15
16
Click the **Add Chart** button to add your first chart card. From the dropdown, select the node you want to add the
17
-chart from, then the context. Netdata Cloud shows you a preview of the chart before you finish adding it.
17
+chart from, then the context. Netdata Cloud shows you a preview of the chart before you finish adding it.
18
19
The **Add Text** button creates a new card with user-defined text, which you can use to describe or document a
20
particular dashboard's meaning and purpose. Enrich the dashboards you create with documentation or procedures on how to
21
-respond
21
+respond
22
23
25
26
-Charts in dashboards are [fully interactive](/docs/visualize/interact-dashboards-charts.md) and synchronized. You can
26
+Charts in dashboards
27
+are [fully interactive](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) and
28
+synchronized. You can
29
pan through time, zoom, highlight specific timeframes, and more.
30
31
Move any card by clicking on their top panel and dragging them to a new location. Other cards re-sort to the grid system
@@ -38,7 +40,8 @@ more detail when troubleshooting an issue. Quickly jump to any node's dashboard
40
of any card to open a menu. Hit the **Go to Chart** item.
41
42
Netdata Cloud takes you to the same chart on that node's dashboard. You can now navigate all that node's metrics and
41
-[interact with charts](/docs/visualize/interact-dashboards-charts.md) to further investigate anomalies or troubleshoot
43
+[interact with charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) to
44
+further investigate anomalies or troubleshoot
45
complex performance problems.
46
47
When viewing a single-node Cloud dashboard, you can also click on the add to dashboard icon <img
@@ -58,7 +61,9 @@ faster.
61
## What's next?
62
63
While it's useful to see real-time metrics on flexible dashboards, you need ways to know precisely when an anomaly
61
-strikes. Every Netdata Agent comes with a health watchdog that uses [alarms](/docs/monitor/configure-alarms.md) and
62
-[notifications](/docs/monitor/enable-notifications.md) to notify you of issues seconds after they strike.
64
+strikes. Every Netdata Agent comes with a health watchdog that
65
+uses [alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) and
66
+[notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to notify you of
67
+issues seconds after they strike.
68
69
docs/visualize/interact-dashboards-charts.md
+19
-19
@@ -6,30 +6,30 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/i
6
7
# Interact with dashboards and charts
8
9
-> ⚠️ There is a new version of charts that is currently **only** available on [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/visualize/interact-new-charts). We didn't
9
+> ⚠️ There is a new version of charts that is currently **only** available on [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md). We didn't
10
> want to keep this valuable feature from you, so after we get this into your hands on the Cloud, we will collect and implement your feedback to make sure we are providing the best possible version of the feature on the Netdata Agent dashboard as quickly as possible.
11
12
You can find Netdata's dashboards in two places: locally served at `http://NODE:19999` by the Netdata Agent, and in
13
Netdata Cloud. While you access these dashboards differently, they have similar interfaces, identical charts and
14
metrics, and you interact with both of them the same way.
15
16
-> If you're not sure which option is best for you, see our [single-node](/docs/quickstart/single-node.md) and
17
-> [infrastructure](/docs/quickstart/infrastructure.md) quickstart guides.
16
+> If you're not sure which option is best for you, see our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) and
17
+> [infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) quickstart guides.
18
19
Netdata dashboards are single, scrollable pages with many charts stacked on top of one another. As you scroll up or
20
down, charts appearing in your browser's viewport automatically load and update every second.
21
22
The dashboard is broken up into multiple **sections**, such as **System Overview**, **CPU**, **Disk**, which are
23
-automatically generated based on which [collectors](/docs/collect/how-collectors-work.md) begin collecting metrics when
23
+automatically generated based on which [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) begin collecting metrics when
24
Netdata starts up. Sections also appear in the right-hand **menu**, along with submenus based on the contexts and
25
families Netdata creates for your node.
26
27
## Choose timeframes to visualize
28
29
Both the local Agent dashboard and Netdata Cloud feature time & date pickers to help you visualize specific points in
30
-time. In Netdata Cloud, the picker appears in the [Overview](/docs/visualize/overview-infrastructure.md), [Nodes
31
-view](https://learn.netdata.cloud/docs/cloud/visualize/nodes), [new
32
-dashboards](https://learn.netdata.cloud/docs/cloud/visualize/dashboards), and any single-node dashboards you visit.
30
+time. In Netdata Cloud, the picker appears in the [Overview](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md), [Nodes
31
+view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md), [new
32
+dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md), and any single-node dashboards you visit.
33
34
Local Agent dashboard:
35
@@ -45,8 +45,8 @@ Their behavior is identical. Use the Quick Selector to visualize generic timefra
45
select days, hours, minutes or seconds. Click **Apply** to re-render all visualizations with new metrics data, or
46
**Clear** to restore the default timeframe.
47
48
-See reference documentation for the [local Agent dashboard](/web/gui/README.md#time--date-picker) and [Netdata
49
-Cloud](https://learn.netdata.cloud/docs/cloud/war-rooms#time--date-picker) for additional context about how the time &
48
+See reference documentation for the [local Agent dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md#time--date-picker) and [Netdata
49
+Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md#time--date-picker) for additional context about how the time &
50
date picker behaves in each environment.
51
52
## Charts, dimensions, families, and contexts
@@ -68,7 +68,7 @@ A **context** groups several charts based on the types of metrics being collecte
68
this context to create individual charts and then groups them by family. You can always see the context of any chart by
69
looking at its name or hovering over the chart's date.
70
71
-See our [dashboard docs](/web/README.md#charts-contexts-families) for more information about the above distinctions
71
+See our [dashboard docs](https://github.com/netdata/netdata/blob/master/web/README.md#charts-contexts-families) for more information about the above distinctions
72
and how they're used across Netdata to meaningfully organize and present metrics.
73
74
## Interact with charts
@@ -107,25 +107,25 @@ height](https://user-images.githubusercontent.com/1153921/102652691-24b25c00-412
107
Netdata Cloud now supports composite charts in the Overview interface. Composite charts come with a few additional UI
108
elements and varied interactions, such as the location of dimensions and a utility bar for configuring the state of
109
individual composite charts. All of these details are covered in the [Overview
110
-reference](https://learn.netdata.cloud/docs/cloud/visualize/overview) doc.
110
+reference](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) doc.
111
112
## What's next?
113
114
-Netdata Cloud users can [build new dashboards](/docs/visualize/create-dashboards.md) in just a few clicks. By
114
+Netdata Cloud users can [build new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) in just a few clicks. By
115
aggregating relevant metrics from any number of nodes onto a single interface, you can respond faster to anomalies,
116
perform more targeted troubleshooting, or keep tabs on a bird's eye view of your infrastructure.
117
118
If you're finished with dashboards for now, skip to Netdata's health watchdog for information on [creating or
119
-configuring](/docs/monitor/configure-alarms.md) alarms, and [send notifications](/docs/monitor/enable-notifications.md)
119
+configuring](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) alarms, and [send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md)
120
to get informed when something goes wrong in your infrastructure.
121
122
### Related reference documentation
123
124
-- [Netdata Agent · Web dashboards overview](/web/README.md)
125
-- [Netdata Cloud · Interact with new charts](https://learn.netdata.cloud/docs/cloud/visualize/interact-new-charts)
126
-- [Netdata Cloud · War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms)
127
-- [Netdata Cloud · Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview)
128
-- [Netdata Cloud · Nodes](https://learn.netdata.cloud/docs/cloud/visualize/nodes)
129
-- [Netdata Cloud · Build new dashboards](https://learn.netdata.cloud/docs/cloud/visualize/dashboards)
124
+- [Netdata Agent · Web dashboards overview](https://github.com/netdata/netdata/blob/master/web/README.md)
125
+- [Netdata Cloud · Interact with new charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
126
+- [Netdata Cloud · War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
127
+- [Netdata Cloud · Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)
128
+- [Netdata Cloud · Nodes](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
129
+- [Netdata Cloud · Build new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)
130
131
docs/visualize/overview-infrastructure.md
+16
-16
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/o
7
# See an overview of your infrastructure
8
9
In Netdata Cloud, your nodes are organized into War Rooms. One of the two available views for a War Room is the
10
-[**Overview**](https://learn.netdata.cloud/docs/cloud/visualize/overview), which uses composite charts to display
10
+[**Overview**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), which uses composite charts to display
11
real-time, aggregated metrics from all the nodes (or a filtered selection) in a given War Room.
12
13
With Overview's composite charts, you can see your infrastructure from a single pane of glass, discover trends or
@@ -15,7 +15,7 @@ anomalies, then drill down with filtering or single-node dashboards to see more.
15
each chart visualizes average or sum metrics values from across 5 distributed nodes.
16
17
Netdata also supports robust Kubernetes monitoring using the Overview. Read our [deployment
18
-doc](/packaging/installer/methods/kubernetes.md) for details on visualizing Kubernetes metrics in Netdata Cloud.
18
+doc](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md) for details on visualizing Kubernetes metrics in Netdata Cloud.
19
20
@@ -32,8 +32,8 @@ Let's walk through some examples of using the Overview to monitor and troublesho
32
### Filter nodes and pick relevant times
33
34
While not exclusive to Overview, you can use two important features, [node
35
-filtering](https://learn.netdata.cloud/docs/cloud/war-rooms#node-filter) and the [time & date
36
-picker](https://learn.netdata.cloud/docs/cloud/war-rooms#time--date-picker), to widen or narrow your infrastructure
35
+filtering](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md#node-filter) and the [time & date
36
+picker](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md#time--date-picker), to widen or narrow your infrastructure
37
monitoring focus.
38
39
By default, the Overview shows composite charts aggregated from every node in the War Room, but you can change that
@@ -48,7 +48,7 @@ establishing a baseline of infrastructure performance or targeted root cause ana
48
For example, use the **Quick Selector** options to pick the 12-hour option first thing in the morning to check your
49
infrastructure for any odd behavior overnight. Use the 7-day option to observe trends between various days of the week.
50
51
-See the [War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms) docs for more details on both features.
51
+See the [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md) docs for more details on both features.
52
53
### Configure composite charts to identify problems
54
@@ -60,7 +60,7 @@ affects a single node, a subset of nodes, or an entire infrastructure.
60
62
63
-Use [_group by node_](https://learn.netdata.cloud/docs/cloud/visualize/overview#group-by-dimension-or-node) to visualize
63
+Use [_group by node_](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#group-by-dimension-or-node) to visualize
64
a single metric across all contributing nodes. If the composite chart has 5 contributing nodes, there will be 5
65
lines/areas, one for the most relevant dimension from each node.
66
@@ -80,32 +80,32 @@ given node to quickly _jump to the same chart in that node's single-node dashboa
80
81
You can use single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to
82
investigate historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
83
-All of the familiar [interactions](/docs/visualize/interact-dashboards-charts.md) are available, as is adding any chart
84
-to a [new dashboard](/docs/visualize/create-dashboards.md).
83
+All of the familiar [interactions](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) are available, as is adding any chart
84
+to a [new dashboard](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md).
85
86
## Nodes view
87
88
You can also use the **Nodes view** to monitor the health status and user-configurable key metrics from multiple nodes
89
-in a War Room. Read the [Nodes view doc](https://learn.netdata.cloud/docs/cloud/visualize/nodes) for details.
89
+in a War Room. Read the [Nodes view doc](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) for details.
90
91
92
93
## What's next?
94
95
To troubleshoot complex performance issues using Netdata, you need to understand how to interact with its meaningful
96
-visualizations. Learn more about [interaction](/docs/visualize/interact-dashboards-charts.md) to see historical metrics,
96
+visualizations. Learn more about [interaction](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) to see historical metrics,
97
highlight timeframes for targeted analysis, and more.
98
99
If you're a Kubernetes user, read about Netdata's [Kubernetes
100
-visualizations](https://learn.netdata.cloud/docs/cloud/visualize/kubernetes) for details about the health map and
100
+visualizations](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) for details about the health map and
101
time-series k8s charts, and our tutorial, [_Kubernetes monitoring with Netdata: Overview and
102
-visualizations_](/docs/guides/monitor/kubernetes-k8s-netdata.md), for a full walkthrough.
102
+visualizations_](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/kubernetes-k8s-netdata.md), for a full walkthrough.
103
104
### Related reference documentation
105
106
-- [Netdata Cloud · War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms)
107
-- [Netdata Cloud · Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview)
108
-- [Netdata Cloud · Nodes view](https://learn.netdata.cloud/docs/cloud/visualize/nodes)
109
-- [Netdata Cloud · Kubernetes visualizations](https://learn.netdata.cloud/docs/cloud/visualize/kubernetes)
106
+- [Netdata Cloud · War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
107
+- [Netdata Cloud · Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)
108
+- [Netdata Cloud · Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
109
+- [Netdata Cloud · Kubernetes visualizations](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)
110
111
docs/why-netdata/README.md
+4
-4
@@ -11,19 +11,19 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata
11
12
Netdata is built around 4 principles:
13
14
-1. **[Per second data collection for all metrics.](/docs/why-netdata/1s-granularity.md)**
14
+1. **[Per second data collection for all metrics.](https://github.com/netdata/netdata/blob/master/docs/why-netdata/1s-granularity.md)**
15
16
_It is impossible to monitor a 2 second SLA, with 10 second metrics._
17
18
-2. **[Collect and visualize all the metrics from all possible sources.](/docs/why-netdata/unlimited-metrics.md)**
18
+2. **[Collect and visualize all the metrics from all possible sources.](https://github.com/netdata/netdata/blob/master/docs/why-netdata/unlimited-metrics.md)**
19
20
_To troubleshoot slowdowns, we need all the available metrics. The console should not provide more metrics._
21
22
-3. **[Meaningful presentation, optimized for visual anomaly detection.](/docs/why-netdata/meaningful-presentation.md)**
22
+3. **[Meaningful presentation, optimized for visual anomaly detection.](https://github.com/netdata/netdata/blob/master/docs/why-netdata/meaningful-presentation.md)**
23
24
_Metrics are a lot more than name-value pairs over time. The monitoring tool should know all the metrics. Users should not!_
25
26
-4. **[Immediate results, just install and use.](/docs/why-netdata/immediate-results.md)**
26
+4. **[Immediate results, just install and use.](https://github.com/netdata/netdata/blob/master/docs/why-netdata/immediate-results.md)**
27
28
_Most of our infrastructure is standardized. There is no point to configure everything metric by metric._
29
exporting/README.md
+14
-14
@@ -16,13 +16,13 @@ configuring, and monitoring Netdata's exporting engine, which allows you to send
16
databases.
17
18
For a quick introduction to the exporting engine's features, read our doc on [exporting metrics to time-series
19
-databases](/docs/export/external-databases.md), or jump in to [enabling a connector](/docs/export/enable-connector.md).
19
+databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md), or jump in to [enabling a connector](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md).
20
21
The exporting engine has a modular structure and supports metric exporting via multiple exporting connector instances at
22
the same time. You can have different update intervals and filters configured for every exporting connector instance.
23
24
When you enable the exporting engine and a connector, the Netdata Agent exports metrics _beginning from the time you
25
-restart its process_, not the entire [database of long-term metrics](/docs/store/change-metrics-storage.md).
25
+restart its process_, not the entire [database of long-term metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).
26
27
Since Netdata collects thousands of metrics per server per second, which would easily congest any database server when
28
several Netdata servers are sending data to it, Netdata allows sending metrics at a lower frequency, by resampling them.
@@ -35,27 +35,27 @@ X seconds (though, it can send them per second if you need it to).
35
### Integration
36
37
The exporting engine uses a number of connectors to send Netdata metrics to external time-series databases. See our
38
-[list of supported databases](/docs/export/external-databases.md#supported-databases) for information on which
38
+[list of supported databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md#supported-databases) for information on which
39
connector to enable and configure for your database of choice.
40
41
-- [**AWS Kinesis Data Streams**](/exporting/aws_kinesis/README.md): Metrics are sent to the service in `JSON`
41
+- [**AWS Kinesis Data Streams**](https://github.com/netdata/netdata/blob/master/exporting/aws_kinesis/README.md): Metrics are sent to the service in `JSON`
42
format.
43
-- [**Google Cloud Pub/Sub Service**](/exporting/pubsub/README.md): Metrics are sent to the service in `JSON`
43
+- [**Google Cloud Pub/Sub Service**](https://github.com/netdata/netdata/blob/master/exporting/pubsub/README.md): Metrics are sent to the service in `JSON`
44
format.
45
-- [**Graphite**](/exporting/graphite/README.md): A plaintext interface. Metrics are sent to the database server as
45
+- [**Graphite**](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md): A plaintext interface. Metrics are sent to the database server as
46
`prefix.hostname.chart.dimension`. `prefix` is configured below, `hostname` is the hostname of the machine (can
47
also be configured). Learn more in our guide to [export and visualize Netdata metrics in
48
- Graphite](/docs/guides/export/export-netdata-metrics-graphite.md).
49
-- [**JSON** document databases](/exporting/json/README.md)
50
-- [**OpenTSDB**](/exporting/opentsdb/README.md): Use a plaintext or HTTP interfaces. Metrics are sent to
48
+ Graphite](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md).
49
+- [**JSON** document databases](https://github.com/netdata/netdata/blob/master/exporting/json/README.md)
50
+- [**OpenTSDB**](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md): Use a plaintext or HTTP interfaces. Metrics are sent to
51
OpenTSDB as `prefix.chart.dimension` with tag `host=hostname`.
52
-- [**MongoDB**](/exporting/mongodb/README.md): Metrics are sent to the database in `JSON` format.
53
-- [**Prometheus**](/exporting/prometheus/README.md): Use an existing Prometheus installation to scrape metrics
52
+- [**MongoDB**](https://github.com/netdata/netdata/blob/master/exporting/mongodb/README.md): Metrics are sent to the database in `JSON` format.
53
+- [**Prometheus**](https://github.com/netdata/netdata/blob/master/exporting/prometheus/README.md): Use an existing Prometheus installation to scrape metrics
54
from node using the Netdata API.
55
-- [**Prometheus remote write**](/exporting/prometheus/remote_write/README.md). A binary snappy-compressed protocol
55
+- [**Prometheus remote write**](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md). A binary snappy-compressed protocol
56
buffer encoding over HTTP. Supports many [storage
57
providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage).
58
-- [**TimescaleDB**](/exporting/TIMESCALE.md): Use a community-built connector that takes JSON streams from a
58
+- [**TimescaleDB**](https://github.com/netdata/netdata/blob/master/exporting/TIMESCALE.md): Use a community-built connector that takes JSON streams from a
59
Netdata client and writes them to a TimescaleDB table.
60
61
### Chart filtering
@@ -296,7 +296,7 @@ Configure individual connectors and override any global settings with the follow
296
Netdata can send metrics to external databases using the TLS/SSL protocol. Unfortunately, some of
297
them does not support encrypted connections, so you will have to configure a reverse proxy to enable
298
HTTPS communication between Netdata and an external database. You can set up a reverse proxy with
299
-[Nginx](/docs/Running-behind-nginx.md).
299
+[Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md).
300
301
## Exporting engine monitoring
302
exporting/WALKTHROUGH.md
+2
-2
@@ -67,7 +67,7 @@ command to run (`/bin/bash`) and then chooses the base container images (`centos
67
be sitting inside the shell of the container.
68
69
After we have entered the shell we can install Netdata. This process could not be easier. If you take a look at [this
70
-link](/packaging/installer/README.md), the Netdata devs give us several one-liners to install Netdata. I have not had
70
+link](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md), the Netdata devs give us several one-liners to install Netdata. I have not had
71
any issues with these one liners and their bootstrapping scripts so far (If you guys run into anything do share). Run
72
the following command in your container.
73
@@ -226,7 +226,7 @@ the `chart` dimension. If you'd like you can combine the `chart` and `instance`
226
Let's give this a try: `netdata_system_cpu_percentage_average{chart="system.cpu", instance="netdata:19999"}`
227
228
This is the basics of using Prometheus to query Netdata. I'd advise everyone at this point to read [this
229
-page](/exporting/prometheus/README.md#using-netdata-with-prometheus). The key point here is that Netdata can export metrics from
229
+page](https://github.com/netdata/netdata/blob/master/exporting/prometheus/README.md#using-netdata-with-prometheus). The key point here is that Netdata can export metrics from
230
its internal DB or can send metrics _as-collected_ by specifying the `source=as-collected` URL parameter like so.
231
<http://localhost:19999/api/v1/allmetrics?format=prometheus&help=yes&types=yes&source=as-collected> If you choose to use
232
this method you will need to use Prometheus's set of functions here: <https://prometheus.io/docs/querying/functions/> to
exporting/aws_kinesis/README.md
+2
-1
@@ -54,7 +54,8 @@ Set AWS credentials and stream name:
54
stream name = your_stream_name
55
```
56
57
-Alternatively, you can set AWS credentials for the `netdata` user using AWS SDK for C++ [standard methods](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/credentials.html).
57
+Alternatively, you can set AWS credentials for the `netdata` user using AWS SDK for
58
+C++ [standard methods](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/credentials.html).
59
60
Netdata automatically computes a partition key for every record with the purpose to distribute records across
61
available shards evenly.
exporting/graphite/README.md
+7
-5
@@ -11,8 +11,9 @@ learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
11
12
# Export metrics to Graphite providers
13
14
-You can use the Graphite connector for the [exporting engine](/exporting/README.md) to archive your agent's metrics to
15
-Graphite providers for long-term storage, further analysis, or correlation with data from other sources.
14
+You can use the Graphite connector for
15
+the [exporting engine](https://github.com/netdata/netdata/blob/master/exporting/README.md) to archive your agent's
16
+metrics to Graphite providers for long-term storage, further analysis, or correlation with data from other sources.
17
18
## Configuration
19
@@ -25,7 +26,8 @@ directory and set the following options:
26
destination = localhost:2003
27
```
28
28
-Add `:http` or `:https` modifiers to the connector type if you need to use other than a plaintext protocol. For example: `graphite:http:my_graphite_instance`,
29
+Add `:http` or `:https` modifiers to the connector type if you need to use other than a plaintext protocol. For
30
+example: `graphite:http:my_graphite_instance`,
31
`graphite:https:my_graphite_instance`. You can set basic HTTP authentication credentials using
32
33
```conf
@@ -33,7 +35,7 @@ Add `:http` or `:https` modifiers to the connector type if you need to use other
35
password = my_password
36
```
37
36
-The Graphite connector is further configurable using additional settings. See the [exporting reference
37
-doc](/exporting/README.md#options) for details.
38
+The Graphite connector is further configurable using additional settings. See
39
+the [exporting reference doc](https://github.com/netdata/netdata/blob/master/exporting/README.md#options) for details.
40
41
exporting/json/README.md
+3
-3
@@ -11,7 +11,7 @@ learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
11
12
# Export metrics to JSON document databases
13
14
-You can use the JSON connector for the [exporting engine](/exporting/README.md) to archive your agent's metrics to JSON
14
+You can use the JSON connector for the [exporting engine](https://github.com/netdata/netdata/blob/master/exporting/README.md) to archive your agent's metrics to JSON
15
document databases for long-term storage, further analysis, or correlation with data from other sources.
16
17
## Configuration
@@ -33,7 +33,7 @@ Add `:http` or `:https` modifiers to the connector type if you need to use other
33
password = my_password
34
```
35
36
-The JSON connector is further configurable using additional settings. See the [exporting reference
37
-doc](/exporting/README.md#options) for details.
36
+The JSON connector is further configurable using additional settings. See
37
+the [exporting reference doc](https://github.com/netdata/netdata/blob/master/exporting/README.md#options) for details.
38
39
exporting/mongodb/README.md
+3
-2
@@ -11,8 +11,9 @@ learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
11
12
# Export metrics to MongoDB
13
14
-You can use the MongoDB connector for the [exporting engine](/exporting/README.md) to archive your agent's metrics to a
15
-MongoDB database for long-term storage, further analysis, or correlation with data from other sources.
14
+You can use the MongoDB connector for
15
+the [exporting engine](https://github.com/netdata/netdata/blob/master/exporting/README.md) to archive your agent's
16
+metrics to a MongoDB database for long-term storage, further analysis, or correlation with data from other sources.
17
18
## Prerequisites
19
exporting/opentsdb/README.md
+7
-5
@@ -11,8 +11,9 @@ learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
11
12
# Export metrics to OpenTSDB
13
14
-You can use the OpenTSDB connector for the [exporting engine](/exporting/README.md) to archive your agent's metrics to OpenTSDB
15
-databases for long-term storage, further analysis, or correlation with data from other sources.
14
+You can use the OpenTSDB connector for
15
+the [exporting engine](https://github.com/netdata/netdata/blob/master/exporting/README.md) to archive your agent's
16
+metrics to OpenTSDB databases for long-term storage, further analysis, or correlation with data from other sources.
17
18
## Configuration
19
@@ -25,7 +26,8 @@ directory and set the following options:
26
destination = localhost:4242
27
```
28
28
-Add `:http` or `:https` modifiers to the connector type if you need to use other than a plaintext protocol. For example: `opentsdb:http:my_opentsdb_instance`,
29
+Add `:http` or `:https` modifiers to the connector type if you need to use other than a plaintext protocol. For
30
+example: `opentsdb:http:my_opentsdb_instance`,
31
`opentsdb:https:my_opentsdb_instance`. You can set basic HTTP authentication credentials using
32
33
```conf
@@ -33,7 +35,7 @@ Add `:http` or `:https` modifiers to the connector type if you need to use other
35
password = my_password
36
```
37
36
-The OpenTSDB connector is further configurable using additional settings. See the [exporting reference
37
-doc](/exporting/README.md#options) for details.
38
+The OpenTSDB connector is further configurable using additional settings. See
39
+the [exporting reference doc](https://github.com/netdata/netdata/blob/master/exporting/README.md#options) for details.
40
41
exporting/prometheus/README.md
+52
-48
@@ -22,7 +22,8 @@ are starting at a fresh ubuntu shell (whether you'd like to follow along in a VM
22
23
### Installing Netdata
24
25
-There are number of ways to install Netdata according to [Installation](/packaging/installer/README.md). The suggested way
25
+There are number of ways to install Netdata according to
26
+[Installation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). The suggested way
27
of installing the latest Netdata and keep it upgrade automatically.
28
29
<!-- candidate for reuse -->
@@ -82,24 +83,24 @@ sudo tar -xvf /tmp/prometheus-*linux-amd64.tar.gz -C /opt/prometheus --strip=1
83
84
We will use the following `prometheus.yml` file. Save it at `/opt/prometheus/prometheus.yml`.
85
85
-Make sure to replace `your.netdata.ip` with the IP or hostname of the host running Netdata.
86
+Make sure to replace `your.netdata.ip` with the IP or hostname of the host running Netdata.
87
88
```yaml
89
# my global config
90
global:
90
- scrape_interval: 5s # Set the scrape interval to every 5 seconds. Default is every 1 minute.
91
+ scrape_interval: 5s # Set the scrape interval to every 5 seconds. Default is every 1 minute.
92
evaluation_interval: 5s # Evaluate rules every 5 seconds. The default is every 1 minute.
93
# scrape_timeout is set to the global default (10s).
94
95
# Attach these labels to any time series or alerts when communicating with
96
# external systems (federation, remote storage, Alertmanager).
97
external_labels:
97
- monitor: 'codelab-monitor'
98
+ monitor: 'codelab-monitor'
99
100
# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
101
rule_files:
101
- # - "first.rules"
102
- # - "second.rules"
102
+# - "first.rules"
103
+# - "second.rules"
104
105
# A scrape configuration containing exactly one endpoint to scrape:
106
# Here it's Prometheus itself.
@@ -111,7 +112,7 @@ scrape_configs:
112
# scheme defaults to 'http'.
113
114
static_configs:
114
- - targets: ['0.0.0.0:9090']
115
+ - targets: [ '0.0.0.0:9090' ]
116
117
- job_name: 'netdata-scrape'
118
@@ -119,7 +120,7 @@ scrape_configs:
120
params:
121
# format: prometheus | prometheus_all_hosts
122
# You can use `prometheus_all_hosts` if you want Prometheus to set the `instance` to your hostname instead of IP
122
- format: [prometheus]
123
+ format: [ prometheus ]
124
#
125
# sources: as-collected | raw | average | sum | volume
126
# default is: average
@@ -131,7 +132,7 @@ scrape_configs:
132
honor_labels: true
133
134
static_configs:
134
- - targets: ['{your.netdata.ip}:19999']
135
+ - targets: [ '{your.netdata.ip}:19999' ]
136
```
137
138
#### Install nodes.yml
@@ -207,7 +208,7 @@ sudo systemctl start prometheus
208
sudo systemctl enable prometheus
209
```
210
210
-Prometheus should now start and listen on port 9090. Attempt to head there with your browser.
211
+Prometheus should now start and listen on port 9090. Attempt to head there with your browser.
212
213
If everything is working correctly when you fetch `http://your.prometheus.ip:9090` you will see a 'Status' tab. Click
214
this and click on 'targets' We should see the Netdata host as a scraped target.
@@ -224,16 +225,16 @@ Before explaining the changes, we have to understand the key differences between
225
226
Each chart in Netdata has several properties (common to all its metrics):
227
227
-- `chart_id` - uniquely identifies a chart.
228
+- `chart_id` - uniquely identifies a chart.
229
229
-- `chart_name` - a more human friendly name for `chart_id`, also unique.
230
+- `chart_name` - a more human friendly name for `chart_id`, also unique.
231
231
-- `context` - this is the template of the chart. All disk I/O charts have the same context, all mysql requests charts
232
- have the same context, etc. This is used for alarm templates to match all the charts they should be attached to.
232
+- `context` - this is the template of the chart. All disk I/O charts have the same context, all mysql requests charts
233
+ have the same context, etc. This is used for alarm templates to match all the charts they should be attached to.
234
234
-- `family` groups a set of charts together. It is used as the submenu of the dashboard.
235
+- `family` groups a set of charts together. It is used as the submenu of the dashboard.
236
236
-- `units` is the units for all the metrics attached to the chart.
237
+- `units` is the units for all the metrics attached to the chart.
238
239
#### dimensions
240
@@ -245,44 +246,44 @@ they are both in the same chart).
246
247
Netdata can send metrics to Prometheus from 3 data sources:
248
248
-- `as collected` or `raw` - this data source sends the metrics to Prometheus as they are collected. No conversion is
249
- done by Netdata. The latest value for each metric is just given to Prometheus. This is the most preferred method by
250
- Prometheus, but it is also the harder to work with. To work with this data source, you will need to understand how
251
- to get meaningful values out of them.
249
+- `as collected` or `raw` - this data source sends the metrics to Prometheus as they are collected. No conversion is
250
+ done by Netdata. The latest value for each metric is just given to Prometheus. This is the most preferred method by
251
+ Prometheus, but it is also the harder to work with. To work with this data source, you will need to understand how
252
+ to get meaningful values out of them.
253
253
- The format of the metrics is: `CONTEXT{chart="CHART",family="FAMILY",dimension="DIMENSION"}`.
254
+ The format of the metrics is: `CONTEXT{chart="CHART",family="FAMILY",dimension="DIMENSION"}`.
255
255
- If the metric is a counter (`incremental` in Netdata lingo), `_total` is appended the context.
256
+ If the metric is a counter (`incremental` in Netdata lingo), `_total` is appended the context.
257
257
- Unlike Prometheus, Netdata allows each dimension of a chart to have a different algorithm and conversion constants
258
- (`multiplier` and `divisor`). In this case, that the dimensions of a charts are heterogeneous, Netdata will use this
259
- format: `CONTEXT_DIMENSION{chart="CHART",family="FAMILY"}`
258
+ Unlike Prometheus, Netdata allows each dimension of a chart to have a different algorithm and conversion constants
259
+ (`multiplier` and `divisor`). In this case, that the dimensions of a charts are heterogeneous, Netdata will use this
260
+ format: `CONTEXT_DIMENSION{chart="CHART",family="FAMILY"}`
261
261
-- `average` - this data source uses the Netdata database to send the metrics to Prometheus as they are presented on
262
- the Netdata dashboard. So, all the metrics are sent as gauges, at the units they are presented in the Netdata
263
- dashboard charts. This is the easiest to work with.
262
+- `average` - this data source uses the Netdata database to send the metrics to Prometheus as they are presented on
263
+ the Netdata dashboard. So, all the metrics are sent as gauges, at the units they are presented in the Netdata
264
+ dashboard charts. This is the easiest to work with.
265
265
- The format of the metrics is: `CONTEXT_UNITS_average{chart="CHART",family="FAMILY",dimension="DIMENSION"}`.
266
+ The format of the metrics is: `CONTEXT_UNITS_average{chart="CHART",family="FAMILY",dimension="DIMENSION"}`.
267
267
- When this source is used, Netdata keeps track of the last access time for each Prometheus server fetching the
268
- metrics. This last access time is used at the subsequent queries of the same Prometheus server to identify the
269
- time-frame the `average` will be calculated.
268
+ When this source is used, Netdata keeps track of the last access time for each Prometheus server fetching the
269
+ metrics. This last access time is used at the subsequent queries of the same Prometheus server to identify the
270
+ time-frame the `average` will be calculated.
271
271
- So, no matter how frequently Prometheus scrapes Netdata, it will get all the database data.
272
- To identify each Prometheus server, Netdata uses by default the IP of the client fetching the metrics.
273
-
274
- If there are multiple Prometheus servers fetching data from the same Netdata, using the same IP, each Prometheus
275
- server can append `server=NAME` to the URL. Netdata will use this `NAME` to uniquely identify the Prometheus server.
272
+ So, no matter how frequently Prometheus scrapes Netdata, it will get all the database data.
273
+ To identify each Prometheus server, Netdata uses by default the IP of the client fetching the metrics.
274
277
-- `sum` or `volume`, is like `average` but instead of averaging the values, it sums them.
275
+ If there are multiple Prometheus servers fetching data from the same Netdata, using the same IP, each Prometheus
276
+ server can append `server=NAME` to the URL. Netdata will use this `NAME` to uniquely identify the Prometheus server.
277
279
- The format of the metrics is: `CONTEXT_UNITS_sum{chart="CHART",family="FAMILY",dimension="DIMENSION"}`. All the
280
- other operations are the same with `average`.
278
+- `sum` or `volume`, is like `average` but instead of averaging the values, it sums them.
279
282
- To change the data source to `sum` or `as-collected` you need to provide the `source` parameter in the request URL.
283
- e.g.: `http://your.netdata.ip:19999/api/v1/allmetrics?format=prometheus&help=yes&source=as-collected`
280
+ The format of the metrics is: `CONTEXT_UNITS_sum{chart="CHART",family="FAMILY",dimension="DIMENSION"}`. All the
281
+ other operations are the same with `average`.
282
285
- Keep in mind that early versions of Netdata were sending the metrics as: `CHART_DIMENSION{}`.
283
+ To change the data source to `sum` or `as-collected` you need to provide the `source` parameter in the request URL.
284
+ e.g.: `http://your.netdata.ip:19999/api/v1/allmetrics?format=prometheus&help=yes&source=as-collected`
285
+
286
+ Keep in mind that early versions of Netdata were sending the metrics as: `CHART_DIMENSION{}`.
287
288
### Querying Metrics
289
@@ -369,7 +370,7 @@ functionality of Netdata this ignores any upstream hosts - so you should conside
370
```yaml
371
metrics_path: '/api/v1/allmetrics'
372
params:
372
- format: [prometheus_all_hosts]
373
+ format: [ prometheus_all_hosts ]
374
honor_labels: true
375
```
376
@@ -394,7 +395,9 @@ To save bandwidth, and because Prometheus does not use them anyway, `# TYPE` and
395
wanted they can be re-enabled via `types=yes` and `help=yes`, e.g.
396
`/api/v1/allmetrics?format=prometheus&types=yes&help=yes`
397
397
-Note that if enabled, the `# TYPE` and `# HELP` lines are repeated for every occurrence of a metric, which goes against the Prometheus documentation's [specification for these lines](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#comments-help-text-and-type-information).
398
+Note that if enabled, the `# TYPE` and `# HELP` lines are repeated for every occurrence of a metric, which goes against
399
+the Prometheus
400
+documentation's [specification for these lines](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#comments-help-text-and-type-information).
401
402
### Names and IDs
403
@@ -413,8 +416,8 @@ The default is controlled in `exporting.conf`:
416
417
You can overwrite it from Prometheus, by appending to the URL:
418
416
-- `&names=no` to get IDs (the old behaviour)
417
-- `&names=yes` to get names
419
+- `&names=no` to get IDs (the old behaviour)
420
+- `&names=yes` to get names
421
422
### Filtering metrics sent to Prometheus
423
@@ -425,7 +428,8 @@ Netdata can filter the metrics it sends to Prometheus with this setting:
428
send charts matching = *
429
```
430
428
-This settings accepts a space separated list of [simple patterns](/libnetdata/simple_pattern/README.md) to match the
431
+This settings accepts a space separated list
432
+of [simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) to match the
433
**charts** to be sent to Prometheus. Each pattern can use `*` as wildcard, any number of times (e.g `*a*b*c*` is valid).
434
Patterns starting with `!` give a negative match (e.g `!*.bad users.* groups.*` will send all the users and groups
435
except `bad` user and `bad` group). The order is important: the first match (positive or negative) left to right, is
exporting/prometheus/remote_write/README.md
+1
-1
@@ -18,7 +18,7 @@ than 20 external storage providers for long-term archiving and further analysis.
18
To use the Prometheus remote write API with [storage
19
providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage), install
20
[protobuf](https://developers.google.com/protocol-buffers/) and [snappy](https://github.com/google/snappy) libraries.
21
-Next, [reinstall Netdata](/packaging/installer/REINSTALL.md), which detects that the required libraries and utilities
21
+Next, [reinstall Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md), which detects that the required libraries and utilities
22
are now available.
23
24
## Configuration
health/README.md
+5
-7
@@ -14,15 +14,13 @@ worked closely with our community of DevOps engineers, SREs, and developers to d
14
alarms that work without any configuration.
15
16
The Agent's health monitoring system is also dynamic and fully customizable. You can write entirely new alarms, tune the
17
-community-configured alarms for every app/service [the Agent collects metrics from](/collectors/COLLECTORS.md), or
17
+community-configured alarms for every app/service [the Agent collects metrics from](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md), or
18
silence anything you're not interested in. You can even power complex lookups by running statistical algorithms against
19
your metrics.
20
21
Ready to take the next steps with health monitoring?
22
23
-[Quickstart](https://github.com/netdata/netdata/edit/master/health/QUICKSTART.md)
24
-
25
-[Configuration reference](https://github.com/netdata/netdata/edit/master/health/REFERENCE.md)
23
+[Configuration reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md)
24
25
## Guides
26
@@ -30,13 +28,13 @@ Every infrastructure is different, so we're not interested in mandating how you
28
monitoring features. Instead, these guides should give you the details you need to tweak alarms to your heart's
29
content.
30
33
-[Stopping notifications for individual alarms](https://github.com/netdata/netdata/edit/master/docs/guides/monitor/stop-notifications-alarms.md)
31
+[Stopping notifications for individual alarms](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/stop-notifications-alarms.md)
32
35
-[Use dimension templates to create dynamic alarms](https://github.com/netdata/netdata/edit/master/docs/guides/monitor/dimension-templates.md)
33
+[Use dimension templates to create dynamic alarms](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/dimension-templates.md)
34
35
## Related features
36
39
-**[Notifications](https://github.com/netdata/netdata/edit/master/health/notifications/README.md)**: Get notified about ongoing alarms from your Agents via your
37
+**[Notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md)**: Get notified about ongoing alarms from your Agents via your
38
favorite platform(s), such as Slack, Discord, PagerDuty, email, and much more.
39
40
health/REFERENCE.md
+16
-16
@@ -15,7 +15,7 @@ This guide contains information about editing health configuration files to twea
15
entities that are customized to the needs of your infrastructure.
16
17
To learn the basics of locating and editing health configuration files, see the [health
18
-quickstart](/health/QUICKSTART.md).
18
+quickstart](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md).
19
20
## Health configuration files
21
@@ -23,7 +23,7 @@ You can configure the Agent's health watchdog service by editing files in two lo
23
24
- The `[health]` section in `netdata.conf`. By editing the daemon's behavior, you can disable health monitoring
25
altogether, run health checks more or less often, and more. See [daemon
26
- configuration](/daemon/config/README.md#health-section-options) for a table of all the available settings, their
26
+ configuration](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#health-section-options) for a table of all the available settings, their
27
default values, and what they control.
28
- The individual `.conf` files in `health.d/`. These health entity files are organized by the type of metric they are
29
performing calculations on or their associated collector. You should edit these files using the `edit-config`
@@ -56,7 +56,7 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation
56
- The `every` line is **required** if not using `lookup`.
57
- Each entity **must** have at least one of the following lines: `lookup`, `calc`, `warn`, or `crit`.
58
- A few lines use space-separated lists to define how the entity behaves. You can use `*` as a wildcard or prefix with
59
- `!` for a negative match. Order is important, too! See our [simple patterns docs](/libnetdata/simple_pattern/README.md) for
59
+ `!` for a negative match. Order is important, too! See our [simple patterns docs](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) for
60
more examples.
61
- Lines terminated by a `\` are spliced together with the next line. The backslash is removed and the following line is
62
joined with the current one. No space is inserted, so you may split a line anywhere, even in the middle of a word.
@@ -240,7 +240,7 @@ hosts: server1 server2 database* !redis3 redis*
240
#### Alarm line `plugin`
241
242
The `plugin` line filters which plugin within the context this alarm should apply to. The value is a space-separated
243
-list of [simple patterns](/libnetdata/simple_pattern/README.md). For example,
243
+list of [simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md). For example,
244
you can create a filter for an alarm that applies specifically to `python.d.plugin`:
245
246
```yaml
@@ -254,7 +254,7 @@ comprehensive example using both.
254
#### Alarm line `module`
255
256
The `module` line filters which module within the context this alarm should apply to. The value is a space-separated
257
-list of [simple patterns](/libnetdata/simple_pattern/README.md). For
257
+list of [simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md). For
258
example, you can create an alarm that applies only on the `isc_dhcpd` module started by `python.d.plugin`:
259
260
```yaml
@@ -266,7 +266,7 @@ module: isc_dhcpd
266
267
The `charts` line filters which chart this alarm should apply to. It is only available on entities using the
268
[`template`](#alarm-line-alarm-or-template) line.
269
-The value is a space-separated list of [simple patterns](/libnetdata/simple_pattern/README.md). For
269
+The value is a space-separated list of [simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md). For
270
example, a template that applies to `disk.svctm` (Average Service Time) context, but excludes the disk `sdb` from alarms:
271
272
```yaml
@@ -280,7 +280,7 @@ template: disk_svctm_alarm
280
The `families` line, used only alongside templates, filters which families within the context this alarm should apply
281
to. The value is a space-separated list.
282
283
-The value is a space-separate list of simple patterns. See our [simple patterns docs](/libnetdata/simple_pattern/README.md) for
283
+The value is a space-separate list of simple patterns. See our [simple patterns docs](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) for
284
some examples.
285
286
For example, you can create a template on the `disk.io` context, but filter it to only the `sda` and `sdb` families:
@@ -299,7 +299,7 @@ The format is:
299
lookup: METHOD AFTER [at BEFORE] [every DURATION] [OPTIONS] [of DIMENSIONS] [foreach DIMENSIONS]
300
```
301
302
-Everything is the same with [badges](/web/api/badges/README.md). In short:
302
+Everything is the same with [badges](https://github.com/netdata/netdata/blob/master/web/api/badges/README.md). In short:
303
304
- `METHOD` is one of `average`, `min`, `max`, `sum`, `incremental-sum`.
305
This is required.
@@ -316,7 +316,7 @@ Everything is the same with [badges](/web/api/badges/README.md). In short:
316
above too).
317
318
- `OPTIONS` is a space separated list of `percentage`, `absolute`, `min2max`, `unaligned`,
319
- `match-ids`, `match-names`. Check the [badges](/web/api/badges/README.md) documentation for more info.
319
+ `match-ids`, `match-names`. Check the [badges](https://github.com/netdata/netdata/blob/master/web/api/badges/README.md) documentation for more info.
320
321
- `of DIMENSIONS` is optional and has to be the last parameter. Dimensions have to be separated
322
by `,` or `|`. The space characters found in dimensions will be kept as-is (a few dimensions
@@ -503,7 +503,7 @@ good idea to tell Netdata to not clear the notification, by using the `no-clear-
503
504
#### Alarm line `host labels`
505
506
-Defines the list of labels present on a host. See our [host labels guide](/docs/guides/using-host-labels.md) for
506
+Defines the list of labels present on a host. See our [host labels guide](https://github.com/netdata/netdata/blob/master/docs/guides/using-host-labels.md) for
507
an explanation of host labels and how to implement them.
508
509
For example, let's suppose that `netdata.conf` is configured with the following labels:
@@ -536,7 +536,7 @@ that will be applied to all hosts installed in the last decade with the followin
536
host labels: installed = 201*
537
```
538
539
-See our [simple patterns docs](/libnetdata/simple_pattern/README.md) for more examples.
539
+See our [simple patterns docs](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) for more examples.
540
541
#### Alarm line `info`
542
@@ -651,15 +651,15 @@ You can find all the variables that can be used for a given chart, using
651
Agent dashboard. For example, [variables for the `system.cpu` chart of the
652
registry](https://registry.my-netdata.io/api/v1/alarm_variables?chart=system.cpu).
653
654
-> If you don't know how to find the CHART_NAME, you can read about it [here](/web/README.md#charts).
654
+> If you don't know how to find the CHART_NAME, you can read about it [here](https://github.com/netdata/netdata/blob/master/web/README.md#charts).
655
656
Netdata supports 3 internal indexes for variables that will be used in health monitoring.
657
658
<details markdown="1"><summary>The variables below can be used in both chart alarms and context templates.</summary>
659
660
Although the `alarm_variables` link shows you variables for a particular chart, the same variables can also be used in
661
-templates for charts belonging to a given [context](/web/README.md#contexts). The reason is that all charts of a given
662
-context are essentially identical, with the only difference being the [family](/web/README.md#families) that
661
+templates for charts belonging to a given [context](https://github.com/netdata/netdata/blob/master/web/README.md#contexts). The reason is that all charts of a given
662
+context are essentially identical, with the only difference being the [family](https://github.com/netdata/netdata/blob/master/web/README.md#families) that
663
identifies a particular hardware or software instance. Charts and templates do not apply to specific families anyway,
664
unless if you explicitly limit an alarm with the [alarm line `families`](#alarm-line-families).
665
@@ -999,7 +999,7 @@ The `lookup` line will use the `anomaly_rate` dimension of the `anomaly_detectio
999
1000
## Troubleshooting
1001
1002
-You can compile Netdata with [debugging](/daemon/README.md#debugging) and then set in `netdata.conf`:
1002
+You can compile Netdata with [debugging](https://github.com/netdata/netdata/blob/master/daemon/README.md#debugging) and then set in `netdata.conf`:
1003
1004
```yaml
1005
[global]
@@ -1022,6 +1022,6 @@ expression.
1022
It's currently not possible to schedule notifications from within the alarm template. For those scenarios where you need
1023
to temporary disable notifications (for instance when running backups triggers a disk alert) you can disable or silence
1024
notifications are runtime. The health checks can be controlled at runtime via the [health management
1025
-api](/web/api/health/README.md).
1025
+api](https://github.com/netdata/netdata/blob/master/web/api/health/README.md).
1026
1027
health/notifications/custom/README.md
+2
-2
@@ -13,8 +13,8 @@ learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
13
Netdata allows you to send custom notifications to any endpoint you choose.
14
15
To configure custom notifications, you will need to customize `health_alarm_notify.conf`. Open the file for editing
16
-using [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config
17
-directory](/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
16
+using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config
17
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
18
19
You can look at the other senders in `/usr/libexec/netdata/plugins.d/alarm-notify.sh` for examples of how to modify the `custom_sender()` function in `health_alarm_notify.conf`.
20
health/notifications/gotify/README.md
+1
-1
@@ -25,7 +25,7 @@ You can generate a new token in the Gotify Web UI.
25
To set up Gotify in Netdata:
26
27
1. Switch to your [config
28
-directory](/docs/configure/nodes.md) and edit the file `health_alarm_notify.conf` using the edit config script.
28
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) and edit the file `health_alarm_notify.conf` using the edit config script.
29
30
```bash
31
./edit-config health_alarm_notify.conf
health/notifications/opsgenie/README.md
+5
-5
@@ -17,9 +17,9 @@ incidents.
17
18
The first step is to create a [Netdata integration](https://docs.opsgenie.com/docs/api-integration) in the
19
[Opsgenie](https://www.atlassian.com/software/opsgenie) dashboard. After this, you need to edit
20
-`health_alarm_notify.conf` on your system, by running the following from your [config
21
-directory](/docs/configure/nodes.md):
22
-
20
+`health_alarm_notify.conf` on your system, by running the following from
21
+your [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md):
22
+
23
```bash
24
./edit-config health_alarm_notify.conf
25
```
@@ -60,7 +60,7 @@ message:
60
2020-09-03 23:07:00: alarm-notify.sh: ERROR: failed to send opsgenie notification for: hades test.chart.test_alarm is CRITICAL, with HTTP error code 401.
61
```
62
63
-You can find more details about the Opsgenie error codes in their [response
64
-docs](https://docs.opsgenie.com/docs/response).
63
+You can find more details about the Opsgenie error codes in
64
+their [response docs](https://docs.opsgenie.com/docs/response).
65
66
health/notifications/pagerduty/README.md
+5
-5
@@ -18,7 +18,7 @@ resolution times.
18
19
## What you need to get started
20
21
-- An installation of the open-source [Netdata](/docs/get-started.mdx) monitoring agent.
21
+- An installation of the open-source [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) monitoring agent.
22
- An installation of the [PagerDuty agent](https://www.pagerduty.com/docs/guides/agent-install-guide/) on the node
23
running Netdata.
24
- A PagerDuty `Generic API` service using either the `Events API v2` or `Events API v1`.
@@ -29,8 +29,8 @@ resolution times.
29
to PagerDuty. Click **Use our API directly** and select either `Events API v2` or `Events API v1`. Once you finish
30
creating the service, click on the **Integrations** tab to find your **Integration Key**.
31
32
-Navigate to the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) and use
33
-[`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) to open
32
+Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) and use
33
+[`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) to open
34
`health_alarm_notify.conf`.
35
36
```bash
@@ -63,5 +63,5 @@ sudo su -s /bin/bash netdata
63
Aside from the three values set in `health_alarm_notify.conf`, there is no further configuration required to send alert
64
notifications to PagerDuty.
65
66
-To configure individual alarms, read our [alert configuration](/docs/monitor/configure-alarms.md) doc or
67
-the [health entity reference](/health/REFERENCE.md) doc.
66
+To configure individual alarms, read our [alert configuration](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) doc or
67
+the [health entity reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) doc.
health/notifications/stackpulse/README.md
+1
-1
@@ -44,7 +44,7 @@ STACKPULSE_WEBHOOK="https://hooks.stackpulse.io/v1/webhooks/YOUR_UNIQUE_ID"
44
```
45
46
4. Now restart Netdata using `sudo systemctl restart netdata`, or the [appropriate
47
- method](/docs/configure/start-stop-restart.md) for your system. When your node creates an alarm, you can see the
47
+ method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. When your node creates an alarm, you can see the
48
associated notification on your StackPulse Administration Portal
49
50
## React to alarms with playbooks
libnetdata/procfile/README.md
+1
-1
@@ -28,7 +28,7 @@ For each iteration, the caller:
28
- calls `procfile_readall()` to read updated contents.
29
This call also rewinds (`lseek()` to 0) before reading it.
30
31
- For every file, a [BUFFER](/libnetdata/buffer/README.md) is used that is automatically adjusted to fit the entire
31
+ For every file, a [BUFFER](https://github.com/netdata/netdata/blob/master/libnetdata/buffer/README.md) is used that is automatically adjusted to fit the entire
32
file contents of the file. So the file is read with a single `read()` call (providing atomicity / consistency when
33
the data are read from the kernel).
34
ml/README.md
+3
-3
@@ -114,7 +114,7 @@ To enable or disable anomaly detection:
114
2. In the `[ml]` section, set `enabled = yes` to enable or `enabled = no` to disable.
115
3. Restart netdata (typically `sudo systemctl restart netdata`).
116
117
-**Note**: If you would like to learn more about configuring Netdata please see [the configuration guide](https://learn.netdata.cloud/guides/step-by-step/step-04).
117
+**Note**: If you would like to learn more about configuring Netdata please see [the configuration guide](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-04.md).
118
119
Below is a list of all the available configuration params and their default values.
120
@@ -143,7 +143,7 @@ Below is a list of all the available configuration params and their default valu
143
144
If you would like to run ML on a parent instead of at the edge, some configuration options are illustrated below.
145
146
-This example assumes 3 child nodes [streaming](https://learn.netdata.cloud/docs/agent/streaming) to 1 parent node and illustrates the main ways you might want to configure running ML for the children on the parent, running ML on the children themselves, or even a mix of approaches.
146
+This example assumes 3 child nodes [streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) to 1 parent node and illustrates the main ways you might want to configure running ML for the children on the parent, running ML on the children themselves, or even a mix of approaches.
147
148
149
@@ -265,4 +265,4 @@ The anomaly rate across all dimensions of a node.
265
- Netdata uses [dlib](https://github.com/davisking/dlib) under the hood for its core ML features.
266
- You should benchmark Netdata resource usage before and after enabling ML. Typical overhead ranges from 1-2% additional CPU at most.
267
- The "anomaly bit" has been implemented to be a building block to underpin many more ML based use cases that we plan to deliver soon.
268
-- At its core Netdata uses an approach and problem formulation very similar to the Netdata python [anomalies collector](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin/anomalies), just implemented in a much much more efficient and scalable way in the agent in c++. So if you would like to learn more about the approach and are familiar with Python that is a useful resource to explore, as is the corresponding [deep dive tutorial](https://nbviewer.org/github/netdata/community/blob/main/netdata-agent-api/netdata-pandas/anomalies_collector_deepdive.ipynb) where the default model used is PCA instead of K-Means but the overall approach and formulation is similar.
268
+- At its core Netdata uses an approach and problem formulation very similar to the Netdata python [anomalies collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md), just implemented in a much much more efficient and scalable way in the agent in c++. So if you would like to learn more about the approach and are familiar with Python that is a useful resource to explore, as is the corresponding [deep dive tutorial](https://nbviewer.org/github/netdata/community/blob/main/netdata-agent-api/netdata-pandas/anomalies_collector_deepdive.ipynb) where the default model used is PCA instead of K-Means but the overall approach and formulation is similar.
packaging/PLATFORM_SUPPORT.md
+57
-55
@@ -39,7 +39,8 @@ The following table shows a general outline of the various support tiers and cat
39
| Previously Supported | Users asked to upgrade | None | None | Yes, but only already published versions | Best Effort |
40
41
- ‘Bug Support’: How we handle of platform-specific bugs.
42
-- ‘Guaranteed Configurations’: Which runtime configurations for the agent we try to guarantee will work with minimal effort from users.
42
+- ‘Guaranteed Configurations’: Which runtime configurations for the agent we try to guarantee will work with minimal
43
+ effort from users.
44
- ‘CI Coverage’: What level of coverage we provide for the platform in CI.
45
- ‘Native Packages’: Whether we provide native packages for the system package manager for the platform.
46
- ‘Static Build Support’: How well our static builds are expected to work on the platform.
@@ -50,31 +51,32 @@ The following table shows a general outline of the various support tiers and cat
51
52
Platforms in the core support tier are our top priority. They are covered rigorously in our CI, usually
53
include official binary packages, and any platform-specific bugs receive a high priority. From the perspective
53
-of our developers, platforms in the core support tier _must_ work, with almost no exceptions. Our [static
54
-builds](#static-builds) are expected to work on these platforms if available. Source-based installs are expected
54
+of our developers, platforms in the core support tier _must_ work, with almost no exceptions.
55
+Our [static builds](#static-builds) are expected to work on these platforms if available. Source-based installs are
56
+expected
57
to work on these platforms with minimal user effort.
58
57
-| Platform | Version | Official Native Packages | Notes |
58
-| -------- | ------- | ------------------------ | ----- |
59
-| Alpine Linux | 3.17 | No | The latest release of Alpine Linux is guaranteed to remain at **Core** tier due to usage for our Docker images |
60
-| Alma Linux | 9.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
61
-| Alma Linux | 8.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
62
-| CentOS | 7.x | x86\_64 | |
63
-| Docker | 19.03 or newer | x86\_64, i386, ARMv7, AArch64, POWER8+ | See our [Docker documentation](/packaging/docker/README.md) for more info on using Netdata on Docker |
64
-| Debian | 11.x | x86\_64, i386, ARMv7, AArch64 | |
65
-| Debian | 10.x | x86\_64, i386, ARMv7, AArch64 | |
66
-| Fedora | 37 | x86\_64, AArch64 | |
67
-| Fedora | 36 | x86\_64, AArch64 | |
68
-| openSUSE | Leap 15.4 | x86\_64, AArch64 | |
69
-| Oracle Linux | 9.x | x86\_64, AArch64 | |
70
-| Oracle Linux | 8.x | x86\_64, AArch64 | |
71
-| Red Hat Enterprise Linux | 9.x | x86\_64, AArch64 | |
72
-| Red Hat Enterprise Linux | 8.x | x86\_64, AArch64 | |
73
-| Red Hat Enterprise Linux | 7.x | x86\_64 | |
74
-| Ubuntu | 22.10 | x86\_64, ARMv7, AArch64 | |
75
-| Ubuntu | 22.04 | x86\_64, ARMv7, AArch64 | |
76
-| Ubuntu | 20.04 | x86\_64, ARMv7, AArch64 | |
77
-| Ubuntu | 18.04 | x86\_64, i386, ARMv7, AArch64 | |
59
+| Platform | Version | Official Native Packages | Notes |
60
+|--------------------------|----------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
61
+| Alpine Linux | 3.17 | No | The latest release of Alpine Linux is guaranteed to remain at **Core** tier due to usage for our Docker images |
62
+| Alma Linux | 9.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
63
+| Alma Linux | 8.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
64
+| CentOS | 7.x | x86\_64 | |
65
+| Docker | 19.03 or newer | x86\_64, i386, ARMv7, AArch64, POWER8+ | See our [Docker documentation](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md) for more info on using Netdata on Docker |
66
+| Debian | 11.x | x86\_64, i386, ARMv7, AArch64 | |
67
+| Debian | 10.x | x86\_64, i386, ARMv7, AArch64 | |
68
+| Fedora | 37 | x86\_64, AArch64 | |
69
+| Fedora | 36 | x86\_64, AArch64 | |
70
+| openSUSE | Leap 15.4 | x86\_64, AArch64 | |
71
+| Oracle Linux | 9.x | x86\_64, AArch64 | |
72
+| Oracle Linux | 8.x | x86\_64, AArch64 | |
73
+| Red Hat Enterprise Linux | 9.x | x86\_64, AArch64 | |
74
+| Red Hat Enterprise Linux | 8.x | x86\_64, AArch64 | |
75
+| Red Hat Enterprise Linux | 7.x | x86\_64 | |
76
+| Ubuntu | 22.10 | x86\_64, ARMv7, AArch64 | |
77
+| Ubuntu | 22.04 | x86\_64, ARMv7, AArch64 | |
78
+| Ubuntu | 20.04 | x86\_64, ARMv7, AArch64 | |
79
+| Ubuntu | 18.04 | x86\_64, i386, ARMv7, AArch64 | |
80
81
### Intermediate
82
@@ -85,13 +87,13 @@ platforms that we officially support ourselves to the intermediate tier. Our [st
87
expected to work on these platforms if available. Source-based installs are expected to work on these platforms
88
with minimal user effort.
89
88
-| Platform | Version | Official Native Packages | Notes |
89
-| -------- | ------- | ------------------------ | ----- |
90
-| Alpine Linux | 3.16 | No | |
91
-| Alpine Linux | 3.15 | No | |
92
-| Alpine Linux | 3.14 | No | |
93
-| Arch Linux | Latest | No | We officially recommend the community packages available for Arch Linux |
94
-| Manjaro Linux | Latest | No | We officially recommend the community packages available for Arch Linux |
90
+| Platform | Version | Official Native Packages | Notes |
91
+|---------------|---------|--------------------------|-------------------------------------------------------------------------|
92
+| Alpine Linux | 3.16 | No | |
93
+| Alpine Linux | 3.15 | No | |
94
+| Alpine Linux | 3.14 | No | |
95
+| Arch Linux | Latest | No | We officially recommend the community packages available for Arch Linux |
96
+| Manjaro Linux | Latest | No | We officially recommend the community packages available for Arch Linux |
97
98
### Community
99
@@ -101,19 +103,19 @@ to add support for a new platform, that platform generally will start in this ti
103
are expected to work on these platforms if available. Source-based installs are usually expected to work on these
104
platforms, but may require some extra effort from users.
105
104
-| Platform | Version | Official Native Packages | Notes |
105
-| -------- | ------- | ------------------------ | ----- |
106
-| Alpine Linux | Edge | No | |
107
-| Clear Linux | Latest | No | |
108
-| Debian | Sid | No | |
109
-| Fedora | Rawhide | No | |
110
-| FreeBSD | 13-STABLE | No | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
111
-| FreeBSD | 12-STABLE | No | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
112
-| Gentoo | Latest | No | |
113
-| macOS | 12 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies |
114
-| macOS | 11 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies. |
115
-| macOS | 10.15 | No | Requires Homebrew for dependencies. |
116
-| openSUSE | Tumbleweed | No | |
106
+| Platform | Version | Official Native Packages | Notes |
107
+|--------------|------------|--------------------------|-----------------------------------------------------------------------------------------------------------|
108
+| Alpine Linux | Edge | No | |
109
+| Clear Linux | Latest | No | |
110
+| Debian | Sid | No | |
111
+| Fedora | Rawhide | No | |
112
+| FreeBSD | 13-STABLE | No | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
113
+| FreeBSD | 12-STABLE | No | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
114
+| Gentoo | Latest | No | |
115
+| macOS | 12 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies |
116
+| macOS | 11 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies. |
117
+| macOS | 10.15 | No | Requires Homebrew for dependencies. |
118
+| openSUSE | Tumbleweed | No | |
119
120
## Third-party supported platforms
121
@@ -142,22 +144,22 @@ Platforms that meet these criteria will be immediately transitioned to the **Pre
144
with no prior warning from Netdata and no deprecation notice, unlike those being dropped for technical reasons,
145
as our end of support should already coincide with the end of the normal support lifecycle for that platform.
146
145
-On occasion, we may also drop support for a platform due to technical limitations. In such cases, this will be
147
+On occasion, we may also drop support for a platform due to technical limitations. In such cases, this will be
148
announced in the release notes of the next stable release with a deprecation notice. The platform will be supported
149
for _that release_, and will be removed from nightlies some time before the next release after that one.
150
151
This is a list of platforms that we have supported in the recent past but no longer officially support:
152
151
-| Platform | Version | Notes |
152
-| -------- | ------- | ----- |
153
-| Alpine Linux | 3.13 | EOL as of 2022-11-01 |
154
-| Alpine Linux | 3.12 | EOL as of 2022-05-01 |
155
-| Debian | 9.x | EOL as of 2022-06-30 |
156
-| Fedora | 35 | EOL as of 2022-12-13 |
157
-| Fedora | 34 | EOL as of 2022-06-07 |
158
-| openSUSE | Leap 15.3 | EOL as of 2022-12-01 |
159
-| Ubuntu | 21.10 | EOL as of 2022-07-31 |
160
-| Ubuntu | 21.04 | EOL as of 2022-01-01 |
153
+| Platform | Version | Notes |
154
+|--------------|-----------|----------------------|
155
+| Alpine Linux | 3.13 | EOL as of 2022-11-01 |
156
+| Alpine Linux | 3.12 | EOL as of 2022-05-01 |
157
+| Debian | 9.x | EOL as of 2022-06-30 |
158
+| Fedora | 35 | EOL as of 2022-12-13 |
159
+| Fedora | 34 | EOL as of 2022-06-07 |
160
+| openSUSE | Leap 15.3 | EOL as of 2022-12-01 |
161
+| Ubuntu | 21.10 | EOL as of 2022-07-31 |
162
+| Ubuntu | 21.04 | EOL as of 2022-01-01 |
163
164
## Static builds
165
packaging/docker/README.md
+5
-5
@@ -16,7 +16,7 @@ you get set up quickly, and doesn't install anything permanent on the system, wh
16
See our full list of Docker images at [Docker Hub](https://hub.docker.com/r/netdata/netdata).
17
18
Starting with v1.30, Netdata collects anonymous usage information by default and sends it to a self-hosted PostHog instance within the Netdata infrastructure. Read
19
-about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md)
19
+about the information collected, and learn how to-opt, on our [anonymous statistics](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md)
20
page.
21
22
The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for
@@ -176,7 +176,7 @@ to restart the container: `docker restart netdata`.
176
177
### Host-editable configuration
178
179
-> **Warning**: [edit-config](/docs/configure/nodes.md#the-netdata-config-directory) script doesn't work when executed on
179
+> **Warning**: [edit-config](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) script doesn't work when executed on
180
> the host system.
181
182
If you want to make your container's configuration directory accessible from the host system, you need to use a
@@ -322,7 +322,7 @@ your machine from within the container. Please read the following carefully.
322
#### Docker socket proxy (safest option)
323
324
Deploy a Docker socket proxy that accepts and filters out requests using something like
325
-[HAProxy](/docs/Running-behind-haproxy.md) so that it restricts connections to read-only access to the CONTAINERS
325
+[HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md) so that it restricts connections to read-only access to the CONTAINERS
326
endpoint.
327
328
The reason it's safer to expose the socket to the proxy is because Netdata has a TCP port exposed outside the Docker
@@ -441,13 +441,13 @@ services:
441
### Pass command line options to Netdata
442
443
Since we use an [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, you can provide
444
-[Netdata daemon command line options](/daemon/README.md#command-line-options) such as the IP address Netdata will be
444
+[Netdata daemon command line options](https://github.com/netdata/netdata/blob/master/daemon/README.md#command-line-options) such as the IP address Netdata will be
445
running on, using the [command instruction](https://docs.docker.com/engine/reference/builder/#cmd).
446
447
## Install the Agent using Docker Compose with SSL/TLS enabled HTTP Proxy
448
449
For a permanent installation on a public server, you should [secure the Netdata
450
-instance](/docs/netdata-security.md). This section contains an example of how to install Netdata with an SSL
450
+instance](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md). This section contains an example of how to install Netdata with an SSL
451
reverse proxy and basic authentication.
452
453
You can use the following `docker-compose.yml` and Caddyfile files to run Netdata with Docker. Replace the domains and
packaging/installer/README.md
+10
-10
@@ -24,7 +24,7 @@ packages. We recommend you install Netdata using one of the methods listed below
24
checksum-verified packages.
25
26
Netdata collects anonymous usage information by default and sends it to our self hosted [PostHog](https://github.com/PostHog/posthog) installation. PostHog is an open source product analytics platform, you can read
27
-about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md)
27
+about the information collected, and learn how to-opt, on our [anonymous statistics](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md)
28
page.
29
30
The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for
@@ -49,17 +49,17 @@ This script will preferentially use native DEB/RPM packages if we provide them f
49
50
To see more information about this installation script, including how to disable automatic updates, get nightly vs.
51
stable releases, or disable anonymous statistics, see the [`kickstart.sh` method
52
-page](/packaging/installer/methods/kickstart.md).
52
+page](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
53
54
Scroll down for details about [automatic updates](#automatic-updates) or [nightly vs. stable
55
releases](#nightly-vs-stable-releases).
56
57
### Post-installation
58
59
-When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
60
-[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
59
+When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
60
+[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
61
62
-Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
62
+Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
63
64
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
65
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
@@ -68,7 +68,7 @@ external databases, and more.
68
## Have a different operating system, or want to try another method?
69
70
Netdata works on many different platforms. To see all supported platforms, check out our [platform support
71
-policy](/packaging/PLATFORM_SUPPORT.md).
71
+policy](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md).
72
73
Below, you can find a few additional installation methods, followed by separate instructions for a variety of unique
74
operating systems.
@@ -123,7 +123,7 @@ wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/
123
```
124
125
With automatic updates disabled, you can choose exactly when and how you [update
126
-Netdata](/packaging/installer/UPDATE.md).
126
+Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md).
127
128
### Network usage of Netdata’s automatic updater
129
@@ -182,8 +182,8 @@ man-in-the-middle attacks.
182
### CentOS 6 and CentOS 8
183
184
To install the Agent on certain CentOS and RHEL systems, you must enable non-default repositories, such as EPEL or
185
-PowerTools, to gather hard dependencies. See the [CentOS 6](/packaging/installer/methods/manual.md#centos--rhel-6x) and
186
-[CentOS 8](/packaging/installer/methods/manual.md#centos--rhel-8x) sections for more information.
185
+PowerTools, to gather hard dependencies. See the [CentOS 6](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#centos--rhel-6x) and
186
+[CentOS 8](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#centos--rhel-8x) sections for more information.
187
188
### Access to file is not permitted
189
@@ -217,6 +217,6 @@ both.
217
218
Our current build process has some issues when using certain configurations of the `clang` C compiler on Linux. See [the
219
section on `nonrepresentable section on output`
220
-errors](/packaging/installer/methods/manual.md#nonrepresentable-section-on-output-errors) for a workaround.
220
+errors](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#nonrepresentable-section-on-output-errors) for a workaround.
221
222
packaging/installer/REINSTALL.md
+5
-5
@@ -18,11 +18,11 @@ Netdata Agent on your node.
18
### Reinstalling with the same install type
19
20
Run the one-line installer script with the `--reinstall` parameter to reinstall the Netdata Agent. This will preserve
21
-any [user configuration](/docs/configure/nodes.md) in `netdata.conf` or other files, and will keep the same install
21
+any [user configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) in `netdata.conf` or other files, and will keep the same install
22
type that was used for the original install.
23
24
If you used any [optional
25
-parameters](/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) during initial
25
+parameters](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) during initial
26
installation, you need to pass them to the script again during reinstallation. If you cannot remember which options you
27
used, read the contents of the `.environment` file and look for a `REINSTALL_OPTIONS` line. This line contains a list of
28
optional parameters.
@@ -39,7 +39,7 @@ getting a badly broken installation working again. Unlike the regular `--reinsta
39
different install type than the original install used.
40
41
If you used any [optional
42
-parameters](/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) during initial
42
+parameters](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) during initial
43
installation, you need to pass them to the script again during reinstallation. If you cannot remember which options you
44
used, read the contents of the `.environment` file and look for a `REINSTALL_OPTIONS` line. This line contains a list of
45
optional parameters.
@@ -69,8 +69,8 @@ When copying these directories back after the reinstall, you may need to update
69
## Troubleshooting
70
71
If you still experience problems with your Netdata Agent installation after following one of these processes, the next
72
-best route is to [uninstall](/packaging/installer/UNINSTALL.md) and then try a fresh installation using the [one-line
73
-installer](/packaging/installer/methods/kickstart.md).
72
+best route is to [uninstall](https://github.com/netdata/netdata/blob/master/packaging/installer/UNINSTALL.md) and then try a fresh installation using the [one-line
73
+installer](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
74
75
You can also post to our [community forums](https://community.netdata.cloud/c/support/13) or create a new [bug
76
report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
packaging/installer/UNINSTALL.md
+1
-1
@@ -12,7 +12,7 @@ learn_rel_path: "Installation"
12
13
> ⚠️ If you're having trouble updating Netdata, moving from one installation method to another, or generally having
14
> issues with your Netdata Agent installation, consider our [**reinstall Netdata**
15
-> doc](/packaging/installer/REINSTALL.md) instead of removing the Netdata Agent entirely.
15
+> doc](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md) instead of removing the Netdata Agent entirely.
16
17
The recommended method to uninstall Netdata on a system is to use our kickstart installer script with the `--uninstall` option like so:
18
packaging/installer/UPDATE.md
+5
-5
@@ -15,7 +15,7 @@ you installed. If you opted out of automatic updates, you need to update your Ne
15
or stable version. You can also [enable or disable automatic updates on an existing install](#control-automatic-updates).
16
17
> 💡 Looking to reinstall the Netdata Agent to enable a feature, update an Agent that cannot update automatically, or
18
-> troubleshoot an error during the installation process? See our [reinstallation doc](/packaging/installer/REINSTALL.md)
18
+> troubleshoot an error during the installation process? See our [reinstallation doc](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md)
19
> for reinstallation steps.
20
21
Before you update the Netdata Agent, check to see if your Netdata Agent is already up-to-date by clicking on the update
@@ -84,8 +84,8 @@ On such installs, you can update Netdata using your distribution package manager
84
### If the kickstart script does not work
85
86
If the above command fails, you can [reinstall
87
-Netdata](/packaging/installer/REINSTALL.md#one-line-installer-script-kickstartsh) to get the latest version. This
88
-also preserves your [configuration](/docs/configure/nodes.md) in `netdata.conf` or other files just like updating
87
+Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md#one-line-installer-script-kickstartsh) to get the latest version. This
88
+also preserves your [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) in `netdata.conf` or other files just like updating
89
normally would, though you will need to specify any installation options you used originally again.
90
91
## Docker
@@ -109,7 +109,7 @@ docker rm netdata
109
```
110
111
You can now re-create your Netdata container using the `docker` command or a `docker-compose.yml` file. See our [Docker
112
-installation instructions](/packaging/docker/README.md#create-a-new-netdata-agent-container) for details.
112
+installation instructions](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md#create-a-new-netdata-agent-container) for details.
113
114
## macOS
115
@@ -128,7 +128,7 @@ instructions](#updates-for-most-systems) to update Netdata.
128
129
## Manual installation from Git
130
131
-If you installed [Netdata manually from Git](/packaging/installer/methods/manual.md), you can run that installer again
131
+If you installed [Netdata manually from Git](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md), you can run that installer again
132
to update your agent. First, run our automatic requirements installer, which works on many Linux distributions, to
133
ensure your system has the dependencies necessary for new features.
134
packaging/installer/methods/cloud-providers.md
+6
-6
@@ -8,7 +8,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal
8
9
Netdata is fully compatible with popular cloud providers like Google Cloud Platform (GCP), Amazon Web Services (AWS),
10
Azure, and others. You can install Netdata on cloud instances to monitor the apps/services running there, or use
11
-multiple instances in a [parent-child streaming](/streaming/README.md) configuration.
11
+multiple instances in a [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) configuration.
12
13
In some cases, using Netdata on these cloud providers requires unique installation or configuration steps. This page
14
aims to document some of those steps for popular cloud providers.
@@ -53,11 +53,11 @@ command from a remote system, and it fails, it's likely that a firewall is block
53
Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
54
(80/443), which are likely already open on your instance. We have a number of guides available:
55
56
-- [Apache](/docs/Running-behind-apache.md)
57
-- [Nginx](/docs/Running-behind-nginx.md)
58
-- [Caddy](/docs/Running-behind-caddy.md)
59
-- [HAProxy](/docs/Running-behind-haproxy.md)
60
-- [lighttpd](/docs/Running-behind-lighttpd.md)
56
+- [Apache](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md)
57
+- [Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md)
58
+- [Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md)
59
+- [HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md)
60
+- [lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
61
62
The next few sections outline how to add firewall rules to GCP, AWS, and Azure instances.
63
packaging/installer/methods/freebsd.md
+1
-1
@@ -66,7 +66,7 @@ You can now access the Netdata dashboard by navigating to `http://NODE:19999`, r
66
67
Starting with v1.30, Netdata collects anonymous usage information by default and sends it to a self hosted PostHog instance within the Netdata infrastructure. To read
68
more about the information collected and how to opt-out, check the [anonymous statistics
69
-page](/docs/anonymous-statistics.md).
69
+page](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md).
70
71
## Updating the Agent on FreeBSD
72
If you have not passed the `--auto-update` or `-u` parameter for the installer to enable automatic updating, repeat the last step to update Netdata whenever a new version becomes available.
packaging/installer/methods/kickstart.md
+9
-9
@@ -18,8 +18,8 @@ This page covers detailed instructions on using and configuring the automatic on
18
19
The kickstart script works on all Linux distributions and macOS environments. By default, automatic nightly updates are enabled. If you are installing on macOS, make sure to check the [install documentation for macOS](macos.md) before continuing.
20
21
-> If you are unsure whether you want nightly or stable releases, read the [installation guide](/packaging/installer/README.md#nightly-vs-stable-releases).
22
-> If you want to turn off [automatic updates](/packaging/installer/README.md#automatic-updates), use the `--no-updates` option. You can find more installation options below.
21
+> If you are unsure whether you want nightly or stable releases, read the [installation guide](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#nightly-vs-stable-releases).
22
+> If you want to turn off [automatic updates](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#automatic-updates), use the `--no-updates` option. You can find more installation options below.
23
24
To install Netdata, run the following as your normal user:
25
@@ -79,7 +79,7 @@ The `kickstart.sh` script accepts a number of optional parameters to control how
79
- `--reinstall-clean`: Performs an uninstall of Netdata and clean installation.
80
- `--local-build-options`: Specify additional options to pass to the installer code when building locally. Only valid if `--build-only` is also specified.
81
- `--static-install-options`: Specify additional options to pass to the static installer code. Only valid if --static-only is also specified.
82
-- `--prepare-offline-install-source`: Instead of insallling the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
82
+- `--prepare-offline-install-source`: Instead of insallling the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md) for more info.
83
84
Additionally, the following environment variables may be used to further customize how the script runs (most users
85
should not need to use special values for any of these):
@@ -94,9 +94,9 @@ should not need to use special values for any of these):
94
95
### Connect node to Netdata Cloud during installation
96
97
-The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata Cloud immediately after installation.
97
+The `kickstart.sh` script accepts additional parameters to automatically [connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your node to Netdata Cloud immediately after installation.
98
99
-> Note: You either need to run the command with root privileges or run it with the user that is running the agent. More details: [Connect an agent without root privileges](/claim/README.md#connect-an-agent-without-root-privileges) section.
99
+> Note: You either need to run the command with root privileges or run it with the user that is running the agent. More details: [Connect an agent without root privileges](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-an-agent-without-root-privileges) section.
100
101
To automatically claim nodes after installation:
102
@@ -109,7 +109,7 @@ To automatically claim nodes after installation:
109
after the install.
110
- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
111
- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
112
- See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details.
112
+ See [connecting through a proxy](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-through-a-proxy) for details.
113
- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://api.netdata.cloud`.
114
115
For example:
@@ -163,10 +163,10 @@ If the script is valid, this command will return `OK, VALID`.
163
164
## What's next?
165
166
-When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
167
-[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
166
+When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
167
+[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
168
169
-Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
169
+Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
170
171
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
172
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
packaging/installer/methods/kubernetes.md
+5
-5
@@ -45,8 +45,8 @@ dashboards available in Netdata Cloud.
45
46
## Connect your Kubernetes cluster to Netdata Cloud
47
48
-To start [Kubernetes monitoring](https://learn.netdata.cloud/docs/cloud/visualize/kubernetes/), you must first
49
-[connect](/claim/README.md) your Kubernetes cluster to [Netdata Cloud](https://app.netdata.cloud). The connection process securely
48
+To start [Kubernetes monitoring](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md), you must first
49
+[connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your Kubernetes cluster to [Netdata Cloud](https://app.netdata.cloud). The connection process securely
50
connects your Kubernetes cluster to stream metrics data to Netdata Cloud, enabling Kubernetes-specific visualizations
51
like the health map and time-series composite charts.
52
@@ -184,17 +184,17 @@ helm upgrade netdata netdata/netdata
184
185
## What's next?
186
187
-[Start Kubernetes monitoring](https://learn.netdata.cloud/docs/cloud/visualize/kubernetes/) in Netdata Cloud, which
187
+[Start Kubernetes monitoring](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) in Netdata Cloud, which
188
comes with meaningful visualizations out of the box.
189
190
Read our guide, [_Kubernetes monitoring with Netdata: Overview and
191
-visualizations_](/docs/guides/monitor/kubernetes-k8s-netdata.md), for a complete walkthrough of Netdata's Kubernetes
191
+visualizations_](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/kubernetes-k8s-netdata.md), for a complete walkthrough of Netdata's Kubernetes
192
monitoring capabilities, including a health map of every container in your infrastructure, aggregated resource
193
utilization metrics, and application metrics.
194
195
### Related reference documentation
196
197
-- [Netdata Cloud · Kubernetes monitoring](https://learn.netdata.cloud/docs/cloud/visualize/kubernetes/)
197
+- [Netdata Cloud · Kubernetes monitoring](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)
198
- [Netdata Helm chart](https://github.com/netdata/helmchart)
199
- [Netdata service discovery](https://github.com/netdata/agent-service-discovery/)
200
packaging/installer/methods/macos.md
+12
-12
@@ -10,8 +10,8 @@ learn_rel_path: "Installation"
10
# Install Netdata on macOS
11
12
Netdata works on macOS, albeit with some limitations.
13
-The number of charts displaying system metrics is limited, but you can use any of Netdata's [external plugins](/collectors/plugins.d/README.md) to monitor any services you might have installed on your macOS system.
14
-You could also use a macOS system as the parent node in a [streaming configuration](/streaming/README.md).
13
+The number of charts displaying system metrics is limited, but you can use any of Netdata's [external plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md) to monitor any services you might have installed on your macOS system.
14
+You could also use a macOS system as the parent node in a [streaming configuration](https://github.com/netdata/netdata/blob/master/streaming/README.md).
15
16
You can install Netdata in one of the three following ways:
17
@@ -22,12 +22,12 @@ You can install Netdata in one of the three following ways:
22
Each of these installation option requires [Homebrew](https://brew.sh/) for handling dependencies.
23
24
> The Netdata Homebrew package is community-created and -maintained.
25
-> Community-maintained packages _may_ receive support from Netdata, but are only a best-effort affair. Learn more about [Netdata's platform support policy](/packaging/PLATFORM_SUPPORT.md).
25
+> Community-maintained packages _may_ receive support from Netdata, but are only a best-effort affair. Learn more about [Netdata's platform support policy](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md).
26
27
## Install Netdata with our automatic one-line installation script
28
29
**Local Netdata Agent installation**
30
-To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) open a new terminal and run:
30
+To install Netdata using our automatic [kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#automatic-one-line-installation-script) open a new terminal and run:
31
32
```bash
33
curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
@@ -38,16 +38,16 @@ The Netdata Agent is installed under `/usr/local/netdata`. Dependencies are hand
38
<!-- Potential reuse: https://learn.netdata.cloud/docs/agent/claim#connect-an-agent-running-in-macos-->
39
<!--Potential reuse https://learn.netdata.cloud/docs/agent/packaging/installer/methods/kickstart#connect-node-to-netdata-cloud-during-installation The following information is copied from this link.-->
40
41
-The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata
41
+The `kickstart.sh` script accepts additional parameters to automatically [connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your node to Netdata
42
Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
43
Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect Nodes** in the [Spaces management
44
-area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
44
+area](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx#manage-spaces).
45
46
- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
47
after the install.
48
- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
49
- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
50
- See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details.
50
+ See [connecting through a proxy](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-through-a-proxy) for details.
51
- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://api.netdata.cloud`.
52
53
For example:
@@ -56,7 +56,7 @@ curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/n
56
```
57
The Netdata Agent is installed under `/usr/local/netdata` on your machine. Your machine will also show up as a node in your Netdata Cloud.
58
59
-If you experience issues while claiming your node, follow the steps in our [Troubleshooting](/claim/README.md#troubleshooting) documentation.
59
+If you experience issues while claiming your node, follow the steps in our [Troubleshooting](https://github.com/netdata/netdata/blob/master/claim/README.md#troubleshooting) documentation.
60
## Install Netdata via Homebrew
61
62
To install Netdata and all its dependencies, run Homebrew using the following command:
@@ -81,7 +81,7 @@ We don't recommend installing Netdata from source on macOS, as it can be difficu
81
```
82
83
2. Click **Install** on the Software Update popup window that appears.
84
-3. Use the same terminal session to install some of Netdata's prerequisites using Homebrew. If you don't want to use [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/), you can omit `cmake`.
84
+3. Use the same terminal session to install some of Netdata's prerequisites using Homebrew. If you don't want to use [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can omit `cmake`.
85
86
```bash
87
brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake
@@ -106,10 +106,10 @@ We don't recommend installing Netdata from source on macOS, as it can be difficu
106
107
## What's next?
108
109
-When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
110
-[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
109
+When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
110
+[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
111
112
-Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
112
+Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
113
114
115
packaging/installer/methods/manual.md
+7
-7
@@ -202,7 +202,7 @@ cd netdata
202
- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
203
- `--stable-channel`: Automatically update only on the release of new major versions.
204
- `--nightly-channel`: Automatically update on every new nightly build.
205
-- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/anonymous-statistics.md) we use to make
205
+- `--disable-telemetry`: Opt-out of [anonymous statistics](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md) we use to make
206
Netdata better.
207
- `--no-updates`: Prevent automatic updates of any kind.
208
- `--reinstall`: If an existing install is detected, reinstall instead of trying to update it. Note that this
@@ -214,10 +214,10 @@ cd netdata
214
215
### Connect node to Netdata Cloud during installation
216
217
-Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md), the `netdata-installer.sh` script does
218
-not allow you to automatically [connect](/claim/README.md) your node to Netdata Cloud immediately after installation.
217
+Unlike the [`kickstart.sh`](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md), the `netdata-installer.sh` script does
218
+not allow you to automatically [connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your node to Netdata Cloud immediately after installation.
219
220
-See the [connect to cloud](/claim/README.md) doc for details on connecting a node with a manual installation of Netdata.
220
+See the [connect to cloud](https://github.com/netdata/netdata/blob/master/claim/README.md) doc for details on connecting a node with a manual installation of Netdata.
221
222
### 'nonrepresentable section on output' errors
223
@@ -229,10 +229,10 @@ In most cases, you can do this by running `CC=gcc ./netdata-installer.sh`.
229
230
## What's next?
231
232
-When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
233
-[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
232
+When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
233
+[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
234
235
-Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
235
+Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
236
237
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
238
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
packaging/installer/methods/offline.md
+4
-4
@@ -54,16 +54,16 @@ target system. This can be done in any manner you like, as long as filenames are
54
55
After copying the files, simply run the `install.sh` script located in the
56
offline install source directory. It accepts all the [same options as the kickstart
57
-script](/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) for further
57
+script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) for further
58
customization of the installation, though it will default to not enabling automatic updates (as they are not
59
supported on offline installs).
60
61
## What's next?
62
63
-When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
64
-[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
63
+When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
64
+[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
65
66
-Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
66
+Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
67
68
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
69
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
packaging/installer/methods/packages.md
+4
-3
@@ -11,9 +11,10 @@ learn_rel_path: "Installation"
11
# Installing Netdata using native DEB or RPM packages.
12
13
For most common Linux distributions that use either DEB or RPM packages, Netdata provides pre-built native packages
14
-for current releases in-line with our [official platform support policy](/packaging/PLATFORM_SUPPORT.md). These
15
-packages will be used by default when attempting to install on a supported platform using our [kickstart.sh
16
-installer script](/packaging/installer/methods/kickstart.md).
14
+for current releases in-line with
15
+our [official platform support policy](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md).
16
+These packages will be used by default when attempting to install on a supported platform using our
17
+[kickstart.sh installer script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
18
19
When using the kickstart script, you can force usage of native DEB or RPM packages by passing the option
20
`--native-only` when invoking the script. This will cause it to only attempt to use native packages for the install,
packaging/installer/methods/source.md
+1
-1
@@ -13,7 +13,7 @@ learn_rel_path: "Installation"
13
These instructions are for advanced users and distribution package
14
maintainers. Unless this describes you, you almost certainly want
15
to follow [our guide for manually installing Netdata from a git
16
-checkout](/packaging/installer/methods/manual.md) instead.
16
+checkout](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md) instead.
17
18
## Required dependencies
19
packaging/installer/methods/synology.md
+1
-1
@@ -26,7 +26,7 @@ installations run it as the `netdata` user, you might wish to do the same. This
26
2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign
27
the user to the `netdata` group. Netdata will chuid to this user when running.
28
3. Change ownership of the following directories, as defined in [Netdata
29
- Security](/docs/netdata-security.md#security-design):
29
+ Security](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md#security-design):
30
31
```sh
32
chown -R root:netdata /opt/netdata/usr/share/netdata
registry/README.md
+4
-4
@@ -71,8 +71,8 @@ in the Netdata registry regardless of whether you sign in or not.
71
72
## Who talks to the registry?
73
74
-Your web browser **only**! If sending this information is against your policies, you can [run your own
75
-registry](#run-your-own-registry)
74
+Your web browser **only**! If sending this information is against your policies, you
75
+can [run your own registry](#run-your-own-registry)
76
77
Your Netdata servers do not talk to the registry. This is a UML diagram of its operation:
78
@@ -137,7 +137,7 @@ Netdata v1.9+ support limiting access to the registry from given IPs, like this:
137
allow from = *
138
```
139
140
-`allow from` settings are [Netdata simple patterns](/libnetdata/simple_pattern/README.md): string matches that use `*`
140
+`allow from` settings are [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md): string matches that use `*`
141
as wildcard (any number of times) and a `!` prefix for a negative match. So: `allow from = !10.1.2.3 10.*` will allow
142
all IPs in `10.*` except `10.1.2.3`. The order is important: left to right, the first positive or negative match is
143
used.
@@ -184,7 +184,7 @@ Both files are machine readable text files.
184
185
Beginning with `v1.30.0`, when the Netdata Agent's web server processes a request, it delivers the `SameSite=none`
186
and `Secure` cookies. If you have problems accessing the local Agent dashboard or Netdata Cloud, disable these
187
-cookies by [editing `netdata.conf`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files):
187
+cookies by [editing `netdata.conf`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files):
188
189
```conf
190
[registry]
streaming/README.md
+7
-7
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/streaming/README
7
8
Each Netdata node is able to replicate/mirror its database to another Netdata node, by streaming the collected
9
metrics in real-time. This is quite different to [data archiving to third party time-series
10
-databases](/exporting/README.md).
10
+databases](https://github.com/netdata/netdata/blob/master/exporting/README.md).
11
The nodes that send metrics are called **child** nodes, and the nodes that receive metrics are called **parent** nodes.
12
13
There are also **proxy** nodes, which collect metrics from a child and sends it to a parent.
@@ -38,7 +38,7 @@ In a headless setup, the child acts as a plain data collector. It spawns all ext
38
local database and accepting dashboard requests, it streams all metrics to the parent.
39
40
This setup works great to reduce the memory footprint. Depending on the enabled plugins, memory usage is between 6 MiB and 40 MiB. To reduce the memory usage as much as
41
-possible, refer to the [performance optimization guide](/docs/guides/configure/performance.md).
41
+possible, refer to the [performance optimization guide](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md).
42
43
44
### Database Replication
@@ -107,7 +107,7 @@ This also disables the registry (there cannot be a registry without an API).
107
requests from its child nodes. 0 sets no limit, 1 means maximum once every second. If this is set, you may see error log
108
entries "... too busy to accept new streaming request. Will be allowed in X secs".
109
110
-You can [use](/exporting/README.md#configuration) the exporting engine to configure data archiving to an external database (it archives all databases maintained on
110
+You can [use](https://github.com/netdata/netdata/blob/master/exporting/README.md#configuration) the exporting engine to configure data archiving to an external database (it archives all databases maintained on
111
this host).
112
113
### Streaming configuration
@@ -198,7 +198,7 @@ You can also use `default memory mode = dbengine` for an API key or `memory mode
198
199
##### Allow from
200
201
-`allow from` settings are [Netdata simple patterns](/libnetdata/simple_pattern/README.md): string matches
201
+`allow from` settings are [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md): string matches
202
that use `*` as wildcard (any number of times) and a `!` prefix for a negative match.
203
So: `allow from = !10.1.2.3 10.*` will allow all IPs in `10.*` except `10.1.2.3`. The order is
204
important: left to right, the first positive or negative match is used.
@@ -233,7 +233,7 @@ For Netdata v1.9+, streaming can also be monitored via `access.log`.
233
### Securing streaming communications
234
235
Netdata does not activate TLS encryption by default. To encrypt streaming connections:
236
-1. On the parent node (receiving node), [enable TLS support](/web/server/README.md#enabling-tls-support).
236
+1. On the parent node (receiving node), [enable TLS support](https://github.com/netdata/netdata/blob/master/web/server/README.md#enabling-tls-support).
237
2. On the child's `stream.conf`, configure the destination as follows:
238
239
```
@@ -602,7 +602,7 @@ this writing, Netdata supports:
602
- json document DBs
603
- all the compatibles to the above (e.g. kairosdb, influxdb, etc)
604
605
-Check the Netdata [exporting documentation](/docs/export/external-databases.md) for configuring this.
605
+Check the Netdata [exporting documentation](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) for configuring this.
606
607
This is how such a solution will work:
608
@@ -696,7 +696,7 @@ ERROR : STREAM_SENDER[CHILD HOSTNAME] : STREAM child HOSTNAME [send to PARENT HO
696
Chart data needs to be consistent between child and parent nodes. If there are differences between chart data on
697
a parent and a child, such as gaps in metrics collection, it most often means your child's `memory mode`
698
does not match the parent's. To learn more about the different ways Netdata can store metrics, and thus keep chart
699
-data consistent, read our [memory mode documentation](/database/README.md).
699
+data consistent, read our [memory mode documentation](https://github.com/netdata/netdata/blob/master/database/README.md).
700
701
### Forbidding access
702
tests/health_mgmtapi/README.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgm
5
6
# Health command API tester
7
8
-The directory `tests/health_cmdapi` contains the test script `health-cmdapi-test.sh` for the [health command API](/web/api/health/README.md).
8
+The directory `tests/health_cmdapi` contains the test script `health-cmdapi-test.sh` for the [health command API](https://github.com/netdata/netdata/blob/master/web/api/health/README.md).
9
10
The script can be executed with options to prepare the system for the tests, run them and restore the system to its previous state.
11
web/README.md
+9
-9
@@ -14,17 +14,17 @@ team and the community, but you can also customize them yourself.
14
15
There are two primary ways to view Netdata's dashboards:
16
17
-1. The [local Agent dashboard](/web/gui/README.md) that comes pre-configured with every Netdata installation. You can
17
+1. The [local Agent dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md) that comes pre-configured with every Netdata installation. You can
18
see it at `http://NODE:19999`, replacing `NODE` with `localhost`, the hostname of your node, or its IP address. You
19
can customize the contents and colors of the standard dashboard [using
20
- JavaScript](/web/gui/README.md#customizing-the-local-dashboard).
20
+ JavaScript](https://github.com/netdata/netdata/blob/master/web/gui/README.md#customizing-the-local-dashboard).
21
22
2. The [`dashboard.js` JavaScript library](#dashboardjs), which helps you
23
- [customize the standard dashboards](/web/gui/README.md#customizing-the-local-dashboard)
24
- using JavaScript, or create entirely new [custom dashboards](/web/gui/custom/README.md) or
25
- [Atlassian Confluence dashboards](/web/gui/confluence/README.md).
23
+ [customize the standard dashboards](https://github.com/netdata/netdata/blob/master/web/gui/README.md#customizing-the-local-dashboard)
24
+ using JavaScript, or create entirely new [custom dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) or
25
+ [Atlassian Confluence dashboards](https://github.com/netdata/netdata/blob/master/web/gui/confluence/README.md).
26
27
-You can also view all the data Netdata collects through the [REST API v1](/web/api/README.md#netdata-rest-api).
27
+You can also view all the data Netdata collects through the [REST API v1](https://github.com/netdata/netdata/blob/master/web/api/README.md#netdata-rest-api).
28
29
No matter where you use Netdata's charts, you'll want to know how to [use](#using-charts) them. You'll also want to
30
understand how Netdata defines [charts](#charts), [dimensions](#dimensions), [families](#families), and
@@ -84,7 +84,7 @@ Netdata organizes metrics into charts, dimensions, families, and contexts.
84
85
A **chart** is an individual, interactive, always-updating graphic displaying
86
one or more collected/calculated metrics. Charts are generated by
87
-[collectors](/collectors/README.md).
87
+[collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md).
88
89
Here's the system CPU chart, the first chart displayed on the standard
90
dashboard:
@@ -182,7 +182,7 @@ hover over the date above the list of dimensions. A tooltip will appear that
182
shows you two pieces of information: the collector that produces the chart, and
183
the chart's context.
184
185
-Netdata also uses [contexts for alarm templates](/health/REFERENCE.md#alarm-line-on). You can create an alarm for the
185
+Netdata also uses [contexts for alarm templates](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-on). You can create an alarm for the
186
`net.packets` context to receive alerts for any chart with that context, no matter which family it's attached to.
187
188
## Positive and negative values on charts
@@ -215,7 +215,7 @@ all the charts and other visualizations that appear on any Netdata dashboard.
215
You need to put `dashboard.js` on any HTML page that's going to render Netdata
216
charts.
217
218
-The [custom dashboards documentation](/web/gui/custom/README.md) contains examples of such
218
+The [custom dashboards documentation](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) contains examples of such
219
custom HTML pages.
220
221
### Generating dashboard.js
web/api/badges/README.md
+1
-1
@@ -25,7 +25,7 @@ Similarly, there is [a chart that shows outbound bandwidth per class](http://lon
25
26
The right one is a **volume** calculation. Netdata calculated the total of the last 86.400 seconds (a day) which gives `kilobits`, then divided it by 8 to make it KB, then by 1024 to make it MB and then by 1024 to make it GB. Calculations like this are quite accurate, since for every value collected, every second, Netdata interpolates it to second boundary using microsecond calculations.
27
28
-Let's see a few more badge examples (they come from the [Netdata registry](/registry/README.md)):
28
+Let's see a few more badge examples (they come from the [Netdata registry](https://github.com/netdata/netdata/blob/master/registry/README.md)):
29
30
- **cpu usage of user `root`** (you can pick any user; 100% = 1 core). This will be `green <10%`, `yellow <20%`, `orange <50%`, `blue <100%` (1 core), `red` otherwise (you define thresholds and colors on the URL).
31
web/api/exporters/prometheus/README.md
+1
-1
@@ -5,6 +5,6 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporter
5
6
# Prometheus exporter
7
8
-Read the Prometheus exporter documentation: [Using Netdata with Prometheus](/exporting/prometheus/README.md).
8
+Read the Prometheus exporter documentation: [Using Netdata with Prometheus](https://github.com/netdata/netdata/blob/master/exporting/prometheus/README.md).
9
10
web/api/formatters/README.md
+12
-12
@@ -12,18 +12,18 @@ The following formats are supported:
12
13
| format|module|content type|description|
14
|:----:|:----:|:----------:|:----------|
15
-| `array`|[ssv](/web/api/formatters/ssv/README.md)|application/json|a JSON array|
16
-| `csv`|[csv](/web/api/formatters/csv/README.md)|text/plain|a text table, comma separated, with a header line (dimension names) and `\r\n` at the end of the lines|
17
-| `csvjsonarray`|[csv](/web/api/formatters/csv/README.md)|application/json|a JSON array, with each row as another array (the first row has the dimension names)|
18
-| `datasource`|[json](/web/api/formatters/json/README.md)|application/json|a Google Visualization Provider `datasource` javascript callback|
19
-| `datatable`|[json](/web/api/formatters/json/README.md)|application/json|a Google `datatable`|
20
-| `html`|[csv](/web/api/formatters/csv/README.md)|text/html|an html table|
21
-| `json`|[json](/web/api/formatters/json/README.md)|application/json|a JSON object|
22
-| `jsonp`|[json](/web/api/formatters/json/README.md)|application/json|a JSONP javascript callback|
23
-| `markdown`|[csv](/web/api/formatters/csv/README.md)|text/plain|a markdown table|
24
-| `ssv`|[ssv](/web/api/formatters/ssv/README.md)|text/plain|a space separated list of values|
25
-| `ssvcomma`|[ssv](/web/api/formatters/ssv/README.md)|text/plain|a comma separated list of values|
26
-| `tsv`|[csv](/web/api/formatters/csv/README.md)|text/plain|a TAB delimited `csv` (MS Excel flavor)|
15
+| `array`|[ssv](https://github.com/netdata/netdata/blob/master/web/api/formatters/ssv/README.md)|application/json|a JSON array|
16
+| `csv`|[csv](https://github.com/netdata/netdata/blob/master/web/api/formatters/csv/README.md)|text/plain|a text table, comma separated, with a header line (dimension names) and `\r\n` at the end of the lines|
17
+| `csvjsonarray`|[csv](https://github.com/netdata/netdata/blob/master/web/api/formatters/csv/README.md)|application/json|a JSON array, with each row as another array (the first row has the dimension names)|
18
+| `datasource`|[json](https://github.com/netdata/netdata/blob/master/web/api/formatters/json/README.md)|application/json|a Google Visualization Provider `datasource` javascript callback|
19
+| `datatable`|[json](https://github.com/netdata/netdata/blob/master/web/api/formatters/json/README.md)|application/json|a Google `datatable`|
20
+| `html`|[csv](https://github.com/netdata/netdata/blob/master/web/api/formatters/csv/README.md)|text/html|an html table|
21
+| `json`|[json](https://github.com/netdata/netdata/blob/master/web/api/formatters/json/README.md)|application/json|a JSON object|
22
+| `jsonp`|[json](https://github.com/netdata/netdata/blob/master/web/api/formatters/json/README.md)|application/json|a JSONP javascript callback|
23
+| `markdown`|[csv](https://github.com/netdata/netdata/blob/master/web/api/formatters/csv/README.md)|text/plain|a markdown table|
24
+| `ssv`|[ssv](https://github.com/netdata/netdata/blob/master/web/api/formatters/ssv/README.md)|text/plain|a space separated list of values|
25
+| `ssvcomma`|[ssv](https://github.com/netdata/netdata/blob/master/web/api/formatters/ssv/README.md)|text/plain|a comma separated list of values|
26
+| `tsv`|[csv](https://github.com/netdata/netdata/blob/master/web/api/formatters/csv/README.md)|text/plain|a TAB delimited `csv` (MS Excel flavor)|
27
28
For examples of each format, check the relative module documentation.
29
web/api/formatters/csv/README.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatte
5
6
# CSV formatter
7
8
-The CSV formatter presents [results of database queries](/web/api/queries/README.md) in the following formats:
8
+The CSV formatter presents [results of database queries](https://github.com/netdata/netdata/blob/master/web/api/queries/README.md) in the following formats:
9
10
| format|content type|description|
11
| :----:|:----------:|:----------|
web/api/formatters/json/README.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatte
5
6
# JSON formatter
7
8
-The CSV formatter presents [results of database queries](/web/api/queries/README.md) in the following formats:
8
+The CSV formatter presents [results of database queries](https://github.com/netdata/netdata/blob/master/web/api/queries/README.md) in the following formats:
9
10
| format | content type | description|
11
|:----:|:----------:|:----------|
web/api/formatters/ssv/README.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatte
5
6
# SSV formatter
7
8
-The SSV formatter sums all dimensions in [results of database queries](/web/api/queries/README.md)
8
+The SSV formatter sums all dimensions in [results of database queries](https://github.com/netdata/netdata/blob/master/web/api/queries/README.md)
9
to a single value and returns a list of such values showing how it changes through time.
10
11
It supports the following formats:
web/api/formatters/value/README.md
+3
-3
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatte
5
6
# Value formatter
7
8
-The Value formatter presents [results of database queries](/web/api/queries/README.md) as a single value.
8
+The Value formatter presents [results of database queries](https://github.com/netdata/netdata/blob/master/web/api/queries/README.md) as a single value.
9
10
To calculate the single value to be returned, it sums the values of all dimensions.
11
@@ -18,7 +18,7 @@ The Value formatter respects the following API `&options=`:
18
| `min2max` | yes | to return the delta from the minimum value to the maximum value (across dimensions)|
19
20
The Value formatter is not exposed by the API by itself.
21
-Instead it is used by the [`ssv`](/web/api/formatters/ssv/README.md) formatter
22
-and [health monitoring queries](/health/README.md).
21
+Instead it is used by the [`ssv`](https://github.com/netdata/netdata/blob/master/web/api/formatters/ssv/README.md) formatter
22
+and [health monitoring queries](https://github.com/netdata/netdata/blob/master/health/README.md).
23
24
web/api/health/README.md
+3
-3
@@ -72,7 +72,7 @@ You can access the API via GET requests, by adding the bearer token to an `Autho
72
curl "http://NODE:19999/api/v1/manage/health?cmd=RESET" -H "X-Auth-Token: Mytoken"
73
```
74
75
-By default access to the health management API is only allowed from `localhost`. Accessing the API from anything else will return a 403 error with the message `You are not allowed to access this resource.`. You can change permissions by editing the `allow management from` variable in `netdata.conf` within the [web] section. See [web server access lists](/web/server/README.md#access-lists) for more information.
75
+By default access to the health management API is only allowed from `localhost`. Accessing the API from anything else will return a 403 error with the message `You are not allowed to access this resource.`. You can change permissions by editing the `allow management from` variable in `netdata.conf` within the [web] section. See [web server access lists](https://github.com/netdata/netdata/blob/master/web/server/README.md#access-lists) for more information.
76
77
The command `RESET` just returns Netdata to the default operation, with all health checks and notifications enabled.
78
If you've configured and entered your token correctly, you should see the plain text response `All health checks and notifications are enabled`.
@@ -126,7 +126,7 @@ curl "http://NODE:19999/api/v1/manage/health?cmd=SILENCE&context=load" -H "X-Aut
126
127
#### Selection criteria
128
129
-The `selection criteria` are key/value pairs, in the format `key : value`, where value is a Netdata [simple pattern](/libnetdata/simple_pattern/README.md). This means that you can create very powerful selectors (you will rarely need more than one or two).
129
+The `selection criteria` are key/value pairs, in the format `key : value`, where value is a Netdata [simple pattern](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md). This means that you can create very powerful selectors (you will rarely need more than one or two).
130
131
The accepted keys for the `selection criteria` are the following:
132
@@ -220,6 +220,6 @@ The file's location is configurable in `netdata.conf`. The default is shown belo
220
221
### Further reading
222
223
-The test script under [tests/health_mgmtapi](/tests/health_mgmtapi/README.md) contains a series of tests that you can either run or read through to understand the various calls and responses better.
223
+The test script under [tests/health_mgmtapi](https://github.com/netdata/netdata/blob/master/tests/health_mgmtapi/README.md) contains a series of tests that you can either run or read through to understand the various calls and responses better.
224
225
web/api/queries/README.md
+1
-1
@@ -88,7 +88,7 @@ To disable alignment, pass `&options=unaligned` to the query.
88
89
To execute the query, the engine evaluates all dimensions of the chart, one after another.
90
91
-The engine does not evaluate dimensions that do not match the [simple pattern](/libnetdata/simple_pattern/README.md)
91
+The engine does not evaluate dimensions that do not match the [simple pattern](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md)
92
given at the `dimensions` parameter, except when `options=percentage` is given (this option
93
requires all the dimensions to be evaluated to find the percentage of each dimension vs to chart
94
total).
web/gui/README.md
+11
-11
@@ -13,16 +13,16 @@ before:
13
action](https://user-images.githubusercontent.com/1153921/101513938-fae28380-3939-11eb-9434-8ad86a39be62.gif)
14
15
Learn more about how dashboards work and how they're populated using the `dashboards.js` file in our [web dashboards
16
-overview](/web/README.md).
16
+overview](https://github.com/netdata/netdata/blob/master/web/README.md).
17
18
By default, Netdata starts a web server for its dashboard at port `19999`. Open up your web browser of choice and
19
navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If you're unsure, try
20
`http://localhost:19999` first.
21
22
-Netdata uses an [internal, static-threaded web server](/web/server/README.md) to host the HTML, CSS, and JavaScript
22
+Netdata uses an [internal, static-threaded web server](https://github.com/netdata/netdata/blob/master/web/server/README.md) to host the HTML, CSS, and JavaScript
23
files that make up the local Agent dashboard. You don't have to configure anything to access it, although you can adjust
24
-[your settings](/web/server/README.md#other-netdataconf-web-section-options) in the `netdata.conf` file, or run Netdata
25
-behind an [Nginx proxy](https://learn.netdata.cloud/docs/agent/running-behind-nginx), and so on.
24
+[your settings](https://github.com/netdata/netdata/blob/master/web/server/README.md#other-netdataconf-web-section-options) in the `netdata.conf` file, or run Netdata
25
+behind an [Nginx proxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md), and so on.
26
27
## Navigating the local dashboard
28
@@ -40,8 +40,8 @@ dashboard](https://user-images.githubusercontent.com/1153921/101509403-f7e59400-
40
41
Netdata is broken up into multiple **sections**, such as **System Overview**,
42
**CPU**, **Disk**, and more. Inside each section you'll find a number of charts,
43
-broken down into [contexts](/web/README.md#contexts) and
44
-[families](/web/README.md#families).
43
+broken down into [contexts](https://github.com/netdata/netdata/blob/master/web/README.md#contexts) and
44
+[families](https://github.com/netdata/netdata/blob/master/web/README.md#families).
45
46
An example of the **Memory** section on a Linux desktop system.
47
@@ -69,7 +69,7 @@ Use the calendar to select multiple days. Click on a date to begin the timeframe
69
70
Click **Apply** to re-render all visualizations with new metrics data, or **Clear** to restore the default timeframe.
71
72
-[Increase the metrics retention policy](/docs/store/change-metrics-storage.md) for your node to see more historical
72
+[Increase the metrics retention policy](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) for your node to see more historical
73
timeframes.
74
75
### Metrics menus
@@ -80,7 +80,7 @@ section, and menus link to the section they're associated with.
80
81
82
Most metrics menu items will contain several **submenu** entries, which represent any
83
-[families](/web/README.md#families) from that section. Netdata automatically
83
+[families](https://github.com/netdata/netdata/blob/master/web/README.md#families) from that section. Netdata automatically
84
generates these submenu entries.
85
86
Here's a **Disks** menu with several submenu entries for each disk drive and
@@ -100,7 +100,7 @@ a War Room's name to jump to the Netdata Cloud web interface.
100
menus](https://user-images.githubusercontent.com/1153921/80837210-3f8b8c80-8bab-11ea-9c75-128c2d823ef8.png)
101
102
If you want to know more about how Cloud populates this menu, and the Agent-Cloud integration at a high level, see our
103
-document on [using the Agent with Netdata Cloud](/docs/agent-cloud.md).
103
+document on [using the Agent with Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/agent-cloud.md).
104
105
## Customizing the local dashboard
106
@@ -163,5 +163,5 @@ file](https://user-images.githubusercontent.com/1153921/62798924-570e6c80-ba94-1
163
164
## Custom dashboards
165
166
-For information on creating custom dashboards from scratch, see the [custom dashboards](/web/gui/custom/README.md) or
167
-[Atlassian Confluence dashboards](/web/gui/confluence/README.md) guides.
166
+For information on creating custom dashboards from scratch, see the [custom dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) or
167
+[Atlassian Confluence dashboards](https://github.com/netdata/netdata/blob/master/web/gui/confluence/README.md) guides.
web/gui/confluence/README.md
+1
-1
@@ -85,7 +85,7 @@ This badge is now auto-refreshing. It will update itself based on the update fre
85
86
> Keep in mind you can add badges with custom Netdata queries too. Netdata automatically creates badges for all the
87
> alarms, but every chart, every dimension on every chart, can be used for a badge. And Netdata badges are quite
88
-> powerful! Check [Creating Badges](/web/api/badges/README.md) for more information on badges.
88
+> powerful! Check [Creating Badges](https://github.com/netdata/netdata/blob/master/web/api/badges/README.md) for more information on badges.
89
90
So, let's create a table and add this badge for both our web servers:
91
web/gui/custom/README.md
+3
-3
@@ -245,7 +245,7 @@ Each chart can get data from a different Netdata server. You can specify the Net
245
></div>
246
```
247
248
-If you have ephemeral monitoring setup ([More info here](/streaming/README.md#monitoring-ephemeral-nodes)) and have no
248
+If you have ephemeral monitoring setup ([More info here](https://github.com/netdata/netdata/blob/master/streaming/README.md#monitoring-ephemeral-nodes)) and have no
249
direct access to the nodes dashboards, you can use the following:
250
251
```html
@@ -369,7 +369,7 @@ select specific dimensions using this:
369
```
370
371
Netdata supports coma (`,`) or pipe (`|`) separated [simple
372
-patterns](/libnetdata/simple_pattern/README.md) for dimensions. By default it
372
+patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) for dimensions. By default it
373
searches for both dimension IDs and dimension NAMEs. You can control the target
374
of the match with: `data-append-options="match-ids"` or
375
`data-append-options="match-names"`. Spaces in `data-dimensions=""` are matched
@@ -437,7 +437,7 @@ it, using this:
437
438
### API options
439
440
-You can append Netdata **[REST API v1](/web/api/README.md)** data options, using this:
440
+You can append Netdata **[REST API v1](https://github.com/netdata/netdata/blob/master/web/api/README.md)** data options, using this:
441
442
```html
443
<div data-netdata="unique.id"
web/server/README.md
+7
-7
@@ -51,7 +51,7 @@ Using the above, Netdata will bind to:
51
- IPv4 127.0.0.1 at port 19999 (port was used from `default port`). Only the UI (dashboard) and the read API will be accessible on this port. Both HTTP and HTTPS requests will be accepted.
52
- IPv4 10.1.1.1 at port 19998. The management API and `netdata.conf` will be accessible on this port.
53
- All the IPs `hostname` resolves to (both IPv4 and IPv6 depending on the resolved IPs) at port 19997. Only badges will be accessible on this port.
54
-- All IPv6 IPs at port 19996. Only metric streaming requests from other Netdata agents will be accepted on this port. Only encrypted streams will be allowed (i.e. child nodes also need to be [configured for TLS](/streaming/README.md).
54
+- All IPv6 IPs at port 19996. Only metric streaming requests from other Netdata agents will be accepted on this port. Only encrypted streams will be allowed (i.e. child nodes also need to be [configured for TLS](https://github.com/netdata/netdata/blob/master/streaming/README.md).
55
- All the IPs `localhost` resolves to (both IPv4 and IPv6 depending the resolved IPs) at port 19996. This port will only accept registry API requests.
56
- All IPv4 and IPv6 IPs at port `http` as set in `/etc/services`. Only the UI (dashboard) and the read API will be accessible on this port.
57
- Unix domain socket `/run/netdata/netdata.sock`. All requests are serviceable on this socket. Note that in some OSs like Fedora, every service sees a different `/tmp`, so don't create a Unix socket under `/tmp`. `/run` or `/var/run` is suggested.
@@ -140,7 +140,7 @@ Example:
140
bind to = *=dashboard|registry|badges|management|streaming|netdata.conf^SSL=force
141
```
142
143
-For information how to configure the child to use TLS, check [securing the communication](/streaming/README.md#securing-streaming-communications) in the streaming documentation. There you will find additional details on the expected behavior for client and server nodes, when their respective TLS options are enabled.
143
+For information how to configure the child to use TLS, check [securing the communication](https://github.com/netdata/netdata/blob/master/streaming/README.md#securing-streaming-communications) in the streaming documentation. There you will find additional details on the expected behavior for client and server nodes, when their respective TLS options are enabled.
144
145
When we define the use of SSL in a Netdata agent for different ports, Netdata will apply the behavior specified on each port. For example, using the configuration line below:
146
@@ -196,7 +196,7 @@ Netdata supports access lists in `netdata.conf`:
196
- `allow netdata.conf from` checks the IP to allow `http://netdata.host:19999/netdata.conf`.
197
The IPs listed are all the private IPv4 addresses, including link local IPv6 addresses. Keep in mind that connections to Netdata API ports are filtered by `allow connections from`. So, IPs allowed by `allow netdata.conf from` should also be allowed by `allow connections from`.
198
199
-- `allow management from` checks the IPs to allow API management calls. Management via the API is currently supported for [health](/web/api/health/README.md#health-management-api)
199
+- `allow management from` checks the IPs to allow API management calls. Management via the API is currently supported for [health](https://github.com/netdata/netdata/blob/master/web/api/health/README.md#health-management-api)
200
201
In order to check the FQDN of the connection without opening the Netdata agent to DNS-spoofing, a reverse-dns record
202
must be setup for the connecting host. At connection time the reverse-dns of the peer IP address is resolved, and
@@ -222,13 +222,13 @@ present that may match DNS FQDNs.
222
223
|setting|default|info|
224
|:-----:|:-----:|:---|
225
-|ses max window|`15`|See [single exponential smoothing](/web/api/queries/des/README.md)|
226
-|des max window|`15`|See [double exponential smoothing](/web/api/queries/des/README.md)|
225
+|ses max window|`15`|See [single exponential smoothing](https://github.com/netdata/netdata/blob/master/web/api/queries/des/README.md)|
226
+|des max window|`15`|See [double exponential smoothing](https://github.com/netdata/netdata/blob/master/web/api/queries/des/README.md)|
227
|listen backlog|`4096`|The port backlog. Check `man 2 listen`.|
228
|disconnect idle clients after seconds|`60`|The time in seconds to disconnect web clients after being totally idle.|
229
|timeout for first request|`60`|How long to wait for a client to send a request before closing the socket. Prevents slow request attacks.|
230
-|accept a streaming request every seconds|`0`|Can be used to set a limit on how often a parent node will accept streaming requests from child nodes in a [streaming and replication setup](/streaming/README.md)|
231
-|respect do not track policy|`no`|If set to `yes`, Netdata will respect the user's browser preferences for [Do Not Track](https://www.eff.org/issues/do-not-track) (DNT) and storing cookies. If DNT is _enabled_ in the browser, and this option is set to `yes`, users will not be able to sign in to Netdata Cloud via their local Agent dashboard, and their node will not connect to any [registry](/registry/README.md). For certain browsers, users must disable DNT and change this option to `yes` for full functionality.|
230
+|accept a streaming request every seconds|`0`|Can be used to set a limit on how often a parent node will accept streaming requests from child nodes in a [streaming and replication setup](https://github.com/netdata/netdata/blob/master/streaming/README.md)|
231
+|respect do not track policy|`no`|If set to `yes`, Netdata will respect the user's browser preferences for [Do Not Track](https://www.eff.org/issues/do-not-track) (DNT) and storing cookies. If DNT is _enabled_ in the browser, and this option is set to `yes`, users will not be able to sign in to Netdata Cloud via their local Agent dashboard, and their node will not connect to any [registry](https://github.com/netdata/netdata/blob/master/registry/README.md). For certain browsers, users must disable DNT and change this option to `yes` for full functionality.|
232
|x-frame-options response header||[Avoid clickjacking attacks, by ensuring that the content is not embedded into other sites](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options).|
233
|enable gzip compression|`yes`|When set to `yes`, Netdata web responses will be GZIP compressed, if the web client accepts such responses.|
234
|gzip compression strategy|`default`|Valid strategies are `default`, `filtered`, `huffman only`, `rle` and `fixed`|