diff options
author | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2023-02-10 11:21:10 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-10 11:21:10 -0800 |
commit | f9acc1aeadcf36f2373383a0f4a038b3309164e5 (patch) | |
tree | a1e7bba25baaffd019424a37af511031e556e0f8 | |
parent | 77356ce91b694712fdc685b0fb3ae01025f71850 (diff) |
More learn reorg/reordering (#14505)
* Move installation before concepts
* Reorder installation links
* Remove single node monitoring
* Reorg libnetdata content
30 files changed, 31 insertions, 122 deletions
diff --git a/docs/category-overview-pages/installation-overview.md b/docs/category-overview-pages/installation-overview.md index c2b18c3341..f080c44c37 100644 --- a/docs/category-overview-pages/installation-overview.md +++ b/docs/category-overview-pages/installation-overview.md @@ -4,7 +4,7 @@ sidebar_label: "Installation" custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/installation-overview.md" learn_status: "Published" learn_rel_path: "Installation" -sidebar_position: 20 +sidebar_position: 5 --> In this category you can find instructions on all the possible ways you can install Netdata on the diff --git a/docs/quickstart/single-node.md b/docs/quickstart/single-node.md deleted file mode 100644 index 304f4ffcc0..0000000000 --- a/docs/quickstart/single-node.md +++ /dev/null @@ -1,95 +0,0 @@ -<!-- -title: "Single-node monitoring with Netdata" -description: "Learn dashboard basics, configuring your nodes, and collecting metrics from applications to create a powerful single-node monitoring tool." -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/single-node.md -sidebar_label: "Infrastructure monitoring with Netdata" -learn_status: "Published" -learn_topic_type: "References" -learn_rel_path: "Possible old, not wanted documents" ---> - -# Single-node monitoring with Netdata - -Because it's free, open-source, and requires only 1% CPU utilization to collect thousands of metrics every second, -Netdata is a superb single-node monitoring tool. - -In this quickstart guide, you'll learn how to access your single node's metrics through dashboards, configure your node -to your liking, and make sure the Netdata Agent is collecting metrics from the applications or containers you're running -on your node. - -## See your node's metrics - -To see your node's real-time metrics, you need to access its dashboard. You can either view the local dashboard, which -runs on the node itself, or see the dashboard through Netdata Cloud. Both methods feature real-time, interactive, and -synchronized charts, with the same metrics, and use the same UI. - -The primary difference is that Netdata Cloud also has a few extra features, like creating new dashboards using a -drag-and-drop editor, that enhance your monitoring and troubleshooting experience. - -To see your node's local dashboard, open up your web browser of choice and navigate to `http://NODE:19999`, replacing -`NODE` with the IP address or hostname of your Agent. Hit `Enter`. - -![Animated GIF of navigating to the -dashboard](https://user-images.githubusercontent.com/1153921/80825153-abaec600-8b94-11ea-8b17-1b770a2abaa9.gif) - -To see a node's dashboard in Netdata Cloud, [sign in](https://app.netdata.cloud). From the **Nodes** view in your -**General** War Room, click on the hostname of your node to access its dashboard through Netdata Cloud. - -![Screenshot of an embedded node -dashboard](https://user-images.githubusercontent.com/1153921/87457036-9b678e00-c5bc-11ea-977d-ad561a73beef.png) - -Once you've decided which dashboard you prefer, learn about [interacting with dashboards and -charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) to get the most from Netdata's real-time metrics. - -## Configure your node - -The Netdata Agent is highly configurable so that you can match its behavior to your node. You will find most -configuration options in the `netdata.conf` file, which is typically at `/etc/netdata/netdata.conf`. The best way to -edit this file is using the `edit-config` script, which ensures updates to the Netdata Agent do not overwrite your -changes. For example: - -```bash -cd /etc/netdata -sudo ./edit-config netdata.conf -``` - -Our [configuration basics doc](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) contains more information about `netdata.conf`, `edit-config`, -along with simple examples to get you familiar with editing your node's configuration. - -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 -recommended methods. These security best practices ensure no untrusted parties gain access to your dashboard or its -metrics. - -## Collect metrics from your system and applications - -Netdata has [300+ pre-installed collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) that gather thousands of metrics with zero -configuration. Collectors search your node in default locations and ports to find running applications and gather as -many metrics as possible without you having to configure them individually. - -These metrics enrich both the local and Netdata Cloud dashboards. - -Most collectors work without configuration, but you should read up on [how collectors -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. - -In addition, find detailed information about which [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), and [application](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md) metrics you can -collect from across your infrastructure with Netdata. - -## What's next? - -Netdata has many features that help you monitor the health of your node and troubleshoot complex performance problems. -Once you understand configuration, and are certain Netdata is collecting all the important metrics from your node, try -out some of Netdata's other visualization and health monitoring features: - -- [Build new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) to put disparate but relevant metrics onto a single - interface. -- [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 - of anomalies. -- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to Slack, PagerDuty, email, and 30+ other services. -- [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 - collects, your preferred retention period, and the resources you want to dedicate toward long-term metrics - retention. -- [Export metrics](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) to an external time-series database to use Netdata alongside - other monitoring and troubleshooting tools. - - diff --git a/libnetdata/adaptive_resortable_list/README.md b/libnetdata/adaptive_resortable_list/README.md index 957578487c..ceed467d6f 100644 --- a/libnetdata/adaptive_resortable_list/README.md +++ b/libnetdata/adaptive_resortable_list/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/adapt sidebar_label: "Adaptive Re-sortable List (ARL)" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Adaptive Re-sortable List (ARL) diff --git a/libnetdata/aral/README.md b/libnetdata/aral/README.md index 3b0f5bbd62..e556144ba3 100644 --- a/libnetdata/aral/README.md +++ b/libnetdata/aral/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/aral/ sidebar_label: "Array allocator" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Array Allocator diff --git a/libnetdata/avl/README.md b/libnetdata/avl/README.md index 2b03fec4af..94c0f634f7 100644 --- a/libnetdata/avl/README.md +++ b/libnetdata/avl/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/R sidebar_label: "AVL" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # AVL diff --git a/libnetdata/buffer/README.md b/libnetdata/buffer/README.md index 6a84fd8a31..2937ae1417 100644 --- a/libnetdata/buffer/README.md +++ b/libnetdata/buffer/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/buffe sidebar_label: "BUFFER library" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # BUFFER diff --git a/libnetdata/circular_buffer/README.md b/libnetdata/circular_buffer/README.md index 23980dff39..c473865160 100644 --- a/libnetdata/circular_buffer/README.md +++ b/libnetdata/circular_buffer/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circu sidebar_label: "Circular Buffer" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Circular Buffer diff --git a/libnetdata/clocks/README.md b/libnetdata/clocks/README.md index a641381d56..ed45e7ebb8 100644 --- a/libnetdata/clocks/README.md +++ b/libnetdata/clocks/README.md @@ -4,5 +4,5 @@ title: "Clocks" sidebar_label: "Clocks" learn_status: "Published" learn_topic_type: "References" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> diff --git a/libnetdata/config/README.md b/libnetdata/config/README.md index c34cf9255a..c3a9d147c5 100644 --- a/libnetdata/config/README.md +++ b/libnetdata/config/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/confi sidebar_label: "Netdata ini config files" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Netdata ini config files diff --git a/libnetdata/dictionary/README.md b/libnetdata/dictionary/README.md index 508c4e0311..3b54cf18f8 100644 --- a/libnetdata/dictionary/README.md +++ b/libnetdata/dictionary/README.md @@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/dicti sidebar_label: "Dictionaries" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Dictionaries diff --git a/libnetdata/ebpf/README.md b/libnetdata/ebpf/README.md index 39479660f6..bf2c6ff350 100644 --- a/libnetdata/ebpf/README.md +++ b/libnetdata/ebpf/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/ebpf/ sidebar_label: "eBPF" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # eBPF library diff --git a/libnetdata/json/README.md b/libnetdata/json/README.md index e772f114de..1c49739bef 100644 --- a/libnetdata/json/README.md +++ b/libnetdata/json/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/ sidebar_label: "json" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # json diff --git a/libnetdata/july/README.md b/libnetdata/july/README.md index df2a3d38c2..9958491286 100644 --- a/libnetdata/july/README.md +++ b/libnetdata/july/README.md @@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/july/ sidebar_label: "July interface" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> diff --git a/libnetdata/locks/README.md b/libnetdata/locks/README.md index 8810e3d175..ccf9684e64 100644 --- a/libnetdata/locks/README.md +++ b/libnetdata/locks/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/locks sidebar_label: "Locks" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> ## How to trace netdata locks diff --git a/libnetdata/log/README.md b/libnetdata/log/README.md index 7fa6fdb8d9..3684abd688 100644 --- a/libnetdata/log/README.md +++ b/libnetdata/log/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/log/R sidebar_label: "Log" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Log diff --git a/libnetdata/onewayalloc/README.md b/libnetdata/onewayalloc/README.md index 2911376121..38d92cea62 100644 --- a/libnetdata/onewayalloc/README.md +++ b/libnetdata/onewayalloc/README.md @@ -4,7 +4,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/onew sidebar_label: "One way allocator" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # One Way Allocator diff --git a/libnetdata/popen/README.md b/libnetdata/popen/README.md index 804690d13f..7bd2bd3ddb 100644 --- a/libnetdata/popen/README.md +++ b/libnetdata/popen/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/popen sidebar_label: "popen" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # popen diff --git a/libnetdata/procfile/README.md b/libnetdata/procfile/README.md index 8610e77e52..37138bd198 100644 --- a/libnetdata/procfile/README.md +++ b/libnetdata/procfile/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procf sidebar_label: "Procfile" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # PROCFILE diff --git a/libnetdata/simple_pattern/README.md b/libnetdata/simple_pattern/README.md index a0a7cf6888..e00006d37c 100644 --- a/libnetdata/simple_pattern/README.md +++ b/libnetdata/simple_pattern/README.md @@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/simpl sidebar_label: "Simple patterns" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Simple patterns diff --git a/libnetdata/socket/README.md b/libnetdata/socket/README.md index 91ea2609db..e339a071c1 100644 --- a/libnetdata/socket/README.md +++ b/libnetdata/socket/README.md @@ -4,5 +4,5 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/socke sidebar_label: "Socket" learn_status: "Published" learn_topic_type: "References" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> diff --git a/libnetdata/statistical/README.md b/libnetdata/statistical/README.md index 8fa101f0e3..937c26ac6e 100644 --- a/libnetdata/statistical/README.md +++ b/libnetdata/statistical/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/stati sidebar_label: "Statistical functions" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Statistical functions diff --git a/libnetdata/storage_number/README.md b/libnetdata/storage_number/README.md index da2c3ccfd0..2dd6df6cfb 100644 --- a/libnetdata/storage_number/README.md +++ b/libnetdata/storage_number/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/stora sidebar_label: "Storage number" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Netdata storage number diff --git a/libnetdata/string/README.md b/libnetdata/string/README.md index b1c6e61c37..4fd4425077 100644 --- a/libnetdata/string/README.md +++ b/libnetdata/string/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/strin sidebar_label: "String" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # STRING diff --git a/libnetdata/threads/README.md b/libnetdata/threads/README.md index 71979feac4..7e9e493f40 100644 --- a/libnetdata/threads/README.md +++ b/libnetdata/threads/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/threa sidebar_label: "Threads" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Threads diff --git a/libnetdata/url/README.md b/libnetdata/url/README.md index cca6f8731e..1ba51e2ea6 100644 --- a/libnetdata/url/README.md +++ b/libnetdata/url/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/url/R sidebar_label: "URL" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # URL diff --git a/libnetdata/worker_utilization/README.md b/libnetdata/worker_utilization/README.md index 11bd75b3d1..04dfb6215e 100644 --- a/libnetdata/worker_utilization/README.md +++ b/libnetdata/worker_utilization/README.md @@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/worke sidebar_label: "Worker Utilization" learn_status: "Published" learn_topic_type: "References" -learn_rel_path: "Developers/libnetdata libraries" +learn_rel_path: "Developers/libnetdata" --> # Worker Utilization diff --git a/packaging/docker/README.md b/packaging/docker/README.md index f7d25d5dff..49083fb661 100644 --- a/packaging/docker/README.md +++ b/packaging/docker/README.md @@ -6,6 +6,7 @@ sidebar_label: "Install Netdata with Docker" learn_status: "Published" learn_topic_type: "Tasks" learn_rel_path: "Installation" +sidebar_position: 40 --> import Tabs from '@theme/Tabs'; diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md index 286116ccc1..68f8a427ed 100644 --- a/packaging/installer/methods/kickstart.md +++ b/packaging/installer/methods/kickstart.md @@ -6,6 +6,7 @@ sidebar_label: "Install Netdata with kickstart.sh" learn_status: "Published" learn_topic_type: "Tasks" learn_rel_path: "Installation" +sidebar_position: 10 --> import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/' diff --git a/packaging/installer/methods/kubernetes.md b/packaging/installer/methods/kubernetes.md index 9c15e3c60c..6b6b0b05c9 100644 --- a/packaging/installer/methods/kubernetes.md +++ b/packaging/installer/methods/kubernetes.md @@ -1,11 +1,12 @@ <!-- -title: "Deploy Kubernetes monitoring with Netdata" +title: "Install Netdata on Kubernetes" 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." custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kubernetes.md" -sidebar_label: "Deploy Kubernetes monitoring with Netdata" +sidebar_label: "Install Netdata on Kubernetes" learn_status: "Published" learn_topic_type: "Tasks" learn_rel_path: "Installation" +sidebar_position: 60 --> import Tabs from '@theme/Tabs'; diff --git a/packaging/installer/methods/packages.md b/packaging/installer/methods/packages.md index 1355128087..b576fae249 100644 --- a/packaging/installer/methods/packages.md +++ b/packaging/installer/methods/packages.md @@ -6,6 +6,7 @@ sidebar_label: "Install Netdata using native DEB/RPM packages." learn_status: "Published" learn_topic_type: "Tasks" learn_rel_path: "Installation" +sidebar_position: 20 --> # Installing Netdata using native DEB or RPM packages. |