More learn reorg/reordering (#14505)
* Move installation before concepts * Reorder installation links * Remove single node monitoring * Reorg libnetdata content
Chris Akritidis committed
Feb 10, 2023 at 11:21 UTC
f9acc1aeadcf36f2373383a0f4a038b3309164e5
30 files changed
+31
-122
docs/category-overview-pages/installation-overview.md
+1
-1
@@ -4,7 +4,7 @@ sidebar_label: "Installation"
4
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/installation-overview.md"
5
learn_status: "Published"
6
learn_rel_path: "Installation"
7
-sidebar_position: 20
7
+sidebar_position: 5
8
-->
9
10
In this category you can find instructions on all the possible ways you can install Netdata on the
docs/quickstart/single-node.md
deleted
-95
@@ -1,95 +0,0 @@
1
-<!--
2
-title: "Single-node monitoring with Netdata"
3
-description: "Learn dashboard basics, configuring your nodes, and collecting metrics from applications to create a powerful single-node monitoring tool."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/single-node.md
5
-sidebar_label: "Infrastructure monitoring with Netdata"
6
-learn_status: "Published"
7
-learn_topic_type: "References"
8
-learn_rel_path: "Possible old, not wanted documents"
9
--->
10
-
11
-# Single-node monitoring with Netdata
12
-
13
-Because it's free, open-source, and requires only 1% CPU utilization to collect thousands of metrics every second,
14
-Netdata is a superb single-node monitoring tool.
15
-
16
-In this quickstart guide, you'll learn how to access your single node's metrics through dashboards, configure your node
17
-to your liking, and make sure the Netdata Agent is collecting metrics from the applications or containers you're running
18
-on your node.
19
-
20
-## See your node's metrics
21
-
22
-To see your node's real-time metrics, you need to access its dashboard. You can either view the local dashboard, which
23
-runs on the node itself, or see the dashboard through Netdata Cloud. Both methods feature real-time, interactive, and
24
-synchronized charts, with the same metrics, and use the same UI.
25
-
26
-The primary difference is that Netdata Cloud also has a few extra features, like creating new dashboards using a
27
-drag-and-drop editor, that enhance your monitoring and troubleshooting experience.
28
-
29
-To see your node's local dashboard, open up your web browser of choice and navigate to `http://NODE:19999`, replacing
30
-`NODE` with the IP address or hostname of your Agent. Hit `Enter`.
31
-
32
-
34
-
35
-To see a node's dashboard in Netdata Cloud, [sign in](https://app.netdata.cloud). From the **Nodes** view in your
36
-**General** War Room, click on the hostname of your node to access its dashboard through Netdata Cloud.
37
-
38
-
40
-
41
-Once you've decided which dashboard you prefer, learn about [interacting with dashboards and
42
-charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) to get the most from Netdata's real-time metrics.
43
-
44
-## Configure your node
45
-
46
-The Netdata Agent is highly configurable so that you can match its behavior to your node. You will find most
47
-configuration options in the `netdata.conf` file, which is typically at `/etc/netdata/netdata.conf`. The best way to
48
-edit this file is using the `edit-config` script, which ensures updates to the Netdata Agent do not overwrite your
49
-changes. For example:
50
-
51
-```bash
52
-cd /etc/netdata
53
-sudo ./edit-config netdata.conf
54
-```
55
-
56
-Our [configuration basics doc](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) contains more information about `netdata.conf`, `edit-config`,
57
-along with simple examples to get you familiar with editing your node's configuration.
58
-
59
-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
60
-recommended methods. These security best practices ensure no untrusted parties gain access to your dashboard or its
61
-metrics.
62
-
63
-## Collect metrics from your system and applications
64
-
65
-Netdata has [300+ pre-installed collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) that gather thousands of metrics with zero
66
-configuration. Collectors search your node in default locations and ports to find running applications and gather as
67
-many metrics as possible without you having to configure them individually.
68
-
69
-These metrics enrich both the local and Netdata Cloud dashboards.
70
-
71
-Most collectors work without configuration, but you should read up on [how collectors
72
-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.
73
-
74
-In addition, find detailed information about which [system](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md),
75
-[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
76
-collect from across your infrastructure with Netdata.
77
-
78
-## What's next?
79
-
80
-Netdata has many features that help you monitor the health of your node and troubleshoot complex performance problems.
81
-Once you understand configuration, and are certain Netdata is collecting all the important metrics from your node, try
82
-out some of Netdata's other visualization and health monitoring features:
83
-
84
-- [Build new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) to put disparate but relevant metrics onto a single
85
- interface.
86
-- [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
87
- of anomalies.
88
-- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to Slack, PagerDuty, email, and 30+ other services.
89
-- [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
90
- collects, your preferred retention period, and the resources you want to dedicate toward long-term metrics
91
- retention.
92
-- [Export metrics](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) to an external time-series database to use Netdata alongside
93
- other monitoring and troubleshooting tools.
94
-
95
-
libnetdata/adaptive_resortable_list/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/adapt
4
sidebar_label: "Adaptive Re-sortable List (ARL)"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Adaptive Re-sortable List (ARL)
libnetdata/aral/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/aral/
4
sidebar_label: "Array allocator"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Array Allocator
libnetdata/avl/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/R
4
sidebar_label: "AVL"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# AVL
libnetdata/buffer/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/buffe
4
sidebar_label: "BUFFER library"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# BUFFER
libnetdata/circular_buffer/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circu
4
sidebar_label: "Circular Buffer"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Circular Buffer
libnetdata/clocks/README.md
+1
-1
@@ -4,5 +4,5 @@ title: "Clocks"
4
sidebar_label: "Clocks"
5
learn_status: "Published"
6
learn_topic_type: "References"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
libnetdata/config/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/confi
4
sidebar_label: "Netdata ini config files"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Netdata ini config files
libnetdata/dictionary/README.md
+1
-1
@@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/dicti
3
sidebar_label: "Dictionaries"
4
learn_status: "Published"
5
learn_topic_type: "Tasks"
6
-learn_rel_path: "Developers/libnetdata libraries"
6
+learn_rel_path: "Developers/libnetdata"
7
-->
8
9
# Dictionaries
libnetdata/ebpf/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/ebpf/
4
sidebar_label: "eBPF"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# eBPF library
libnetdata/json/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/
4
sidebar_label: "json"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# json
libnetdata/july/README.md
+1
-1
@@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/july/
3
sidebar_label: "July interface"
4
learn_status: "Published"
5
learn_topic_type: "Tasks"
6
-learn_rel_path: "Developers/libnetdata libraries"
6
+learn_rel_path: "Developers/libnetdata"
7
-->
8
9
libnetdata/locks/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/locks
4
sidebar_label: "Locks"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
## How to trace netdata locks
libnetdata/log/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/log/R
4
sidebar_label: "Log"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Log
libnetdata/onewayalloc/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/onew
4
sidebar_label: "One way allocator"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# One Way Allocator
libnetdata/popen/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/popen
4
sidebar_label: "popen"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# popen
libnetdata/procfile/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procf
4
sidebar_label: "Procfile"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# PROCFILE
libnetdata/simple_pattern/README.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/simpl
5
sidebar_label: "Simple patterns"
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
-learn_rel_path: "Developers/libnetdata libraries"
8
+learn_rel_path: "Developers/libnetdata"
9
-->
10
11
# Simple patterns
libnetdata/socket/README.md
+1
-1
@@ -4,5 +4,5 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/socke
4
sidebar_label: "Socket"
5
learn_status: "Published"
6
learn_topic_type: "References"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
libnetdata/statistical/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/stati
4
sidebar_label: "Statistical functions"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Statistical functions
libnetdata/storage_number/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/stora
4
sidebar_label: "Storage number"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Netdata storage number
libnetdata/string/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/strin
4
sidebar_label: "String"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# STRING
libnetdata/threads/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/threa
4
sidebar_label: "Threads"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Threads
libnetdata/url/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/url/R
4
sidebar_label: "URL"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# URL
libnetdata/worker_utilization/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/worke
4
sidebar_label: "Worker Utilization"
5
learn_status: "Published"
6
learn_topic_type: "References"
7
-learn_rel_path: "Developers/libnetdata libraries"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# Worker Utilization
packaging/docker/README.md
+1
@@ -6,6 +6,7 @@ sidebar_label: "Install Netdata with Docker"
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
learn_rel_path: "Installation"
9
+sidebar_position: 40
10
-->
11
12
import Tabs from '@theme/Tabs';
packaging/installer/methods/kickstart.md
+1
@@ -6,6 +6,7 @@ sidebar_label: "Install Netdata with kickstart.sh"
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
learn_rel_path: "Installation"
9
+sidebar_position: 10
10
-->
11
12
import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
packaging/installer/methods/kubernetes.md
+3
-2
@@ -1,11 +1,12 @@
1
<!--
2
-title: "Deploy Kubernetes monitoring with Netdata"
2
+title: "Install Netdata on Kubernetes"
3
description: "Deploy Netdata to monitor a Kubernetes cluster to monitor the health, performance, resource utilization, and application metrics of a Kubernetes cluster in real time."
4
custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kubernetes.md"
5
-sidebar_label: "Deploy Kubernetes monitoring with Netdata"
5
+sidebar_label: "Install Netdata on Kubernetes"
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
learn_rel_path: "Installation"
9
+sidebar_position: 60
10
-->
11
12
import Tabs from '@theme/Tabs';
packaging/installer/methods/packages.md
+1
@@ -6,6 +6,7 @@ sidebar_label: "Install Netdata using native DEB/RPM packages."
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
learn_rel_path: "Installation"
9
+sidebar_position: 20
10
-->
11
12
# Installing Netdata using native DEB or RPM packages.