Fix broken links in markdown files (#14513)
* fix broken links in claim/README.md * delete broken link in docs/guidelines.md * fix broken links * fix broken link * fix broken links * fix broken links * fix broken links * fix broken links * fix broken links * remove broken link * fix broken link * fix broken links * fix broken links * fix broken links * fix broken link * fix linking phrasing * fix broken links batch * fix broken links second batch * fix broken links * fix broken links * fix broken links * Update COLLECTORS.md * fix broken links * fix broken links
Fotis Voutsas committed
Feb 14, 2023 at 17:41 UTC
32baa46cb12a157440a325ec72498f2327b4ef45
46 files changed
+89
-128
claim/README.md
+5
-7
@@ -14,9 +14,7 @@ You can securely connect a Netdata Agent, running on a distributed node, to Netd
14
administrator creates a **claiming token**, which is used to add an Agent to their Space via the [Agent-Cloud link
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://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) guide for a walkthrough of the process and simplified
19
-instructions.
17
+Are you just getting started with Netdata Cloud? You can find simplified instructions in the [Install Netdata documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#get-started)
18
19
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.
20
@@ -32,7 +30,7 @@ identity of the Netdata Agent when it connects to the Cloud. While the data does
30
from Agents to the browser, we do not store or log it.
31
32
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://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx#manage-spaces).
33
+Nodes** in the [Spaces management area](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md#manage-spaces).
34
35
There are two important notes regarding connecting nodes:
36
@@ -373,7 +371,7 @@ If you run the kickstart script and get the following error `Existing install ap
371
372
If you are using an unsupported package, such as a third-party `.deb`/`.rpm` package provided by your distribution,
373
please remove that package and reinstall using our [recommended kickstart
376
-script](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx#install-on-linux-with-one-line-installer).
374
+script](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer).
375
376
#### kickstart: Failed to write new machine GUID
377
@@ -393,7 +391,7 @@ if you installed Netdata to `/opt/netdata`, use `/opt/netdata/bin/netdata-claim.
391
392
If you are using an unsupported package, such as a third-party `.deb`/`.rpm` package provided by your distribution,
393
please remove that package and reinstall using our [recommended kickstart
396
-script](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx#install-on-linux-with-one-line-installer).
394
+script](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer).
395
396
#### Connecting on older distributions (Ubuntu 14.04, Debian 8, CentOS 6)
397
@@ -510,7 +508,7 @@ tool, and details about the files found in `cloud.d`.
508
509
### The `cloud.conf` file
510
513
-This section defines how and whether your Agent connects to [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx)
511
+This section defines how and whether your Agent connects to Netdata Cloud
512
using the [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md).
513
514
| setting | default | info |
collectors/COLLECTORS.md
+3
-3
@@ -14,16 +14,16 @@ real-time, interactive charts. The following list includes collectors for both e
14
internal system metrics.
15
16
Learn more
17
-about [how collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md), and
17
+about [how collectors work](https://github.com/netdata/netdata/blob/master/collectors/README.md), and
18
then learn how to [enable or
19
-configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) any of the below collectors using the same process.
19
+configure](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module) any of the below collectors using the same process.
20
21
Some collectors have both Go and Python versions as we continue our effort to migrate all collectors to Go. In these
22
cases, _Netdata always prioritizes the Go version_, and we highly recommend you use the Go versions for the best
23
experience.
24
25
If you want to use a Python version of a collector, you need to
26
-explicitly [disable the Go version](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md),
26
+explicitly [disable the Go version](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module),
27
and enable the Python version. Netdata then skips the Go version and attempts to load the Python version and its
28
accompanying configuration file.
29
docs/cloud/alerts-notifications/manage-notification-methods.md
+3
-3
@@ -62,13 +62,13 @@ To manage user specific notification settings, you will need the following:
62
- A Cloud account
63
- Have access to, at least, a space
64
65
-Note: If an administrator has disabled a Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-level) notification method this will override any user specific setting.
65
+Note: If an administrator has disabled a Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx#service-level) notification method this will override any user specific setting.
66
67
#### Steps
68
69
1. Click on the **User notification settings** shortcut on top of the help button
70
1. You are presented with:
71
- - The Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-level) notification methods you can manage
71
+ - The Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx#service-level) notification methods you can manage
72
- The list spaces and rooms inside those where you have access to
73
- If you're an administrator, Manager or Troubleshooter you'll also see the Rooms from a space you don't have access to on **All Rooms** tab and you can activate notifications for them by joining the room
74
1. On this modal you will be able to:
@@ -83,6 +83,6 @@ Note: If an administrator has disabled a Personal [service level](https://github
83
- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
84
- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
85
- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
86
-- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md)
86
+- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification.md)
87
- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
88
- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
docs/cloud/alerts-notifications/notifications.mdx
+3
-3
@@ -20,7 +20,7 @@ Having this information centralized helps you:
20
* Have a clear view of the health across your infrastructure, [seeing all a alerts in one place](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx)
21
* Easily [setup your alert notification process](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md):
22
methods to use and where to use them, filtering rules, etc.
23
-* Quickly troubleshoot using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metrics-correlations.md)
23
+* Quickly troubleshoot using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
24
or [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx)
25
26
If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending
@@ -143,13 +143,13 @@ visualization of the health of your infrastructure.
143
144
#### **Related Concepts**
145
- [Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
146
-- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metrics-correlations.md)
146
+- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
147
- [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx)
148
149
#### Related Tasks
150
- [View Active alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx)
151
- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
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)
153
+- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification.md)
154
- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
155
- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
docs/cloud/insights/events-feed.md
+1
-1
@@ -47,7 +47,7 @@ At a high-level view, these are the domains from which the Events feed will prov
47
48
## Who can access the events?
49
50
-All users will be able to see events from the Topology and Alerts domain but Auditing events, once these are added, only be accessible to administrators. For more details checkout [Netdata Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md).
50
+All users will be able to see events from the Topology and Alerts domain but Auditing events, once these are added, only be accessible to administrators. For more details checkout [Netdata Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md).
51
52
## How to use the events feed
53
docs/cloud/manage/plans.md
+3
-3
@@ -76,7 +76,7 @@ Depending on the plan associated to your space you will have different roles ava
76
| **Observers**<p>This role is for read-only access with restricted access to explicit War Rooms and only the Nodes that appear in those War Rooms.</p>💡 Ideal for restricting your customer's access to their own dedicated rooms.<p></p> | - | - | :heavy_check_mark: |
77
| **Billing**<p>This role is for users that need to manage billing options and see invoices, with no further access to the system.</p> | - | - | :heavy_check_mark: |
78
79
-For more details check the documentation under [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md).
79
+For more details check the documentation under [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md).
80
81
##### Events feed
82
@@ -104,8 +104,8 @@ For mode details check the documentation under [Alert Notifications](https://git
104
#### **Related Concepts**
105
- [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
106
- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
107
-- [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/events-feed.md)
108
-- [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md)
107
+- [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md)
108
+- [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md)
109
110
111
#### Related Tasks
docs/cloud/manage/sign-in.mdx
+2
-2
@@ -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](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
38
+quickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
39
40
### Troubleshooting
41
@@ -85,4 +85,4 @@ It is not currently possible to link an account created with `user@example.com`
85
## What's next?
86
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).
88
+the [Get Started section of our documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
docs/cloud/visualize/nodes.md
+1
-1
@@ -39,7 +39,7 @@ 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](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
42
+need to configure those nodes to collect from additional data sources. See our [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.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
docs/collect/application-metrics.md
+2
-3
@@ -51,11 +51,10 @@ application metrics collectors, including those for containers/k8s clusters.
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](https://github.com/netdata/netdata/blob/master/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/packaging/installer/README.md) 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](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
57
+Once you have Netdata running on that separate system, you can follow the [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) documentation to tell the collector to look for exposed metrics on the Windows system's IP
58
address or hostname, plus the applicable port.
59
60
For example, you have a MySQL database with a root password of `my-secret-pw` running on a Windows system with the IP
docs/collect/container-metrics.md
+1
-2
@@ -55,8 +55,7 @@ metrics](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README
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](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) procedures apply whether an application runs on the host system or inside
58
+You could use this technique to monitor an entire infrastructure of Docker containers. The same [enable and configure](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) procedures apply whether an application runs on the host system or inside
59
a container. You may need to configure the target endpoint if it's not the application's default.
60
61
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
docs/collect/system-metrics.md
+3
-3
@@ -38,13 +38,13 @@ can find all system collectors in our [supported collectors list](https://github
38
## Collect Windows system metrics
39
40
Netdata is also capable of monitoring Windows systems. The [WMI
41
-collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md) integrates with
41
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/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://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#requirements).
44
+details see [the requirements](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md#requirements).
45
46
Next, [configure the WMI
47
-collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#configuration) to point to the URL
47
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/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](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.
docs/configure/common-changes.md
+2
-2
@@ -61,7 +61,7 @@ of 5 seconds.
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
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)
64
+the [enable or configure a collector](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
65
doc for details.
66
67
### Disable a collector or plugin
@@ -227,7 +227,7 @@ 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
230
-- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak
230
+- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module) 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.
docs/configure/nodes.md
+3
-3
@@ -45,10 +45,10 @@ exist.
45
for each in the [daemon config](https://github.com/netdata/netdata/blob/master/daemon/config/README.md) doc.
46
- `edit-config` is a shell script used for [editing configuration files](#use-edit-config-to-edit-configuration-files).
47
- Various configuration files ending in `.conf` for [configuring plugins or
48
- 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
+ collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) behave. Examples: `go.d.conf`,
49
`python.d.conf`, and `ebpf.d.conf`.
50
- Various directories ending in `.d`, which contain other configuration files, each ending in `.conf`, for [configuring
51
- specific collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md#configure-a-collector).
51
+ specific collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md).
52
- `apps_groups.conf` is a configuration file for changing how applications/processes are grouped when viewing the
53
**Application** charts from [`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) or
54
[`ebpf.plugin`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
@@ -160,7 +160,7 @@ and `edit-config`. We put together a few security best practices based on how yo
160
161
You can also take what you've learned about node configuration to enable or enhance features:
162
163
-- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak their behavior.
163
+- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) or tweak their behavior.
164
- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or create new ones.
165
- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive updates about the health of your
166
infrastructure.
docs/configure/secure-nodes.md
+1
-1
@@ -121,7 +121,7 @@ Read about [Netdata's security design](https://github.com/netdata/netdata/blob/m
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](https://github.com/netdata/netdata/blob/master/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/collectors/README.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
+1
-1
@@ -88,7 +88,7 @@ Learn more about [securing the Netdata Agent](https://github.com/netdata/netdata
88
89
You can also use the restart/reload methods described above to enable new features:
90
91
-- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak their behavior.
91
+- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.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.
docs/contributing/style-guide.md
+1
-2
@@ -469,7 +469,6 @@ The following tables describe the standard spelling, capitalization, and usage o
469
| **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_. |
470
| **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. |
471
| **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. |
472
-| **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/). |
472
| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
473
| **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. |
474
| **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. |
@@ -482,7 +481,7 @@ The following tables describe the standard spelling, capitalization, and usage o
481
| Term | Definition |
482
|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
483
| **filesystem** | Use instead of _file system_. |
485
-| **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). |
484
+| **preconfigured** | The concept that many of Netdata's features come with sane defaults that users don't need to configure to find immediate value. |
485
| **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. |
486
487
docs/dashboard/how-dashboard-works.mdx
+2
-2
@@ -16,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
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
19
+As soon as you [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md), 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
@@ -59,7 +59,7 @@ synchronizes your interactions to help you understand exactly how a node behaved
59
seconds or days.
60
61
A chart is an individual, interactive, always-updating graphic displaying one or more collected/calculated metrics,
62
-which are generated by [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md).
62
+which are generated by [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md).
63
64
docs/export/external-databases.md
+1
-1
@@ -22,7 +22,7 @@ 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](https://github.com/netdata/netdata/blob/master/docs/overview/netdata-monitoring-stack.md)
25
+Exporting is an important part of Netdata's effort to be interoperable
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
docs/guidelines.md
+1
-6
@@ -303,8 +303,7 @@ button to initiate your pull request (PR).
303
Jump down to our instructions on [PRs](#making-a-pull-request) for your next steps.
304
305
**Note**: If you wish to contribute documentation that is more tailored from your specific infrastructure
306
-monitoring/troubleshooting experience, please consider submitting a blog post about your experience. Check
307
-the [README](https://github.com/netdata/blog/blob/master/README.md) in our blog repo! Any blog submissions that have
306
+monitoring/troubleshooting experience, please consider submitting a blog post about your experience. Check out our [blog](https://github.com/netdata/blog#readme) repo! Any blog submissions that have
307
widespread or universal application will be integrated into our permanent documentation.
308
309
### Edit locally
@@ -765,7 +764,3 @@ TODO: Update this section after implemeting a _docker-compose_ for builting and
764
765
The Netdata team aggregates and publishes all documentation at [learn.netdata.cloud](/) using
766
[Docusaurus](https://v2.docusaurus.io/) over at the [`netdata/learn` repository](https://github.com/netdata/learn).
768
-
769
-## Netdata-specific terms
770
-
771
-Consult the [Netdata Glossary](https://github.com/netdata/netdata/blob/master/docs/glossary.md) Netdata specific terms
docs/guides/configure/performance.md
+3
-4
@@ -83,11 +83,10 @@ seconds, respectively.
83
84
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
85
`python.d.conf`, or `charts.d.conf` files, or in individual collector configuration files. If the `update
86
-every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See the [enable
87
-or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) doc for details.
86
+every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See the [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) for details.
87
88
To reduce the frequency of an [internal
90
-plugin/collector](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), open `netdata.conf` and
89
+plugin/collector](https://github.com/netdata/netdata/blob/master/collectors/README.md#collector-architecture-and-terminology), open `netdata.conf` and
90
find the appropriate section. For example, to reduce the frequency of the `apps` plugin, which collects and visualizes
91
metrics on application resource utilization:
92
@@ -96,7 +95,7 @@ metrics on application resource utilization:
95
update every = 5
96
```
97
99
-To [configure an individual collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md), open its specific configuration file with
98
+To [configure an individual collector](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#configure-a-collector), open its specific configuration file with
99
`edit-config` and look for the `update_every` setting. For example, to reduce the frequency of the `nginx` collector,
100
run `sudo ./edit-config go.d/nginx.conf`:
101
docs/guides/export/export-netdata-metrics-graphite.md
+2
-2
@@ -1,6 +1,7 @@
1
<!--
2
title: "Export and visualize Netdata metrics in Graphite"
3
sidebar_label: "Export and visualize Netdata metrics in Graphite"
4
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/guides/export/export-netdata-metrics-graphite.md"
5
description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis."
6
image: /img/seo/guides/export/export-netdata-metrics-graphite.png
7
learn_status: "Published"
@@ -164,8 +165,7 @@ exporting charts to your Graphite dashboard!
165
### Add exporting charts to Netdata Cloud
166
167
You can also show these exporting engine metrics on Netdata Cloud. If you don't have an account already,
167
-go [sign in](https://app.netdata.cloud) and get started for free. If you need some help along the way, read
168
-the [get started with Cloud guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
168
+go [sign in](https://app.netdata.cloud) and get started for free.
169
170
Add more metrics to a War Room's Nodes view by clicking on the **Add metric** button, then typing `exporting` into the
171
context field. Choose the exporting contexts you want to add, then click **Add**. You'll see these charts alongside any
docs/guides/monitor-cockroachdb.md
+1
-2
@@ -116,8 +116,7 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et
116
./edit-config health.d/cockroachdb.conf # You may need to use `sudo` for write privileges
117
```
118
119
-For more information about editing the defaults or writing new alarm entities, see our health monitoring [quickstart
120
-guide](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md).
119
+For more information about editing the defaults or writing new alarm entities, see our documentation on [configuring health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
120
121
## What's next?
122
docs/guides/monitor/anomaly-detection-python.md
+1
-1
@@ -39,7 +39,7 @@ server](https://user-images.githubusercontent.com/1153921/103586700-da5b0a00-4ea
39
40
## Prerequisites
41
42
-- 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).
42
+- A node running the Netdata Agent. If you don't yet have that, [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
43
- A Netdata Cloud account. [Sign up](https://app.netdata.cloud) if you don't have one already.
44
- Familiarity with configuring the Netdata Agent with [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
45
- _Optional_: An Nginx web server running on the same node to follow the example configuration steps.
docs/guides/monitor/lamp-stack.md
+2
-2
@@ -62,7 +62,7 @@ To follow this tutorial, you need:
62
## Install the Netdata Agent
63
64
If you don't have the free, open-source Netdata monitoring agent installed on your node yet, get started with a [single
65
-kickstart command](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx):
65
+kickstart command](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md):
66
67
<OneLineInstallWget/>
68
@@ -242,7 +242,7 @@ source of issues faster with [Metric Correlations](https://github.com/netdata/ne
242
243
### Related reference documentation
244
245
-- [Netdata Agent · Get started](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx)
245
+- [Netdata Agent · Get started](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md)
246
- [Netdata Agent · Apache data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/apache/README.md)
247
- [Netdata Agent · Web log collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md)
248
- [Netdata Agent · MySQL data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md)
docs/guides/monitor/pi-hole-raspberry-pi.md
+2
-2
@@ -103,7 +103,7 @@ part of your system might affect another.
103
action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif)
104
105
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
106
-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).
106
+walkthrough of all its features. For a more expedited tour, see the [get started documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
107
108
### Enable temperature sensor monitoring
109
@@ -154,7 +154,7 @@ Most importantly, you can always install additional services and instantly colle
154
155
- [Optimize performance](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md) using tweaks developed for IoT devices.
156
- [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.
157
-- [Tweak alarms](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md) for either Pi-hole or the health of your Raspberry Pi.
157
+- [Tweak alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) for either Pi-hole or the health of your Raspberry Pi.
158
- [Export metrics to external databases](https://github.com/netdata/netdata/blob/master/exporting/README.md) with the exporting engine.
159
160
Or, head over to [our guides](https://learn.netdata.cloud/guides/) for even more experiments and insights into
docs/guides/monitor/process.md
+2
-6
@@ -38,11 +38,7 @@ With Netdata's process monitoring, you can:
38
39
## Prerequisites
40
41
-- One or more Linux nodes running [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx). If you
42
- need more time to understand Netdata before
43
- following this guide, see
44
- the [infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) or
45
- [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) monitoring quickstarts.
41
+- One or more Linux nodes running [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md)
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`.
@@ -286,7 +282,7 @@ a [supported collector](https://github.com/netdata/netdata/blob/master/collector
282
set
283
that up if it wasn't autodetected. With both process utilization and application-specific metrics, you should have every
284
piece of data needed to discover the root cause of an incident. See
289
-our [collector setup](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) doc for details.
285
+the [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) documentation for details.
286
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`,
docs/guides/monitor/raspberry-pi-anomaly-detection.md
+2
-2
@@ -27,7 +27,7 @@ Read on to learn all the steps and enable unsupervised anomaly detection on your
27
28
- A Raspberry Pi running Raspbian, which we'll call a _node_.
29
- The [open-source Netdata](https://github.com/netdata/netdata) monitoring agent. If you don't have it installed on your
30
- node yet, [get started now](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
30
+ node yet, [get started now](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
31
32
## Install dependencies
33
@@ -123,7 +123,7 @@ feedback on our [community forum](https://community.netdata.cloud/t/anomalies-co
123
124
### Related reference documentation
125
126
-- [Netdata Agent · Get Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx)
126
+- [Netdata Agent · Get Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md)
127
- [Netdata Agent · Anomalies collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md)
128
129
docs/guides/monitor/statsd.md
+1
-1
@@ -34,7 +34,7 @@ Now, let's see the above process in detail.
34
35
## Prerequisites
36
37
-- A node with the [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) installed.
37
+- A node with the [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) installed.
38
- An application to instrument. For this guide, that will be [k6](https://k6.io/docs/getting-started/installation).
39
40
## Understanding the metrics
docs/guides/monitor/stop-notifications-alarms.md
+2
-4
@@ -37,8 +37,7 @@ In the `source` row, you see that this chart is getting its configuration from
37
`4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. The relevant part of begins at `health.d`: `health.d/cpu.conf`. That's
38
the file you need to edit if you want to silence this alarm.
39
40
-For more information about editing or referencing health configuration files on your system, see the [health
41
-quickstart](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#edit-health-configuration-files).
40
+For more information about editing or referencing health configuration files on your system, see the [Configure health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md#edit-health-configuration-files) and the [Health configuration reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) sections of our documentation.
41
42
## Edit the file to enable silencing
43
@@ -74,8 +73,7 @@ To silence this alarm, change `sysadmin` to `silent`.
73
to: silent
74
```
75
77
-Use one of the available [methods](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#reload-health-configuration) to reload your health configuration
78
- and ensure you get no more notifications about that alarm**.
76
+Use one of the available [methods](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#reload-health-configuration) to reload your health configuration and ensure you get no more notifications about that alarm.
77
78
You can add `to: silent` to any alarm you'd rather not bother you with notifications.
79
docs/guides/python-collector.md
+2
-2
@@ -14,7 +14,7 @@ learn_rel_path: "Guides"
14
15
# Develop a custom data collector in Python
16
17
-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,
17
+The Netdata Agent uses [data collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) to fetch metrics from hundreds of system,
18
container, and service endpoints. While the Netdata team and community has built [powerful
19
collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for most system, container, and service/application endpoints, there are plenty
20
of custom applications that can't be monitored by default.
@@ -33,7 +33,7 @@ covered here, or use the included examples for collecting and organizing either
33
## What you need to get started
34
35
- A physical or virtual Linux system, which we'll call a _node_.
36
-- A working installation of the free and open-source [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) monitoring agent.
36
+- A working installation of the free and open-source [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) monitoring agent.
37
38
## Jobs and elements of a Python collector
39
docs/guides/step-by-step/step-00.md
+1
-1
@@ -22,7 +22,7 @@ completely new to Netdata, or have never tried health monitoring/performance tro
22
guide is perfect for you.
23
24
If you have monitoring experience, or would rather get straight into configuring Netdata to your needs, you can jump
25
-straight into code and configurations with our [getting started guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
25
+straight into code and configurations with our [getting started guide](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
26
27
> This guide contains instructions for Netdata installed on a Linux system. Many of the instructions will work on
28
> other supported operating systems, like FreeBSD and macOS, but we can't make any guarantees.
docs/guides/step-by-step/step-03.md
+3
-5
@@ -18,7 +18,7 @@ You might be thinking, "So, now I have to remember all these IP addresses, and t
18
manually, to move from one system to another? Maybe I should just make a bunch of bookmarks. What's a few more tabs
19
on top of the hundred I have already?"
20
21
-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
21
+We get it. That's why we built [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), which connects many distributed
22
agents for a seamless experience when monitoring an entire infrastructure of Netdata-monitored nodes.
23
24
 does a good job (we think!) of explaining why Cloud
41
-gives you a ton of value at no cost:
40
+Our documentation on [monitoring your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) does a good job (we think!) of explaining why Cloud gives you a ton of value at no cost:
41
42
> Netdata Cloud gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can run all your
43
> distributed Agents in headless mode _and_ access the real-time metrics and insightful charts from their dashboards.
@@ -50,8 +49,7 @@ features, new collectors for more applications, and improved UI, so will Cloud.
49
50
## Get started with Netdata Cloud
51
53
-Signing in, onboarding, and connecting your first nodes only takes a few minutes, and we have a [Get started with
54
-Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) guide to help you walk through every step.
52
+Signing in, onboarding, and connecting your first nodes only takes a few minutes, and we have a [Monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) section to help you walk through every step.
53
54
Or, if you're feeling confident, dive right in.
55
docs/guides/step-by-step/step-05.md
+1
-1
@@ -79,7 +79,7 @@ the `warn` and `crit` lines to the values of your choosing. For example:
79
```
80
81
You _can_ restart Netdata with `sudo systemctl restart netdata`, to enable your tune, but you can also reload _only_ the
82
-health monitoring component using one of the available [methods](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#reload-health-configuration).
82
+health monitoring component using one of the available [methods](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#reload-health-configuration).
83
84
You can also tune any other aspect of the default alarms. To better understand how each line in a health entity works,
85
read our [health documentation](https://github.com/netdata/netdata/blob/master/health/README.md).
docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
+1
-2
@@ -240,8 +240,7 @@ same application on multiple systems and want to correlate how it performs on ea
240
findings with someone else on your team.
241
242
If you don't already have a Netdata Cloud account, go [sign in](https://app.netdata.cloud) and get started for free.
243
-Read the [get started with Cloud guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx) for a walkthrough of
244
-connecting nodes to and other fundamentals.
243
+You can also read how to [monitor your infrastructure with Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) to understand the key features that it has to offer.
244
245
Once you've added one or more nodes to a Space in Netdata Cloud, you can see aggregated eBPF metrics in the [Overview
246
dashboard](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) under the same **Applications** or **eBPF** sections that you
docs/monitor/configure-alarms.md
+1
-1
@@ -14,7 +14,7 @@ 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](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) (see
17
+You can use health alarms in conjunction with any of Netdata's [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.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
docs/quickstart/infrastructure.md
+1
-3
@@ -143,9 +143,7 @@ Netdata has [300+ pre-installed collectors](https://github.com/netdata/netdata/b
143
configuration. Collectors search each of your nodes in default locations and ports to find running applications and
144
gather as many metrics as they can without you having to configure them individually.
145
146
-Most collectors work without configuration, but you should read up on [how collectors
147
-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
148
-that you can see metrics from those applications in Netdata Cloud.
146
+Most collectors work without configuration, should you want more info, you can read more on [how Netdata's metrics collectors work](https://github.com/netdata/netdata/blob/master/collectors/README.md) and the [Collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) documentation.
147
148
In addition, find detailed information about which [system](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md),
149
[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
docs/visualize/interact-dashboards-charts.md
+4
-3
@@ -17,14 +17,15 @@ You can find Netdata's dashboards in two places: locally served at `http://NODE:
17
Netdata Cloud. While you access these dashboards differently, they have similar interfaces, identical charts and
18
metrics, and you interact with both of them the same way.
19
20
-> 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
21
-> [infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) quickstart guides.
20
+> 📑 Note
21
+>
22
+> For a quickstart on how to get started, check the [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) documentation.
23
24
Netdata dashboards are single, scrollable pages with many charts stacked on top of one another. As you scroll up or
25
down, charts appearing in your browser's viewport automatically load and update every second.
26
27
The dashboard is broken up into multiple **sections**, such as **System Overview**, **CPU**, **Disk**, which are
27
-automatically generated based on which [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) begin collecting metrics when
28
+automatically generated based on which [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) begin collecting metrics when
29
Netdata starts up. Sections also appear in the right-hand **menu**, along with submenus based on the contexts and
30
families Netdata creates for your node.
31
health/REFERENCE.md
+1
-2
@@ -14,8 +14,7 @@ Welcome to the health configuration reference.
14
This guide contains information about editing health configuration files to tweak existing alarms or create new health
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](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md).
17
+To learn the basics of locating and editing health configuration files, see the [Configure health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) documentation.
18
19
## Health configuration files
20
health/notifications/pagerduty/README.md
+1
-1
@@ -18,7 +18,7 @@ resolution times.
18
19
## What you need to get started
20
21
-- An installation of the open-source [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) monitoring agent.
21
+- An installation of the open-source [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) 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`.
packaging/installer/README.md
+4
-4
@@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem';
19
Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from
20
any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.
21
22
-Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can monitor your entire infrastructure in
22
+Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you can monitor your entire infrastructure in
23
real time and troubleshoot problems that threaten the health of your nodes.
24
25
Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. It
@@ -32,7 +32,7 @@ To install Netdata in minutes on your platform:
32
2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
33
3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
34
35
-Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx).
35
+Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md).
36
37
Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting,
38
but we have some hints on what you might want to do next.
@@ -56,8 +56,8 @@ metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metric
56
#### Data collection
57
58
If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should
59
-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
60
-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)
59
+learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/collectors/README.md). If there's a [supported
60
+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/collectors/REFERENCE.md)
61
or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
62
63
#### Alarms & notifications
packaging/installer/methods/ansible.md
+2
-2
@@ -11,7 +11,7 @@ learn_rel_path: "Installation"
11
12
# Deploy Netdata with Ansible
13
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
14
+Netdata's [one-line kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer) 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
@@ -166,7 +166,7 @@ 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](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
169
+- [Collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/README.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)
packaging/installer/methods/kickstart.md
+2
-5
@@ -164,11 +164,8 @@ If the script is valid, this command will return `OK, VALID`.
164
165
## What's next?
166
167
-When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
168
-[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
167
+When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
168
170
-Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
171
-
172
-Read through Netdata's [documentation](https://learn.netdata.cloud/), which is structured based on actions and
169
+Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
170
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
171
external databases, and more.
packaging/installer/methods/macos.md
+6
-8
@@ -41,7 +41,7 @@ The Netdata Agent is installed under `/usr/local/netdata`. Dependencies are hand
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://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx#manage-spaces).
44
+area](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md).
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.
@@ -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://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), 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/quickstart/infrastructure.md), 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,8 @@ 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](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](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
113
-
114
-
109
+When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
110
111
+Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
112
+solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
113
+external databases, and more.
packaging/installer/methods/manual.md
+1
-6
@@ -229,13 +229,8 @@ 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](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](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
232
+When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
233
234
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
235
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
236
external databases, and more.
240
-
241
-
packaging/installer/methods/offline.md
+1
-4
@@ -60,10 +60,7 @@ supported on offline installs).
60
61
## What's next?
62
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](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
63
+When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
64
65
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
66
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
web/gui/README.md
-3
@@ -107,9 +107,6 @@ a War Room's name to jump to the Netdata Cloud web interface.
107
109
110
-If you want to know more about how Cloud populates this menu, and the Agent-Cloud integration at a high level, see our
111
-document on [using the Agent with Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/agent-cloud.md).
112
-
110
## Customizing the local dashboard
111
112
Netdata stores information about individual charts in the `dashboard_info.js`