0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-10 08:07:34 +00:00

More learn reorg/reordering ()

* Move installation before concepts

* Reorder installation links

* Remove single node monitoring

* Reorg libnetdata content
This commit is contained in:
Chris Akritidis 2023-02-10 11:21:10 -08:00 committed by GitHub
parent 77356ce91b
commit f9acc1aead
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 31 additions and 122 deletions
docs
category-overview-pages
quickstart
libnetdata
adaptive_resortable_list
aral
avl
buffer
circular_buffer
clocks
config
dictionary
ebpf
json
july
locks
log
onewayalloc
popen
procfile
simple_pattern
socket
statistical
storage_number
string
threads
url
worker_utilization
packaging

View file

@ -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

View file

@ -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.

View file

@ -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)

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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"
-->

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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"
-->

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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"
-->

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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';

View file

@ -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/'

View file

@ -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';

View file

@ -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.