@cryptotaxi247 / netdata-1 / commits / 0541c97e5

Introduce the new Structure of the documentation (#13915)

* Moving the cloud docs under /docs/cloud (previous location: netdata/learn/*) * Added metadata on almost every document of the old learn site for the new ingest process of learn. * Map old learn document to their best fit as topic related docs. Signed-off-by: Tasos Katsoulas <tasos@netdata.cloud> Co-authored-by: DShreve2 <david@netdata.cloud> Co-authored-by: hugovalente-pm <hugo@netdata.cloud>

Fotis Voutsas committed Jan 25, 2023 at 15:29 UTC 0541c97e531bc7220b2879eb8a4139df0dc821b8
206 files changed +4733 -254
aclk/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Agent-Cloud link (ACLK)"
3 description: "The Agent-Cloud link (ACLK) is the mechanism responsible for connecting a Netdata agent to Netdata Cloud."
4 -date: 2020-05-11
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/aclk/README.md
4 +date: "2020-05-11"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/aclk/README.md"
6 +sidebar_label: "Agent-Cloud link (ACLK)"
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Setup"
10 -->
11
12 # Agent-cloud link (ACLK)
claim/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Connect Agent to Cloud"
3 description: "Connecting a Netdata Agent, running on a distributed node, to Netdata Cloud securely via the encrypted Agent-Cloud link (ACLK)."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/claim/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/claim/README.md"
5 +sidebar_label: "Connect Agent to Cloud"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Connect Agent to Cloud
cli/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Netdata CLI"
3 description: "The Netdata Agent includes a command-line experience for reloading health configuration, reopening log files, halting the daemon, and more."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/cli/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/cli/README.md"
5 +sidebar_label: "Agent CLI"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References"
9 -->
10
11 # Netdata CLI
collectors/COLLECTORS.md
+2 -1
@@ -1,7 +1,8 @@
1 <!--
2 title: "Supported collectors list"
3 description: "Netdata gathers real-time metrics from hundreds of data sources using collectors. Most require zero configuration and are pre-configured out of the box."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md"
5 +sidebar_label: "Supported collectors list"
6 -->
7
8 # Supported collectors list
collectors/README.md
+2 -1
@@ -1,7 +1,8 @@
1 <!--
2 title: "Collecting metrics"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/README.md"
4 id: "collectors-ref"
5 +sidebar_label: "Plugins Reference"
6 -->
7
8 # Collecting metrics
collectors/REFERENCE.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "Collectors configuration reference"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md"
4 +sidebar_label: "Collectors configuration"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup"
8 -->
9
10 # Collectors configuration reference
collectors/apps.plugin/README.md
+6 -3
@@ -1,7 +1,10 @@
1 <!--
2 -title: "apps.plugin"
3 -sidebar_label: "Application monitoring (apps.plugin)"
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/README.md
2 +title: "Application monitoring (apps.plugin)"
3 +sidebar_label: "Application monitoring "
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/System metrics"
8 -->
9
10 # apps.plugin
collectors/cgroups.plugin/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "cgroups.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md
2 +title: "Monitor Cgroups (cgroups.plugin)"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md"
4 +sidebar_label: "Monitor Cgroups"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Virtualized environments/Containers"
8 -->
9
10 # cgroups.plugin
collectors/charts.d.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "charts.d.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/README.md"
4 +sidebar_label: "charts.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Developers/Collectors"
8 -->
9
10 # charts.d.plugin
collectors/charts.d.plugin/ap/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Access point monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/ap/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/ap/README.md"
4 sidebar_label: "Access points"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Remotes/Devices"
8 -->
9
10 # Access point monitoring with Netdata
collectors/charts.d.plugin/apcupsd/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "APC UPS monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/apcupsd/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/apcupsd/README.md"
4 sidebar_label: "APC UPS"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Remotes/Devices"
8 -->
9
10 # APC UPS monitoring with Netdata
collectors/charts.d.plugin/example/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "Example"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/example/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/example/README.md"
4 +sidebar_label: "example-charts.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Mock Collectors"
8 -->
9
10 # Example
collectors/charts.d.plugin/libreswan/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Libreswan IPSec tunnel monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/libreswan/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/libreswan/README.md"
4 sidebar_label: "Libreswan IPSec tunnels"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Networking"
8 -->
9
10 # Libreswan IPSec tunnel monitoring with Netdata
collectors/charts.d.plugin/nut/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "UPS/PDU monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/nut/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/nut/README.md"
4 sidebar_label: "UPS/PDU"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Remotes/Devices"
8 -->
9
10 # UPS/PDU monitoring with Netdata
collectors/charts.d.plugin/opensips/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "OpenSIPS monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/opensips/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/opensips/README.md"
4 sidebar_label: "OpenSIPS"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Networking"
8 -->
9
10 # OpenSIPS monitoring with Netdata
collectors/charts.d.plugin/sensors/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "Linux machine sensors monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/sensors/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/sensors/README.md"
4 +sidebar_label: "lm-sensors"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Devices"
8 -->
9
10 # Linux machine sensors monitoring with Netdata
collectors/checks.plugin/README.md new
+12
@@ -0,0 +1,12 @@
1 +<!--
2 +title: "checks.plugin"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/checks.plugin/README.md"
4 +sidebar_label: "checks.plugin"
5 +learn_status: "Unpublished"
6 +-->
7 +
8 +# checks.plugin
9 +
10 +A debugging plugin (by default it is disabled)
11 +
12 +
collectors/cups.plugin/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "cups.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md
2 +title: "Printers (cups.plugin)"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md"
4 +sidebar_label: "cups.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Remotes/Devices"
8 -->
9
10 # cups.plugin
collectors/diskspace.plugin/README.md
+6 -2
@@ -1,7 +1,11 @@
1 <!--
2 -title: "diskspace.plugin"
2 +title: "Monitor disk (diskspace.plugin)"
3 description: "Monitor the disk usage space of mounted disks in real-time with the Netdata Agent, plus preconfigured alarms for disks at risk of filling up."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md"
5 +sidebar_label: "Disks"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Collectors references/System metrics"
9 -->
10
11 # diskspace.plugin
collectors/ebpf.plugin/README.md
+7 -5
@@ -1,9 +1,11 @@
1 <!--
2 -title: "eBPF monitoring with Netdata"
3 -description: "Use Netdata's extended Berkeley Packet Filter (eBPF) collector to monitor kernel-level metrics about your
4 -complex applications with per-second granularity."
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ebpf.plugin/README.md
6 -sidebar_label: "eBPF"
2 +title: "Kernel traces/metrics (eBPF) monitoring with Netdata"
3 +description: "Use Netdata's extended Berkeley Packet Filter (eBPF) collector to monitor kernel-level metrics about yourcomplex applications with per-second granularity."
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/ebpf.plugin/README.md"
5 +sidebar_label: "Kernel traces/metrics (eBPF)"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Collectors references/System metrics"
9 -->
10
11 # eBPF monitoring with Netdata
collectors/freebsd.plugin/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "freebsd.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md
2 +title: "FreeBSD system metrics (freebsd.plugin)"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md"
4 +sidebar_label: "FreeBSD system metrics (freebsd.plugin)"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/System metrics"
8 -->
9
10 # freebsd.plugin
collectors/freeipmi.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "freeipmi.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md"
4 +sidebar_label: "freeipmi.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Devices"
8 -->
9
10 # freeipmi.plugin
collectors/idlejitter.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "idlejitter.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md"
4 +sidebar_label: "idlejitter.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/QoS"
8 -->
9
10 # idlejitter.plugin
collectors/ioping.plugin/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "ioping.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md
2 +title: "Monitor latency for directories/files/devices (ioping.plugin)"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md"
4 +sidebar_label: "Latency monitoring (ioping.plugin)"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/QoS"
8 -->
9
10 # ioping.plugin
collectors/macos.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "macos.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md"
4 +sidebar_label: "macos.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/System metrics"
8 -->
9
10 # macos.plugin
collectors/nfacct.plugin/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "nfacct.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md
2 +title: "Monitor Netfilter statistics (nfacct.plugin)"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md"
4 +sidebar_label: "Netfilter statistics (nfacct.plugin)"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Networking"
8 -->
9
10 # nfacct.plugin
collectors/perf.plugin/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "perf.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md
2 +title: "Monitor CPU performance statistics (perf.plugin)"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md"
4 +sidebar_label: "CPU performance statistics (perf.plugin)"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/System metrics"
8 -->
9
10 # perf.plugin
collectors/plugins.d/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "External plugins overview"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/plugins.d/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/plugins.d/README.md"
4 +sidebar_label: "plugins.d"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/plugins.d"
8 -->
9
10 # External plugins overview
collectors/proc.plugin/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "proc.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md
2 +title: "OS provided metrics (proc.plugin)"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md"
4 +sidebar_label: "OS provided metrics (proc.plugin)"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/System metrics"
8 -->
9
10 # proc.plugin
collectors/python.d.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "python.d.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/README.md"
4 +sidebar_label: "python.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Developers/Collectors"
8 -->
9
10 # python.d.plugin
collectors/python.d.plugin/adaptec_raid/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Adaptec RAID controller monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/adaptec_raid/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/adaptec_raid/README.md"
4 sidebar_label: "Adaptec RAID"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Hardware"
8 -->
9
10 # Adaptec RAID controller monitoring with Netdata
collectors/python.d.plugin/alarms/README.md
+4 -1
@@ -1,6 +1,9 @@
1 <!--
2 title: "Alarms"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/alarms/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/alarms/README.md"
4 +sidebar_label: "alarms"
5 +learn_status: "Unpublished"
6 +learn_topic_type: "References"
7 -->
8
9 # Alarms - graphing Netdata alarm states over time
collectors/python.d.plugin/am2320/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "AM2320 sensor monitoring with netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/am2320/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/am2320/README.md"
4 sidebar_label: "AM2320"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Remotes/Devices"
8 -->
9
10 # AM2320 sensor monitoring with netdata
collectors/python.d.plugin/anomalies/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Anomaly detection with Netdata"
3 description: "Use ML-driven anomaly detection to narrow your focus to only affected metrics and services/processes on your node to shorten root cause analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/anomalies/README.md
5 -sidebar_url: Anomalies
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/anomalies/README.md"
5 +sidebar_url: "Anomalies"
6 +sidebar_label: "anomalies"
7 +learn_status: "Unpublished"
8 +learn_topic_type: "References"
9 +learn_rel_path: "References/Collectors references/Misc"
10 -->
11
12 # Anomaly detection with Netdata
collectors/python.d.plugin/beanstalk/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Beanstalk monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/beanstalk/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/beanstalk/README.md"
4 sidebar_label: "Beanstalk"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Message brokers"
8 -->
9
10 # Beanstalk monitoring with Netdata
collectors/python.d.plugin/bind_rndc/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "ISC Bind monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/bind_rndc/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/bind_rndc/README.md"
4 sidebar_label: "ISC Bind"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # ISC Bind monitoring with Netdata
collectors/python.d.plugin/boinc/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "BOINC monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/boinc/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/boinc/README.md"
4 sidebar_label: "BOINC"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Distributed computing"
8 -->
9
10 # BOINC monitoring with Netdata
collectors/python.d.plugin/ceph/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "CEPH monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ceph/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ceph/README.md"
4 sidebar_label: "CEPH"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Storage"
8 -->
9
10 # CEPH monitoring with Netdata
collectors/python.d.plugin/changefinder/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Online change point detection with Netdata"
3 description: "Use ML-driven change point detection to narrow your focus and shorten root cause analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/changefinder/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/changefinder/README.md"
5 +sidebar_label: "changefinder"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Collectors references/QoS"
9 -->
10
11 # Online changepoint detection with Netdata
collectors/python.d.plugin/dovecot/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Dovecot monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/dovecot/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/dovecot/README.md"
4 sidebar_label: "Dovecot"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # Dovecot monitoring with Netdata
collectors/python.d.plugin/example/README.md
+6 -2
@@ -1,6 +1,10 @@
1 <!--
2 -title: "Example"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/example/README.md
2 +title: "Example module in Python"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/example/README.md"
4 +sidebar_label: "Example module in Python"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Mock Collectors"
8 -->
9
10 # Example
collectors/python.d.plugin/exim/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Exim monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/exim/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/exim/README.md"
4 sidebar_label: "Exim"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # Exim monitoring with Netdata
collectors/python.d.plugin/fail2ban/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Fail2ban monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/fail2ban/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/fail2ban/README.md"
4 sidebar_label: "Fail2ban"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Apps"
8 -->
9
10 # Fail2ban monitoring with Netdata
collectors/python.d.plugin/gearman/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Gearman monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/gearman/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/gearman/README.md"
4 sidebar_label: "Gearman"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Distributed computing"
8 -->
9
10 # Gearman monitoring with Netdata
collectors/python.d.plugin/go_expvar/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Go applications monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/go_expvar/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/go_expvar/README.md"
4 sidebar_label: "Go applications"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Application Performance Monitoring"
8 -->
9
10 # Go applications monitoring with Netdata
collectors/python.d.plugin/haproxy/README.md
+5 -2
@@ -1,7 +1,10 @@
1 <!--
2 title: "HAProxy monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/haproxy/README.md
4 -sidebar_label: "HAProxy"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/haproxy/README.md"
4 +sidebar_label: "haproxy-python.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # HAProxy monitoring with Netdata
collectors/python.d.plugin/hddtemp/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Hard drive temperature monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hddtemp/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hddtemp/README.md"
4 sidebar_label: "Hard drive temperature"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Hardware"
8 -->
9
10 # Hard drive temperature monitoring with Netdata
collectors/python.d.plugin/hpssa/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "HP Smart Storage Arrays monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hpssa/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hpssa/README.md"
4 sidebar_label: "HP Smart Storage Arrays"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Storage"
8 -->
9
10 # HP Smart Storage Arrays monitoring with Netdata
collectors/python.d.plugin/icecast/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Icecast monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/icecast/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/icecast/README.md"
4 sidebar_label: "Icecast"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Networking"
8 -->
9
10 # Icecast monitoring with Netdata
collectors/python.d.plugin/ipfs/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "IPFS monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ipfs/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ipfs/README.md"
4 sidebar_label: "IPFS"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Storage"
8 -->
9
10 # IPFS monitoring with Netdata
collectors/python.d.plugin/litespeed/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "LiteSpeed monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/litespeed/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/litespeed/README.md"
4 sidebar_label: "LiteSpeed"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Application Performance Monitoring"
8 -->
9
10 # LiteSpeed monitoring with Netdata
collectors/python.d.plugin/megacli/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "MegaRAID controller monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/megacli/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/megacli/README.md"
4 sidebar_label: "MegaRAID controllers"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Devices"
8 -->
9
10 # MegaRAID controller monitoring with Netdata
collectors/python.d.plugin/memcached/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Memcached monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/memcached/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/memcached/README.md"
4 sidebar_label: "Memcached"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Databases"
8 -->
9
10 # Memcached monitoring with Netdata
collectors/python.d.plugin/monit/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Monit monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/monit/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/monit/README.md"
4 sidebar_label: "Monit"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Storage"
8 -->
9
10 # Monit monitoring with Netdata
collectors/python.d.plugin/nsd/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "NSD monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nsd/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nsd/README.md"
4 sidebar_label: "NSD"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Networking"
8 -->
9
10 # NSD monitoring with Netdata
collectors/python.d.plugin/ntpd/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "NTP daemon monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ntpd/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ntpd/README.md"
4 sidebar_label: "NTP daemon"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Qos"
8 -->
9
10 # NTP daemon monitoring with Netdata
collectors/python.d.plugin/nvidia_smi/README.md
+5 -2
@@ -1,7 +1,10 @@
1 <!--
2 title: "Nvidia GPU monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nvidia_smi/README.md
4 -sidebar_label: "Nvidia GPUs"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nvidia_smi/README.md"
4 +sidebar_label: "nvidia_smi-python.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Devices"
8 -->
9
10 # Nvidia GPU monitoring with Netdata
collectors/python.d.plugin/openldap/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "OpenLDAP monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/openldap/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/openldap/README.md"
4 sidebar_label: "OpenLDAP"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Networking"
8 -->
9
10 # OpenLDAP monitoring with Netdata
collectors/python.d.plugin/oracledb/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "OracleDB monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/oracledb/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/oracledb/README.md"
4 sidebar_label: "OracleDB"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Databases"
8 -->
9
10 # OracleDB monitoring with Netdata
collectors/python.d.plugin/postfix/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Postfix monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/postfix/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/postfix/README.md"
4 sidebar_label: "Postfix"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # Postfix monitoring with Netdata
collectors/python.d.plugin/proxysql/README.md
+5 -2
@@ -1,7 +1,10 @@
1 <!--
2 title: "ProxySQL monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/proxysql/README.md
4 -sidebar_label: "ProxySQL"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/proxysql/README.md"
4 +sidebar_label: "proxysql-python.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Databases"
8 -->
9
10 # ProxySQL monitoring with Netdata
collectors/python.d.plugin/puppet/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Puppet monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/puppet/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/puppet/README.md"
4 sidebar_label: "Puppet"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Provisioning tools"
8 -->
9
10 # Puppet monitoring with Netdata
collectors/python.d.plugin/rabbitmq/README.md
+5 -2
@@ -1,7 +1,10 @@
1 <!--
2 title: "RabbitMQ monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rabbitmq/README.md
4 -sidebar_label: "RabbitMQ"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rabbitmq/README.md"
4 +sidebar_label: "rabbitmq-python.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Message brokers"
8 -->
9
10 # RabbitMQ monitoring with Netdata
collectors/python.d.plugin/rethinkdbs/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "RethinkDB monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rethinkdbs/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rethinkdbs/README.md"
4 sidebar_label: "RethinkDB"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Databases"
8 -->
9
10 # RethinkDB monitoring with Netdata
collectors/python.d.plugin/retroshare/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "RetroShare monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/retroshare/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/retroshare/README.md"
4 sidebar_label: "RetroShare"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Apm"
8 -->
9
10 # RetroShare monitoring with Netdata
collectors/python.d.plugin/riakkv/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Riak KV monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/riakkv/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/riakkv/README.md"
4 sidebar_label: "Riak KV"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Databases"
8 -->
9
10 # Riak KV monitoring with Netdata
collectors/python.d.plugin/samba/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Samba monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/samba/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/samba/README.md"
4 sidebar_label: "Samba"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Apps"
8 -->
9
10 # Samba monitoring with Netdata
collectors/python.d.plugin/sensors/README.md
+5 -2
@@ -1,7 +1,10 @@
1 <!--
2 title: "Linux machine sensors monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/sensors/README.md
4 -sidebar_label: "Linux machine sensors"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/sensors/README.md"
4 +sidebar_label: "sensors-python.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Devices"
8 -->
9
10 # Linux machine sensors monitoring with Netdata
collectors/python.d.plugin/smartd_log/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Storage devices monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/smartd_log/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/smartd_log/README.md"
4 sidebar_label: "S.M.A.R.T. attributes"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Devices"
8 -->
9
10 # Storage devices monitoring with Netdata
collectors/python.d.plugin/spigotmc/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "SpigotMC monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/spigotmc/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/spigotmc/README.md"
4 sidebar_label: "SpigotMC"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # SpigotMC monitoring with Netdata
collectors/python.d.plugin/squid/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Squid monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/squid/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/squid/README.md"
4 sidebar_label: "Squid"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # Squid monitoring with Netdata
collectors/python.d.plugin/tomcat/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Apache Tomcat monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tomcat/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tomcat/README.md"
4 sidebar_label: "Tomcat"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # Apache Tomcat monitoring with Netdata
collectors/python.d.plugin/tor/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Tor monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tor/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tor/README.md"
4 sidebar_label: "Tor"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Apps"
8 -->
9
10 # Tor monitoring with Netdata
collectors/python.d.plugin/traefik/README.md
+5 -2
@@ -1,7 +1,10 @@
1 <!--
2 title: "Traefik monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/traefik/README.md
4 -sidebar_label: "Traefik"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/traefik/README.md"
4 +sidebar_label: "traefik-python.d.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # Traefik monitoring with Netdata
collectors/python.d.plugin/uwsgi/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "uWSGI monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/uwsgi/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/uwsgi/README.md"
4 sidebar_label: "uWSGI"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # uWSGI monitoring with Netdata
collectors/python.d.plugin/varnish/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "Varnish Cache monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/varnish/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/varnish/README.md"
4 sidebar_label: "Varnish Cache"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Webapps"
8 -->
9
10 # Varnish Cache monitoring with Netdata
collectors/python.d.plugin/w1sensor/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "1-Wire Sensors monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/w1sensor/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/w1sensor/README.md"
4 sidebar_label: "1-Wire sensors"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Remotes/Devices"
8 -->
9
10 # 1-Wire Sensors monitoring with Netdata
collectors/python.d.plugin/zscores/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "zscores"
3 description: "Use statistical anomaly detection to narrow your focus and shorten root cause analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/zscores/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/zscores/README.md"
5 +sidebar_label: "zscores"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Collectors references/Uncategorized"
9 -->
10
11 # Z-Scores - basic anomaly detection for your key metrics and charts
collectors/slabinfo.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "slabinfo.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md"
4 +sidebar_label: "slabinfo.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/System metrics"
8 -->
9
10 # slabinfo.plugin
collectors/statsd.plugin/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "statsd.plugin"
3 description: "The Netdata Agent is a fully-featured StatsD server that collects metrics from any custom application and visualizes them in real-time."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/README.md"
5 +sidebar_label: "statsd.plugin"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Collectors references/Apm"
9 -->
10
11 StatsD is a system to collect data from any application. Applications send metrics to it, usually via non-blocking UDP communication, and StatsD servers collect these metrics, perform a few simple calculations on them and push them to backend time-series databases.
collectors/statsd.plugin/asterisk.md
+4 -2
@@ -1,8 +1,10 @@
1 <!--
2 title: "Asterisk monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/asterisk.md
4 -
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/asterisk.md"
4 sidebar_label: "Asterisk"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Apm/Statsd"
8 -->
9
10 # Asterisk monitoring with Netdata
collectors/statsd.plugin/k6.md
+4 -2
@@ -1,8 +1,10 @@
1 <!--
2 title: "K6 load test monitoring with Netdata"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/k6.md
4 -
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/k6.md"
4 sidebar_label: "K6 Load Testing"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Apm/Statsd"
8 -->
9
10 # K6 Load Testing monitoring with Netdata
collectors/tc.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "tc.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md"
4 +sidebar_label: "tc.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Networking"
8 -->
9
10 # tc.plugin
collectors/timex.plugin/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "timex.plugin"
3 description: "Monitor the system clock synchronization state."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/timex.plugin/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/timex.plugin/README.md"
5 +sidebar_label: "timex.plugin"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Collectors references/System metrics"
9 -->
10
11 # timex.plugin
collectors/xenstat.plugin/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "xenstat.plugin"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/xenstat.plugin/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/xenstat.plugin/README.md"
4 +sidebar_label: "xenstat.plugin"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references/Virtualized environments/Virtualize hosts"
8 -->
9
10 # xenstat.plugin
contribution-guidelines.md new
+773
@@ -0,0 +1,773 @@
1 +# Docs Development Guidelines
2 +
3 +Welcome to our docs developer guidelines!
4 +
5 +We store documentation related to Netdata inside of the [`netdata/netdata` repository](https://github.com/netdata/netdata) on GitHub.
6 +
7 +The Netdata team aggregates and publishes all documentation at [learn.netdata.cloud](/) using
8 +[Docusaurus](https://v2.docusaurus.io/) over at the [`netdata/learn` repository](https://github.com/netdata/learn).
9 +
10 +## Before you get started
11 +
12 +Anyone interested in contributing to documentation should first read the [Netdata style guide](#styling-guide) further down below and the [Netdata Community Code of Conduct](/contribute/code-of-conduct).
13 +
14 +Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on creating paragraphs, styled text, lists, tables, and more, and read further down about some special occasions [while writing in MDX](#mdx-and-markdown).
15 +
16 +### Netdata's Documentation structure
17 +
18 +Netdata's documentation is separated into 5 categories.
19 +
20 +- **Getting Started**: This section’s purpose is to present “What is Netdata” and for whom is it for while also presenting all the ways Netdata can be deployed. That includes Netdata’s platform support, Standalone deployment, Parent-child deployments, deploying on Kubernetes and also deploying on IoT nodes.
21 + - Stored in **WIP**
22 + - Published in **WIP**
23 +- **Concepts**: This section’s purpose is to take a pitch on all the aspects of Netdata. We present the functionality of each component/idea and support it with examples but we don’t go deep into technical details.
24 + - Stored in the `/docs/concepts` directory in the `netdata/netdata` repository.
25 + - Published in **WIP**
26 +- **Tasks**: This section's purpose is to break down any operation into a series of fundamental tasks for the Netdata solution.
27 + - Stored in the `/docs/tasks` directory in the `netdata/netdata` repository.
28 + - Published in **WIP**
29 +- **References**: This section’s purpose is to explain thoroughly every part of Netdata. That covers settings, configurations and so on.
30 + - Stored near the component they refer to.
31 + - Published in **WIP**
32 +- **Collectors References**: This section’s purpose is to explain thoroughly every collector that Netdata supports and it's configuration options.
33 + - Stored in stored near the collector they refer to.
34 + - Published in **WIP**
35 +
36 +## How to contribute
37 +
38 +The easiest way to contribute to Netdata's documentation is to edit a file directly on GitHub. This is perfect for small fixes to a single document, such as fixing a typo or clarifying a confusing sentence.
39 +
40 +Click on the **Edit this page** button on any published document on [Netdata Learn](https://learn.netdata.cloud). Each
41 +page has two of these buttons: One beneath the table of contents, and another at the end of the document, which take you
42 +to GitHub's code editor. Make your suggested changes, keeping the [Netdata style guide](#styling-guide)
43 +in mind, and use the ***Preview changes*** button to ensure your Markdown syntax works as expected.
44 +
45 +Under the **Commit changes** header, write descriptive title for your requested change. Click the **Commit changes**
46 +button to initiate your pull request (PR).
47 +
48 +Jump down to our instructions on [PRs](#making-a-pull-request) for your next steps.
49 +
50 +### Edit locally
51 +
52 +Editing documentation locally is the preferred method for complex changes that span multiple documents or change the documentation's style or structure.
53 +
54 +Create a fork of the Netdata Agent repository by visit the [Netdata repository](https://github.com/netdata/netdata) and clicking on the **Fork** button.
55 +
56 +GitHub will ask you where you want to clone the repository. When finished, you end up at the index of your forked Netdata Agent repository. Clone your fork to your local machine:
57 +
58 +```bash
59 +git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git
60 +```
61 +
62 +Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping the [Netdata style guide](/contribute/style-guide) in mind. Add, commit, and push changes to your fork. When you're finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull request based on the changes you made in the new branch of your fork.
63 +
64 +### Making a pull request
65 +
66 +Pull requests (PRs) should be concise and informative. See our [PR guidelines](/contribute/handbook#pr-guidelines) for specifics.
67 +
68 +- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50 characters.
69 +- The description should explain what was changed and why. Verify that you tested any code or processes that you are trying to change.
70 +
71 +The Netdata team will review your PR and assesses it for correctness, conciseness, and overall quality. We may point to specific sections and ask for additional information or other fixes.
72 +
73 +After merging your PR, the Netdata team rebuilds the [documentation site](https://learn.netdata.cloud) to publish the changed documentation.
74 +
75 +## Writing Docs
76 +
77 +We have three main types of Docs: **References**, **Concepts** and **Tasks**.
78 +
79 +### Metadata Tags
80 +
81 +
82 +All of the Docs however have what we call "metadata" tags. these help to organize the document upon publishing.
83 +
84 +So let's go through the different necessary metadata tags to get a document properly published on Learn:
85 +
86 +- Docusaurus Specific:\
87 +These metadata tags are parsed automatically by Docusaurus and are rendered in the published document. **Note**: Netdata only uses the Docusaurus metadata tags releveant for our documentation infrastructure.
88 + - `title: "The title of the document"` : Here we specify the title of our document, which is going to be converted to the heading of the published page.
89 + - `description: "The description of the file"`: Here we give a description of what this file is about.
90 + - `custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md`: Here is an example of the link that the user will be redirected to if he clicks the "Edit this page button", as you see it leads directly to the edit page of the source file.
91 +- Netdata Learn specific:
92 + - `learn_status: "..."`
93 + - The options for this tag are:
94 + - `"published"`
95 + - `"unpublished"`
96 + - `learn_topic_type: "..."`
97 + - The options for this tag are:
98 + - `"Getting Started"`
99 + - `"Concepts"`
100 + - `"Tasks"`
101 + - `"References"`
102 + - `"Collectors References"`
103 + - This is the Topic that the file belongs to, and this is going to resemble the start directory of the file's path on Learn for example if we write `"Concepts"` in the field, then the file is going to be placed under `/Concepts/....` inside Learn.
104 + - `learn_rel_path: "/example/"`
105 + - This tag represents the rest of the path, without the filename in the end, so in this case if the file is a Concept, it would go under `Concepts/example/filename.md`. If you want to place the file under the "root" topic folder, input `"/"`.
106 + - ⚠️ In case any of these "Learn" tags are missing or falsely inputted the file will remain unpublished. This is by design to prevent non-properly tagged files from getting published.
107 +
108 +While Docusaurus can make use of more metadata tags than the above, these are the minimum we require to publish the file on Learn.
109 +
110 +### Doc Templates
111 +
112 +These are the templates we use for our Documentation files:
113 +
114 +<details>
115 +<summary>Reference Docs</summary>
116 +
117 +The template that is used for Reference files is:
118 +
119 +```
120 + <!--
121 + title: "Apache monitoring with Netdata"
122 + description: "Monitor the health and performance of Apache web servers with zero configuration, per-second metric granularity, and interactive visualizations."
123 + custom_edit_url: https://github.com/netdata/go.d.plugin/edit/master/modules/apache/README.md
124 + learn_topic_type: "Collector References"
125 + learn_rel_path: "/sample_category"
126 + learn_status: "published"
127 + -->
128 +```
129 +
130 +## Configuration files
131 +
132 +### Data collection
133 +
134 +```
135 +go.d/apache.conf
136 +```
137 +
138 +To make changes, see `the ./edit-config task <link>`
139 +
140 +### Alerts
141 +
142 +none
143 +
144 +## Requirements to run this module
145 +
146 +- none
147 +
148 +## Requirement on the monitored application
149 +
150 +- `Apache` with enabled [`mod_status`](https://httpd.apache.org/docs/2.4/mod/mod_status.html)
151 +
152 +## Auto detection
153 +
154 +### Single node installation
155 +
156 +. . . we autodetect localhost:port and what configurations are defaults
157 +
158 +### Kubernetes installations
159 +
160 +. . . Service discovery, click here
161 +
162 +## Metrics
163 +
164 +Columns: Context | description (of the context) | units (of the context) | dimensions | alerts
165 +
166 +- Requests in `requests/s`
167 +- Connections in `connections`
168 +- Async Connections in `connections`
169 +- Scoreboard in `connections`
170 +- Bandwidth in `kilobits/s`
171 +- Workers in `workers`
172 +- Lifetime Average Number Of Requests Per Second in `requests/s`
173 +- Lifetime Average Number Of Bytes Served Per Second in `KiB/s`
174 +- Lifetime Average Response Size in `KiB`
175 +
176 +### Labels
177 +
178 +just like <https://github.com/netdata/go.d.plugin/tree/master/modules/k8s_state#labels>
179 +
180 +## Alerts
181 +
182 +collapsible content for every alert, just like the alert guides
183 +
184 +## Configuration options
185 +
186 +Table with all the configuration options available.
187 +
188 +Columns: name | description | default
189 +
190 +## Configuration example
191 +
192 +Needs only `url` to server's `server-status?auto`. Here is an example for 2 servers:
193 +
194 +```yaml
195 +jobs:
196 +- name: local
197 + url: http://127.0.0.1/server-status?auto
198 +- name: remote
199 + url: http://203.0.113.10/server-status?auto
200 +```
201 +
202 +For all available options please see
203 +module [configuration file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/apache.conf).
204 +
205 +## Troubleshoot
206 +
207 +backlink to the task to run this module in debug mode
208 +
209 +</details>
210 +
211 +<details>
212 +<summary>Task Docs</summary>
213 +
214 +The template that is used for Task files is:
215 +
216 +```
217 + <!--
218 + title: "Task title"
219 + description: "Task description"
220 + custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Tasks/sampletask.md
221 + learn_topic_type: "Tasks"
222 + learn_rel_path: "/sample_category"
223 + learn_status: "published"
224 + -->
225 +```
226 +
227 +## Description
228 +
229 +A small description of the Task.
230 +
231 +## Prerequisites
232 +
233 +Describe all the information that the user needs to know before proceeding with the task.
234 +
235 +## Context
236 +
237 +Describe the background information of the Task, the purpose of the Task, and what will the user achieve by completing it.
238 +
239 +## Steps
240 +
241 +A task consists of steps, here provide the actions needed from the user, so he can complete the task correctly.
242 +
243 +## Result
244 +
245 +Describe the expected output/ outcome of the result.
246 +
247 +## Example
248 +
249 +Provide any examples needed for the Task
250 +
251 +</details>
252 +
253 +<details>
254 +<summary>Concept Docs</summary>
255 +
256 +The template of the Concept files is:
257 +
258 +```
259 + <!--
260 + title: "Concept title"
261 + description: "Concept description"
262 + custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Concepts/sampleconcept.md
263 + learn_topic_type: "Concepts"
264 + learn_rel_path: "/sample_category"
265 + learn_status: "published"
266 + -->
267 +```
268 +
269 +## Description
270 +
271 +In our concepts we have a more loose structure, the goal is to communicate the "concept" to the user, starting with simple language that even a new user can understand, and building from there.
272 +
273 +</details>
274 +
275 +## Styling Guide
276 +
277 +The *Netdata style guide* establishes editorial guidelines for any writing produced by the Netdata team or the Netdata
278 +community, including documentation, articles, in-product UX copy, and more. Both internal Netdata teams and external
279 +contributors to any of Netdata's open-source projects should reference and adhere to this style guide as much as
280 +possible.
281 +
282 +Netdata's writing should **empower** and **educate**. You want to help people understand Netdata's value, encourage them
283 +to learn more, and ultimately use Netdata's products to democratize monitoring in their organizations. To achieve these
284 +goals, your writing should be:
285 +
286 +- **Clear**. Use simple words and sentences. Use strong, direct, and active language that encourages readers to action.
287 +- **Concise**. Provide solutions and answers as quickly as possible. Give users the information they need right now,
288 + along with opportunities to learn more.
289 +- **Universal**. Think of yourself as a guide giving a tour of Netdata's products, features, and capabilities to a
290 + diverse group of users. Write to reach the widest possible audience.
291 +
292 +You can achieve these goals by reading and adhering to the principles outlined below.
293 +
294 +## Voice and tone
295 +
296 +One way we write empowering, educational content is by using a consistent voice and an appropriate tone.
297 +
298 +*Voice* is like your personality, which doesn't really change day to day.
299 +
300 +*Tone* is how you express your personality. Your expression changes based on your attitude or mood, or based on who
301 +you're around. In writing, your reflect tone in your word choice, punctuation, sentence structure, or even the use of
302 +emoji.
303 +
304 +The same idea about voice and tone applies to organizations, too. Our voice shouldn't change much between two pieces of
305 +content, no matter who wrote each, but the tone might be quite different based on who we think is reading.
306 +
307 +For example, a [blog post](https://www.netdata.cloud/blog/) and a [press release](https://www.netdata.cloud/news/)
308 +should have a similar voice, despite most often being written by different people. However, blog posts are relaxed and
309 +witty, while press releases are focused and academic. You won't see any emoji in a press release.
310 +
311 +### Voice
312 +
313 +Netdata's voice is authentic, passionate, playful, and respectful.
314 +
315 +- **Authentic** writing is honest and fact-driven. Focus on Netdata's strength while accurately communicating what
316 + Netdata can and cannot do, and emphasize technical accuracy over hard sells and marketing jargon.
317 +- **Passionate** writing is strong and direct. Be a champion for the product or feature you're writing about, and let
318 + your unique personality and writing style shine.
319 +- **Playful** writing is friendly, thoughtful, and engaging. Don't take yourself too seriously, as long as it's not at
320 + the expense of Netdata or any of its users.
321 +- **Respectful** writing treats people the way you want to be treated. Prioritize giving solutions and answers as
322 + quickly as possible.
323 +
324 +### Tone
325 +
326 +Netdata's tone is fun and playful, but clarity and conciseness comes first. We also tend to be informal, and aren't
327 +afraid of a playful joke or two.
328 +
329 +While we have general standards for voice and tone, we do want every individual's unique writing style to reflect in
330 +published content.
331 +
332 +## Universal communication
333 +
334 +Netdata is a global company in every sense, with employees, contributors, and users from around the world. We strive to
335 +communicate in a way that is clear and easily understood by everyone.
336 +
337 +Here are some guidelines, pointers, and questions to be aware of as you write to ensure your writing is universal. Some
338 +of these are expanded into individual sections in the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
339 +
340 +- Would this language make sense to someone who doesn't work here?
341 +- Could someone quickly scan this document and understand the material?
342 +- Create an information hierarchy with key information presented first and clearly called out to improve scannability.
343 +- Avoid directional language like "sidebar on the right of the page" or "header at the top of the page" since
344 + presentation elements may adapt for devices.
345 +- Use descriptive links rather than "click here" or "learn more".
346 +- Include alt text for images and image links.
347 +- Ensure any information contained within a graphic element is also available as plain text.
348 +- Avoid idioms that may not be familiar to the user or that may not make sense when translated.
349 +- Avoid local, cultural, or historical references that may be unfamiliar to users.
350 +- Prioritize active, direct language.
351 +- Avoid referring to someone's age unless it is directly relevant; likewise, avoid referring to people with age-related
352 + descriptors like "young" or "elderly."
353 +- Avoid disability-related idioms like "lame" or "falling on deaf ears." Don't refer to a person's disability unless
354 + it’s directly relevant to what you're writing.
355 +- Don't call groups of people "guys." Don't call women "girls."
356 +- Avoid gendered terms in favor of neutral alternatives, like "server" instead of "waitress" and "businessperson"
357 + instead of "businessman."
358 +- When writing about a person, use their communicated pronouns. When in doubt, just ask or use their name. It's OK to
359 + use "they" as a singular pronoun.
360 +
361 +> Some of these guidelines were adapted from MailChimp under the Creative Commons license.
362 +
363 +## Language, grammar, and mechanics
364 +
365 +To ensure Netdata's writing is clear, concise, and universal, we have established standards for language, grammar, and
366 +certain writing mechanics. However, if you're writing about Netdata for an external publication, such as a guest blog
367 +post, follow that publication's style guide or standards, while keeping the [preferred spelling of Netdata
368 +terms](#netdata-specific-terms) in mind.
369 +
370 +### Active voice
371 +
372 +Active voice is more concise and easier to understand compared to passive voice. When using active voice, the subject of
373 +the sentence is action. In passive voice, the subject is acted upon. A famous example of passive voice is the phrase
374 +"mistakes were made."
375 +
376 +| | |
377 +| --------------- | ----------------------------------------------------------------------------------------- |
378 +| Not recommended | When an alarm is triggered by a metric, a notification is sent by Netdata. |
379 +| **Recommended** | When a metric triggers an alarm, Netdata sends a notification to your preferred endpoint. |
380 +
381 +### Second person
382 +
383 +Use the second person ("you") to give instructions or "talk" directly to users.
384 +
385 +In these situations, avoid "we," "I," "let's," and "us," particularly in documentation. The "you" pronoun can also be
386 +implied, depending on your sentence structure.
387 +
388 +One valid exception is when a member of the Netdata team or community wants to write about said team or community.
389 +
390 +| | |
391 +| ------------------------------ | ------------------------------------------------------------ |
392 +| Not recommended | To install Netdata, we should try the one-line installer... |
393 +| **Recommended** | To install Netdata, you should try the one-line installer... |
394 +| **Recommended**, implied "you" | To install Netdata, try the one-line installer... |
395 +
396 +### "Easy" or "simple"
397 +
398 +Using words that imply the complexity of a task or feature goes against our policy of [universal
399 +communication](#universal-communication). If you claim that a task is easy and the reader struggles to complete it, you
400 +may inadvertently discourage them.
401 +
402 +However, if you give users two options and want to relay that one option is genuinely less complex than another, be
403 +specific about how and why.
404 +
405 +For example, don't write, "Netdata's one-line installer is the easiest way to install Netdata." Instead, you might want
406 +to say, "Netdata's one-line installer requires fewer steps than manually installing from source."
407 +
408 +### Slang, metaphors, and jargon
409 +
410 +A particular word, phrase, or metaphor you're familiar with might not translate well to the other cultures featured
411 +among Netdata's global community. We recommended you avoid slang or colloquialisms in your writing.
412 +
413 +In addition, don't use abbreviations that have not yet been defined in the content. See our section on
414 +[abbreviations](#abbreviations-acronyms-and-initialisms) for additional guidance.
415 +
416 +If you must use industry jargon, such as "mean time to resolution," define the term as clearly and concisely as you can.
417 +
418 +> Netdata helps you reduce your organization's mean time to resolution (MTTR), which is the average time the responsible
419 +> team requires to repair a system and resolve an ongoing incident.
420 +
421 +### Spelling
422 +
423 +While the Netdata team is mostly *not* American, we still aspire to use American spelling whenever possible, as it is
424 +the standard for the monitoring industry.
425 +
426 +See the [word list](#word-list) for spellings of specific words.
427 +
428 +### Capitalization
429 +
430 +Follow the general [English standards](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for
431 +capitalization. In summary:
432 +
433 +- Capitalize the first word of every new sentence.
434 +- Don't use uppercase for emphasis. (Netdata is the BEST!)
435 +- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
436 + Docker, Apache, NGINX)
437 +- Avoid camel case (NetData) or all caps (NETDATA).
438 +
439 +Whenever you refer to the company Netdata, Inc., or the open-source monitoring agent the company develops, capitalize
440 +**Netdata**.
441 +
442 +However, if you are referring to a process, user, or group on a Linux system, use lowercase and fence the word in an
443 +inline code block: `` `netdata` ``.
444 +
445 +| | |
446 +| --------------- | ---------------------------------------------------------------------------------------------- |
447 +| Not recommended | The netdata agent, which spawns the netdata process, is actively maintained by netdata, inc. |
448 +| **Recommended** | The Netdata Agent, which spawns the `netdata` process, is actively maintained by Netdata, Inc. |
449 +
450 +#### Capitalization of document titles and page headings
451 +
452 +Document titles and page headings should use sentence case. That means you should only capitalize the first word.
453 +
454 +If you need to use the name of a brand, software, product, and company, capitalize it according to their official
455 +guidelines.
456 +
457 +Also, don't put a period (`.`) or colon (`:`) at the end of a title or header.
458 +
459 +| | |
460 +| --------------- | --------------------------------------------------------------------------------------------------- |
461 +| Not recommended | Getting Started Guide <br />Service Discovery and Auto-Detection: <br />Install netdata with docker |
462 +| **Recommended** | Getting started guide <br />Service discovery and auto-detection <br />Install Netdata with Docker |
463 +
464 +### Abbreviations (acronyms and initialisms)
465 +
466 +Use abbreviations (including [acronyms and initialisms](https://www.dictionary.com/e/acronym-vs-abbreviation/)) in
467 +documentation when one exists, when it's widely accepted within the monitoring/sysadmin community, and when it improves
468 +the readability of a document.
469 +
470 +When introducing an abbreviation to a document for the first time, give the reader both the spelled-out version and the
471 +shortened version at the same time. For example:
472 +
473 +> Use Netdata to monitor Extended Berkeley Packet Filter (eBPF) metrics in real-time.
474 +After you define an abbreviation, don't switch back and forth. Use only the abbreviation for the rest of the document.
475 +
476 +You can also use abbreviations in a document's title to keep the title short and relevant. If you do this, you should
477 +still introduce the spelled-out name alongside the abbreviation as soon as possible.
478 +
479 +### Clause order
480 +
481 +When instructing users to take action, give them the context first. By placing the context in an initial clause at the
482 +beginning of the sentence, users can immediately know if they want to read more, follow a link, or skip ahead.
483 +
484 +| | |
485 +| --------------- | ------------------------------------------------------------------------------ |
486 +| Not recommended | Read the reference guide if you'd like to learn more about custom dashboards. |
487 +| **Recommended** | If you'd like to learn more about custom dashboards, read the reference guide. |
488 +
489 +### Oxford comma
490 +
491 +The Oxford comma is the comma used after the second-to-last item in a list of three or more items. It appears just
492 +before "and" or "or."
493 +
494 +| | |
495 +| --------------- | ---------------------------------------------------------------------------- |
496 +| Not recommended | Netdata can monitor RAM, disk I/O, MySQL queries per second and lm-sensors. |
497 +| **Recommended** | Netdata can monitor RAM, disk I/O, MySQL queries per second, and lm-sensors. |
498 +
499 +### Future releases or features
500 +
501 +Do not mention future releases or upcoming features in writing unless they have been previously communicated via a
502 +public roadmap.
503 +
504 +In particular, documentation must describe, as accurately as possible, the Netdata Agent _as of the [latest
505 +commit](https://github.com/netdata/netdata/commits/master) in the GitHub repository_. For Netdata Cloud, documentation
506 +must reflect the *current state* of [production](https://app.netdata.cloud).
507 +
508 +### Informational links
509 +
510 +Every link should clearly state its destination. Don't use words like "here" to describe where a link will take your
511 +reader.
512 +
513 +| | |
514 +| --------------- | ------------------------------------------------------------------------------------------ |
515 +| Not recommended | To install Netdata, click [here](/docs/agent/packaging/installer). |
516 +| **Recommended** | To install Netdata, read the [installation instructions](/docs/agent/packaging/installer). |
517 +
518 +Use links as often as required to provide necessary context. Blog posts and guides require less hyperlinks than
519 +documentation. See the section on [linking between documentation](#linking-between-documentation) for guidance on the
520 +Markdown syntax and path structure of inter-documentation links.
521 +
522 +### Contractions
523 +
524 +Contractions like "you'll" or "they're" are acceptable in most Netdata writing. They're both authentic and playful, and
525 +reinforce the idea that you, as a writer, are guiding users through a particular idea, process, or feature.
526 +
527 +Contractions are generally not used in press releases or other media engagements.
528 +
529 +### Emoji
530 +
531 +Emoji can add fun and character to your writing, but should be used sparingly and only if it matches the content's tone
532 +and desired audience.
533 +
534 +### Switching Linux users
535 +
536 +Netdata documentation often suggests that users switch from their normal user to the `netdata` user to run specific
537 +commands. Use the following command to instruct users to make the switch:
538 +
539 +```bash
540 +sudo su -s /bin/bash netdata
541 +```
542 +
543 +### Hostname/IP address of a node
544 +
545 +Use `NODE` instead of an actual or example IP address/hostname when referencing the process of navigating to a dashboard
546 +or API endpoint in a browser.
547 +
548 +| | |
549 +| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
550 +| Not recommended | Navigate to `http://example.com:19999` in your browser to see Netdata's dashboard. <br />Navigate to `http://203.0.113.0:19999` in your browser to see Netdata's dashboard. |
551 +| **Recommended** | Navigate to `http://NODE:19999` in your browser to see Netdata's dashboard. |
552 +
553 +If you worry that `NODE` doesn't provide enough context for the user, particularly in documentation or guides designed
554 +for beginners, you can provide an explanation:
555 +
556 +> With the Netdata Agent running, visit `http://NODE:19999/api/v1/info` in your browser, replacing `NODE` with the IP
557 +> address or hostname of your Agent.
558 +
559 +### Paths and running commands
560 +
561 +When instructing users to run a Netdata-specific command, don't assume the path to said command, because not every
562 +Netdata Agent installation will have commands under the same paths. When applicable, help them navigate to the correct
563 +path, providing a recommendation or instructions on how to view the running configuration, which includes the correct
564 +paths.
565 +
566 +For example, the [configuration](/docs/configure/nodes) doc first teaches users how to find the Netdata config
567 +directory and navigate to it, then runs commands from the `/etc/netdata` path so that the instructions are more
568 +universal.
569 +
570 +Don't include full paths, beginning from the system's root (`/`), as these might not work on certain systems.
571 +
572 +| | |
573 +| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
574 +| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
575 +| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](/docs/configure/nodes#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
576 +
577 +### `sudo`
578 +
579 +Include `sudo` before a command if you believe most Netdata users will need to elevate privileges to run it. This makes
580 +our writing more universal, and users on `sudo`-less systems are generally already aware that they need to run commands
581 +differently.
582 +
583 +For example, most users need to use `sudo` with the `edit-config` script, because the Netdata config directory is owned
584 +by the `netdata` user. Same goes for restarting the Netdata Agent with `systemctl`.
585 +
586 +| | |
587 +| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
588 +| Not recommended | Run `edit-config netdata.conf` to configure the Netdata Agent. <br />Run `systemctl restart netdata` to restart the Netdata Agent. |
589 +| **Recommended** | Run `sudo edit-config netdata.conf` to configure the Netdata Agent. <br />Run `sudo systemctl restart netdata` to restart the Netdata Agent. |
590 +
591 +## Markdown syntax
592 +
593 +Netdata's documentation uses Markdown syntax.
594 +
595 +If you're not familiar with Markdown, read the [Mastering
596 +Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on creating
597 +paragraphs, styled text, lists, tables, and more.
598 +
599 +The following sections describe situations in which a specific syntax is required.
600 +
601 +### Syntax standards (`remark-lint`)
602 +
603 +The Netdata team uses [`remark-lint`](https://github.com/remarkjs/remark-lint) for Markdown code styling.
604 +
605 +- Use a maximum of 120 characters per line.
606 +- Begin headings with hashes, such as `# H1 heading`, `## H2 heading`, and so on.
607 +- Use `_` for italics/emphasis.
608 +- Use `**` for bold.
609 +- Use dashes `-` to begin an unordered list, and put a single space after the dash.
610 +- Tables should be padded so that pipes line up vertically with added whitespace.
611 +
612 +If you want to see all the settings, open the
613 +[`remarkrc.js`](https://github.com/netdata/netdata/blob/master/.remarkrc.js) file in the `netdata/netdata` repository.
614 +
615 +### MDX and markdown
616 +
617 +While writing in Docusaurus, you might want to take leverage of it's features that are supported in MDX formatted files.
618 +One of those that we use is [Tabs](https://docusaurus.io/docs/next/markdown-features/tabs). They use an HTML syntax, which requires some changes in the way we write markdown inside them.
619 +
620 +In detail:
621 +
622 +Due to a bug with docusaurus, we prefer to use `<h1>heading</h1> instead of # H1` so that docusaurus doesn't render the contents of all Tabs on the right hand side, while not being able to navigate them [relative link](https://github.com/facebook/docusaurus/issues/7008).
623 +
624 +You can use markdown syntax for every other styling you want to do except Admonitions:
625 +For admonitions, follow [this](https://docusaurus.io/docs/markdown-features/admonitions#usage-in-jsx) guide to use admonitions inside JSX. While writing in JSX, all the markdown stylings have to be in HTML format to be rendered properly.
626 +
627 +### Frontmatter
628 +
629 +Every document must begin with frontmatter, followed by an H1 (`#`) heading.
630 +
631 +Unlike typical Markdown frontmatter, Netdata uses HTML comments (`<!--`, `-->`) to begin and end the frontmatter block.
632 +These HTML comments are later converted into typical frontmatter syntax when building [Netdata
633 +Learn](https://learn.netdata.cloud).
634 +
635 +Frontmatter *must* contain the following variables:
636 +
637 +- A `title` that quickly and distinctly describes the document's content.
638 +- A `description` that elaborates on the purpose or goal of the document using no less than 100 characters and no more
639 + than 155 characters.
640 +- A `custom_edit_url` that links directly to the GitHub URL where another user could suggest additional changes to the
641 + published document.
642 +
643 +Some documents, like the Ansible guide and others in the `/docs/guides` folder, require an `image` variable as well. In
644 +this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of the path to the document in question. End
645 +the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
646 +
647 +For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
648 +Ansible](/guides/deploy/ansible).
649 +
650 +```markdown
651 +<!--
652 +title: Deploy Netdata with Ansible
653 +description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
654 +image: /img/seo/guides/deploy/ansible.png
655 +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
656 +-->
657 +
658 +# Deploy Netdata with Ansible
659 +
660 +...
661 +```
662 +
663 +Questions about frontmatter in documentation? [Ask on our community
664 +forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
665 +
666 +### Admonitions
667 +
668 +In addition to basic markdown syntax, we also encourage the use of admonition syntax, which allows for a more aesthetically seamless presentation of supplemental information. For general instructions on using admonitions, feel free to read this [feature guide](https://docusaurus.io/docs/markdown-features/admonitions).
669 +
670 +We encourage the use of **Note** admonitions to provide important supplemental information to a user within a task step, reference item, or concept passage.
671 +
672 +Additionally, you should use a **Caution** admonition to provide necessary information to present any risk to a user's setup or data.
673 +
674 +**Danger** admonitions should be avoided, as these admonitions are typically applied to reduce physical or bodily harm to an individual.
675 +
676 +### Linking between documentation
677 +
678 +Documentation should link to relevant pages whenever it's relevant and provides valuable context to the reader.
679 +
680 +Links should always reference the full path to the document, beginning at the root of the Netdata Agent repository
681 +(`/`), and ending with the `.md` file extension. Avoid relative links or traversing up directories using `../`.
682 +
683 +For example, if you want to link to our node configuration document, link to `/docs/configure/nodes.md`. To reference
684 +the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`.
685 +
686 +### References to UI elements
687 +
688 +When referencing a user interface (UI) element in Netdata, reference the label text of the link/button with Markdown's
689 +(`**bold text**`) tag.
690 +
691 +```markdown
692 +Click the **Sign in** button.
693 +```
694 +
695 +Avoid directional language whenever possible. Not every user can use instructions like "look at the top-left corner" to
696 +find their way around an interface, and interfaces often change between devices. If you must use directional language,
697 +try to supplement the text with an [image](#images).
698 +
699 +### Images
700 +
701 +Don't rely on images to convey features, ideas, or instructions. Accompany every image with descriptive alt text.
702 +
703 +In Markdown, use the standard image syntax, `![](/docs/agent/contributing)`, and place the alt text between the brackets `[]`. Here's an example
704 +using our logo:
705 +
706 +```markdown
707 +![The Netdata logo](/docs/agent/web/gui/static/img/netdata-logomark.svg)
708 +```
709 +
710 +Reference in-product text, code samples, and terminal output with actual text content, not screen captures or other
711 +images. Place the text in an appropriate element, such as a blockquote or code block, so all users can parse the
712 +information.
713 +
714 +### Syntax highlighting
715 +
716 +Our documentation site at [learn.netdata.cloud](https://learn.netdata.cloud) uses
717 +[Prism](https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting) for syntax highlighting. Netdata
718 +documentation will use the following for the most part: `c`, `python`, `js`, `shell`, `markdown`, `bash`, `css`, `html`,
719 +and `go`. If no language is specified, Prism tries to guess the language based on its content.
720 +
721 +Include the language directly after the three backticks (```` ``` ````) that start the code block. For highlighting C
722 +code, for example:
723 +
724 +````c
725 +```c
726 +inline char *health_stock_config_dir(void) {
727 + char buffer[FILENAME_MAX + 1];
728 + snprintfz(buffer, FILENAME_MAX, "%s/health.d", netdata_configured_stock_config_dir);
729 + return config_get(CONFIG_SECTION_DIRECTORIES, "stock health config", buffer);
730 +}
731 +```
732 +````
733 +
734 +And the prettified result:
735 +
736 +```c
737 +inline char *health_stock_config_dir(void) {
738 + char buffer[FILENAME_MAX + 1];
739 + snprintfz(buffer, FILENAME_MAX, "%s/health.d", netdata_configured_stock_config_dir);
740 + return config_get(CONFIG_SECTION_DIRECTORIES, "stock health config", buffer);
741 +}
742 +```
743 +
744 +Prism also supports titles and line highlighting. See the [Docusaurus
745 +documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
746 +
747 +## Word list
748 +
749 +The following tables describe the standard spelling, capitalization, and usage of words found in Netdata's writing.
750 +
751 +### Netdata-specific terms
752 +
753 +| Term | Definition |
754 +| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
755 +| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](/docs/agent/claim). The claimed node will then appear in your Space and any War Rooms you added it to. |
756 +| **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use *netdata* or *NetData*. <br /><br />**Note:** You should use "Netdata" when referencing any general element, function, or part of the user experience. In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write *Learn more about enabling alarm notifications on your preferred platforms* instead of *Netdata sends alarm notifications to your preferred platforms*. |
757 +| **Netdata Agent** or **Open-source Netdata Agent** | The free and open source [monitoring agent](https://github.com/netdata/netdata) that you can install on all of your distributed systems, whether they're physical, virtual, containerized, ephemeral, and more. The Agent monitors systems running Linux, Docker, Kubernetes, macOS, FreeBSD, and more, and collects metrics from hundreds of popular services and applications. <br /><br /> **Note:** You should avoid referencing the Netdata Agent or Open-source Netdata agent in any scenario that does not specifically require the distinction for clear instructions. |
758 +| **Netdata Cloud** | The web application hosted at [https://app.netdata.cloud](https://app.netdata.cloud) that helps you monitor an entire infrastructure of distributed systems in real time. <br /><br />**Notes:** Never use *Cloud* without the preceding *Netdata* to avoid ambiguity. You should avoid referencing Netdata Cloud in any scenario that does not specifically require the distinction for clear instructions. | |
759 +| **Netdata community** | Contributors to any of Netdata's [open-source projects](/contribute/projects), members of the [community forum](https://community.netdata.cloud/). |
760 +| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
761 +| **node** | A system on which the Netdata Agent is installed. The system can be physical, virtual, in a Docker container, and more. Depending on your infrastructure, you may have one, dozens, or hundreds of nodes. Some nodes are *ephemeral*, in that they're created/destroyed automatically by an orchestrator service. |
762 +| **Space** | The highest level container within Netdata Cloud for a user to organize their team members and nodes within their infrastructure. A Space likely represents an entire organization or a large team. <br /><br />*Space* is always capitalized. |
763 +| **unreachable node** | A connected node with a disrupted [Agent-Cloud link](/docs/agent/aclk). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. |
764 +| **visited node** | A node which has had its Agent dashboard directly visited by a user. A list of these is maintained on a per-user basis. |
765 +| **War Room** | A smaller grouping of nodes where users can view key metrics in real-time and monitor the health of many nodes with their alarm status. War Rooms can be used to organize nodes in any way that makes sense for your infrastructure, such as by a service, purpose, physical location, and more. <br /><br />*War Room* is always capitalized. |
766 +
767 +### Other technical terms
768 +
769 +| Term | Definition |
770 +| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
771 +| **filesystem** | Use instead of *file system*. |
772 +| **preconfigured** | The concept that many of Netdata's features come with sane defaults that users don't need to configure to find [immediate value](/docs/overview/why-netdata#simple-to-deploy). |
773 +| **real time**/**real-time** | Use *real time* as a noun phrase, most often with *in*: *Netdata collects metrics in real time*. Use *real-time* as an adjective: _Netdata collects real-time metrics from hundreds of supported applications and services. |
daemon/README.md
+6 -2
@@ -1,7 +1,11 @@
1 <!--
2 title: "Netdata daemon"
3 -date: 2020-04-29
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/README.md
3 +date: "2020-04-29"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/daemon/README.md"
5 +sidebar_label: "Netdata daemon"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Configuration"
9 -->
10
11 # Netdata daemon
daemon/config/README.md
+6 -1
@@ -1,7 +1,12 @@
1 <!--
2 title: "Daemon configuration"
3 description: "The Netdata Agent's daemon is installed preconfigured to collect thousands of metrics every second, but is highly configurable for real-world workloads."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/config/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/daemon/config/README.md"
5 +sidebar_label: "Daemon"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Configuration"
9 +learn_doc_purpose: "Explain the daemon options, the log files, the process scheduling, virtual memory, explain how the netdata.conf is used and backlink to the netdata.conf file reference"
10 -->
11
12 # Daemon configuration
database/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Database"
3 description: "The Netdata Agent leverages multiple, user-configurable time-series databases that use RAM and/or disk to store metrics on any type of node."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/database/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/database/README.md"
5 +sidebar_label: "Database"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Database
database/engine/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Database engine"
3 description: "Netdata's highly-efficient database engine use both RAM and disk for distributed, long-term storage of per-second metrics."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/database/engine/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/database/engine/README.md"
5 +sidebar_label: "Database engine"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # DBENGINE
docs/Running-behind-apache.md
+7 -4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Netdata via apache's mod_proxy"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md"
4 +sidebar_label: "Netdata via apache's mod_proxy"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Expose local dashboard through proxy"
8 -->
9
10 # Netdata via apache's mod_proxy
@@ -35,7 +39,6 @@ Also, enable the rewrite module:
39 sudo a2enmod rewrite
40 ```
41
38 ----
42
43 ## Netdata on an existing virtual host
44
@@ -314,7 +317,7 @@ or
317 bind to = ::1
318 ```
319
317 ----
320 +
321
322 You can also use a unix domain socket. This will also provide a faster route between apache and Netdata:
323
@@ -338,7 +341,7 @@ At the apache side, prepend the 2nd argument to `ProxyPass` with `unix:/tmp/netd
341 ProxyPass "/netdata/" "unix:/tmp/netdata.sock|http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on
342 ```
343
341 ----
344 +
345
346 If your apache server is not on localhost, you can set:
347
docs/Running-behind-caddy.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "Netdata via Caddy"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-caddy.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-caddy.md"
4 +sidebar_label: "Netdata via Caddy"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Expose local dashboard through proxy"
8 -->
9
10 # Netdata via Caddy
docs/Running-behind-h2o.md
+7 -3
@@ -1,6 +1,10 @@
1 <!--
2 title: "Running Netdata behind H2O"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-h2o.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-h2o.md"
4 +sidebar_label: "Running Netdata behind H2O"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Expose local dashboard through proxy"
8 -->
9
10 # Running Netdata behind H2O
@@ -142,7 +146,7 @@ If your H2O server is on `localhost`, you can use this to ensure external access
146 bind to = 127.0.0.1 ::1
147 ```
148
145 ----
149 +
150
151 You can also use a unix domain socket. This will provide faster communication between H2O and Netdata as well:
152
@@ -157,7 +161,7 @@ In the H2O configuration, use a line like the following to connect to Netdata vi
161 proxy.reverse.url http://[unix:/run/netdata/netdata.sock]
162 ```
163
160 ----
164 +
165
166 If your H2O server is not on localhost, you can set:
167
docs/Running-behind-haproxy.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "Netdata via HAProxy"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-haproxy.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-haproxy.md"
4 +sidebar_label: "Netdata via HAProxy"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Expose local dashboard through proxy"
8 -->
9
10 # Netdata via HAProxy
docs/Running-behind-lighttpd.md
+7 -3
@@ -1,6 +1,10 @@
1 <!--
2 title: "Netdata via lighttpd v1.4.x"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-lighttpd.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-lighttpd.md"
4 +sidebar_label: "Netdata via lighttpd v1.4.x"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Expose local dashboard through proxy"
8 -->
9
10 # Netdata via lighttpd v1.4.x
@@ -27,7 +31,7 @@ $SERVER["socket"] == ":19998" {
31 }
32 ```
33
30 ----
34 +
35
36 If the only thing the server is exposing via the web is Netdata (and thus no suburl rewriting required),
37 then you can get away with just
@@ -51,7 +55,7 @@ auth.require = ( "" => ( "method" => "digest",
55
56 other auth methods, and more info on htdigest, can be found in lighttpd's [mod_auth docs](http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModAuth).
57
54 ----
58 +
59
60 It seems that lighttpd (or some versions of it), fail to proxy compressed web responses.
61 To solve this issue, disable web response compression in Netdata.
docs/Running-behind-nginx.md
+6 -3
@@ -1,6 +1,10 @@
1 <!--
2 title: "Running Netdata behind Nginx"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-nginx.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-nginx.md"
4 +sidebar_label: "Running Netdata behind Nginx"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Expose local dashboard through proxy"
8 -->
9
10 # Running Netdata behind Nginx
@@ -212,7 +216,7 @@ If your Nginx is on `localhost`, you can use this to protect your Netdata:
216 bind to = 127.0.0.1 ::1
217 ```
218
215 ----
219 +
220
221 You can also use a unix domain socket. This will also provide a faster route between Nginx and Netdata:
222
@@ -232,7 +236,6 @@ upstream backend {
236 }
237 ```
238
235 ----
239
240 If your Nginx server is not on localhost, you can set:
241
docs/cloud/alerts-notifications/notifications.mdx new
+112
@@ -0,0 +1,112 @@
1 +---
2 +title: "Alert notifications"
3 +description: "Configure Netdata Cloud to send notifications to your team whenever any node on your infrastructure triggers a pre-configured or custom alert threshold."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx"
5 +sidebar_label: "Alert notifications"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +import Callout from '@site/src/components/Callout'
12 +
13 +Netdata Cloud can send centralized alert notifications to your team whenever a node enters a warning, critical, or
14 +unreachable state. By enabling notifications, you ensure no alert, on any node in your infrastructure, goes unnoticed by
15 +you or your team.
16 +
17 +If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending
18 +you a flood protection notification. Getting one of these notifications is a good signal of health or performance issues
19 +on that node.
20 +
21 +Netdata Cloud currently supports email notifications. We're working on additional endpoints and functionality.
22 +
23 +Admins must enable alert notifications for their [Space(s)](#manage-alert-notifications-for-a-space). All users in a
24 +Space can then personalize their notifications settings from within their [account
25 +menu](#manage-alert-notifications-per-user).
26 +
27 +<Callout type="notice">
28 +
29 +Centralized alert notifications from Netdata Cloud is a independent process from [notifications from
30 +Netdata](/docs/monitor/enable-notifications). You can enable one or the other, or both, based on your needs. However,
31 +the alerts you see in Netdata Cloud are based on those streamed from your Netdata-monitoring nodes. If you want to tweak
32 +or add new alert that you see in Netdata Cloud, and receive via centralized alert notifications, you must
33 +[configure](/docs/monitor/configure-alarms) each node's alert watchdog.
34 +
35 +</Callout>
36 +
37 +## Manage alert notifications for a Space
38 +
39 +To enable notifications for a Space, click **Manage Space** in the [Space](/docs/cloud/spaces) management area.
40 +
41 +![The Manage Space
42 +button](https://user-images.githubusercontent.com/1153921/108530321-b6a52500-7292-11eb-9599-a5ba77a25094.png)
43 +
44 +In the modal, click on the **Notifications** tab. This menu option is visible only to administrators.
45 +
46 +![The Space-level management panel for alert
47 +notifications](https://user-images.githubusercontent.com/1153921/99722010-3f7eab80-2a6d-11eb-8836-547a6d243d51.png)
48 +
49 +Click on the toggle to enable or disable a notification method.
50 +
51 +## Manage alert notifications per user
52 +
53 +You, and other individual users in your Space, can also enable and disable notification methods.
54 +
55 +Click on your profile icon at the top-right of the Cloud UI to open your account menu, then **Profile** in the dropdown.
56 +Click on the **Notifications** tab in the panel that appears.
57 +
58 +![The user-level management panel for alert
59 +notifications](https://user-images.githubusercontent.com/1153921/99722015-40174200-2a6d-11eb-837e-3de761127ca7.png)
60 +
61 +Enable or disable notification methods with the toggle buttons.
62 +
63 +Select which the notifications you want to receive from each War Room:
64 +
65 +- **All alerts and unreachable**: Receive notifications for all changes in alert status: critical, warning, and
66 + cleared. In addition, receive notifications for any node that enters an unreachable state.
67 +- **All alerts**: Receive notifications for all changes in alert status: critical, warning, and cleared.
68 +- **Critical only**: Receive notifications only for critical alerts.
69 +- **No notifications**: Receive no notifications for nodes in this War Room.
70 +
71 +If a Space's administrator has disabled notifications, you will see a mesage similar to, "E-mail notifications for this space has been disabled by admin," and your settings have no effect.
72 +
73 +## Flood protection
74 +
75 +If a node has too many state changes like firing too many alerts or going from reachable to unreachable, Netdata Cloud
76 +enables flood protection. As long as a node is in flood protection mode, Netdata Cloud does not send notifications about
77 +this node. Even with flood protection active, it is possible to access the node directly, either via Netdata Cloud or
78 +the local Agent dashboard at `http://NODE:19999`.
79 +
80 +## Anatomy of an alert notification
81 +
82 +Email alarm notifications show the following information:
83 +
84 +- The Space's name
85 +- The node's name
86 +- Alarm status: critical, warning, cleared
87 +- Previous alarm status
88 +- Time at which the alarm triggered
89 +- Chart context that triggered the alarm
90 +- Name and information about the triggered alarm
91 +- Alarm value
92 +- Total number of warning and critical alerts on that node
93 +- Threshold for triggering the given alarm state
94 +- Calculation or database lookups that Netdata uses to compute the value
95 +- Source of the alarm, including which file you can edit to configure this alarm on an individual node
96 +
97 +Email notifications also feature a **Go to Node** button, which takes you directly to the offending chart for that node
98 +within Cloud's embedded dashboards.
99 +
100 +Here's an example email notification for the `ram_available` chart, which is in a critical state:
101 +
102 +![Screenshot of an alarm notification email from Netdata
103 +Cloud](https://user-images.githubusercontent.com/1153921/87461878-e933c480-c5c3-11ea-870b-affdb0801854.png)
104 +
105 +## What's next?
106 +
107 +Netdata Cloud's alarm notifications feature leverages the alarms configuration on each node in your infrastructure. If
108 +you'd like to tweak any of these alarms, or even add new ones based on your needs, read our [health
109 +quickstart](/docs/monitor/configure-alarms).
110 +
111 +You can also [view active alarms](/docs/cloud/alerts-notifications/view-active-alerts) in Netdata Cloud for an instant
112 +visualization of the health of your infrastructure.
docs/cloud/alerts-notifications/smartboard.mdx new
+44
@@ -0,0 +1,44 @@
1 +---
2 +title: "Alerts smartboard"
3 +description: ""
4 +type: "reference"
5 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.mdx"
6 +sidebar_label: "Alerts smartboard"
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Operations"
10 +---
11 +
12 +The Alerts view gives you a high level of availability and performance information for every node you're
13 +monitoring with Netdata Cloud. We expect it to become the "home base" for many Netdata Cloud users who want to instantly
14 +understand what's going on with their infrastructure and exactly where issues might be.
15 +
16 +The Alerts view is available entirely for free to all users and for any number of nodes.
17 +
18 +## Alerts table and filtering
19 +
20 +The Alerts view shows all active alerts in your War Room, including the alert's name, the most recent value, a
21 +timestamp of when it became active, and the relevant node.
22 +
23 +You can use the checkboxes in the filter pane on the right side of the screen to filter the alerts displayed in the table
24 +by Status, Class, Type & Componenet, Role, Operating System, or Node.
25 +
26 +Click on any of the alert names to see the alert.
27 +
28 +## View active alerts
29 +
30 +In the `Active` subtab, you can see exactly how many **critical** and **warning** alerts are active across your nodes.
31 +
32 +## View configured alerts
33 +
34 +You can view all the configured alerts on all the agents that belong to a War Room in the `Alert Configurations` subtab.
35 +From within the Alerts view, you can click the `Alert Configurations` subtab to see a high level view of the states of
36 +the alerts on the nodes within this War Room and drill down to the node level where each alert is configured with their latest status.
37 +
38 +
39 +
40 +
41 +
42 +
43 +
44 +
docs/cloud/alerts-notifications/view-active-alerts.mdx new
+63
@@ -0,0 +1,63 @@
1 +---
2 +title: "View active alerts"
3 +description: "Track the health of your infrastructure in one place by taking advantage of the powerful health monitoring watchdog running on every node."
4 +type: "how-to"
5 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx"
6 +sidebar_label: "View active alerts"
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Operations"
10 +---
11 +
12 +Netdata Cloud receives information about active alerts on individual nodes in your infrastructure and updates the
13 +interface based on those status changes.
14 +
15 +Netdata Cloud doesn't produce alerts itself but rather receives and aggregates alerts from each node in your
16 +infrastructure based on their configuration. Every node comes with hundreds of pre-configured alerts that have been
17 +tested by Netdata's community of DevOps engineers and SREs, but you may want to customize existing alerts or create new
18 +ones entirely.
19 +
20 +Read our doc on [health alerts](/docs/monitor/configure-alarms) to learn how to tweak existing alerts or create new
21 +health entities based on the specific needs of your infrastructure. By taking charge of alert configuration, you'll
22 +ensure Netdata Cloud always delivers the most relevant alerts about the well-being of your nodes.
23 +
24 +## View all active alerts
25 +
26 +The [Alerts Smartboard](/docs/cloud/alerts-notifications/smartboard) provides a high-level interface for viewing the
27 +number of critical or warning alerts and where they are in your infrastructure.
28 +
29 +![The Alerts
30 +Smartboard](https://user-images.githubusercontent.com/1153921/119025635-2fcb1b80-b959-11eb-9fdb-7f1a082f43c5.png)
31 +
32 +Click on the **Alerts** tab in any War Room to open the Smartboard. Alternatively, click on any of the alert badges in
33 +the [Nodes view](/docs/cloud/visualize/nodes) to jump to the Alerts Smartboard.
34 +
35 +From here, filter active alerts using the **critical** or **warning** boxes, or hover over a box in the [nodes
36 +map](/docs/cloud/alerts-notifications/smartboard#nodes-map) to see a popup node-specific alert information.
37 +
38 +## View alerts in context with charts
39 +
40 +If you click on any of the alerts, either in a nodes map popup or the alerts table, Netdata Cloud navigates you to the
41 +single-node dashboard and scrolls to the relevant chart. Netdata Cloud also draws a highlight and the value at the
42 +moment your node triggered this alert.
43 +
44 +![An alert in context with charts and
45 +dimensions](https://user-images.githubusercontent.com/1153921/119039593-4a0cf580-b969-11eb-840c-4ecb123df9f5.png)
46 +
47 +You can then [select this area](/docs/dashboard/interact-charts#select) with `Alt/⌘ + mouse selection` to highlight the
48 +alerted timeframe while you explore other charts for root cause analysis.
49 +
50 +Or, select the area and run [Metric Correlations](/docs/cloud/insights/metric-correlations) to filter the single-node
51 +dashboard to only those charts most likely to be connected to the alert.
52 +
53 +## What's next?
54 +
55 +Learn more about the features of the Smartboard in its [reference](/docs/cloud/alerts-notifications/smartboard) doc. To
56 +stay notified of active alerts, enable [centralized alert notifications](/docs/cloud/alerts-notifications/notifications)
57 +from Netdata Cloud.
58 +
59 +If you're through with setting up alerts, it might be time to [invite your
60 +team](/docs/cloud/manage/invite-your-team).
61 +
62 +Check out our recommendations on organizing and using [Spaces](/docs/cloud/spaces) and [War
63 +Rooms](/docs/cloud/war-rooms) to streamline your processes once you find an alert in Netdata Cloud.
docs/cloud/beta-architecture/new-architecture.md new
+36
@@ -0,0 +1,36 @@
1 +---
2 +title: "Test the New Cloud Architecture"
3 +description: "Would you like to be the first to try our new architecture and provide feedback? If so, this guide will help you sign up for our beta testing group."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/beta-architecture/new-architecture.md"
5 +---
6 +
7 +To enhance the stability and reliability of Netdata Cloud, we did extensive work on our backend, and we would like to give you the opportunity
8 +to be among the first users to try these changes to our Cloud architecture and provide feedback.
9 +
10 +The backend architecture changes should offer notable improvements in reliability and stability in Netdata Cloud,
11 +but more importantly, it allows us to develop new features and enhanced functionality, including features and enhancements
12 +that you have specifically requested. Features that will be developed on the new architecture include:
13 +
14 +- Parent/Child Cloud relationships
15 +- Alert logs
16 +- Alert management
17 +- Much more
18 +
19 +## Enabling the new architecture
20 +
21 +To enable the new architecture, first ensure that you have installed the latest Netdata version following
22 +[our guide](https://learn.netdata.cloud/docs/get-started/). Then, you or your administrator will need to retrieve the Space IDs
23 +within Netdata Cloud by clicking `Manage Space` in the left pane, selecting the `Space` tab, and copying the value in the `Space Id` field.
24 +You can then send an email to [beta@Netdata.cloud](mailto:beta@netdata.cloud) requesting to be included in our beta testers, and include
25 +in the body of the email a list of Space IDs for any space you would like to have whitelisted for the update. If you received an email
26 +invitation, you can also just reply to the invitation with your Space IDs in the body of the reply.
27 +
28 +Feel free to send the Space IDs for multiple spaces to test the new infrastructure on each of them.
29 +
30 +## Reporting issues
31 +
32 +After you are set up with the new architecture changes, we ask that you report any issues you encounter in our
33 +[designated Discord channel](https://discord.gg/dGzdemHwHh). This feedback
34 +will help us ensure the highest performance of the new architecture and expedite the development and release
35 +of the aforementioned enhancements and features.
36 +
docs/cloud/cheatsheet.mdx new
+231
@@ -0,0 +1,231 @@
1 +---
2 +title: "'Netdata management and configuration cheatsheet'"
3 +description: "'Connecting an Agent to the Cloud allows a Netdata Agent, running on a distributed node, to securely connect to Netdata Cloud via the encrypted Agent-Cloud link (ACLK).'"
4 +image: "/cheatsheet/cheatsheet-meta.png"
5 +sidebar_label: "Cheatsheet"
6 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/cheatsheet.mdx"
7 +part_of_learn: "True"
8 +learn_status: "Published"
9 +learn_topic_type: "Getting started"
10 +learn_rel_path: "Getting started"
11 +---
12 +
13 +import {
14 + OneLineInstallWget,
15 + OneLineInstallCurl,
16 +} from '@site/src/components/OneLineInstall/';
17 +
18 +Use our management &amp; configuration cheatsheet to simplify your interactions with Netdata, including configuration,
19 +using charts, managing the daemon, and more.
20 +
21 +## Install Netdata
22 +
23 +#### Install Netdata
24 +
25 +<OneLineInstallWget />
26 +
27 +Or, if you have cURL but not wget (such as on macOS):
28 +
29 +<OneLineInstallCurl />
30 +
31 +#### Claim a node to Netdata Cloud
32 +
33 +To do so, sign in to Netdata Cloud, click the `Claim Nodes` button, choose the `War Rooms` to add nodes to, then click `Copy` to copy the full script to your clipboard. Paste that into your node’s terminal and run it.
34 +
35 +## Metrics collection & retention
36 +
37 +You can tweak your settings in the netdata.conf file.
38 +📄 [Find your netdata.conf file](https://learn.netdata.cloud/guides/step-by-step/step-04#find-your-netdataconf-file)
39 +
40 +Open a new terminal and navigate to the netdata.conf file. Use the edit-config script to make changes: `sudo ./edit-config netdata.conf`
41 +
42 +The most popular settings to change are:
43 +
44 +#### Increase metrics retention (4GiB)
45 +
46 +```
47 +sudo ./edit-config netdata.conf
48 +```
49 +
50 +```
51 +[global]
52 + dbengine multihost disk space = 4096
53 +```
54 +
55 +#### Reduce the collection frequency (every 5 seconds)
56 +
57 +```
58 +sudo ./edit-config netdata.conf
59 +```
60 +
61 +```
62 +[global]
63 + update every = 5
64 +```
65 +
66 +#### Enable/disable plugins (groups of collectors)
67 +
68 +```
69 +sudo ./edit-config netdata.conf
70 +```
71 +
72 +```
73 +[plugins]
74 + go.d = yes # enabled
75 + node.d = no # disabled
76 +```
77 +
78 +#### Enable/disable specific collectors
79 +
80 +```
81 +sudo ./edit-config go.d.conf
82 +```
83 +
84 +> `Or python.d.conf, node.d.conf, edbpf.conf, and so on`.
85 +
86 +```
87 +modules:
88 + activemq: no # disabled
89 + bind: no # disabled
90 + cockroachdb: yes # enabled
91 +```
92 +
93 +#### Edit a collector's config (example)
94 +
95 +```
96 +$ sudo ./edit-config go.d/mysql.conf
97 +$ sudo ./edit-config ebpf.conf
98 +$ sudo ./edit-config python.d/anomalies.conf
99 +```
100 +
101 +## Configuration
102 +
103 +#### The Netdata config directory: `/etc/netdata`
104 +
105 +> If you don't have such a directory:
106 +> 📄 [Find your netdata.conf file](https://learn.netdata.cloud/guides/step-by-step/step-04#find-your-netdataconf-file)
107 +> The cheatsheet assumes you’re running all commands from within the Netdata config directory!
108 +
109 +#### Edit Netdata's main config file: `$ sudo ./edit-config netdata.conf`
110 +
111 +#### Edit Netdata's other config files (examples):
112 +
113 +- `$ sudo ./edit-config apps_groups.conf`
114 +- `$ sudo ./edit-config ebpf.conf`
115 +- `$ sudo ./edit-config health.d/load.conf`
116 +- `$ sudo ./edit-config go.d/prometheus.conf`
117 +
118 +#### View the running Netdata configuration: `http://NODE:19999/netdata.conf`
119 +
120 +> Replace `NODE` with the IP address or hostname of your node. Often `localhost`.
121 +
122 +## Alarms & notifications
123 +
124 +#### Add a new alarm
125 +
126 +```
127 +sudo touch health.d/example-alarm.conf
128 +sudo ./edit-config health.d/example-alarm.conf
129 +```
130 +
131 +#### Configure a specific alarm
132 +
133 +```
134 +sudo ./edit-config health.d/example-alarm.conf
135 +```
136 +
137 +#### Silence a specific alarm
138 +
139 +```
140 +sudo ./edit-config health.d/example-alarm.conf
141 + to: silent
142 +```
143 +
144 +#### Disable alarms and notifications
145 +
146 +```
147 +[health]
148 + enabled = no
149 +```
150 +
151 +> After any change, reload the Netdata health configuration
152 +
153 +```
154 +netdatacli reload-health
155 +```
156 +
157 +or if that command doesn't work on your installation, use:
158 +
159 +```
160 +killall -USR2 netdata
161 +```
162 +
163 +## Manage the daemon
164 +
165 +| Intent | Action |
166 +| :-------------------------- | --------------------------------------------------------------------: |
167 +| Start Netdata | `$ sudo systemctl start netdata` |
168 +| Stop Netdata | `$ sudo systemctl stop netdata` |
169 +| Restart Netdata | `$ sudo systemctl restart netdata` |
170 +| Reload health configuration | `$ sudo netdatacli reload-health` <br></br> `$ killall -USR2 netdata` |
171 +| View error logs | `less /var/log/netdata/error.log` |
172 +
173 +## See metrics and dashboards
174 +
175 +#### Netdata Cloud: `https://app.netdata.cloud`
176 +
177 +#### Local dashboard: `https://NODE:19999`
178 +
179 +> Replace `NODE` with the IP address or hostname of your node. Often `localhost`.
180 +
181 +#### Access the Netdata API: `http://NODE:19999/api/v1/info`
182 +
183 +## Interact with charts
184 +
185 +| Intent | Action |
186 +| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
187 +| Stop a chart from updating | `click` |
188 +| Zoom | **Cloud** <br/> use the `zoom in` and `zoom out` buttons on any chart (upper right corner) <br/><br/> **Agent**<br/>`SHIFT` or `ALT` + `mouse scrollwheel` <br/> `SHIFT` or `ALT` + `two-finger pinch` (touchscreen) <br/> `SHIFT` or `ALT` + `two-finger scroll` (touchscreen) |
189 +| Zoom to a specific timeframe | **Cloud**<br/>use the `select and zoom` button on any chart and then do a `mouse selection` <br/><br/> **Agent**<br/>`SHIFT` + `mouse selection` |
190 +| Pan forward or back in time | `click` & `drag` <br/> `touch` & `drag` (touchpad/touchscreen) |
191 +| Select a certain timeframe | `ALT` + `mouse selection` <br/> WIP need to evaluate this `command?` + `mouse selection` (macOS) |
192 +| Reset to default auto refreshing state | `double click` |
193 +
194 +## Dashboards
195 +
196 +#### Disable the local dashboard
197 +
198 +Use the `edit-config` script to edit the `netdata.conf` file.
199 +
200 +```
201 +[web]
202 +mode = none
203 +```
204 +
205 +#### Change the port Netdata listens to (port 39999)
206 +
207 +```
208 +[web]
209 +default port = 39999
210 +```
211 +
212 +#### Opt out from anonymous statistics
213 +
214 +```
215 +sudo touch .opt-out-from-anonymous-statistics
216 +```
217 +
218 +## Understanding the dashboard
219 +
220 +**Charts**: A visualization displaying one or more collected/calculated metrics in a time series. Charts are generated
221 +by collectors.
222 +
223 +**Dimensions**: Any value shown on a chart, which can be raw or calculated values, such as percentages, averages,
224 +minimums, maximums, and more.
225 +
226 +**Families**: One instance of a monitored hardware or software resource that needs to be monitored and displayed
227 +separately from similar instances. Example, disks named
228 +**sda**, **sdb**, **sdc**, and so on.
229 +
230 +**Contexts**: A grouping of charts based on the types of metrics collected and visualized.
231 +**disk.io**, **disk.ops**, and **disk.backlog** are all contexts.
docs/cloud/cloud.mdx new
+74
@@ -0,0 +1,74 @@
1 +---
2 +title: "Netdata Cloud docs"
3 +description: "Netdata Cloud is real-time visibility for entire infrastructures. View key metrics, insightful charts, and active alarms from all your nodes."
4 +custom_edit_url: "https://github.com/netdata/learn/blob/master/docs/cloud.mdx"
5 +---
6 +
7 +import { Grid, Box, BoxList, BoxListItem } from '@site/src/components/Grid/'
8 +import { RiExternalLinkLine } from 'react-icons/ri'
9 +
10 +This is the documentation for the Netdata Cloud web application, which works in parallel with the open-source Netdata
11 +monitoring agent to help you monitor your entire infrastructure [for free <RiExternalLinkLine className="inline-block"
12 +/>](https://netdata.cloud/pricing/) in real time and troubleshoot problems that threaten the health of your
13 +nodes before they occur.
14 +
15 +Netdata Cloud requires the open-source [Netdata](/docs/) monitoring agent, which is the basis for the metrics,
16 +visualizations, and alarms that you'll find in Netdata Cloud. Every time you view a node in Netdata Cloud, its metrics
17 +and metadata are streamed to Netdata Cloud, then proxied to your browser, with an infrastructure that ensures [data
18 +privacy <RiExternalLinkLine className="inline-block" />](https://netdata.cloud/privacy/).
19 +
20 +
21 +Read [_What is Netdata?_](/docs/overview/what-is-netdata) for details about how Netdata and Netdata Cloud work together
22 +and how they're different from other monitoring solutions, or the
23 +[FAQ <RiExternalLinkLine className="inline-block" />](https://community.netdata.cloud/tags/c/general/29/faq) for answers to common questions.
24 +
25 +<Grid columns="1" className="mb-16">
26 + <Box
27 + to="/docs/cloud/get-started"
28 + title="Get started with Netdata Cloud"
29 + cta="Go"
30 + image={true}>
31 + Ready to get real-time visibility into your entire infrastructure? This guide will help you get started on Netdata Cloud, from signing in for a free account to connecting your nodes.
32 + </Box>
33 +</Grid>
34 +
35 +## Learn about Netdata Cloud's features
36 +
37 +<Grid columns="2">
38 + <Box
39 + title="Spaces and War Rooms">
40 + <BoxList>
41 + <BoxListItem to="/docs/cloud/spaces" title="Spaces" />
42 + <BoxListItem to="/docs/cloud/war-rooms" title="War Rooms" />
43 + </BoxList>
44 + </Box>
45 + <Box
46 + title="Dashboards">
47 + <BoxList>
48 + <BoxListItem to="/docs/cloud/visualize/overview" title="Overview" />
49 + <BoxListItem to="/docs/cloud/visualize/nodes" title="Nodes view" />
50 + <BoxListItem to="/docs/cloud/visualize/kubernetes" title="Kubernetes" />
51 + <BoxListItem to="/docs/cloud/visualize/dashboards" title="Create new dashboards" />
52 + </BoxList>
53 + </Box>
54 + <Box
55 + title="Alerts and notifications">
56 + <BoxList>
57 + <BoxListItem to="/docs/cloud/alerts-notifications/view-active-alerts" title="View active alerts" />
58 + <BoxListItem to="/docs/cloud/alerts-notifications/smartboard" title="Alerts Smartboard" />
59 + <BoxListItem to="/docs/cloud/alerts-notifications/notifications" title="Alert notifications" />
60 + </BoxList>
61 + </Box>
62 + <Box
63 + title="Troubleshooting with Netdata Cloud">
64 + <BoxListItem to="/docs/cloud/insights/metric-correlations" title="Metric Correlations" />
65 + </Box>
66 + <Box
67 + title="Management and settings">
68 + <BoxList>
69 + <BoxListItem to="/docs/cloud/manage/sign-in" title="Sign in with email, Google, or GitHub" />
70 + <BoxListItem to="/docs/cloud/manage/invite-your-team" title="Invite your team" />
71 + <BoxListItem to="/docs/cloud/manage/themes" title="Choose your Netdata Cloud theme" />
72 + </BoxList>
73 + </Box>
74 +</Grid>
docs/cloud/data-privacy.mdx new
+39
@@ -0,0 +1,39 @@
1 +---
2 +title: "Data privacy in the Netdata Cloud"
3 +description: "Keeping your data safe and secure is our priority.Netdata never stores your personal information in the Netdata Cloud."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/data-privacy.mdx"
5 +sidebar_label: "Data privacy in the Netdata Cloud"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 +---
10 +
11 +[Data privacy](https://netdata.cloud/privacy/) is very important to us. We firmly believe that your data belongs to
12 +you. This is why **we don't store any metric data in Netdata Cloud**.
13 +
14 +Your local installations of the Netdata Agent form the basis for the Netdata Cloud. All the data that you see in the web browser when using Netdata Cloud, is actually streamed directly from the Netdata Agent to the Netdata Cloud dashboard.
15 +The data passes through our systems, but it isn't stored. You can learn more about [the Agent's security design](https://learn.netdata.cloud/docs/agent/netdata-security) in the Agent documentation.
16 +
17 +However, to be able to offer the stunning visualizations and advanced functionality of Netdata Cloud, it does store a limited number of _metadata_.
18 +
19 +## Metadata
20 +
21 +Let's look at the metadata Netdata Cloud stores using the publicly available demo server `frankfurt.my-netdata.io`:
22 +
23 +- The email address you used to sign up/or sign in
24 +- For each node connected to your Spaces in Netdata Cloud:
25 + - Hostname (as it appears in Netdata Cloud)
26 + - Information shown in `/api/v1/info`. For example: [https://frankfurt.my-netdata.io/api/v1/info](https://frankfurt.my-netdata.io/api/v1/info).
27 + - The chart metadata shown in `/api/v1/charts`. For example: [https://frankfurt.my-netdata.io/api/v1/info](https://frankfurt.my-netdata.io/api/v1/info).
28 + - Alarm configurations shown in `/api/v1/alarms?all`. For example: [https://frankfurt.my-netdata.io/api/v1/alarms?all](https://frankfurt.my-netdata.io/api/v1/alarms?all).
29 + - Active alarms shown in `/api/v1/alarms`. For example: [https://frankfurt.my-netdata.io/api/v1/alarms](https://frankfurt.my-netdata.io/api/v1/alarms).
30 +
31 +How we use them:
32 +
33 +- The data is stored in our production database on AWS. Some of it is also used in Google BigQuery, our data lake, for analytics purposes. These analytics are crucial for our product development process.
34 +- Email is used to identify users in regards to product use and to enrich our tools with product use, such as our CRM.
35 +- This data is only available to Netdata and never to a 3rd party.
36 +
37 +## Delete all personal data
38 +
39 +To remove all personal info we have about you (email and activities) you need to delete your cloud account by logging into https://app.netdata.cloud and accessing your profile, at the bottom left of your screen.
docs/cloud/get-started.mdx new
+109
@@ -0,0 +1,109 @@
1 +---
2 +title: "Get started with Netdata Cloud"
3 +description: "Ready to get real-time visibility into your entire infrastructure? This guide will help you get started on Netdata Cloud."
4 +image: "/img/seo/cloud_get-started.png"
5 +custom_edit_url: "https://github.com/netdata/learn/blob/master/docs/cloud/get-started.mdx"
6 +---
7 +
8 +import Link from '@docusaurus/Link'
9 +import Callout from '@site/src/components/Callout'
10 +
11 +Ready to get real-time visibility into your entire infrastructure with Netdata Cloud? This guide will walk you through
12 +the onboarding process, such as setting up your Space and War Room and connecting your first nodes.
13 +
14 +## Before you start
15 +
16 +Before you get started with Netdata Cloud, you should have the open-source Netdata monitoring agent installed. See our
17 +[installation guide](/docs/get-started) for details.
18 +
19 +If you already have the Netdata agent running on your node(s), make sure to update it to v1.32 or higher. Read the
20 +[updating documentation](/docs/agent/packaging/installer/update/) for information on how to update based on the method
21 +you used to install Netdata on that node.
22 +
23 +## Begin the onboarding process
24 +
25 +Get started by signing in to Netdata. Read the [sign in](/docs/cloud/manage/sign-in) doc for details on the
26 +authentication methods we use.
27 +
28 +<Link to="https://app.netdata.cloud" className="group">
29 + <button className="relative text-text bg-gray-200 px-4 py-2 rounded">
30 + <span className="z-10 relative font-semibold group-hover:text-gray-100">Sign in to Netdata</span>
31 + <div className="opacity-0 group-hover:opacity-100 transition absolute z-0 inset-0 bg-gradient-to-r from-green to-green-lighter rounded"></div>
32 + </button>
33 +</Link>
34 +
35 +Once signed in with your preferred method, a General [War Room](/docs/cloud/war-rooms) and a [Space](/docs/cloud/spaces)
36 +named for your login email are automatically created. You can configure more Spaces and War Rooms to help you you organize your team
37 +and the many systems that make up your infrastructure. For example, you can put product and infrastructure SRE teams in separate
38 +Spaces, and then use War Rooms to group nodes by their service (`nginx`), purpose (`webservers`), or physical location (`IAD`).
39 +
40 +Don't worry! You can always add more Spaces and War Rooms later if you decide to reorganize how you use Netdata Cloud.
41 +
42 +## Connect your nodes
43 +
44 +From within the created War Rooms, Netdata Cloud prompts you to [connect](/docs/agent/claim) your nodes to Netdata Cloud. Non-admin
45 +users can users can select from existing nodes already connected to the space or select an admin from a provided list to connect node.
46 +You can connect any node running Netdata, whether it's a physical or virtual machine, a Docker container, IoT device, and more.
47 +
48 +The connection process securely connects any node to Netdata Cloud using the [Agent-Cloud link](/docs/agent/aclk). By
49 +connecting a node, you prove you have write and administrative access to that node. Connecting to Cloud also prevents any third party
50 +from connecting a node that you control. Keep in mind:
51 +
52 +- _You can only connect any given node in a single Space_. You can, however, add that connected node to multiple War Rooms
53 + within that one Space.
54 +- You must repeat the connection process on every node you want to add to Netdata Cloud.
55 +
56 +<Callout type="notice">
57 +
58 +**Netdata Cloud ensures your data privacy by not storing metrics data from your nodes**. See our statement on Netdata
59 +Cloud [data privacy](/docs/agent/aclk/#data-privacy) for details on the data that's streamed from your nodes and the
60 +[connecting to cloud](/docs/agent/claim) doc for details about why we implemented the connection process and the encryption methods
61 +we use to secure your data in transit.
62 +
63 +</Callout>
64 +
65 +To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy the script given by
66 +Netdata Cloud into your node's terminal.
67 +
68 +Hit **Enter**. The script should return `Agent was successfully claimed.`. If the claiming script returns errors, or if
69 +you don't see the node in your Space after 60 seconds, see the [troubleshooting
70 +information](/docs/agent/claim#troubleshooting).
71 +
72 +Repeat this process with every node you want to add to Netdata Cloud during onboarding. You can also add more nodes once
73 +you've finished onboarding by clicking the **Connect Nodes** button in the [Space management
74 +area](/docs/cloud/spaces/#manage-spaces).
75 +
76 +### Alternatives and other operating systems
77 +
78 +**Docker**: You can execute the claiming script Netdata running as a Docker container, or attach the claiming script
79 +when creating the container for the first time, such as when you're spinning up ephemeral containers. See the [connect an agent running in Docker](/docs/agent/claim#connect-an-agent-running-in-docker) documentation for details.
80 +
81 +**Without root privileges**: If you want to connect an agent without using root privileges, see our [connect
82 +documentation](/docs/agent/claim#connect-an-agent-without-root-privileges).
83 +
84 +**With a proxy**: If your node uses a proxy to connect to the internet, you need to configure the node's proxy settings.
85 +See our [connect through a proxy](/docs/agent/claim#connect-through-a-proxy) doc for details.
86 +
87 +## Add bookmarks to essential resources
88 +
89 +When an anomaly or outage strikes, your team needs to access other essential resources quickly. You can use Netdata
90 +Cloud's bookmarks to put these tools in one accessible place. Bookmarks are shared between all War Rooms in a Space, so
91 +any users in your Space will be able to see and use them.
92 +
93 +Bookmarks can link to both internal and external resources. You can bookmark your app's status page for quick updates
94 +during an outage, a messaging system on your organization's intranet, or other tools your team uses to respond to
95 +changes in your infrastructure.
96 +
97 +To add a new bookmark, click on the **Add bookmark** link. In the panel, name the bookmark, include its URL, and write a
98 +short description for your team's reference.
99 +
100 +## What's next?
101 +
102 +You finish onboarding by [inviting members of your team](/docs/cloud/manage/invite-your-team) to your Space. You
103 +can also invite them later. At this point, you're ready to use Cloud.
104 +
105 +Next, learn about the organization and interfaces behind [Spaces](/docs/cloud/spaces) and [War
106 +Rooms](/docs/cloud/war-rooms).
107 +
108 +If you're ready to explore, check out how to use the [Overview dashboard](/docs/cloud/visualize/overview), which is the
109 +default view for each new War Room you create.
docs/cloud/insights/anomaly-advisor.mdx new
+86
@@ -0,0 +1,86 @@
1 +---
2 +title: "Anomaly Advisor"
3 +description: "Quickly find anomalous metrics anywhere in your infrastructure."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx"
5 +sidebar_label: "Anomaly Advisor"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +import ReactPlayer from 'react-player'
12 +
13 +The Anomaly Advisor feature lets you quickly surface potentially anomalous metrics and charts related to a particular highlight window of
14 +interest.
15 +
16 +<ReactPlayer playing true controls true url='https://user-images.githubusercontent.com/24860547/165943403-1acb9759-7446-4704-8955-c566d04ad7ab.mp4' />
17 +
18 +## Getting Started
19 +
20 +If you are running a Netdata version higher than `v1.35.0-29-nightly` you will be able to use the Anomaly Advisor out of the box with zero configuration. If you are on an earlier Netdata version you will need to first enable ML on your nodes by following the steps below.
21 +
22 +To enable the Anomaly Advisor you must first enable ML on your nodes via a small config change in `netdata.conf`. Once the anomaly detection models have trained on the Agent (with default settings this takes a couple of hours until enough data has been seen to train the models) you will then be able to enable the Anomaly Advisor feature in Netdata Cloud.
23 +
24 +### Enable ML on Netdata Agent
25 +
26 +To enable ML on your Netdata Agent, you need to edit the `[ml]` section in your `netdata.conf` to look something like the following example.
27 +
28 +```bash
29 +[ml]
30 + enabled = yes
31 +```
32 +
33 +At a minimum you just need to set `enabled = yes` to enable ML with default params. More details about configuration can be found in the [Netdata Agent ML docs](https://learn.netdata.cloud/docs/agent/ml#configuration).
34 +
35 +**Note**: Follow [this guide](https://learn.netdata.cloud/guides/step-by-step/step-04) if you are unfamiliar with making configuration changes in Netdata.
36 +
37 +When you have finished your configuration, restart Netdata with a command like `sudo systemctl restart netdata` for the config changes to take effect. You can find more info on restarting Netdata [here](https://learn.netdata.cloud/docs/configure/start-stop-restart).
38 +
39 +After a brief delay, you should see the number of `trained` dimensions start to increase on the "dimensions" chart of the "Anomaly Detection" menu on the Overview page. By default the `minimum num samples to train = 3600` parameter means at least 1 hour of data is required to train initial models, but you could set this to `900` if you want to train initial models quicker but on less data. Over time, they will retrain on up to `maximum num samples to train = 14400` (4 hours by default), but you could increase this is you wanted to train on more data.
40 +
41 +![image](https://user-images.githubusercontent.com/2178292/166474099-ba6f5ebe-12b2-4ef2-af9f-e84a05349791.png)
42 +
43 +Once this line flattens out all configured metrics should have models trained and predicting anomaly scores each second, ready to be used by the new "anomalies" tab of the Anomaly Advisor.
44 +
45 +## Using Anomaly Advisor
46 +
47 +To use the Anomaly Advisor, go to the "anomalies" tab. Once you highlight a particular timeframe of interest, a selection of the most anomalous dimensions will appear below.
48 +
49 +The aim here is to surface the most anomalous metrics in the space or room for the highlighted window to try and cut down on the amount of manual searching required to get to the root cause of your issues.
50 +
51 +![image](https://user-images.githubusercontent.com/2178292/164427337-a40820d2-8d36-4a94-8dfb-cfd3194941e0.png)
52 +
53 +The "Anomaly Rate" chart shows the percentage of anomalous metrics over time per node. For example, in the following image, 3.21% of the metrics on the "ml-demo-ml-disabled" node were considered anomalous. This elevated anomaly rate could be a sign of something worth investigating.
54 +
55 +**Note**: in this example the anomaly rates for this node are actually being calculated on the parent it streams to, you can run ml on the Agent itselt or on a parent the Agent stream to. Read more about the various configuration options in the [Agent docs](https://github.com/netdata/netdata/blob/master/ml/README.md).
56 +
57 +![image](https://user-images.githubusercontent.com/2178292/164428307-6a86989a-611d-47f8-a673-911d509cd954.png)
58 +
59 +The "Count of Anomalous Metrics" chart (collapsed by default) shows raw counts of anomalous metrics per node so may often be similar to the anomaly rate chart, apart from where nodes may have different numbers of metrics.
60 +
61 +The "Anomaly Events Detected" chart (collapsed by default) shows if the anomaly rate per node was sufficiently elevated to trigger a node level anomaly. Anomaly events will appear slightly after the anomaly rate starts to increase in the timeline, this is because a significant number of metrics in the node need to be anomalous before an anomaly event is triggered.
62 +
63 +Once you have highlighted a window of interest, you should see an ordered list of anomaly rate sparklines in the "Anomalous metrics" section like below.
64 +
65 +![image](https://user-images.githubusercontent.com/2178292/164427592-ab1d0eb1-57e2-4a05-aaeb-da4437a019b1.png)
66 +
67 +You can expand any sparkline chart to see the underlying raw data to see how it relates to the corresponding anomaly rate.
68 +
69 +![image](https://user-images.githubusercontent.com/2178292/164430105-f747d1e0-f3cb-4495-a5f7-b7bbb71039ae.png)
70 +
71 +On the upper right hand side of the page you can select which nodes to filter on if you wish to do so. The ML training status of each node is also displayed.
72 +
73 +On the lower right hand side of the page an index of anomaly rates is displayed for the highlighted timeline of interest. The index is sorted from most anomalous metric (highest anomaly rate) to least (lowest anomaly rate). Clicking on an entry in the index will scroll the rest of the page to the corresponding anomaly rate sparkline for that metric.
74 +
75 +### Usage Tips
76 +
77 +- If you are interested in a subset of specific nodes then filtering to just those nodes before highlighting tends to give better results. This is because when you highlight a region, Netdata Cloud will ask the Agents for a ranking over all metrics so if you can filter this early to just the subset of nodes you are interested in, less 'averaging' will occur and so you might be a less noisy ranking.
78 +- Ideally try and highlight close to a spike or window of interest so that the resulting ranking can narrow in more easily on the timeline you are interested in.
79 +
80 +You can read more detail on how anomaly detection in the Netdata Agent works in our [Agent docs](https://github.com/netdata/netdata/blob/master/ml/README.md).
81 +
82 +🚧 **Note**: This functionality is still **under active development** and considered experimental. We dogfood it internally and among early adopters within the Netdata community to build the feature. If you would like to get involved and help us with feedback, you can reach us through any of the following channels:
83 +- Email us at analytics-ml-team@netdata.cloud
84 +- Comment on the [beta launch post](https://community.netdata.cloud/t/anomaly-advisor-beta-launch/2717) in the Netdata community
85 +- Join us in the [🤖-ml-powered-monitoring](https://discord.gg/4eRSEUpJnc) channel of the Netdata discord.
86 +- Or open a discussion in GitHub if that's more your thing
docs/cloud/insights/metric-correlations.md new
+87
@@ -0,0 +1,87 @@
1 +---
2 +title: "Metric Correlations"
3 +description: "Quickly find metrics and charts closely related to a particular timeframe of interest anywhere in your infrastructure to discover the root cause faster."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md"
5 +sidebar_label: "Metric Correlations"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +The Metric Correlations (MC) feature lets you quickly find metrics and charts related to a particular window of interest that you want to explore further. By displaying the standard Netdata dashboard, filtered to show only charts that are relevant to the window of interest, you can get to the root cause sooner.
12 +
13 +Because Metric Correlations uses every available metric from your infrastructure, with as high as 1-second granularity, you get the most accurate insights using every possible metric.
14 +
15 +## Using Metric Correlations
16 +
17 +When viewing the overview or a single-node dashboard, the **Metric Correlations** button appears in the top right corner of the page.
18 +
19 +![The Metric Correlations button](https://user-images.githubusercontent.com/2178292/201082551-d805b20d-0472-455d-9f11-b2329adf3098.png)
20 +
21 +To start correlating metrics, click the **Metric Correlations** button, then hold the `Alt` key (or `⌘` on macOS) and click-and-drag a selection of metrics on a single chart. The selected timeframe needs to be at least 15 seconds for Metric Correlation to work.
22 +
23 +The menu then displays information about the selected area and reference baseline. Metric Correlations uses the reference baseline to discover which additional metrics are most closely connected to the selected metrics. The reference baseline is based upon the period immediately preceding the highlighted window and is the length of 4 times the highlighted window. This is to ensure that the reference baseline is always immediately before the highlighted window of interest and a bit longer so as to ensure it's a more representative short term baseline.
24 +
25 +Press the **Find Correlations** button to start up the correlations process, the button is only enabled when a valid timeframe is selected (at least 15 seconds). Once pressed, the process will score all available metrics on your nodes and return a filtered version of the Netdata dashboard. Now, you'll see only those metrics that have changed the most between a baseline window and the highlighted window you have selected.
26 +
27 +![Metric Correlations results](https://user-images.githubusercontent.com/2178292/181751182-25e0890d-a5f4-4799-9936-1523603cf97d.png)
28 +
29 +These charts are fully interactive, and whenever possible, will only show the _dimensions_ related to the timeline you selected.
30 +
31 +You can interact with all the scored metrics via the slider. Slide toward **show less** for more nuanced and significant results, or toward **show more** to "loosen" the threshold to explore other charts that may have changed too, but in a less significant manner.
32 +
33 +If you find something else interesting in the results, you can select another window and press **Find Correlations** again to kick the process off again.
34 +
35 +## Metric Correlations options
36 +
37 +MC enables a few input parameters that users can define to iteratively explore their data in different ways. As is usually the case in Machine Learning (ML), there is no "one size fits all" algorithm, what approach works best will typically depend on the type of data (which can be very different from one metric to the next) and even the nature of the event or incident you might be exploring in Netdata.
38 +
39 +So when you first run MC it will use the most sensible and general defaults. But you can also then vary any of the below options to explore further.
40 +
41 +### Method
42 +
43 +There are two algorithms available that aim to score metrics based on how much they have changed between the baseline and highlight windows.
44 +
45 +- `KS2` - A statistical test ([Two-sample Kolmogorov Smirnov](https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test#Two-sample_Kolmogorov%E2%80%93Smirnov_test)) comparing the distribution of the highlighted window to the baseline to try and quantify which metrics have most evidence of a significant change. You can explore our implementation [here](https://github.com/netdata/netdata/blob/d917f9831c0a1638ef4a56580f321eb6c9a88037/database/metric_correlations.c#L212).
46 +- `Volume` - A heuristic measure based on the percentage change in averages between highlighted window and baseline, with various edge cases sensibly controlled for. You can explore our implementation [here](https://github.com/netdata/netdata/blob/d917f9831c0a1638ef4a56580f321eb6c9a88037/database/metric_correlations.c#L516).
47 +
48 +### Aggregation
49 +
50 +Behind the scenes, Netdata will aggregate the raw data as needed such that arbitrary window lengths can be selected for MC. By default, Netdata will just `Average` raw data when needed as part of pre-processing. However other aggregations like `Median`, `Min`, `Max`, `Stddev` are also possible.
51 +
52 +### Data
53 +
54 +Netdata is different from typical observability agents since, in addition to just collecting raw metric values, it will by default also assign an "[Anomaly Bit](/docs/agent/ml#anomaly-bit)" related to each collected metric each second. This bit will be 0 for "normal" and 1 for "anomalous". This means that each metric also natively has an "[Anomaly Rate](/docs/agent/ml#anomaly-rate)" associated with it and, as such, MC can be run against the raw metric values or their corresponding anomaly rates.
55 +
56 +**Note**: Read more [here](https://learn.netdata.cloud/guides/monitor/anomaly-detection) to learn more about the native anomaly detection features within netdata.
57 +
58 +- `Metrics` - Run MC on the raw metric values.
59 +- `Anomaly Rate` - Run MC on the corresponding anomaly rate for each metric.
60 +
61 +## Metric Correlations on the agent
62 +
63 +As of `v1.35.0` Netdata is able to run the Metric Correlations algorithm ([Two Sample Kolmogorov-Smirnov test](https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test#Two-sample_Kolmogorov%E2%80%93Smirnov_test)) on the agent itself. This avoids sending the underlying raw data to the original Netdata Cloud based microservice and so typically will be much much faster as no data moves around and the computation happens instead on the agent.
64 +
65 +When a Metric Correlations request is made to Netdata Cloud, if any node instances have MC enabled then the request will be routed to the node instance with the highest hops (e.g. a parent node if one is found or the node itself if not). If no node instances have MC enabled then the request will be routed to the original Netdata Cloud based service which will request input data from the nodes and run the computation within the Netdata Cloud backend.
66 +
67 +#### Enabling/Disabling Metric Correlations on the agent
68 +
69 +As of `v1.35.0-22-nightly` Metric Correlation has been enabled by default on all agents. After further optimizations to the implementation, the impact of running the metric correlations algorithm on the agent was less than the impact of preparing all the data to send to cloud for MC to run in the cloud, as such running MC on the agent is less impactful on local resources than running via cloud.
70 +
71 +Should you still want to, disabling nodes for Metric Correlation on the agent is a simple one line config change. Just set `enable metric correlations = no` in the `[global]` section of `netdata.conf`
72 +
73 +## Usage tips!
74 +
75 +- When running Metric Correlations from the [Overview tab](https://learn.netdata.cloud/docs/cloud/visualize/overview#overview) across multiple nodes, you might find better results if you iterate on the initial results by grouping by node to then filter to nodes of interest and run the Metric Correlations again. So a typical workflow in this case would be to:
76 + - If unsure which nodes you are interested in then run MC on all nodes.
77 + - Within the initial results returned group the most interesting chart by node to see if the changes are across all nodes or a subset of nodes.
78 + - If you see a subset of nodes clearly jump out when you group by node, then filter for just those nodes of interest and run the MC again. This will result in less aggregation needing to be done by Netdata and so should help give clearer results as you interact with the slider.
79 +- Use the `Volume` algorithm for metrics with a lot of gaps (e.g. request latency when there are few requests), otherwise stick with `KS2`
80 + - By default, Netdata uses the `KS2` algorithm which is a tried and tested method for change detection in a lot of domains. The [Wikipedia](https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test) article gives a good overview of how this works. Basically, it is comparing, for each metric, its cumulative distribution in the highlight window with its cumulative distribution in the baseline window. The statistical test then seeks to quantify the extent to which we can say these two distributions look similar enough to be considered the same or not. The `Volume` algorithm is a bit more simple than `KS2` in that it basically compares (with some edge cases sensibly handled) the average value of the metric across baseline and highlight and looks at the percentage change. Often both `KS2` and `Volume` will have significant agreement and return similar metrics.
81 + - `Volume` might favour picking up more sparse metrics that were relatively flat and then came to life with some spikes (or vice versa). This is because for such metrics that just don't have that many different values in them, it is impossible to construct a cumulative distribution that can then be compared. So `Volume` might be useful in spotting examples of metrics turning on or off. ![example where volume captured network traffic turning on](https://user-images.githubusercontent.com/2178292/182336924-d02fd3d3-7f09-41da-9cfc-809d01396d9d.png)
82 + - `KS2` since it relies on the full distribution might be better at highlighting more complex changes that `Volume` is unable to capture. For example a change in the variation of a metric might be picked up easily by `KS2` but missed (or just much lower scored) by `Volume` since the averages might remain not all that different between baseline and highlight even if their variance has changed a lot. ![example where KS2 captured a change in entropy distribution that volume alone might not have picked up](https://user-images.githubusercontent.com/2178292/182338289-59b61e6b-089d-431c-bc8e-bd19ba6ad5a5.png)
83 +- Use `Volume` and `Anomaly Rate` together to ask what metrics have turned most anomalous from baseline to highlighted window. You can expand the embedded anomaly rate chart once you have results to see this more clearly. ![example where Volume and Anomaly Rate together help show what dimensions where most anomalous](https://user-images.githubusercontent.com/2178292/182338666-6d19fa92-89d3-4d61-804c-8f10982114f5.png)
84 +
85 +## What's next?
86 +
87 +You can read more about all the ML powered capabilities of Netdata [here](https://learn.netdata.cloud/guides/monitor/anomaly-detection). If you aren't yet familiar with the power of Netdata Cloud's visualization features, check out the [Nodes view](/docs/cloud/visualize/nodes) and learn how to [build new dashboards](/docs/cloud/visualize/dashboards).
docs/cloud/manage/invite-your-team.md new
+35
@@ -0,0 +1,35 @@
1 +---
2 +title: "Invite your team"
3 +description: "Invite your entire SRE, DevOPs, or ITOps team to Netdata Cloud to give everyone insights into your infrastructure from a single pane of glass."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md"
5 +sidebar_label: "Invite your team"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +Invite new users to your Space by clicking on **Invite Users** in the [Space](/docs/cloud/spaces) management area.
12 +
13 +![Opening the invitation panel in Netdata
14 +Cloud](https://user-images.githubusercontent.com/1153921/108529805-1b13b480-7292-11eb-862f-0499e3fdac17.png)
15 +
16 +Enter the email addresses for the users you want to invite to your Space. You can enter any number of email addresses,
17 +separated by a comma, to send multiple invitations at once.
18 +
19 +Next, choose the War Rooms you want to invite these users to. Once logged in, these users are not restricted only to
20 +these War Rooms. They can be invited to others, or join any that are public.
21 +
22 +Click the **Send** button to send an email invitation, which will prompt them to [sign up](/docs/cloud/manage/sign-in)
23 +and join your Space.
24 +
25 +![The invitation panel in Netdata
26 +Cloud](https://user-images.githubusercontent.com/1153921/97762959-53b33680-1ac7-11eb-8e9d-f3f4a14c0028.png)
27 +
28 +Any unaccepted invitations remain under **Invitations awaiting response**. These invitations can be rescinded at any
29 +time by clicking the trash can icon.
30 +
31 +## What's next?
32 +
33 +If your team members have trouble signing in, direct them to the [sign in guide](/docs/cloud/manage/sign-in). Once your
34 +team is onboarded to Netdata Cloud, they can view shared assets, such as [new
35 +dashboards](https://learn.netdata.cloud/docs/cloud/visualize/dashboards).
docs/cloud/manage/sign-in.mdx new
+88
@@ -0,0 +1,88 @@
1 +---
2 +title: "Sign in with email, Google, or GitHub"
3 +description: "Learn how signing in to Cloud works via one of our three authentication methods, plus some tips if you're having trouble signing in."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.mdx"
5 +sidebar_label: "Sign in with email, Google, or GitHub"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +You can [sign in to Netdata](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_first_section) through one of three methods: email, Google, or GitHub. Email uses a
12 +time-sensitive link that authenticates your browser, and Google/GitHub both use OAuth to associate your email address
13 +with a Netdata Cloud account.
14 +
15 +No matter the method, your Netdata Cloud account is based around your email address. Netdata Cloud does not store
16 +passwords.
17 +
18 +
19 +## Email
20 +
21 +To sign in with email, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_email_section), enter your email address, and click
22 +the **Sign in by email** button.
23 +
24 +![Verify your email!](https://user-images.githubusercontent.com/82235632/125475486-c667635a-067f-4866-9411-9f7f795a0d50.png)
25 +
26 +Click the **Verify** button in the email to begin using Netdata Cloud.
27 +
28 +To use this same Netdata Cloud account on additional devices, request another sign in email, open the email on that
29 +device, and sign in.
30 +
31 +### Don't have a Netdata Cloud account yet?
32 +
33 +If you don't have a Netdata Cloud account yet you won't need to worry about it. During the sign in process we will create one for you and make the process seamless to you.
34 +
35 +After your account is created and you sign in to Netdata, you first are asked to agree to Netdata Cloud's [Privacy
36 +Policy](https://www.netdata.cloud/privacy/) and [Terms of Use](https://www.netdata.cloud/terms/). Once you agree with these you are directed
37 +through the Netdata Cloud onboarding process, which is explained in the [Netdata Cloud
38 +quickstart](/docs/cloud/get-started).
39 +
40 +### Troubleshooting
41 +
42 +You should receive your sign in email in less than a minute. The subject is **Verify your email!** and the sender is `no-reply@app.netdata.cloud` via `sendgrid.net`.
43 +
44 +If you don't see the email, try the following:
45 +
46 +- Check [Netdata Cloud status](https://status.netdata.cloud) for ongoing issues with our infrastructure.
47 +- Request another sign in email via the [sign in page](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_troubleshooting_section).
48 +- Check your spam folder.
49 +- In Gmail, check the **Updates** category.
50 +
51 +You may also want to add `no-reply@app.netdata.cloud` to your address book or contacts list, especially if you're using
52 +a public email service, such as Gmail. You may also want to whitelist/allowlist either the specific email or the entire
53 +`app.netdata.cloud` domain.
54 +
55 +## Google and GitHub OAuth
56 +
57 +When you use Google/GitHub OAuth, your Netdata Cloud account is associated with the email address that Netdata Cloud
58 +receives via OAuth.
59 +
60 +To sign in with Google or GitHub OAuth, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_google_github_section) and click the
61 +**Continue with Google/GitHub** or button. Enter your Google/GitHub username and your password. Complete two-factor
62 +authentication if you or your organization has it enabled.
63 +
64 +You are then signed in to Netdata Cloud or directed to the new-user onboarding if you have not signed up previously.
65 +
66 +## Reset a password
67 +
68 +Netdata Cloud does not store passwords and does not support password resets. All of our sign in methods do not
69 +require passwords, and use either links in emails or Google/GitHub OAuth for authentication.
70 +
71 +## Switch between sign in methods
72 +
73 +You can switch between sign in methods if the email account associated with each method is the same.
74 +
75 +For example, you first sign in via your email account, `user@example.com`, and later sign out. You later attempt to sign
76 +in via a GitHub account associated with `user@example.com`. Netdata Cloud recognizes that the two are the same and signs
77 +you in to your original account.
78 +
79 +However, if you first sign in via your `user@example.com` email account and then sign in via a Google account associated
80 +with `user2@example.com`, Netdata Cloud creates a new account and begins the onboarding process.
81 +
82 +It is not currently possible to link an account created with `user@example.com` to a Google account associated with
83 +`user2@example.com`.
84 +
85 +## What's next?
86 +
87 +If you haven't already onboarded to Netdata Cloud and connected your first nodes, visit the [get started
88 +guide](/docs/cloud/get-started).
docs/cloud/manage/themes.md new
+22
@@ -0,0 +1,22 @@
1 +---
2 +title: "Choose your Netdata Cloud theme"
3 +description: "Switch between Light and Dark themes in Netdata Cloud to match your personal visualization preferences."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/themes.md"
5 +sidebar_label: "Choose your Netdata Cloud theme"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +The Dark theme is the default for all new Netdata Cloud accounts.
12 +
13 +To change your theme across Netdata Cloud, click on your profile picture, then **Profile**. Click on the **Settings**
14 +tab, then choose your preferred theme: Light or Dark.
15 +
16 +**Light**:
17 +
18 +![Dark theme](https://user-images.githubusercontent.com/1153921/108530742-2ca98c00-7293-11eb-8c1e-1e0dd34eb87b.png)
19 +
20 +**Dark (default)**:
21 +
22 +![Light theme](https://user-images.githubusercontent.com/1153921/108530848-4519a680-7293-11eb-897d-1c470b67ceb0.png)
docs/cloud/netdata-functions.md new
+56
@@ -0,0 +1,56 @@
1 +<!--
2 +title: "Netdata Functions"
3 +sidebar_label: "Netdata Functions"
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md"
5 +sidebar_position: "2800"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 +learn_docs_purpose: "Present the Netdata Functions what these are and why they should be used."
10 +-->
11 +
12 +Netdata Agent collectors are able to expose functions that can be executed in run-time and on-demand. These will be
13 +executed on the node - host where the function is made
14 +available.
15 +
16 +#### What is a function?
17 +
18 +Collectors besides the metric collection, storing, and/or streaming work are capable of executing specific routines on
19 +request. These routines will bring additional information
20 +to help you troubleshoot or even trigger some action to happen on the node itself.
21 +
22 +A function is a `key` - `value` pair. The `key` uniquely identifies the function within a node. The `value` is a
23 +function (i.e. code) to be run by a data collector when
24 +the function is invoked.
25 +
26 +For more details please check out documentation on our first collector that exposes
27 +functions - [plugins.d](/docs/nightly/references/collectors-references/plugins.d/#function)
28 +
29 +#### How do functions work with streaming?
30 +
31 +Via streaming, the definitions of functions are transmitted to a parent node so it knows all the functions available on
32 +any children connected to it.
33 +
34 +If the parent node is the one connected to Netdata Cloud it is capable of triggering the call to the respective children
35 +node to run the function.
36 +
37 +#### Why are they available only on Netdata Cloud?
38 +
39 +Since these functions are able to execute routines on the node and due the potential use cases that they can cover, our
40 +concern is to ensure no sensitive
41 +information or disruptive actions are exposed through the Agent's API.
42 +
43 +With the communication between the Netdata Agent and Netdata Cloud being
44 +through [ACLK](https://github.com/netdata/netdata/blob/master/docs/concepts/netdata-agent/aclk.md#ACLK) this
45 +concern is addressed.
46 +
47 +## Related Topics
48 +
49 +### **Related Concepts**
50 +
51 +- [ACLK](https://github.com/netdata/netdata/blob/master/docs/concepts/netdata-agent/aclk.md)
52 +- [plugins.d](https://github.com/netdata/netdata/tree/master/collectors/plugins.d)
53 +
54 +### Related Tasks
55 +
56 +- [Run-time troubleshooting with Functions](docs/nightly/tasks/operations/runtime-troubleshootting-with-function)
docs/cloud/runtime-troubleshooting-with-functions.md new
+41
@@ -0,0 +1,41 @@
1 +<!--
2 +title: "Run-time troubleshooting with Functions"
3 +sidebar_label: "Run-time troubleshooting with Functions"
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/runtime-troubleshooting-with-functions.md"
5 +learn_status: "Published"
6 +sidebar_position: "4"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +learn_docs_purpose: "Instructions on how to use Functions"
10 +-->
11 +
12 +Netdata Functions feature allows you to execute on-demand a pre-defined routine on a node where a Netdata Agent is running. These routines are exposed by a given collector.
13 +These routines can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself.
14 +
15 +
16 +### Prerequisites
17 +
18 +The following is required to be able to run Functions from Netdata Cloud.
19 +* Have at least one capable node claimed to one of your Spaces (node on a version higher than `v1.37`)
20 +* Ensure that node has the collector that exposes the function enabled
21 +
22 +### Execute a function (from functions view)
23 +
24 +1. From the right-hand bar select the **Function** you want to run
25 +2. Still on the right-hand bar select the **Node** where you want to run it
26 +3. Results will be displayed in the central area for you to interact with
27 +4. Additional filtering capabilities, depending on the function, should be available on right-hand bar
28 +
29 +### Execute a function (from Nodes view)
30 +
31 +1. Click on the functions icon for a node that has this active
32 +2. You are directed to the **Functions** tab
33 +3. Follow the above instructions from step 3.
34 +
35 +## Related Topics
36 +
37 +### **Related Concepts**
38 +- [Netdata Functions](https://github.com/netdata/netdata/blob/master/docs/concepts/guided-troubleshooting/netdata-functions.md)
39 +
40 +#### Related References documentation
41 +- [External plugins overview](https://github.com/netdata/netdata/tree/master/collectors/plugins.d#function)
docs/cloud/spaces.md new
+86
@@ -0,0 +1,86 @@
1 +---
2 +title: "Spaces"
3 +description: " Organize your infrastructure monitoring on Netdata Cloud by creating Spaces, then groupingyour Agent-monitored nodes. "
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md"
5 +sidebar_label: "Spaces"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +A Space is a high-level container. It's a collaboration space where you can organize team members, access levels and the
12 +nodes you want to monitor.
13 +
14 +Let's talk through some strategies for creating the most intuitive Cloud experience for your team.
15 +
16 +## How to organize your Netdata Cloud
17 +
18 +You can use any number of Spaces you want, but as you organize your Cloud experience, keep in mind that _you can only
19 +add any given node to a single Space_. This 1:1 relationship between node and Space may dictate whether you use one
20 +encompassing Space for your entire team and separate them by War Rooms, or use different Spaces for teams monitoring
21 +discrete parts of your infrastructure.
22 +
23 +If you have been invited to Netdata Cloud by another user by default you will able to see this space. If you are a new
24 +user the first space is already created.
25 +
26 +The other consideration for the number of Spaces you use to organize your Netdata Cloud experience is the size and
27 +complexity of your organization.
28 +
29 +For small team and infrastructures we recommend sticking to a single Space so that you can keep all your nodes and their
30 +respective metrics in one place. You can then use multiple [War Rooms](/docs/cloud/war-rooms) to further organize your
31 +infrastructure monitoring.
32 +
33 +Enterprises may want to create multiple Spaces for each of their larger teams, particularly if those teams have
34 +different responsibilities or parts of the overall infrastructure to monitor. For example, you might have one SRE team
35 +for your user-facing SaaS application and a second team for infrastructure tooling. If they don't need to monitor the
36 +same nodes, you can create separate Spaces for each team.
37 +
38 +## Navigate between spaces
39 +
40 +Click on any of the boxes to switch between available Spaces.
41 +
42 +Netdata Cloud abbreviates each Space to the first letter of the name, or the first two letters if the name is two words
43 +or more. Hover over each icon to see the full name in a tooltip.
44 +
45 +To add a new Space click on the green **+** button . Enter the name of the Space and click **Save**.
46 +
47 +![Switch between Spaces](/img/cloud/main-page-add-space.png)
48 +
49 +## Manage Spaces
50 +
51 +Manage your spaces by selecting in a particular space and clicking in the small gear icon in the lower left corner. This
52 +will open a side tab in which you can:
53 +
54 +1. _Configure this Space*_, in the first tab (**Space**) you can change the name, description or/and some privilege
55 + options of this space
56 +
57 +2. _Edit the War Rooms*_, click on the **War rooms** tab to add or remove War Rooms.
58 +
59 +3. _Connect nodes*_, click on **Nodes** tab. Copy the claiming script to your node and run it. See the
60 + [connect to Cloud doc](/docs/agent/claim) for details.
61 +
62 +4. _Manage the users*_, click on **Users**. The [invitation doc](/docs/cloud/manage/invite-your-team)
63 + details the invitation process.
64 +
65 +5. _Manage notification setting*_, click on **Notifications** tab to turn off/on notification methods.
66 +
67 +6. _Manage your bookmarks*_, click on the **Bookmarks** tab to add or remove bookmarks that you need.
68 +
69 +:::note \* This action requires admin rights for this space
70 +:::
71 +
72 +## Obsoleting offline nodes from a Space
73 +
74 +Netdata admin users now have the ability to remove obsolete nodes from a space.
75 +
76 +- Only admin users have the ability to obsolete nodes
77 +- Only offline nodes can be marked obsolete (Live nodes and stale nodes cannot be obsoleted)
78 +- Node obsoletion works across the entire space, so the obsoleted node will be removed from all rooms belonging to the
79 + space
80 +- If the obsoleted nodes eventually become live or online once more they will be automatically re-added to the space
81 +
82 +![Obsoleting an offline node](https://user-images.githubusercontent.com/24860547/173087202-70abfd2d-f0eb-4959-bd0f-74aeee2a2a5a.gif)
83 +
84 +## What's next?
85 +
86 +Once you configured your Spaces, it's time to set up your [War Rooms](/docs/cloud/war-rooms).
docs/cloud/visualize/dashboards.md new
+119
@@ -0,0 +1,119 @@
1 +---
2 +title: "Build new dashboards"
3 +description: "Design new dashboards that target your infrastructure's unique needs and share them with your team for targeted visual anomaly detection or incident response."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md"
5 +sidebar_label: "Build new dashboards"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations/Visualizations"
9 +---
10 +
11 +With Netdata Cloud, you can build new dashboards that target your infrastructure's unique needs. Put key metrics from
12 +any number of distributed systems in one place for a bird's eye view of your infrastructure.
13 +
14 +Click on the **Dashboards** tab in any War Room to get started.
15 +
16 +## Create your first dashboard
17 +
18 +From the Dashboards tab, click on the **+** button.
19 +
20 +![Add or manage
21 +dashboards](https://user-images.githubusercontent.com/1153921/108529360-a2145d00-7291-11eb-814b-2ea3303beb64.png)
22 +
23 +In the modal, give your new dashboard a name, and click **+ Add**.
24 +
25 +Click the **Add Chart** button to add your first chart card. From the dropdown, select either *All Nodes** or a specific
26 +node. If you select **All Nodes**, you will add a [composite chart](/docs/cloud/visualize/overview#composite-charts) to
27 +your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
28 +
29 +The **Add Text** button creates a new card with user-defined text, which you can use to describe or document a
30 +particular dashboard's meaning and purpose.
31 +
32 +Be sure to click the **Save** button any time you make changes to your dashboard.
33 +
34 +![An example multi-node dashboard for system CPU
35 +metrics](https://user-images.githubusercontent.com/1153921/108526381-4f857180-728e-11eb-9d65-1613e60891a5.png)
36 +
37 +## Using your dashboard
38 +
39 +Dashboards are designed to be interactive and flexible so you can design them to your exact needs. Dashboards are made
40 +of any number of **cards**, which can contain charts or text.
41 +
42 +### Chart cards
43 +
44 +Click the **Add Chart** button to add your first chart card. From the dropdown, select either *All Nodes** or a specific
45 +node. If you select **All Nodes**, you will add a [composite chart](/docs/cloud/visualize/overview#composite-charts) to
46 +your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
47 +
48 +The charts you add to any dashboard are fully interactive, just like the charts in an Agent dashboard or a single node's
49 +dashboard in Cloud. Zoom in and out, highlight timeframes, and more. See our [Agent dashboard
50 +docs](https://learn.netdata.cloud/docs/agent/web#using-charts) for all the shortcuts.
51 +
52 +Charts also synchronize as you interact with them, even across contexts _or_ nodes.
53 +
54 +### Text cards
55 +
56 +The **Add Text** button creates a new card with user-defined text. When you create a new text card or edit an existing
57 +one, select/highlight characters or words to open a modal to make them **bold**, _italic_, or <ins>underlined</ins>. You
58 +can also create a link.
59 +
60 +### Move cards
61 +
62 +To move any card, click and hold on the top of the card, then drag it to a new location. A red placeholder indicates the
63 +new location. Once you release your mouse, other charts re-sort to the grid system automatically.
64 +
65 +### Resize cards
66 +
67 +To resize any card on a dashboard, click on the bottom-right corner and drag to the card's new size. Other cards re-sort
68 +to the grid system automatically.
69 +
70 +## Jump to single-node dashboards
71 +
72 +Quickly jump to any node's dashboard by clicking the 3-dot icon in the corner of any card to open a menu. Hit the **Go
73 +to Chart** item.
74 +
75 +You'll land directly on that chart of interest, but you can now scroll up and down to correlate your findings with other
76 +charts. Of course, you can continue to zoom, highlight, and pan through time just as you're used to with Agent
77 +dashboards.
78 +
79 +## Pin dashboards
80 +
81 +Click on the **Pin** button in any dashboard to put those charts into a separate panel at the bottom of the screen. You
82 +can now navigate through Netdata Cloud freely, individual Cloud dashboards, the Nodes view, different War Rooms, or even
83 +different Spaces, and have those valuable metrics follow you.
84 +
85 +Pinning dashboards helps you correlate potentially related charts across your infrastructure, no matter how you
86 +organized your Spaces and War Rooms, and helps you discover root causes faster.
87 +
88 +## Manage your dashboards
89 +
90 +To see dashboards associated with the current War Room, click **Dashboards** tab in any War Room. You can select
91 +dashboards and delete them using the 🗑️ icon.
92 +
93 +### Update/save a dashboard
94 +
95 +If you've made changes to a dashboard, such as adding or moving cards, the **Save** button is enabled. Click it to save
96 +your most recent changes. Any other members of the War Room will be able to see these changes the next time they load
97 +this dashboard.
98 +
99 +If multiple users attempt to make concurrent changes to the same dashboard, the second user who hits Save will be
100 +prompted to either overwrite the dashboard or reload to see the most recent changes.
101 +
102 +### Remove an individual card
103 +
104 +Click on the 3-dot icon in the corner of any card to open a menu. Click the **Remove Card** item to remove the card.
105 +
106 +### Delete a dashboard
107 +
108 +Delete any dashboard by navigating to it and clicking the **Delete** button. This will remove this entry from the
109 +dropdown for every member of this War Room.
110 +
111 +### Minimum browser viewport
112 +
113 +Because of the visual complexity of individual charts, dashboards require a minimum browser viewport of 800px.
114 +
115 +## What's next?
116 +
117 +Once you've designed a dashboard or two, make sure to [invite your team](/docs/cloud/manage/invite-your-team) if
118 +you haven't already. You can add these new users to the same War Room to let them see the same dashboards without any
119 +effort.
docs/cloud/visualize/interact-new-charts.md new
+185
@@ -0,0 +1,185 @@
1 +---
2 +title: "Interact with charts"
3 +description: "Learn how to get the most out of Netdata's charts. These charts will help you make sense of all the metrics at your disposal, helping you troubleshoot with real-time, per-second metric data"
4 +type: "how-to"
5 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md"
6 +sidebar_label: "Interact with charts"
7 +learn_status: "Published"
8 +learn_topic_type: "Concepts"
9 +learn_rel_path: "Operations/Visualizations"
10 +---
11 +
12 +> ⚠️ This new version of charts is currently **only** available on Netdata Cloud. We didn't want to keep this valuable
13 +> feature from you, so after we get this into your hands on the Cloud, we will collect and implement your feedback. Together, we will be able to provide the best possible version of charts on the Netdata Agent dashboard, as quickly as possible.
14 +
15 +Netdata excels in collecting, storing, and organizing metrics in out-of-the-box dashboards.
16 +To make sense of all the metrics, Netdata offers an enhanced version of charts that update every second.
17 +
18 +These charts provide a lot of useful information, so that you can:
19 +
20 +- Enjoy the high-resolution, granular metrics collected by Netdata
21 +- Explore visualization with more options such as _line_, _stacked_ and _area_ types (other types like _bar_, _pie_ and _gauges_ are to be added shortly)
22 +- Examine all the metrics by hovering over them with your cursor
23 +- Use intuitive tooling and shortcuts to pan, zoom or highlight your charts
24 +- On highlight, ease access to [Metric Correlations](/docs/cloud/insights/metric-correlations) to see other metrics with similar patterns
25 +- Have the dimensions sorted based on name or value
26 +- View information about the chart, its plugin, context, and type
27 +- Get the chart status and possible errors. On top, reload functionality
28 +
29 +These charts will available on [Overview tab](/docs/cloud/visualize/overview), Single Node view and on your [Custom Dashboards](/docs/cloud/visualize/dashboards).
30 +
31 +## Overview
32 +
33 +Have a look at the can see the overall look and feel of the charts for both with a composite chart from the [Overview tab](/docs/cloud/visualize/overview) and a simple chart from the single node view:
34 +
35 +![NRve6zr325.gif](https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/5ecaf5ec-1229-480e-b122-62f63e9df227)
36 +
37 +With a quick glance you have immediate information available at your disposal:
38 +
39 +- Chart title and units
40 +- Action bars
41 +- Chart area
42 +- Legend with dimensions
43 +
44 +## Play, Pause and Reset
45 +
46 +Your charts are controlled using the available [Time controls](/docs/dashboard/visualization-date-and-time-controls#time-controls). Besides these, when interacting with the chart you can also activate these controls by:
47 +
48 +- hovering over any chart to temporarily pause it - this momentarily switches time control to Pause, so that you can hover over a specific timeframe. When moving out of the chart time control will go back to Play (if it was it's previous state)
49 +- clicking on the chart to lock it - this enables the Pause option on the time controls, to the current timeframe. This is if you want to jump to a different chart to look for possible correlations.
50 +- double clicking to release a previously locked chart - move the time control back to Play
51 +
52 + ![23CHKCPnnJ.gif](https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/0b1e111e-df44-4d92-b2e3-be5cfd9db8df)
53 +
54 +| Interaction | Keyboard/mouse | Touchpad/touchscreen | Time control |
55 +| :---------------- | :------------- | :------------------- | :-------------------- |
56 +| **Pause** a chart | `hover` | `n/a` | Temporarily **Pause** |
57 +| **Stop** a chart | `click` | `tap` | **Pause** |
58 +| **Reset** a chart | `double click` | `n/a` | **Play** |
59 +
60 +Note: These interactions are available when the default "Pan" action is used. Other actions are accessible via the [Exploration action bar](#exploration-action-bar).
61 +
62 +## Title and chart action bar
63 +
64 +When you start interacting with a chart, you'll notice valuable information on the top bar. You will see information from the chart title to a chart action bar.
65 +
66 +The elements that you can find on this top bar are:
67 +
68 +- Netdata icon: this indicates that data is continuously being updated, this happens if [Time controls](/docs/dashboard/visualization-date-and-time-controls#time-controls) are in Play or Force Play mode
69 +- Chart status icon: indicates the status of the chart. Possible values are: Loading, Timeout, Error or No data
70 +- Chart title: on the chart title you can see the title together with the metric being displayed, as well as the unit of measurement
71 +- Chart action bar: here you'll have access to chart info, change chart types, enables fullscreen mode, and the ability to add the chart to a custom dashboard
72 +
73 +![image.png](https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/c8f5f0bd-5f84-4812-970b-0e4340f4773b)
74 +
75 +### Chart action bar
76 +
77 +On this bar you have access to immediate actions over the chart, the available actions are:
78 +
79 +- Chart info: you will be able to get more information relevant to the chart you are interacting with
80 +- Chart type: change the chart type from _line_, _stacked_ or _area_
81 +- Enter fullscreen mode: allows you expand the current chart to the full size of your screen
82 +- Add chart to dashboard: This allows you to add the chart to an existing custom dashboard or directly create a new one that includes the chart.
83 +
84 +<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/65ac4fc8-3d8d-4617-8234-dbb9b31b4264" width="40%" height="40%" />
85 +
86 +## Exploration action bar
87 +
88 +When exploring the chart you will see a second action bar. This action bar is there to support you on this task. The available actions that you can see are:
89 +
90 +- Pan
91 +- Highlight
92 +- Horizontal and Vertical zooms
93 +- In-context zoom in and out
94 +
95 +<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/0417ad66-fcf6-42d5-9a24-e9392ec51f87" width="40%" height="40%" />
96 +
97 +### Pan
98 +
99 +Drag your mouse/finger to the right to pan backward through time, or drag to the left to pan forward in time. Think of it like pushing the current timeframe off the screen to see what came before or after.
100 +
101 +| Interaction | Keyboard | Mouse | Touchpad/touchscreen |
102 +| :---------- | :------- | :------------- | :------------------- |
103 +| **Pan** | `n/a` | `click + drag` | `touch drag` |
104 +
105 +### Highlight
106 +
107 +Selecting timeframes is useful when you see an interesting spike or change in a chart and want to investigate further, from looking at the same period of time on other charts/sections or triggering actions to help you troubleshoot with an in-context action bar to help you troubleshoot (currently only available on
108 + Single Node view). The available actions:
109 +
110 +- run [Metric Correlations](/docs/cloud/insights/metric-correlations)
111 +- zoom in on the selected timeframe
112 +
113 +[Metric Correlations](/docs/cloud/insights/metric-correlations) will only be available if you respect the timeframe selection limitations. The selected duration pill together with the button state helps visualize this.
114 +
115 +<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/2ffc157d-0f0f-402e-80bb-5ffa8a2091d5" width="50%" height="50%" />
116 +
117 +<p/>
118 +
119 +| Interaction | Keyboard/mouse | Touchpad/touchscreen |
120 +| :--------------------------------- | :------------------------------------------------------- | :------------------- |
121 +| **Highlight** a specific timeframe | `Alt + mouse selection` or `⌘ + mouse selection` (macOS) | `n/a` |
122 +
123 +### Zoom
124 +
125 +Zooming in helps you see metrics with maximum granularity, which is useful when you're trying to diagnose the root cause
126 +of an anomaly or outage. Zooming out lets you see metrics within the larger context, such as the last hour, day, or
127 +week, which is useful in understanding what "normal" looks like, or to identify long-term trends, like a slow creep in
128 +memory usage.
129 +
130 +The actions above are _normal_ vertical zoom actions. We also provide an horizontal zoom action that helps you focus on a
131 +specific Y-axis area to further investigate a spike or dive on your charts.
132 +
133 +![Y5IESOjD3s.gif](https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/f8722ee8-e69b-426c-8bcb-6cb79897c177)
134 +
135 +| Interaction | Keyboard/mouse | Touchpad/touchscreen |
136 +| :----------------------------------------- | :----------------------------------- | :--------------------------------------------------- |
137 +| **Zoom** in or out | `Shift + mouse scrollwheel` | `two-finger pinch` <br />`Shift + two-finger scroll` |
138 +| **Zoom** to a specific timeframe | `Shift + mouse vertical selection` | `n/a` |
139 +| **Horizontal Zoom** a specific Y-axis area | `Shift + mouse horizontal selection` | `n/a` |
140 +
141 +You also have two direct action buttons on the exploration action bar for in-context `Zoom in` and `Zoom out`.
142 +
143 +## Other interactions
144 +
145 +### Order dimensions legend
146 +
147 +The bottom legend of the chart where you can see the dimensions of the chart can now be ordered by:
148 +
149 +- Dimension name (Ascending or Descending)
150 +- Dimension value (Ascending or Descending)
151 +
152 +<img src="https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/d3031c35-37bc-46c1-bcf9-be29dea0b476" width="50%" height="50%" />
153 +
154 +### Show and hide dimensions
155 +
156 +Hiding dimensions simplifies the chart and can help you better discover exactly which aspect of your system might be
157 +behaving strangely.
158 +
159 +| Interaction | Keyboard/mouse | Touchpad/touchscreen |
160 +| :------------------------------------- | :-------------- | :------------------- |
161 +| **Show one** dimension and hide others | `click` | `tap` |
162 +| **Toggle (show/hide)** one dimension | `Shift + click` | `n/a` |
163 +
164 +### Resize
165 +
166 +To resize the chart, click-and-drag the icon on the bottom-right corner of any chart. To restore the chart to its original height,
167 +double-click the same icon.
168 +
169 +![AjqnkIHB9H.gif](https://images.zenhubusercontent.com/60b4ebb03f4163193ec31819/1bcc6a0a-a58e-457b-8a0c-e5d361a3083c)
170 +
171 +## What's next?
172 +
173 +We recommend you read up on the differences between [chart dimensions, contexts, and
174 +families](/docs/dashboard/dimensions-contexts-families) to strengthen your understanding of how Netdata organizes its
175 +dashboards. Another valuable way to interact with charts is to use the [date and time controls](/docs/dashboard/visualization-date-and-time-controls), which helps you visualize specific moments of historical metrics.
176 +
177 +### Further reading & related information
178 +
179 +- Dashboard
180 + - [How the dashboard works](/docs/dashboard/how-dashboard-works)
181 + - [Chart dimensions, contexts, and families](/docs/dashboard/dimensions-contexts-families)
182 + - [Date and Time controls](/docs/dashboard/visualization-date-and-time-controls)
183 + - [Customize the standard dashboard](/docs/dashboard/customize)
184 + - [Metric Correlations](/docs/cloud/insights/metric-correlations)
185 + - [Netdata Agent - Interact with charts](/docs/dashboard/interact-charts)
docs/cloud/visualize/kubernetes.md new
+154
@@ -0,0 +1,154 @@
1 +---
2 +title: "Kubernetes visualizations"
3 +description: "Netdata Cloud features rich, zero-configuration Kubernetes monitoring for the resource utilization and application metrics of Kubernetes (k8s) clusters."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md"
5 +sidebar_label: "Kubernetes visualizations"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Operations/Visualizations"
9 +---
10 +
11 +Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in
12 +the default [Overview](/docs/cloud/visualize/overview/) dashboard.
13 +
14 +These visualizations include a health map for viewing the status of k8s pods/containers, in addition to composite charts
15 +for viewing per-second CPU, memory, disk, and networking metrics from k8s nodes.
16 +
17 +## Before you begin
18 +
19 +In order to use the Kubernetes visualizations in Netdata Cloud, you need:
20 +
21 +- A Kubernetes cluster running Kubernetes v1.9 or newer.
22 +- A Netdata deployment using the latest version of the [Helm chart](https://github.com/netdata/helmchart), which
23 + installs [v1.29.2](https://github.com/netdata/netdata/releases) or newer of the Netdata Agent.
24 +- To connect your Kubernetes cluster to Netdata Cloud.
25 +- To enable the feature flag described below.
26 +
27 +See our [Kubernetes deployment instructions](/docs/agent/packaging/installer/methods/kubernetes/) for details on
28 +installation and connecting to Netdata Cloud.
29 +
30 +## Available Kubernetes metrics
31 +
32 +Netdata Cloud organizes and visualizes the following metrics from your Kubernetes cluster from every container:
33 +
34 +- `cpu_limit`: CPU utilization as a percentage of the limit defined by the [pod specification
35 + `spec.containers[].resources.limits.cpu`](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container)
36 + or a [`LimitRange`
37 + object](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/cpu-default-namespace/#create-a-limitrange-and-a-pod).
38 +- `cpu`: CPU utilization of the pod/container. 100% usage equals 1 fully-utilized core, 200% equals 2 fully-utilized
39 + cores, and so on.
40 +- `cpu_per_core`: CPU utilization averaged across available cores.
41 +- `mem_usage_limit`: Memory utilization, without cache, as a percentage of the limit defined by the [pod specification
42 + `spec.containers[].resources.limits.memory`](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container)
43 + or a [`LimitRange`
44 + object](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/cpu-default-namespace/#create-a-limitrange-and-a-pod).
45 +- `mem_usage`: Used memory, without cache.
46 +- `mem`: The sum of `cache` and `rss` (resident set size) memory usage.
47 +- `writeback`: The size of `dirty` and `writeback` cache.
48 +- `mem_activity`: Sum of `in` and `out` bandwidth.
49 +- `pgfaults`: Sum of page fault bandwidth, which are raised when the Kubernetes cluster tries accessing a memory page
50 + that is mapped into the virtual address space, but not actually loaded into main memory.
51 +- `throttle_io`: Sum of `read` and `write` per second across all PVs/PVCs attached to the container.
52 +- `throttle_serviced_ops`: Sum of the `read` and `write` operations per second across all PVs/PVCs attached to the
53 + container.
54 +- `net.net`: Sum of `received` and `sent` bandwidth per second.
55 +- `net.packets`: Sum of `multicast`, `received`, and `sent` packets.
56 +
57 +When viewing the [health map](#health-map), Netdata Cloud shows the above metrics per container, or aggregated based on
58 +their associated pods.
59 +
60 +When viewing the [composite charts](#composite-charts), Netdata Cloud aggregates metrics from multiple nodes, pods, or
61 +containers, depending on the grouping chosen. For example, if you group the `cpu_limit` composite chart by
62 +`k8s_namespace`, the metrics shown will be the average of `cpu_limit` metrics from all nodes/pods/containers that are
63 +part of that namespace.
64 +
65 +## Health map
66 +
67 +The health map places each container or pod as a single box, then varies the intensity of its color to visualize the
68 +resource utilization of specific k8s pods/containers.
69 +
70 +![The Kubernetes health map in Netdata
71 +Cloud](https://user-images.githubusercontent.com/1153921/106964367-39f54100-66ff-11eb-888c-5a04f8abb3d0.png)
72 +
73 +Change the health map's coloring, grouping, and displayed nodes to customize your experience and learn more about the
74 +status of your k8s cluster.
75 +
76 +### Color by
77 +
78 +Color the health map by choosing an aggregate function to apply to an [available Kubernetes
79 +metric](#available-kubernetes-metrics), then whether you to display boxes for individual pods or containers.
80 +
81 +The default is the _average, of CPU within the configured limit, organized by container_.
82 +
83 +### Group by
84 +
85 +Group the health map by the `k8s_cluster_id`, `k8s_controller_kind`, `k8s_controller_name`, `k8s_kind`, `k8s_namespace`,
86 +and `k8s_node_name`. The default is `k8s_controller_name`.
87 +
88 +### Filtering
89 +
90 +Filtering behaves identically to the [node filter in War Rooms](/docs/cloud/war-rooms#node-filter), with the ability to
91 +filter pods/containers by `container_id` and `namespace`.
92 +
93 +### Detailed information
94 +
95 +Hover over any of the pods/containers in the map to display a modal window, which contains contextual information
96 +and real-time metrics from that resource.
97 +
98 +![The modal containing additional information about a k8s
99 +resource](https://user-images.githubusercontent.com/1153921/106964369-3a8dd780-66ff-11eb-8a8a-a5c8f0d5711f.png)
100 +
101 +The **context** tab provides the following details about a container or pod:
102 +
103 +- Cluster ID
104 +- Node
105 +- Controller Kind
106 +- Controller Name
107 +- Pod Name
108 +- Container
109 +- Kind
110 +- Pod UID
111 +
112 +This information helps orient you as to where the container/pod operates inside your cluster.
113 +
114 +The **Metrics** tab contains charts visualizing the last 15 minutes of the same metrics available in the [color by
115 +option](#color-by). Use these metrics along with the context, to identify which containers or pods are experiencing
116 +problematic behavior to investigate further, troubleshoot, and remediate with `kubectl` or another tool.
117 +
118 +## Composite charts
119 +
120 +The Kubernetes composite charts show real-time and historical resource utilization metrics from nodes, pods, or
121 +containers within your Kubernetes deployment.
122 +
123 +See the [Overview](/docs/cloud/visualize/overview#definition-bar) doc for details on how composite charts work. These
124 +work similarly, but in addition to visualizing _by dimension_ and _by node_, Kubernetes composite charts can also be
125 +grouped by the following labels:
126 +
127 +- `k8s_cluster_id`
128 +- `k8s_container_id`
129 +- `k8s_container_name`
130 +- `k8s_controller_kind`
131 +- `k8s_kind`
132 +- `k8s_namespace`
133 +- `k8s_node_name`
134 +- `k8s_pod_name`
135 +- `k8s_pod_uid`
136 +
137 +![Composite charts of Kubernetes metrics in Netdata
138 +Cloud](https://user-images.githubusercontent.com/1153921/106964370-3a8dd780-66ff-11eb-8858-05b2253b25c6.png)
139 +
140 +In addition, when you hover over a composite chart, the colors in the heat map changes as well, so you can see how
141 +certain pod/container-level metrics change over time.
142 +
143 +## Caveats
144 +
145 +There are some caveats and known issues with Kubernetes monitoring with Netdata Cloud.
146 +
147 +- **No way to remove any nodes** you might have
148 + [drained](https://kubernetes.io/docs/tasks/administer-cluster/safely-drain-node/) from your Kubernetes cluster. These
149 + drained nodes will be marked "unreachable" and will show up in War Room management screens/dropdowns. The same applies
150 + for any ephemeral nodes created and destroyed during horizontal scaling.
151 +
152 +## What's next?
153 +
154 +For more information about monitoring a k8s cluster with Netdata, see our guide: [_Kubernetes monitoring with Netdata: Overview and visualizations_](/guides/monitor/kubernetes-k8s-netdata/).
docs/cloud/visualize/nodes.md new
+53
@@ -0,0 +1,53 @@
1 +---
2 +title: "Nodes view"
3 +description: "See charts from all your nodes in one pane of glass, then dive in to embedded dashboards for granular troubleshooting of ongoing issues."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md"
5 +sidebar_label: "Nodes view"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Operations/Visualizations"
9 +---
10 +
11 +The Nodes view lets you see and customize key metrics from any number of Agent-monitored nodes and seamlessly navigate
12 +to any node's dashboard for troubleshooting performance issues or anomalies using Netdata's highly-granular metrics.
13 +
14 +![The Nodes view in Netdata
15 +Cloud](https://user-images.githubusercontent.com/1153921/119035218-2eebb700-b964-11eb-8b74-4ec2df0e457c.png)
16 +
17 +Each War Room's Nodes view is populated based on the nodes you added to that specific War Room. Each node occupies a
18 +single row, first featuring that node's alarm status (yellow for warnings, red for critical alarms) and operating
19 +system, some essential information about the node, followed by columns of user-defined key metrics represented in
20 +real-time charts.
21 +
22 +Use the [Overview](/docs/cloud/visualize/overview) for monitoring an infrastructure in real time using
23 +composite charts and Netdata's familiar dashboard UI.
24 +
25 +Check the [War Room docs](/docs/cloud/war-rooms) for details on the utility bar, which contains the [node
26 +filter](/docs/cloud/war-rooms#node-filter) and the [timeframe
27 +selector](/docs/cloud/war-rooms#play-pause-force-play-and-timeframe-selector).
28 +
29 +## Add and customize metrics columns
30 +
31 +Add more metrics columns by clicking the gear icon. Choose the context you'd like to add, give it a relevant name, and
32 +select whether you want to see all dimensions (the default), or only the specific dimensions your team is interested in.
33 +
34 +Click the gear icon and hover over any existing charts, then click the pencil icon. This opens a panel to
35 +edit that chart. Edit the context, its title, add or remove dimensions, or delete the chart altogether.
36 +
37 +These customizations appear for anyone else with access to that War Room.
38 +
39 +## See more metrics in Netdata Cloud
40 +
41 +If you want to add more metrics to your War Rooms and they don't show up when you add new metrics to Nodes, you likely
42 +need to configure those nodes to collect from additional data sources. See our [collectors doc](/docs/collect/enable-configure)
43 +to learn how to use dozens of pre-installed collectors that can instantly collect from your favorite services and applications.
44 +
45 +If you want to see up to 30 days of historical metrics in Cloud (and more on individual node dashboards), read our guide
46 +on [long-term storage of historical metrics](/guides/longer-metrics-storage). Also, see our
47 +[calculator](/docs/store/change-metrics-storage#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
48 +for finding the disk and RAM you need to store metrics for a certain period of time.
49 +
50 +## What's next?
51 +
52 +Now that you know how to view your nodes at a glance, learn how to [track active
53 +alarms](/docs/cloud/alerts-notifications/view-active-alerts) with the Alerts Smartboard.
docs/cloud/visualize/overview.md new
+220
@@ -0,0 +1,220 @@
1 +---
2 +title: "Home, Overview and Single Node view"
3 +description: "The Home tab automatically presents relevant information of your War Room, the Overview uses composite charts from all the nodes in a given War Room and Single Node view provides a look at a specific Node"
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md"
5 +sidebar_label: "Home, Overview and Single Node view"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Operations/Visualizations"
9 +---
10 +
11 +## Home
12 +
13 +The Home tab provides a predefined dashboard of relevant information about entities in the War Room.
14 +
15 +This tab will
16 +automatically present summarized information in an easily digestible display. You can see information about your
17 +nodes, data collection and retention stats, alerts, users and dashboards.
18 +
19 +## Overview
20 +
21 +The Overview tab is another great way to monitor infrastructure using Netdata Cloud. While the interface might look similar to local
22 +dashboards served by an Agent Overview uses **composite charts**.
23 +These charts display real-time aggregated metrics from all the nodes (or a filtered selection) in a given War Room.
24 +
25 +With Overview's composite charts, you can see your infrastructure from a single pane of glass, discover trends or
26 +anomalies, then drill down by grouping metrics by node and jumping to single-node dashboards for root cause analysis.
27 +
28 +## Single Node view
29 +
30 +The Single Node view dashboard engine is the same as the Overview, meaning that it also uses **composite charts**, and displays real-time aggregated metrics from a specific node.
31 +
32 +As mentioned above, the interface is similar to local dashboards served by an Agent but this dashboard also uses **composite charts** which, in the case of a single node, will aggregate
33 +multiple chart _instances_ belonging to a context into a single chart. For example, on `disk.io` context it will get into a single chart an aggregated view of each disk the node has.
34 +
35 +Further tools provided in composite chart [definiton bar](/docs/cloud/visualize/overview#definition-bar) will allow you to explore in more detail what is happening on each _instance_.
36 +
37 +## Before you get started
38 +
39 +Only nodes with v1.25.0-127 or later of the the [open-source Netdata](https://github.com/netdata/netdata) monitoring
40 +agent can contribute to composite charts. If your node(s) use an earlier version of Netdata, you will see them marked as
41 +**needs upgrade** in various dropdowns.
42 +
43 +See our [update docs](/docs/agent/packaging/installer/update) for the preferred update method based on how you installed
44 +Netdata.
45 +
46 +## Composite charts
47 +
48 +The Overview uses composite charts, which aggregate metrics from all the nodes (or a filtered selection) in a given War
49 +Room.
50 +
51 +## Definition bar
52 +
53 +Each composite chart has a definition bar to provide information about the following:
54 +* Grouping option
55 +* Aggregate function to be applied in case multiple data sources exist
56 +* Instances
57 +* Nodes
58 +* Dimensions, and
59 +* Aggregate function over time to be applied if one point in the chart consists of multiple data points aggregated
60 +
61 +### Group by dimension, node, or chart
62 +
63 +Click on the **dimension** dropdown to change how a composite chart groups metrics.
64 +
65 +The default option is by _dimension_, so that each line/area in the visualization is the aggregation of a single dimension.
66 +This provides a per dimension view of the data from all the nodes in the War Room, taking into account filtering criteria if defined.
67 +
68 +A composite chart grouped by _node_ visualizes a single metric across contributing nodes. If the composite chart has five
69 +contributing nodes, there will be five lines/areas. This is typically an absolute value of the sum of the dimensions over each node but there
70 +are some opinionated-but-valuable exceptions where a specific dimension is selected.
71 +Grouping by nodes allows you to quickly understand which nodes in your infrastructure are experiencing anomalous behavior.
72 +
73 +A composite chart grouped by _instance_ visualizes each instance of one software or hardware on a node and displays these as a separate dimension. By grouping the
74 +`disk.io` chart by _instance_, you can visualize the activity of each disk on each node that contributes to the composite
75 +chart.
76 +
77 +Another very pertinent example is composite charts over contexts related to cgroups (VMs and containers). You have the means to change the default group by or apply filtering to
78 +get a better view into what data your are trying to analyze. For example, if you change the group by to _instance_ you get a view with the data of all the instances (cgroups) that
79 +contribute to that chart. Then you can use further filtering tools to focus the data that is important to you and even save the result to your own dashboards.
80 +
81 +![image](https://user-images.githubusercontent.com/82235632/201902017-04b76701-0ff9-4498-aa9b-6d507b567bea.png)
82 +
83 +### Aggregate functions over data sources
84 +
85 +Each chart uses an opinionated-but-valuable default aggregate function over the data sources. For example, the `system.cpu` chart shows the
86 +average for each dimension from every contributing chart, while the `net.net` chart shows the sum for each dimension
87 +from every contributing chart, which can also come from multiple networking interfaces.
88 +
89 +The following aggregate functions are available for each selected dimension:
90 +
91 +- **Average**: Displays the average value from contributing nodes. If a composite chart has 5 nodes with the following
92 + values for the `out` dimension&mdash;`-2.1`, `-5.5`, `-10.2`, `-15`, `-0.1`&mdash;the composite chart displays a
93 + value of `−6.58`.
94 +- **Sum**: Displays the sum of contributed values. Using the same nodes, dimension, and values as above, the composite
95 + chart displays a metric value of `-32.9`.
96 +- **Min**: Displays a minimum value. For dimensions with positive values, the min is the value closest to zero. For
97 + charts with negative values, the min is the value with the largest magnitude.
98 +- **Max**: Displays a maximum value. For dimensions with positive values, the max is the value with the largest
99 + magnitude. For charts with negative values, the max is the value closet to zero.
100 +
101 +### Dimensions
102 +
103 +Select which dimensions to display on the composite chart. You can choose **All dimensions**, a single dimension, or any
104 +number of dimensions available on that context.
105 +
106 +### Instances
107 +
108 +Click on **X Instances** to display a dropdown of instances and nodes contributing to that composite chart. Each line in the
109 +dropdown displays an instance name and the associated node's hostname.
110 +
111 +### Nodes
112 +
113 +Click on **X Nodes** to display a dropdown of nodes contributing to that composite chart. Each line displays a hostname
114 +to help you identify which nodes contribute to a chart. You can also use this component to filter nodes directly on the chart.
115 +
116 +If one or more nodes can't contribute to a given chart, the definition bar shows a warning symbol plus the number of
117 +affected nodes, then lists them in the dropdown along with the associated error. Nodes might return errors because of
118 +networking issues, a stopped `netdata` service, or because that node does not have any metrics for that context.
119 +
120 +### Aggregate functions over time
121 +
122 +When the granularity of the data collected is higher than the plotted points on the chart an aggregation function over time
123 +is applied. By default the aggregation applied is _average_ but the user can choose different options from the following:
124 +
125 +* Min
126 +* Max
127 +* Average
128 +* Sum
129 +* Incremental sum (Delta)
130 +* Standard deviation
131 +* Median
132 +* Single exponential smoothing
133 +* Double exponential smoothing
134 +* Coefficient variation
135 +* Trimmed Median `*`
136 +* Trimmed Mean `*`
137 +* Percentile `**`
138 +
139 +:::info
140 +
141 +- `*` For **Trimmed Median and Mean** you can choose the percentage of data tha you want to focus on: 1%, 2%, 3%, 5%, 10%, 15%, 20% and 25%.
142 +- `**` For **Percentile** you can specify the percentile you want to focus on: 25th, 50th, 75th, 80th, 90th, 95th, 97th, 98th and 99th.
143 +
144 +:::
145 +
146 +
147 +For more details on each, you can refer to our Agent's HTTP API details on [Data Queries - Data Grouping](/docs/agent/web/api/queries#data-grouping).
148 +
149 +### Reset to defaults
150 +
151 +Click on the 3-dot icon (**⋮**) on any chart, then **Reset to Defaults**, to reset the definition bar to its initial
152 +state.
153 +
154 +## Jump to single-node dashboards
155 +
156 +Click on **X Charts**/**X Nodes** to display one of the two dropdowns that list the charts and nodes contributing to a
157 +given composite chart. For example, the nodes dropdown.
158 +
159 +![The nodes dropdown in a composite
160 +chart](https://user-images.githubusercontent.com/1153921/99305049-7c019b80-2810-11eb-942a-8ebfcf236b7f.png)
161 +
162 +To jump to a single-node dashboard, click on the link icon <img class="img__inline img__inline--link"
163 +src="https://user-images.githubusercontent.com/1153921/95762109-1d219300-0c62-11eb-8daa-9ba509a8e71c.png" /> next to the
164 +node you're interested in.
165 +
166 +The single-node dashboard opens in a new tab. From there, you can continue to troubleshoot or run [Metric
167 +Correlations](/docs/cloud/insights/metric-correlations) for faster root cause analysis.
168 +
169 +## Add composite charts to a dashboard
170 +
171 +Click on the 3-dot icon (**⋮**) on any chart, then click on **Add to Dashboard**. Click the **+** button for any
172 +dashboard you'd like to add this composite chart to, or create a new dashboard an initiate it with your chosen chart by
173 +entering the name and clicking **New Dashboard**.
174 +
175 +## Interacting with composite charts: pan, zoom, and resize
176 +
177 +You can interact with composite charts as you would with other Netdata charts. You can use the controls beneath each
178 +chart to pan, zoom, or resize the chart, or use various combinations of the keyboard and mouse. See the [chart
179 +interaction doc](/docs/dashboard/interact-charts) for details.
180 +
181 +## Menu
182 +
183 +The Overview uses a similar menu to local Agent dashboards and single-node dashboards in Netdata Cloud, with sections
184 +and sub-menus aggregated from every contributing node. For example, even if only two nodes actively collect from and
185 +monitor an Apache web server, the **Apache** section still appears and displays composite charts from those two nodes.
186 +
187 +![A menu in the Overview
188 +screen](https://user-images.githubusercontent.com/1153921/95785094-fa0ad980-0c89-11eb-8328-2ff11ac630b4.png)
189 +
190 +One difference between the Overview's menu and those found in single-node dashboards or local Agent dashboards is that
191 +the Overview condenses multiple services, families, or instances into single sections, sub-menus, and associated charts.
192 +
193 +For services, let's say you have two concurrent jobs with the [web_log
194 +collector](/docs/agent/collectors/go.d.plugin/modules/weblog), one for Apache and another for Nginx. A single-node or
195 +local dashboard shows two section, **web_log apache** and **web_log nginx**, whereas the Overview condenses these into a
196 +single **web_log** section containing composite charts from both jobs.
197 +
198 +The Overview also consdenses multiple families or multiple instances into a single **all** sub-menu and associated
199 +charts. For example, if Node A has 5 disks, and Node B has 3, each disk contributes to a single `disk.io` composite
200 +chart. The utility bar should show that there are 8 charts from 2 nodes contributing to that chart.
201 +
202 +This action applies to disks, network devices, and other metric types that involve multiple instances of a piece of
203 +hardware or software. The Overview currently does not display metrics from filesystems. Read more about [families and
204 +instances](/docs/dashboard/dimensions-contexts-families)
205 +
206 +## Persistence of composite chart settings
207 +
208 +When you change a composite chart via its definition bar, Netdata Cloud persists these settings in a query string
209 +attached to the URL in your browser. You can "save" these settings by bookmarking this particular URL, or share it with
210 +colleagues by having them copy-paste it into their browser.
211 +
212 +## What's next?
213 +
214 +For another way to view an infrastructure from a high level, see the [Nodes view](/docs/cloud/visualize/nodes).
215 +
216 +If you need a refresher on how Netdata's charts work, see our doc on [interacting with
217 +charts](/docs/dashboard/interact-charts).
218 +
219 +Or, get more granular with configuring how you monitor your infrastructure by [building new
220 +dashboards](/docs/cloud/visualize/dashboards).
docs/cloud/war-rooms.md new
+147
@@ -0,0 +1,147 @@
1 +---
2 +title: "War Rooms"
3 +description: " Netdata Cloud uses War Rooms to group related nodes and create insightful compositedashboards based on their aggregate health and performance."
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md"
5 +sidebar_label: "War Rooms"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 +---
10 +
11 +War Rooms organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and
12 +visualizations.
13 +
14 +Once you add nodes to a Space, all of your nodes will be visible in the _All nodes_ War Room. This is a special War Room
15 +which gives you an overview of all of your nodes in this particular space. Then you can create functional separations of
16 +your nodes into more War Rooms. Every War Room has its own dashboards, navigation, indicators, and management tools.
17 +
18 +![An example War Room](/img/cloud/main-page.png)
19 +
20 +## Navigation
21 +
22 +### Switching between views - static tabs
23 +
24 +Every War Rooms provides multiple views. Each view focus on a particular area/subject of the nodes which you monitor in
25 +this War Rooms. Let's explore what view you have available:
26 +
27 +- The default view for any War Room is the [Home tab](/docs/cloud/visualize/overview#home), which give you an overview
28 + of this space. Here you can see the number of Nodes claimed, data retention statics, user particate, alerts and more
29 +
30 +- The second and most important view is the [Overview tab](/docs/cloud/visualize/overview#overview) which uses composite
31 + charts to display real-time metrics from every available node in a given War Room.
32 +
33 +- The [Nodes tab](/docs/cloud/visualize/nodes) gives you the ability to see the status (offline or online), host details
34 + , alarm status and also a short overview of some key metrics from all your nodes at a glance.
35 +
36 +- [Kubernetes tab](/docs/cloud/visualize/kubernetes) is a logical grouping of charts regards to your Kubernetes clusters.
37 + It contains a subset of the charts available in the _Overview tab_
38 +
39 +- The [Dashboards tab](/docs/cloud/visualize/dashboards) gives you the ability to have tailored made views of
40 + specific/targeted interfaces for your infrastructure using any number of charts from any number of nodes.
41 +
42 +- The **Alerts tab** provides you with an overview for all the active alerts you receive for the nodes in this War Room,
43 + you can also see alla the alerts that are configured to be triggered in any given moment.
44 +
45 +- The **Anomalies tab** is dedicated to the [Anomaly Advisor](/docs/cloud/insights/anomaly-advisor) tool
46 +
47 +### Non static tabs
48 +
49 +If you open a [new dashboard](/docs/cloud/visualize/dashboards), jump to a single-node dashboard, or navigate to a dedicated
50 +alert page they will open in a new War Room tab.
51 +
52 +Tabs can be rearranged with drag-and-drop or closed with the **X** button. Open tabs persist between sessions, so you
53 +can always come right back to your preferred setup.
54 +
55 +### Play, pause, force play, and timeframe selector
56 +
57 +A War Room has three different states: playing, paused, and force playing. The default playing state refreshes charts
58 +every second as long as the browser tab is in focus. [Interacting with a chart](/docs/dashboard/interact-charts) pauses
59 +the War Room. Once the tab loses focus, charts pause automatically.
60 +
61 +The top navigation bar features a play/pause button to quickly change the state, and a dropdown to select **Force Play**
62 +, which keeps charts refreshing, potentially at the expense of system performance.
63 +
64 +Next to the play/pause button is the timeframe selector, which helps you select a precise window of metrics data to
65 +visualize. By default, all visualizations in Netdata Cloud show the last 15 minutes of metrics data.
66 +
67 +Use the **Quick Selector** to visualize metrics from predefined timeframes, or use the input field below to enter a
68 +number and an appropriate unit of time. The calendar allows you to select multiple days of metrics data.
69 +
70 +Click **Apply** to re-render all visualizations with new metrics data streamed to your browser from each distributed
71 +node. Click **Clear** to remove any changes and apply the default 15-minute timeframe.
72 +
73 +The fields beneath the calendar display the beginning and ending timestamps your selected timeframe.
74 +
75 +
76 +### Node filter
77 +
78 +The node filter allows you to quickly filter the nodes visualized in a War Room's views. It appears on all views, but
79 +not on single-node dashboards.
80 +
81 +![The node filter](https://user-images.githubusercontent.com/12612986/172674440-df224058-2b2c-41da-bb45-f4eb82e342e5.png)
82 +
83 +
84 +## War Room organization
85 +
86 +We recommend a few strategies for organizing your War Rooms.
87 +
88 +**Service, purpose, location, etc.**: You can group War Rooms by a service (think Nginx, MySQL, Pulsar, and so on),
89 +their purpose (webserver, database, application), their physical location, whether they're baremetal or a Docker
90 +container, the PaaS/cloud provider it runs on, and much more. This allows you to see entire slices of your
91 +infrastructure by moving from one War Room to another.
92 +
93 +**End-to-end apps/services**: If you have a user-facing SaaS product, or an internal service that said product relies
94 +on, you may want to monitor that entire stack in a single War Room. This might include Kubernetes clusters, Docker
95 +containers, proxies, databases, web servers, brokers, and more. End-to-end War Rooms are valuable tools for ensuring the
96 +health and performance of your organization's essential services.
97 +
98 +**Incident response**: You can also create new War Rooms as one of the first steps in your incident response process.
99 +For example, you have a user-facing web app that relies on Apache Pulsar for a message queue, and one of your nodes
100 +using the [Pulsar collector](/docs/agent/collectors/go.d.plugin/modules/pulsar) begins reporting a suspiciously low
101 +messages rate. You can create a War Room called `$year-$month-$day-pulsar-rate`, add all your Pulsar nodes in addition
102 +to nodes they connect to, and begin diagnosing the root cause in a War Room optimized for getting to resolution as fast
103 +as possible.
104 +
105 +## Add War Rooms
106 +
107 +To add new War Rooms to any Space, click on the green plus icon **+** next the **War Rooms** heading. on the left (
108 +space's) sidebar.
109 +
110 +In the panel, give the War Room a name and description, and choose whether it's public or private. Anyone in your Space
111 +can join public War Rooms, but can only join private War Rooms with an invitation.
112 +
113 +## Manage War Rooms
114 +
115 +All the users and nodes involved in a particular space can potential be part of a War Room.
116 +
117 +Any user can change simple settings of a War room, like the name or the users participating in it. Click on the gear
118 +icon of the War Room's name in the top of the page to do that. A sidebar will open with options for this War Room:
119 +
120 +1. To _change a War Room's name, description, or public/private status_, click on **War Room** tab of the sidebar.
121 +
122 +2. To _include an existing node_ to a War Room or _connect a new node*_ click on **Nodes** tab of the sidebar. Choose any
123 +connected node you want to add to this War Room by clicking on the checkbox next to its hostname, then click **+ Add**
124 +at the top of the panel.
125 +
126 +3. To _add existing users to a War Room_, click on **Add Users**. See our [invite doc](/docs/cloud/manage/invite-your-team)
127 +for details on inviting new users to your Space in Netdata Cloud.
128 +
129 +:::note
130 + \* This action requires admin rights for this space
131 +:::
132 +
133 +### More actions
134 +
135 +To _view or remove nodes_ in a War Room, click on **Nodes view**. To remove a node from the current War Room, click on
136 +the **🗑** icon.
137 +
138 +:::info
139 + Removing a node from a War Room does not remove it from your Space.
140 +:::
141 +
142 +
143 +
144 +## What's next?
145 +
146 +Once you've figured out an organizational structure that works for your team, learn more about how you can use Netdata
147 +Cloud to monitor distributed nodes using [real-time composite charts](/docs/cloud/visualize/overview).
docs/collect/application-metrics.md
+4 -1
@@ -2,7 +2,10 @@
2 title: "Collect application metrics with Netdata"
3 sidebar_label: "Application metrics"
4 description: "Monitor and troubleshoot every application on your infrastructure with per-second metrics, zero configuration, and meaningful charts."
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/collect/application-metrics.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/collect/application-metrics.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # Collect application metrics with Netdata
docs/collect/container-metrics.md
+4 -1
@@ -2,7 +2,10 @@
2 title: "Collect container metrics with Netdata"
3 sidebar_label: "Container metrics"
4 description: "Use Netdata to collect per-second utilization and application-level metrics from Linux/Docker containers and Kubernetes clusters."
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/collect/container-metrics.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/collect/container-metrics.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # Collect container metrics with Netdata
docs/collect/enable-configure.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Enable or configure a collector"
3 description: "Every collector is highly configurable, allowing them to collect metrics from any node and any infrastructure."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/collect/enable-configure.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/collect/enable-configure.md"
5 +sidebar_label: "Enable or configure a collector"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Enable or configure a collector
docs/collect/how-collectors-work.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "How Netdata's metrics collectors work"
3 description: "When Netdata starts, and with zero configuration, it auto-detects thousands of data sources and immediately collects per-second metrics."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/collect/how-collectors-work.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/collect/how-collectors-work.md"
5 +sidebar_label: "How Netdata's metrics collectors work"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # How Netdata's metrics collectors work
docs/collect/system-metrics.md
+4 -1
@@ -2,7 +2,10 @@
2 title: "Collect system metrics with Netdata"
3 sidebar_label: "System metrics"
4 description: "Netdata collects thousands of metrics from physical and virtual systems, IoT/edge devices, and containers with zero configuration."
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/collect/system-metrics.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/collect/system-metrics.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # Collect system metrics with Netdata
docs/configure/common-changes.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Common configuration changes"
3 description: "See the most popular configuration changes to make to the Netdata Agent, including longer metrics retention, reduce sampling, and more."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/common-changes.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/configure/common-changes.md"
5 +sidebar_label: "Common configuration changes"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Common configuration changes
docs/configure/nodes.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Configure the Netdata Agent"
3 description: "Netdata is zero-configuration for most users, but complex infrastructures may require you to tweak some of the Agent's granular settings."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/nodes.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/configure/nodes.md"
5 +sidebar_label: "Configure the Netdata Agent"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # Configure the Netdata Agent
docs/configure/secure-nodes.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Secure your nodes"
3 description: "Your data and systems are safe with Netdata, but we recommend a few easy ways to improve the security of your infrastructure."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/secure-nodes.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/configure/secure-nodes.md"
5 +sidebar_label: "Secure your nodes"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Secure your nodes
docs/configure/start-stop-restart.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Start, stop, or restart the Netdata Agent"
3 description: "Manage the Netdata Agent daemon, load configuration changes, and troubleshoot stuck processes on systemd and non-systemd nodes."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/start-stop-restart.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/configure/start-stop-restart.md"
5 +sidebar_label: "Start, stop, or restart the Netdata Agent"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 -->
10
11 # Start, stop, or restart the Netdata Agent
docs/dashboard/customize.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "Customize the standard dashboard"
3 description: "Netdata's preconfigured dashboard offers many customization options, such as choosing when charts are updated, your preferred theme, and custom text to document processes, and more."
4 -type: how-to
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/customize.mdx
4 +type: "how-to"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/customize.mdx"
6 +sidebar_label: "Customize the standard dashboard"
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Operations"
10 ---
11
12 # Customize the standard dashboard
docs/dashboard/dimensions-contexts-families.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "Chart dimensions, contexts, and families"
3 description: "Netdata organizes charts into dimensions, contexts, and families to automatically and meaningfully organize thousands of metrics into interactive charts."
4 -type: explanation
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/dimensions-contexts-families.mdx
4 +type: "explanation"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/dimensions-contexts-families.mdx"
6 +sidebar_label: "Chart dimensions, contexts, and families"
7 +learn_status: "Published"
8 +learn_topic_type: "Concepts"
9 +learn_rel_path: "Concepts"
10 ---
11
12 # Chart dimensions, contexts, and families
docs/dashboard/how-dashboard-works.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "How the dashboard works"
3 description: "Learn how to navigate Netdata's preconfigured dashboard to get started exploring, visualizing, and troubleshooting in real time."
4 -type: explanation
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/how-dashboard-works.mdx
4 +type: "explanation"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/how-dashboard-works.mdx"
6 +sidebar_label: "How the dashboard works"
7 +learn_status: "Published"
8 +learn_topic_type: "Concepts"
9 +learn_rel_path: "Concepts"
10 ---
11
12 # How the dashboard works
docs/dashboard/import-export-print-snapshot.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "Import, export, and print a snapshot"
3 description: "Snapshots can be incredibly useful for diagnosing anomalies after they've already happened, and are interoperable with any other node running Netdata."
4 -type: how-to
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/import-export-print-snapshot.mdx
4 +type: "how-to"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/import-export-print-snapshot.mdx"
6 +sidebar_label: "Import, export, and print a snapshot"
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Operations"
10 ---
11
12 # Import, export, and print snapshots
docs/dashboard/interact-charts.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "Interact with charts"
3 description: "Learn how to pan, zoom, select, and customize Netdata's preconfigured charts to help you troubleshooting with real-time, per-second metrics data."
4 -type: how-to
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/interact-charts.mdx
4 +type: "how-to"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/interact-charts.mdx"
6 +sidebar_label: "Interact with charts"
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Operations"
10 ---
11
12 # Interact with charts
docs/dashboard/visualization-date-and-time-controls.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "Visualization date and time controls"
3 description: "Netdata's dashboard features powerful date visualization controls that include a time control (play, pause, force play), a timezone selector and a rich date and timeframe selector, with useful defaults and rich customization, to help you narrow your focus when troubleshooting issues or anomalies."
4 -type: how-to
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/visualization-date-and-time-controls.mdx
4 +type: "how-to"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboard/visualization-date-and-time-controls.mdx"
6 +sidebar_label: "Visualization date and time controls"
7 +learn_status: "Published"
8 +learn_topic_type: "Concepts"
9 +learn_rel_path: "Concepts"
10 ---
11
12 # Visualization date and time controls
docs/export/enable-connector.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Enable an exporting connector"
3 description: "Learn how to enable and configure any connector using examples to start exporting metrics to external time-series databases in minutes."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/export/enable-connector.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/export/enable-connector.md"
5 +sidebar_label: "Enable an exporting connector"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Enable an exporting connector
docs/export/external-databases.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Export metrics to external time-series databases"
3 description: "Use the exporting engine to send Netdata metrics to popular external time series databases for long-term storage or further analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/export/external-databases.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/export/external-databases.md"
5 +sidebar_label: "Export metrics to external time-series databases"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # Export metrics to external time-series databases
docs/get-started.mdx
+6 -4
@@ -1,9 +1,11 @@
1 ---
2 -title: "Get started with Netdata"
2 +title: "Install Netdata"
3 description: "Download and install the open-source Netdata monitoring agent on physical/virtual servers, Linux (Ubuntu/Debian/CentOS/etc), Docker, Kubernetes, and many others, often with one command."
4 -type: how-to
5 -sidebar_label: "Get started"
6 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/get-started.mdx
4 +sidebar_label: "Install Netdata"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/get-started.mdx"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Getting started"
9 ---
10
11 import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
docs/getting-started/integrations.md new
+12
@@ -0,0 +1,12 @@
1 +<!--
2 +title: "Integrations"
3 +sidebar_label: "Integrations"
4 +custom_edit_url: null
5 +learn_status: "Published"
6 +learn_topic_type: "Getting started"
7 +learn_rel_path: "Getting started"
8 +learn_docs_purpose: "Present all the Netdata integrations"
9 +learn_doc_type: "AUTOGENERATED"
10 +-->
11 +
12 +This page is autogenerated, this is placeholder document
\ No newline at end of file
docs/getting-started/introduction.md new
+158
@@ -0,0 +1,158 @@
1 +<!--
2 +title: "Introduction"
3 +sidebar_label: "Introduction"
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/getting-started/intro.md"
5 +learn_status: "Published"
6 +sidebar_position: "1"
7 +learn_topic_type: "Getting started"
8 +learn_rel_path: "Getting started"
9 +learn_docs_purpose: "Present netdata in a nutshell"
10 +-->
11 +
12 +## What is Netdata ?
13 +
14 +Netdata is designed by system administrators, DevOps engineers, and developers to collect everything, help you visualize
15 +metrics, troubleshoot complex performance problems, and make data interoperable with the rest of your monitoring stack.
16 +
17 +You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container platforms (Kubernetes
18 +clusters, Docker), and many other operating systems (FreeBSD).
19 +
20 +Netdata is:
21 +
22 +### Simple to deploy
23 +
24 +- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures.
25 +- **Zero configuration and maintenance** required to collect thousands of metrics, every second, from the underlying
26 + OS and running applications.
27 +- **Prebuilt charts and alarms** alert you to common anomalies and performance issues without manual configuration.
28 +- **Distributed storage** to simplify the cost and complexity of storing metrics data from any number of nodes.
29 +
30 +### Powerful and scalable
31 +
32 +- **1% CPU utilization, a few MB of RAM, and minimal disk I/O** to run the monitoring Agent on bare metal, virtual
33 + machines, containers, and even IoT devices.
34 +- **Per-second granularity** for an unlimited number of metrics based on the hardware and applications you're running
35 + on your nodes.
36 +- **Interoperable exporters** let you connect Netdata's per-second metrics with an existing monitoring stack and other
37 + time-series databases.
38 +
39 +### Optimized for troubleshooting
40 +
41 +- **Visual anomaly detection** with a UI/UX that emphasizes the relationships between charts.
42 +- **Customizable dashboards** to pinpoint correlated metrics, respond to incidents, and help you streamline your
43 + workflows.
44 +- **Distributed metrics in a centralized interface** to assist users or teams trace complex issues between distributed
45 + nodes.
46 +
47 +### Secure by design
48 +
49 +- **Distributed data architecture** so fast and efficient, there’s no limit to the number of metrics you can follow.
50 +- Because your data is **stored at the edge**, security is ensured.
51 +-
52 +### Comparison with other monitoring solutions
53 +
54 +Netdata offers many benefits over the existing monitoring landscape, whether they're expensive SaaS products or other
55 +open-source tools.
56 +
57 +| Netdata | Others (open-source and commercial) |
58 +| :-------------------------------------------------------------- | :--------------------------------------------------------------- |
59 +| **High resolution metrics** (1s granularity) | Low resolution metrics (10s granularity at best) |
60 +| Collects **thousands of metrics per node** | Collects just a few metrics |
61 +| Fast UI optimized for **anomaly detection** | UI is good for just an abstract view |
62 +| **Long-term, autonomous storage** at one-second granularity | Centralized metrics in an expensive data lake at 10s granularity |
63 +| **Meaningful presentation**, to help you understand the metrics | You have to know the metrics before you start |
64 +| Install and get results **immediately** | Long sales process and complex installation process |
65 +| Use it for **troubleshooting** performance problems | Only gathers _statistics of past performance_ |
66 +| **Kills the console** for tracing performance issues | The console is always required for troubleshooting |
67 +| Requires **zero dedicated resources** | Require large dedicated resources |
68 +
69 +
70 +Netdata works with tons of applications, notifications platforms, and other time-series databases:
71 +
72 +- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
73 + immediately visualize them into meaningful charts designed for troubleshooting. See [everything we
74 + support](https://learn.netdata.cloud/docs/agent/collectors/collectors).
75 +- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
76 + platform](https://learn.netdata.cloud/docs/monitor/enable-notifications) to inform you of anomalies just seconds
77 + after they affect your node.
78 +- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
79 + Cloud-based databases](https://learn.netdata.cloud/docs/export/external-databases) for best-in-class
80 + interoperability.
81 +
82 +
83 +## How it works
84 +
85 +Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for concurrent operations on the metrics.
86 +
87 +You can see a high level representation in the following diagram.
88 +
89 +![Diagram of Netdata's core functionality](https://user-images.githubusercontent.com/2662304/199225735-01a41cc5-c074-4fe2-b780-5f08e92c6769.png)
90 +
91 +And a higher level diagram in this one.
92 +
93 +![Diagram 2 of Netdata's core
94 +functionality](https://user-images.githubusercontent.com/1153921/95367248-5f755980-0889-11eb-827f-9b7aa02a556e.png)
95 +
96 +You can even visit this slightly dated [interactive infographic](https://my-netdata.io/infographic.html) and get lost in a rabbit hole.
97 +
98 +But the best way to get under the hood or in the steering wheel of our highly efficient, low-latency system (supporting multiple readers and one writer on each metric) is to read the rest of our docs, or just to jump in and [get started](app.netdata.com). But here's a good breakdown:
99 +
100 +### Netdata Agent
101 +
102 +Netdata's distributed monitoring Agent collects thousands of metrics from systems, hardware, and applications with zero configuration. It runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices.
103 +
104 +You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no sudo required.
105 +
106 +### Netdata Cloud
107 +Netdata Cloud is a web application that gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can view key metrics, insightful charts, and active alarms from all your nodes in a single web interface. When an anomaly strikes, seamlessly navigate to any node to troubleshoot and discover the root cause with the familiar Netdata dashboard.
108 +
109 +Netdata Cloud is free! You can add an entire infrastructure of nodes, invite all your colleagues, and visualize any number of metrics, charts, and alarms entirely for free.
110 +
111 +While Netdata Cloud offers a centralized method of monitoring your Agents, your metrics data is not stored or centralized in any way. Metrics data remains with your nodes and is only streamed to your browser, through Cloud, when you're viewing the Netdata Cloud interface.
112 +
113 +
114 +## Community
115 +
116 +Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://learn.netdata.cloud/contribute/code-of-conduct).
117 +
118 +Find most of the Netdata team in our [community forums](https://community.netdata.cloud). It's the best place to
119 +ask questions, find resources, and engage with passionate professionals. The team is also available and active in our [Discord](https://discord.com/invite/mPZ6WZKKG2) too.
120 +
121 +You can also find Netdata on:
122 +
123 +- [Twitter](https://twitter.com/linuxnetdata)
124 +- [YouTube](https://www.youtube.com/c/Netdata)
125 +- [Reddit](https://www.reddit.com/r/netdata/)
126 +- [LinkedIn](https://www.linkedin.com/company/netdata-cloud/)
127 +- [StackShare](https://stackshare.io/netdata)
128 +- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/)
129 +- [Repology](https://repology.org/metapackage/netdata/versions)
130 +- [Facebook](https://www.facebook.com/linuxnetdata/)
131 +
132 +## Contribute
133 +
134 +Contributions are the lifeblood of open-source projects. While we continue to invest in and improve Netdata, we need help to democratize monitoring!
135 +
136 +- Read our [Contributing Guide](https://learn.netdata.cloud/contribute/handbook), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums!
137 +- We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9)
138 +- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=%5BBug%5D%3A+).
139 +- View our [Security Policy](https://github.com/netdata/netdata/security/policy).
140 +
141 +Package maintainers should read the guide on [building Netdata from source](/packaging/installer/methods/source.md) for
142 +instructions on building each Netdata component from source and preparing a package.
143 +
144 +## License
145 +
146 +The Netdata Agent is an open source project distributed under [GPLv3+](/LICENSE). Netdata re-distributes other open-source tools and libraries. Please check the
147 +[third party licenses](/REDISTRIBUTED.md).
148 +
149 +## Is it any good?
150 +
151 +Yes.
152 +
153 +_When people first hear about a new product, they frequently ask if it is any good. A Hacker News user
154 +[remarked](https://news.ycombinator.com/item?id=3067434):_
155 +
156 +> Note to self: Starting immediately, all raganwald projects will have a “Is it any good?” section in the readme, and
157 +> the answer shall be “yes.".
158 +*******************************************************************************
docs/guidelines.md new
+772
@@ -0,0 +1,772 @@
1 +<!--
2 +title: "Contribute to the documentation"
3 +sidebar_label: "to Documentation"
4 +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/guidelines.md"
5 +sidebar_position: "10000"
6 +learn_status: "Published"
7 +learn_topic_type: "Custom"
8 +learn_rel_path: "Contribute"
9 +learn_docs_purpose: "TBD"
10 +-->
11 +
12 +import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
13 +
14 +Welcome to our docs developer guidelines!
15 +
16 +This document will guide you to the process of contributing to our
17 +docs (**learn.netdata.cloud**)
18 +
19 +## Documentation architecture
20 +
21 +Netdata docs follows has two principals.
22 +
23 +1. Keep the documentation of each component _as close as you can to the codebase_
24 +2. Every component is analyzed via topic related docs.
25 +
26 +To this end:
27 +
28 +1. Documentation lives in every possible repo in the netdata organization. At the moment we contribute to:
29 + - netdata/netdata
30 + - netdata/learn (final site)
31 + - netdata/go.d.plugin
32 + - netdata/agent-service-discovery
33 +
34 + In each of these repos you will find markdown files. These markdown files may or not be part of the final docs. You
35 + understand what documents are part of the final docs in the following section:[_How to update documentation of
36 + learn.netdata.cloud_](#how-to-update-documentation-of-learn-netdata-cloud)
37 +
38 +2. Netdata docs processes are inspired from
39 + the [DITA 1.2 guidelines](http://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/dita-1.2_technicalContent_overview.html)
40 + for Technical content.
41 +
42 +## Topic types
43 +
44 +### Concepts
45 +
46 +A concept introduces a single feature or concept. A concept should answer the questions:
47 +
48 +- What is this?
49 +- Why would I use it?
50 +
51 +Concept topics:
52 +
53 +- Are abstract ideas
54 +- Explain meaning or benefit
55 +- Can stay when specifications change
56 +- Provide background information
57 +
58 +### Tasks
59 +
60 +Concept and reference topics exist to support tasks. _The goal for users … is not to understand a concept but to
61 +complete a task_. A task gives instructions for how to complete a procedure.
62 +
63 +Much of the uncertainty whether a topic is a concept or a reference disappears, when you have strong, solid task topics
64 +in place, furthermore topics directly address your users and their daily tasks and help them to get their job done. A
65 +task **must give an answer** to the **following questions**:
66 +
67 +- How do I create cool espresso drinks with my new coffee machine?
68 +- How do I clean the milk steamer?
69 +
70 +For the title text, use the structure active verb + noun. For example, for instance _Deploy the Agent_.
71 +
72 +### References
73 +
74 +The reference document and information types provide for the separation of fact-based information from concepts and
75 +tasks. \
76 +Factual information may include tables and lists of specifications, parameters, parts, commands, edit-files and other
77 +information that the users are likely to look up. The reference information type allows fact-based content to be
78 +maintained by those responsible for its accuracy and consistency.
79 +
80 +## Contribute to the documentation of learn.netdata.cloud
81 +
82 +### Encapsulate topics into markdown files.
83 +
84 +Netdata uses markdown files to document everything. To implement concrete sections of these [Topic types](#topic-types)
85 +we encapsulate this logic as follows. Every document is characterized by its topic type ('learn_topic_type' metadata
86 +field). To avoid breaking every single netdata concept into numerous small markdown files each document can be either a
87 +single `Reference` or `Concept` or `Task` or a group of `References`, `Concepts`, `Tasks`.
88 +
89 +To this end, every single topic is encapsulated into a `Heading 3 (###)` section. That means, when you have a single
90 +file you only make use of `Headings 4` and lower (`4, 5, 6`, for templated section or subsection). In case you want to
91 +includ multiple (`Concepts` let's say) in a single document, you use `Headings 3` to seperate each concept. `Headings 2`
92 +are used only in case you want to logically group topics inside a document.
93 +
94 +For instance:
95 +
96 +```markdown
97 +
98 +Small introduction of the document.
99 +
100 +### Concept A
101 +
102 +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
103 +aliqua.
104 +
105 +#### Field from template 1
106 +
107 +Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
108 +
109 +#### Field from template 1
110 +
111 +Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
112 +
113 +##### Subsection 1
114 +
115 +. . .
116 +
117 +### Concept A
118 +
119 +Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
120 +
121 +#### Field from template 1
122 +
123 +. . .
124 +
125 +
126 +```
127 +
128 +This approach gives a clean and readable outlook in each document from a single sidebar.
129 +
130 +Here you can find the preferred templates for each topic type:
131 +
132 +
133 +<Tabs>
134 + <TabItem value="Concept" label="Concept" default>
135 +
136 + ```markdown
137 + Small intro, give some context to the user of what you will cover on this document
138 +
139 + ### concept title (omit if the document describes only one concept)
140 +
141 + A concept introduces a single feature or concept. A concept should answer the questions:
142 +
143 + 1. What is this?
144 + 2. Why would I use it?
145 +
146 + ```
147 +
148 + </TabItem>
149 + <TabItem value="Task" label="Tasks">
150 +
151 + ```markdown
152 + Small intro, give some context to the user of what you will cover on this document
153 +
154 + ### Task title (omit if the document describes only one task)
155 +
156 + #### Prerequisite
157 +
158 + Unordered list of what you will need.
159 +
160 + #### Steps
161 +
162 + Exact list of step the user must follow
163 +
164 + #### Expected result
165 +
166 + What you expect to see when you complete the steps above
167 +
168 + #### Example
169 +
170 + Example configuration/actions of the task
171 +
172 + #### Related reference documentation
173 +
174 + List of reference docs user needs to be aware of.
175 + ```
176 +
177 + </TabItem>
178 + <TabItem value="Reference-collectors" label="Reference-collectors">
179 +
180 + ```markdown
181 + Small intro, give some context to the user of what you will cover on this document
182 +
183 + ### Reference name (omit if the document describes only one reference)
184 +
185 + #### Requirements
186 +
187 + Document any dependencies needed to run this module
188 +
189 + #### Requirements on the monitored component
190 +
191 + Document any steps user must take to sucessful monitor application,
192 + for instance (create a user)
193 +
194 + #### Configuration files
195 +
196 + table with path and configuration files purpose
197 + Columns: File name | Description (Purpose in a nutshell)
198 +
199 + #### Data collection
200 +
201 + To make changes, see `the ./edit-config task <link>`
202 +
203 + #### Auto discovery
204 +
205 + ##### Single node installation
206 +
207 + . . . we autodetect localhost:port and what configurations are defaults
208 +
209 + ##### Kubernetes installations
210 +
211 + . . . Service discovery, click here
212 +
213 + #### Metrics
214 +
215 + Columns: Metric (Context) | Scope | description (of the context) | dimensions | units (of the context) | Alert triggered
216 +
217 +
218 + #### Alerts
219 +
220 + Collapsible content for every alert, just like the alert guides
221 +
222 + #### Configuration options
223 +
224 + Table with all the configuration options available.
225 +
226 + Columns: name | description | default | file_name
227 +
228 + #### Configuration example
229 +
230 + Default configuration example
231 +
232 + #### Troubleshoot
233 +
234 + backlink to the task to run this module in debug mode (here you provide the debug flags)
235 +
236 +
237 +```
238 +
239 + </TabItem>
240 +</Tabs>
241 +
242 +### Metadata fields
243 +
244 +All Docs that are supposed to be part of learn.netdata.cloud have **hidden** sections in the begining of document. These
245 +sections are plain lines of text and we call them metadata. Their represented as `key : "Value"` pairs. Some of them are
246 +needed from our statice website builder (docusaurus) others are needed for our internal pipelines to build docs
247 +(have prefix `learn_`).
248 +
249 +So let's go through the different necessary metadata tags to get a document properly published on Learn:
250 +
251 +| metadata_key | Value(s) | Frontmatter effect | Mandatory | Limitations |
252 +|:---------------------:|---------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------:|:---------------------------------------:|
253 +| `title` | `String` | Title in each document | yes | |
254 +| `custom_edit_url` | `String` | The source GH link of the file | yes | |
255 +| `description` | `String or multiline String` | - | yes | |
256 +| `sidebar_label` | `String or multiline String` | Name in the TOC tree | yes | |
257 +| `sidebar_position` | `String or multiline String` | Global position in the TOC tree (local for per folder) | yes | |
258 +| `learn_status` | [`Published`, `Unpublished`, `Hidden`] | `Published`: Document visible in learn,<br/> `Unpublished`: Document archived in learn, <br/>`Hidden`: Documentplaced under learn_rel_path but it's hidden] | yes | |
259 +| `learn_topic_type` | [`Concepts`, `Tasks`, `References`, `Getting Started`] | | yes | |
260 +| `learn_rel_path` | `Path` (the path you want this file to appear in learn<br/> without the /docs prefix and the name of the file | | yes | |
261 +| `learn_autogenerated` | `Dictionary` (for internal use) | | no | Keys in the dictionary must be in `' '` |
262 +
263 +:::important
264 +
265 +1. In case any mandatory tags are missing or falsely inputted the file will remain unpublished. This is by design to
266 + prevent non-properly tagged files from getting published.
267 +2. All metadata values must be included in `" "`. From `string` noted text inside the fields use `' ''`
268 +
269 +
270 +While Docusaurus can make use of more metadata tags than the above, these are the minimum we require to publish the file
271 +on Learn.
272 +
273 +:::
274 +
275 +### Placing a document in learn
276 +
277 +Here you can see how the metadata are parsed and create a markdown file in learn.
278 +
279 +![](https://user-images.githubusercontent.com/12612986/207310336-f7cc150b-543c-4f13-be98-5058a4d29284.png)
280 +
281 +### Before you get started
282 +
283 +Anyone interested in contributing to documentation should first read the [Netdata style guide](#styling-guide) further
284 +down below and the [Netdata Community Code of Conduct](/contribute/code-of-conduct).
285 +
286 +Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read
287 +the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on
288 +creating paragraphs, styled text, lists, tables, and more, and read further down about some special
289 +occasions [while writing in MDX](#mdx-and-markdown).
290 +
291 +### Making your first contribution
292 +
293 +The easiest way to contribute to Netdata's documentation is to edit a file directly on GitHub. This is perfect for small
294 +fixes to a single document, such as fixing a typo or clarifying a confusing sentence.
295 +
296 +Click on the **Edit this page** button on any published document on [Netdata Learn](https://learn.netdata.cloud). Each
297 +page has two of these buttons: One beneath the table of contents, and another at the end of the document, which take you
298 +to GitHub's code editor. Make your suggested changes, keeping the [Netdata style guide](#styling-guide)
299 +in mind, and use the ***Preview changes*** button to ensure your Markdown syntax works as expected.
300 +
301 +Under the **Commit changes** header, write descriptive title for your requested change. Click the **Commit changes**
302 +button to initiate your pull request (PR).
303 +
304 +Jump down to our instructions on [PRs](#making-a-pull-request) for your next steps.
305 +
306 +**Note**: If you wish to contribute documentation that is more tailored from your specific infrastructure
307 +monitoring/troubleshooting experience, please consider submitting a blog post about your experience. Check
308 +the [README](https://github.com/netdata/blog/blob/master/README.md) in our blog repo! Any blog submissions that have
309 +widespread or universal application will be integrated into our permanent documentation.
310 +
311 +### Edit locally
312 +
313 +Editing documentation locally is the preferred method for complex changes that span multiple documents or change the
314 +documentation's style or structure.
315 +
316 +Create a fork of the Netdata Agent repository by visit the [Netdata repository](https://github.com/netdata/netdata) and
317 +clicking on the **Fork** button.
318 +
319 +GitHub will ask you where you want to clone the repository. When finished, you end up at the index of your forked
320 +Netdata Agent repository. Clone your fork to your local machine:
321 +
322 +```bash
323 +git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git
324 +```
325 +
326 +Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping
327 +the [Netdata style guide](/contribute/style-guide) in mind. Add, commit, and push changes to your fork. When you're
328 +finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull request
329 +based on the changes you made in the new branch of your fork.
330 +
331 +### Making a pull request
332 +
333 +Pull requests (PRs) should be concise and informative. See our [PR guidelines](/contribute/handbook#pr-guidelines) for
334 +specifics.
335 +
336 +- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50
337 + characters.
338 +- The description should explain what was changed and why. Verify that you tested any code or processes that you are
339 + trying to change.
340 +
341 +The Netdata team will review your PR and assesses it for correctness, conciseness, and overall quality. We may point to
342 +specific sections and ask for additional information or other fixes.
343 +
344 +After merging your PR, the Netdata team rebuilds the [documentation site](https://learn.netdata.cloud) to publish the
345 +changed documentation.
346 +
347 +## Styling guide
348 +
349 +The *Netdata style guide* establishes editorial guidelines for any writing produced by the Netdata team or the Netdata
350 +community, including documentation, articles, in-product UX copy, and more. Both internal Netdata teams and external
351 +contributors to any of Netdata's open-source projects should reference and adhere to this style guide as much as
352 +possible.
353 +
354 +Netdata's writing should **empower** and **educate**. You want to help people understand Netdata's value, encourage them
355 +to learn more, and ultimately use Netdata's products to democratize monitoring in their organizations. To achieve these
356 +goals, your writing should be:
357 +
358 +- **Clear**. Use simple words and sentences. Use strong, direct, and active language that encourages readers to action.
359 +- **Concise**. Provide solutions and answers as quickly as possible. Give users the information they need right now,
360 + along with opportunities to learn more.
361 +- **Universal**. Think of yourself as a guide giving a tour of Netdata's products, features, and capabilities to a
362 + diverse group of users. Write to reach the widest possible audience.
363 +
364 +You can achieve these goals by reading and adhering to the principles outlined below.
365 +
366 +If you're not familiar with Markdown, read
367 +the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on
368 +creating paragraphs, styled text, lists, tables, and more.
369 +
370 +The following sections describe situations in which a specific syntax is required.
371 +
372 +#### Syntax standards (`remark-lint`)
373 +
374 +The Netdata team uses [`remark-lint`](https://github.com/remarkjs/remark-lint) for Markdown code styling.
375 +
376 +- Use a maximum of 120 characters per line.
377 +- Begin headings with hashes, such as `# H1 heading`, `## H2 heading`, and so on.
378 +- Use `_` for italics/emphasis.
379 +- Use `**` for bold.
380 +- Use dashes `-` to begin an unordered list, and put a single space after the dash.
381 +- Tables should be padded so that pipes line up vertically with added whitespace.
382 +
383 +If you want to see all the settings, open the
384 +[`remarkrc.js`](https://github.com/netdata/netdata/blob/master/.remarkrc.js) file in the `netdata/netdata` repository.
385 +
386 +#### MDX and markdown
387 +
388 +While writing in Docusaurus, you might want to take leverage of it's features that are supported in MDX formatted files.
389 +One of those that we use is [Tabs](https://docusaurus.io/docs/next/markdown-features/tabs). They use an HTML syntax,
390 +which requires some changes in the way we write markdown inside them.
391 +
392 +In detail:
393 +
394 +Due to a bug with docusaurus, we prefer to use `<h1>heading</h1> instead of # H1` so that docusaurus doesn't render the
395 +contents of all Tabs on the right hand side, while not being able to navigate
396 +them [relative link](https://github.com/facebook/docusaurus/issues/7008).
397 +
398 +You can use markdown syntax for every other styling you want to do except Admonitions:
399 +For admonitions, follow [this](https://docusaurus.io/docs/markdown-features/admonitions#usage-in-jsx) guide to use
400 +admonitions inside JSX. While writing in JSX, all the markdown stylings have to be in HTML format to be rendered
401 +properly.
402 +
403 +#### Admonitions
404 +
405 +Use admonitions cautiously. Admonitions may draw user's attention, to that end we advise you to use them only for side
406 +content/info, without significantly interrupting the document flow.
407 +
408 +You can find the supported admonitions in the docusaurus's [documentation](https://docusaurus.io/docs/markdown-features/admonitions).
409 +
410 +#### Images
411 +
412 +Don't rely on images to convey features, ideas, or instructions. Accompany every image with descriptive alt text.
413 +
414 +In Markdown, use the standard image syntax, `![](/docs/agent/contributing)`, and place the alt text between the
415 +brackets `[]`. Here's an example using our logo:
416 +
417 +```markdown
418 +![The Netdata logo](/docs/agent/web/gui/static/img/netdata-logomark.svg)
419 +```
420 +
421 +Reference in-product text, code samples, and terminal output with actual text content, not screen captures or other
422 +images. Place the text in an appropriate element, such as a blockquote or code block, so all users can parse the
423 +information.
424 +
425 +#### Syntax highlighting
426 +
427 +Our documentation site at [learn.netdata.cloud](https://learn.netdata.cloud) uses
428 +[Prism](https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting) for syntax highlighting. Netdata can use
429 +any of
430 +the [supported languages by prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer/blob/master/src/vendor/prism/includeLangs.js)
431 +.
432 +
433 +If no language is specified, Prism tries to guess the language based on its content.
434 +
435 +Include the language directly after the three backticks (```` ``` ````) that start the code block. For highlighting C
436 +code, for example:
437 +
438 +````c
439 +```c
440 +inline char *health_stock_config_dir(void) {
441 + char buffer[FILENAME_MAX + 1];
442 + snprintfz(buffer, FILENAME_MAX, "%s/health.d", netdata_configured_stock_config_dir);
443 + return config_get(CONFIG_SECTION_DIRECTORIES, "stock health config", buffer);
444 +}
445 +```
446 +````
447 +
448 +And the prettified result:
449 +
450 +```c
451 +inline char *health_stock_config_dir(void) {
452 + char buffer[FILENAME_MAX + 1];
453 + snprintfz(buffer, FILENAME_MAX, "%s/health.d", netdata_configured_stock_config_dir);
454 + return config_get(CONFIG_SECTION_DIRECTORIES, "stock health config", buffer);
455 +}
456 +```
457 +
458 +Prism also supports titles and line highlighting. See
459 +the [Docusaurus documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
460 +
461 +## Language, grammar, and mechanics
462 +
463 +#### Voice and tone
464 +
465 +One way we write empowering, educational content is by using a consistent voice and an appropriate tone.
466 +
467 +*Voice* is like your personality, which doesn't really change day to day.
468 +
469 +*Tone* is how you express your personality. Your expression changes based on your attitude or mood, or based on who
470 +you're around. In writing, your reflect tone in your word choice, punctuation, sentence structure, or even the use of
471 +emoji.
472 +
473 +The same idea about voice and tone applies to organizations, too. Our voice shouldn't change much between two pieces of
474 +content, no matter who wrote each, but the tone might be quite different based on who we think is reading.
475 +
476 +For example, a [blog post](https://www.netdata.cloud/blog/) and a [press release](https://www.netdata.cloud/news/)
477 +should have a similar voice, despite most often being written by different people. However, blog posts are relaxed and
478 +witty, while press releases are focused and academic. You won't see any emoji in a press release.
479 +
480 +##### Voice
481 +
482 +Netdata's voice is authentic, passionate, playful, and respectful.
483 +
484 +- **Authentic** writing is honest and fact-driven. Focus on Netdata's strength while accurately communicating what
485 + Netdata can and cannot do, and emphasize technical accuracy over hard sells and marketing jargon.
486 +- **Passionate** writing is strong and direct. Be a champion for the product or feature you're writing about, and let
487 + your unique personality and writing style shine.
488 +- **Playful** writing is friendly, thoughtful, and engaging. Don't take yourself too seriously, as long as it's not at
489 + the expense of Netdata or any of its users.
490 +- **Respectful** writing treats people the way you want to be treated. Prioritize giving solutions and answers as
491 + quickly as possible.
492 +
493 +##### Tone
494 +
495 +Netdata's tone is fun and playful, but clarity and conciseness comes first. We also tend to be informal, and aren't
496 +afraid of a playful joke or two.
497 +
498 +While we have general standards for voice and tone, we do want every individual's unique writing style to reflect in
499 +published content.
500 +
501 +#### Universal communication
502 +
503 +Netdata is a global company in every sense, with employees, contributors, and users from around the world. We strive to
504 +communicate in a way that is clear and easily understood by everyone.
505 +
506 +Here are some guidelines, pointers, and questions to be aware of as you write to ensure your writing is universal. Some
507 +of these are expanded into individual sections in
508 +the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
509 +
510 +- Would this language make sense to someone who doesn't work here?
511 +- Could someone quickly scan this document and understand the material?
512 +- Create an information hierarchy with key information presented first and clearly called out to improve scannability.
513 +- Avoid directional language like "sidebar on the right of the page" or "header at the top of the page" since
514 + presentation elements may adapt for devices.
515 +- Use descriptive links rather than "click here" or "learn more".
516 +- Include alt text for images and image links.
517 +- Ensure any information contained within a graphic element is also available as plain text.
518 +- Avoid idioms that may not be familiar to the user or that may not make sense when translated.
519 +- Avoid local, cultural, or historical references that may be unfamiliar to users.
520 +- Prioritize active, direct language.
521 +- Avoid referring to someone's age unless it is directly relevant; likewise, avoid referring to people with age-related
522 + descriptors like "young" or "elderly."
523 +- Avoid disability-related idioms like "lame" or "falling on deaf ears." Don't refer to a person's disability unless
524 + it’s directly relevant to what you're writing.
525 +- Don't call groups of people "guys." Don't call women "girls."
526 +- Avoid gendered terms in favor of neutral alternatives, like "server" instead of "waitress" and "businessperson"
527 + instead of "businessman."
528 +- When writing about a person, use their communicated pronouns. When in doubt, just ask or use their name. It's OK to
529 + use "they" as a singular pronoun.
530 +
531 +> Some of these guidelines were adapted from MailChimp under the Creative Commons license.
532 +
533 +To ensure Netdata's writing is clear, concise, and universal, we have established standards for language, grammar, and
534 +certain writing mechanics. However, if you're writing about Netdata for an external publication, such as a guest blog
535 +post, follow that publication's style guide or standards, while keeping
536 +the [preferred spelling of Netdata terms](#netdata-specific-terms) in mind.
537 +
538 +#### Active voice
539 +
540 +Active voice is more concise and easier to understand compared to passive voice. When using active voice, the subject of
541 +the sentence is action. In passive voice, the subject is acted upon. A famous example of passive voice is the phrase
542 +"mistakes were made."
543 +
544 +| | |
545 +| --------------- | ----------------------------------------------------------------------------------------- |
546 +| Not recommended | When an alarm is triggered by a metric, a notification is sent by Netdata. |
547 +| **Recommended** | When a metric triggers an alarm, Netdata sends a notification to your preferred endpoint. |
548 +
549 +#### Second person
550 +
551 +Use the second person ("you") to give instructions or "talk" directly to users.
552 +
553 +In these situations, avoid "we," "I," "let's," and "us," particularly in documentation. The "you" pronoun can also be
554 +implied, depending on your sentence structure.
555 +
556 +One valid exception is when a member of the Netdata team or community wants to write about said team or community.
557 +
558 +| | |
559 +| ------------------------------ | ------------------------------------------------------------ |
560 +| Not recommended | To install Netdata, we should try the one-line installer... |
561 +| **Recommended** | To install Netdata, you should try the one-line installer... |
562 +| **Recommended**, implied "you" | To install Netdata, try the one-line installer... |
563 +
564 +#### "Easy" or "simple"
565 +
566 +Using words that imply the complexity of a task or feature goes against our policy
567 +of [universal communication](#universal-communication). If you claim that a task is easy and the reader struggles to
568 +complete it, you may inadvertently discourage them.
569 +
570 +However, if you give users two options and want to relay that one option is genuinely less complex than another, be
571 +specific about how and why.
572 +
573 +For example, don't write, "Netdata's one-line installer is the easiest way to install Netdata." Instead, you might want
574 +to say, "Netdata's one-line installer requires fewer steps than manually installing from source."
575 +
576 +#### Slang, metaphors, and jargon
577 +
578 +A particular word, phrase, or metaphor you're familiar with might not translate well to the other cultures featured
579 +among Netdata's global community. We recommended you avoid slang or colloquialisms in your writing.
580 +
581 +In addition, don't use abbreviations that have not yet been defined in the content. See our section on
582 +[abbreviations](#abbreviations-acronyms-and-initialisms) for additional guidance.
583 +
584 +If you must use industry jargon, such as "mean time to resolution," define the term as clearly and concisely as you can.
585 +
586 +> Netdata helps you reduce your organization's mean time to resolution (MTTR), which is the average time the responsible
587 +> team requires to repair a system and resolve an ongoing incident.
588 +
589 +#### Spelling
590 +
591 +While the Netdata team is mostly *not* American, we still aspire to use American spelling whenever possible, as it is
592 +the standard for the monitoring industry.
593 +
594 +See the [word list](#word-list) for spellings of specific words.
595 +
596 +#### Capitalization
597 +
598 +Follow the general [English standards](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for
599 +capitalization. In summary:
600 +
601 +- Capitalize the first word of every new sentence.
602 +- Don't use uppercase for emphasis. (Netdata is the BEST!)
603 +- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
604 + Docker, Apache, NGINX)
605 +- Avoid camel case (NetData) or all caps (NETDATA).
606 +
607 +Whenever you refer to the company Netdata, Inc., or the open-source monitoring agent the company develops, capitalize
608 +**Netdata**.
609 +
610 +However, if you are referring to a process, user, or group on a Linux system, use lowercase and fence the word in an
611 +inline code block: `` `netdata` ``.
612 +
613 +| | |
614 +| --------------- | ---------------------------------------------------------------------------------------------- |
615 +| Not recommended | The netdata agent, which spawns the netdata process, is actively maintained by netdata, inc. |
616 +| **Recommended** | The Netdata Agent, which spawns the `netdata` process, is actively maintained by Netdata, Inc. |
617 +
618 +##### Capitalization of document titles and page headings
619 +
620 +Document titles and page headings should use sentence case. That means you should only capitalize the first word.
621 +
622 +If you need to use the name of a brand, software, product, and company, capitalize it according to their official
623 +guidelines.
624 +
625 +Also, don't put a period (`.`) or colon (`:`) at the end of a title or header.
626 +
627 +| | |
628 +| --------------- | --------------------------------------------------------------------------------------------------- |
629 +| Not recommended | Getting Started Guide <br />Service Discovery and Auto-Detection: <br />Install netdata with docker |
630 +| **
631 +Recommended** | Getting started guide <br />Service discovery and auto-detection <br />Install Netdata with Docker |
632 +
633 +#### Abbreviations (acronyms and initialisms)
634 +
635 +Use abbreviations (including [acronyms and initialisms](https://www.dictionary.com/e/acronym-vs-abbreviation/)) in
636 +documentation when one exists, when it's widely accepted within the monitoring/sysadmin community, and when it improves
637 +the readability of a document.
638 +
639 +When introducing an abbreviation to a document for the first time, give the reader both the spelled-out version and the
640 +shortened version at the same time. For example:
641 +
642 +> Use Netdata to monitor Extended Berkeley Packet Filter (eBPF) metrics in real-time. After you define an abbreviation, don't switch back and forth. Use only the abbreviation for the rest of the document.
643 +
644 +You can also use abbreviations in a document's title to keep the title short and relevant. If you do this, you should
645 +still introduce the spelled-out name alongside the abbreviation as soon as possible.
646 +
647 +#### Clause order
648 +
649 +When instructing users to take action, give them the context first. By placing the context in an initial clause at the
650 +beginning of the sentence, users can immediately know if they want to read more, follow a link, or skip ahead.
651 +
652 +| | |
653 +| --------------- | ------------------------------------------------------------------------------ |
654 +| Not recommended | Read the reference guide if you'd like to learn more about custom dashboards. |
655 +| **Recommended** | If you'd like to learn more about custom dashboards, read the reference guide. |
656 +
657 +#### Oxford comma
658 +
659 +The Oxford comma is the comma used after the second-to-last item in a list of three or more items. It appears just
660 +before "and" or "or."
661 +
662 +| | |
663 +| --------------- | ---------------------------------------------------------------------------- |
664 +| Not recommended | Netdata can monitor RAM, disk I/O, MySQL queries per second and lm-sensors. |
665 +| **Recommended** | Netdata can monitor RAM, disk I/O, MySQL queries per second, and lm-sensors. |
666 +
667 +#### Future releases or features
668 +
669 +Do not mention future releases or upcoming features in writing unless they have been previously communicated via a
670 +public roadmap.
671 +
672 +In particular, documentation must describe, as accurately as possible, the Netdata Agent _as of
673 +the [latest commit](https://github.com/netdata/netdata/commits/master) in the GitHub repository_. For Netdata Cloud,
674 +documentation must reflect the *current state* of [production](https://app.netdata.cloud).
675 +
676 +#### Informational links
677 +
678 +Every link should clearly state its destination. Don't use words like "here" to describe where a link will take your
679 +reader.
680 +
681 +| | |
682 +| --------------- | ------------------------------------------------------------------------------------------ |
683 +| Not recommended | To install Netdata, click [here](/docs/agent/packaging/installer). |
684 +| **Recommended** | To install Netdata, read the [installation instructions](/docs/agent/packaging/installer). |
685 +
686 +Use links as often as required to provide necessary context. Blog posts and guides require less hyperlinks than
687 +documentation. See the section on [linking between documentation](#linking-between-documentation) for guidance on the
688 +Markdown syntax and path structure of inter-documentation links.
689 +
690 +#### Contractions
691 +
692 +Contractions like "you'll" or "they're" are acceptable in most Netdata writing. They're both authentic and playful, and
693 +reinforce the idea that you, as a writer, are guiding users through a particular idea, process, or feature.
694 +
695 +Contractions are generally not used in press releases or other media engagements.
696 +
697 +#### Emoji
698 +
699 +Emoji can add fun and character to your writing, but should be used sparingly and only if it matches the content's tone
700 +and desired audience.
701 +
702 +#### Switching Linux users
703 +
704 +Netdata documentation often suggests that users switch from their normal user to the `netdata` user to run specific
705 +commands. Use the following command to instruct users to make the switch:
706 +
707 +```bash
708 +sudo su -s /bin/bash netdata
709 +```
710 +
711 +#### Hostname/IP address of a node
712 +
713 +Use `NODE` instead of an actual or example IP address/hostname when referencing the process of navigating to a dashboard
714 +or API endpoint in a browser.
715 +
716 +| | |
717 +| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
718 +| Not recommended | Navigate to `http://example.com:19999` in your browser to see Netdata's dashboard. <br />Navigate to `http://203.0.113.0:19999` in your browser to see Netdata's dashboard. |
719 +| **
720 +Recommended** | Navigate to `http://NODE:19999` in your browser to see Netdata's dashboard. |
721 +
722 +If you worry that `NODE` doesn't provide enough context for the user, particularly in documentation or guides designed
723 +for beginners, you can provide an explanation:
724 +
725 +> With the Netdata Agent running, visit `http://NODE:19999/api/v1/info` in your browser, replacing `NODE` with the IP
726 +> address or hostname of your Agent.
727 +
728 +#### Paths and running commands
729 +
730 +When instructing users to run a Netdata-specific command, don't assume the path to said command, because not every
731 +Netdata Agent installation will have commands under the same paths. When applicable, help them navigate to the correct
732 +path, providing a recommendation or instructions on how to view the running configuration, which includes the correct
733 +paths.
734 +
735 +For example, the [configuration](/docs/configure/nodes) doc first teaches users how to find the Netdata config directory
736 +and navigate to it, then runs commands from the `/etc/netdata` path so that the instructions are more universal.
737 +
738 +Don't include full paths, beginning from the system's root (`/`), as these might not work on certain systems.
739 +
740 +| | |
741 +| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
742 +| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
743 +| **
744 +Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](/docs/configure/nodes#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
745 +
746 +#### `sudo`
747 +
748 +Include `sudo` before a command if you believe most Netdata users will need to elevate privileges to run it. This makes
749 +our writing more universal, and users on `sudo`-less systems are generally already aware that they need to run commands
750 +differently.
751 +
752 +For example, most users need to use `sudo` with the `edit-config` script, because the Netdata config directory is owned
753 +by the `netdata` user. Same goes for restarting the Netdata Agent with `systemctl`.
754 +
755 +| | |
756 +| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
757 +| Not recommended | Run `edit-config netdata.conf` to configure the Netdata Agent. <br />Run `systemctl restart netdata` to restart the Netdata Agent. |
758 +| **
759 +Recommended** | Run `sudo edit-config netdata.conf` to configure the Netdata Agent. <br />Run `sudo systemctl restart netdata` to restart the Netdata Agent. |
760 +
761 +## Deploy and test docs
762 +
763 +<!--
764 +TODO: Update this section after implemeting a _docker-compose_ for builting and testing learn
765 +-->
766 +
767 +The Netdata team aggregates and publishes all documentation at [learn.netdata.cloud](/) using
768 +[Docusaurus](https://v2.docusaurus.io/) over at the [`netdata/learn` repository](https://github.com/netdata/learn).
769 +
770 +## Netdata-specific terms
771 +
772 +Consult the [Netdata Glossary](https://github.com/netdata/netdata/blob/master/docs/glossary.md) Netdata specific terms
\ No newline at end of file
docs/metrics-storage-management/enable-streaming.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "Enable streaming between nodes"
3 description: "With metrics streaming enabled, you can not only replicate metrics data into a second database, but also view dashboards and trigger alarm notifications for multiple nodes in parallel."
4 -type: how-to
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/enable-streaming.mdx
4 +type: "how-to"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/enable-streaming.mdx"
6 +sidebar_label: "Enable streaming between nodes"
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Setup"
10 ---
11
12 # Enable streaming between nodes
docs/metrics-storage-management/how-streaming-works.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "How metrics streaming works"
3 description: "Netdata's real-time streaming allows you to replicate metrics data across multiple nodes, or centralize all your metrics data into a single time-series database (TSDB)."
4 -type: explanation
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/how-streaming-works.mdx
4 +type: "explanation"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/how-streaming-works.mdx"
6 +sidebar_label: "How metrics streaming works"
7 +learn_status: "Published"
8 +learn_topic_type: "Concepts"
9 +learn_rel_path: "Concepts"
10 ---
11
12 # How metrics streaming works
docs/metrics-storage-management/reference-streaming.mdx
+6 -2
@@ -1,8 +1,12 @@
1 ---
2 title: "Streaming reference"
3 description: "Each node running Netdata can stream the metrics it collects, in real time, to another node. See all of the available settings in this reference document."
4 -type: reference
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/reference-streaming.mdx
4 +type: "reference"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/reference-streaming.mdx"
6 +sidebar_label: "Streaming reference"
7 +learn_status: "Published"
8 +learn_topic_type: "References"
9 +learn_rel_path: "References/Configuration"
10 ---
11
12 # Streaming reference
docs/monitor/configure-alarms.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Configure health alarms"
3 description: "Netdata's health monitoring watchdog is incredibly adaptable to your infrastructure's unique needs, with configurable health alarms."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/monitor/configure-alarms.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/monitor/configure-alarms.md"
5 +sidebar_label: "Configure health alarms"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Configure health alarms
docs/monitor/enable-notifications.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Enable alarm notifications"
3 description: "Send Netdata alarms from a centralized place with Netdata Cloud, or configure nodes individually, to enable incident response and faster resolution."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/monitor/enable-notifications.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/monitor/enable-notifications.md"
5 +sidebar_label: "Enable alarm notifications"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Enable alarm notifications
docs/monitor/view-active-alarms.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "View active health alarms"
3 description: "View active alarms and their rich data to discover and resolve anomalies and performance issues across your infrastructure."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/monitor/view-active-alarms.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/monitor/view-active-alarms.md"
5 +sidebar_label: "View active health alarms"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Operations"
9 -->
10
11 # View active health alarms
docs/store/change-metrics-storage.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Change how long Netdata stores metrics"
3 description: "With a single configuration change, the Netdata Agent can store days, weeks, or months of metrics at its famous per-second granularity."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/store/change-metrics-storage.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/store/change-metrics-storage.md"
5 +sidebar_label: "Change how long Netdata stores metrics"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10
11 # Change how long Netdata stores metrics
docs/store/distributed-data-architecture.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Distributed data architecture"
3 description: "Netdata's distributed data architecture stores metrics on individual nodes for high performance and scalability using all your granular metrics."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/store/distributed-data-architecture.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/store/distributed-data-architecture.md"
5 +sidebar_label: "Distributed data architecture"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Concepts"
9 -->
10
11 # Distributed data architecture
exporting/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Exporting reference"
3 description: "With the exporting engine, you can archive your Netdata metrics to multiple external databases for long-term storage or further analysis."
4 -sidebar_label: Exporting reference
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/README.md
4 +sidebar_label: "Exporting reference"
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Configuration"
9 +learn_doc_purpose: "Explain the exporting engine options and all of our the exporting connectors options"
10 -->
11
12 # Exporting reference
exporting/TIMESCALE.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Writing metrics to TimescaleDB"
3 description: "Send Netdata metrics to TimescaleDB for long-term archiving and further analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/TIMESCALE.md
5 -sidebar_label: Writing metrics to TimescaleDB
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/TIMESCALE.md"
5 +sidebar_label: "Writing metrics to TimescaleDB"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Writing metrics to TimescaleDB
exporting/WALKTHROUGH.md
+5 -2
@@ -1,8 +1,11 @@
1 <!--
2 title: "Exporting to Netdata, Prometheus, Grafana stack"
3 description: "Using Netdata in conjunction with Prometheus and Grafana."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/WALKTHROUGH.md
5 -sidebar_label: Netdata, Prometheus, Grafana stack
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/WALKTHROUGH.md"
5 +sidebar_label: "Netdata, Prometheus, Grafana stack"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 -->
10
11 # Netdata, Prometheus, Grafana stack
exporting/aws_kinesis/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Export metrics to AWS Kinesis Data Streams"
3 description: "Archive your Agent's metrics to AWS Kinesis Data Streams for long-term storage, further analysis, or correlation with data from other sources."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/aws_kinesis/README.md
5 -sidebar_label: AWS Kinesis Data Streams
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/aws_kinesis/README.md"
5 +sidebar_label: "AWS Kinesis Data Streams"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Export metrics to AWS Kinesis Data Streams
exporting/graphite/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Export metrics to Graphite providers"
3 description: "Archive your Agent's metrics to a any Graphite database provider for long-term storage, further analysis, or correlation with data from other sources."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/graphite/README.md
5 -sidebar_label: Graphite
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/graphite/README.md"
5 +sidebar_label: "Graphite"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Export metrics to Graphite providers
exporting/json/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Export metrics to JSON document databases"
3 description: "Archive your Agent's metrics to a JSON document database for long-term storage, further analysis, or correlation with data from other sources."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/json/README.md
5 -sidebar_label: JSON Document Databases
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/json/README.md"
5 +sidebar_label: "JSON Document Databases"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Export metrics to JSON document databases
exporting/mongodb/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Export metrics to MongoDB"
3 description: "Archive your Agent's metrics to a MongoDB database for long-term storage, further analysis, or correlation with data from other sources."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/mongodb/README.md
5 -sidebar_label: MongoDB
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/mongodb/README.md"
5 +sidebar_label: "MongoDB"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Export metrics to MongoDB
exporting/opentsdb/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Export metrics to OpenTSDB"
3 description: "Archive your Agent's metrics to an OpenTSDB database for long-term storage and further analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/opentsdb/README.md
5 -sidebar_label: OpenTSDB
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/opentsdb/README.md"
5 +sidebar_label: "OpenTSDB"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Export metrics to OpenTSDB
exporting/prometheus/README.md
+6 -1
@@ -1,9 +1,14 @@
1 <!--
2 title: "Export metrics to Prometheus"
3 description: "Export Netdata metrics to Prometheus for archiving and further analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/prometheus/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/prometheus/README.md"
5 sidebar_label: "Using Netdata with Prometheus"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11 +
12 import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
13
14 # Using Netdata with Prometheus
exporting/prometheus/remote_write/README.md
+5 -2
@@ -1,8 +1,11 @@
1 <!--
2 title: "Export metrics to Prometheus remote write providers"
3 description: "Send Netdata metrics to your choice of more than 20 external storage providers for long-term archiving and further analysis."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/prometheus/remote_write/README.md
5 -sidebar_label: Prometheus remote write
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/prometheus/remote_write/README.md"
5 +sidebar_label: "Prometheus remote write"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 -->
10
11 # Prometheus remote write exporting connector
exporting/pubsub/README.md
+6 -2
@@ -1,8 +1,12 @@
1 <!--
2 title: "Export metrics to Google Cloud Pub/Sub Service"
3 description: "Export Netdata metrics to the Google Cloud Pub/Sub Service for long-term archiving or analytical processing."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/pubsub/README.md
5 -sidebar_label: Google Cloud Pub/Sub Service
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/pubsub/README.md"
5 +sidebar_label: "Google Cloud Pub/Sub Service"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Exporting connectors"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Export metrics to Google Cloud Pub/Sub Service
health/REFERENCE.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "Health configuration reference"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/REFERENCE.md
3 +sidebar_label: "Health"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/REFERENCE.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Operations"
8 -->
9
10 # Health configuration reference
health/notifications/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Alarm notifications"
3 description: "Reference documentation for Netdata's alarm notification feature, which supports dozens of endpoints, user roles, and more."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/README.md"
5 +sidebar_label: "Notifications Reference"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 -->
10
11 # Alarm notifications
health/notifications/alerta/README.md
+6 -1
@@ -1,7 +1,12 @@
1 <!--
2 title: "alerta.io"
3 +sidebar_label: "Alerta"
4 description: "Send alarm notifications to Alerta to see the latest health status updates from multiple nodes in a single interface."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # alerta.io
health/notifications/awssns/README.md
+6 -1
@@ -1,7 +1,12 @@
1 <!--
2 title: "Amazon SNS"
3 +sidebar_label: "Amazon SNS"
4 description: "hello"
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Amazon SNS
health/notifications/custom/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Custom"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md
3 +sidebar_label: "Custom endpoint"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Custom
health/notifications/discord/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Discordapp.com"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md
3 +sidebar_label: "Discord"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Discordapp.com
health/notifications/dynatrace/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Dynatrace"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md
3 +sidebar_label: "Dynatrace Events"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Dynatrace
health/notifications/email/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Email"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md
3 +sidebar_label: "Email"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': True, 'part_of_agent': True}"
9 -->
10
11 # Email
health/notifications/flock/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Flock"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/flock/README.md
3 +sidebar_label: "Flock"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/flock/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Flock
health/notifications/gotify/README.md
+4
@@ -3,6 +3,10 @@ title: "Send notifications to Gotify"
3 description: "Send alerts to your Gotify instance when an alert gets triggered in Netdata."
4 sidebar_label: "Gotify"
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/gotify/README.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Send notifications to Gotify
health/notifications/hangouts/README.md
+5 -1
@@ -2,7 +2,11 @@
2 title: "Send notifications to Google Hangouts"
3 description: "Send alerts to Send notifications to Google Hangouts any time an anomaly or performance issue strikes a node in your infrastructure."
4 sidebar_label: "Google Hangouts"
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/hangouts/README.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/hangouts/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Send notifications to Google Hangouts
health/notifications/irc/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "IRC"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md
3 +sidebar_label: "IRC"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # IRC
health/notifications/kavenegar/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Kavenegar"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md
3 +sidebar_label: "Kavenegar"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Kavenegar
health/notifications/matrix/README.md
+5 -1
@@ -2,7 +2,11 @@
2 title: "Send Netdata notifications to Matrix network rooms"
3 description: "Stay aware of warning or critical anomalies by sending health alarms to Matrix network rooms with Netdata's health monitoring watchdog."
4 sidebar_label: "Matrix"
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Matrix
health/notifications/messagebird/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Messagebird"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md
3 +sidebar_label: "Messagebird"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Messagebird
health/notifications/msteams/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Microsoft Teams"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/msteams/README.md
3 +sidebar_label: "Microsoft Teams"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/msteams/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Microsoft Teams
health/notifications/opsgenie/README.md
+5 -1
@@ -2,7 +2,11 @@
2 title: "Send notifications to Opsgenie"
3 description: "Send alerts to your Opsgenie incident response account any time an anomaly or performance issue strikes a node in your infrastructure."
4 sidebar_label: "Opsgenie"
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/opsgenie/README.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/opsgenie/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Send notifications to Opsgenie
health/notifications/pagerduty/README.md
+5 -1
@@ -2,7 +2,11 @@
2 title: "Send alert notifications to PagerDuty"
3 description: "Send alerts to your PagerDuty dashboard any time an anomaly or performance issue strikes a node in your infrastructure."
4 sidebar_label: "PagerDuty"
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Send alert notifications to PagerDuty
health/notifications/prowl/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Prowl"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/prowl/README.md
3 +sidebar_label: "Prowl"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/prowl/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Prowl
health/notifications/pushbullet/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "PushBullet"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md
3 +sidebar_label: "PushBullet"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # PushBullet
health/notifications/pushover/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "PushOver"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md
3 +sidebar_label: "PushOver"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # PushOver
health/notifications/rocketchat/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Rocket.Chat"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md
3 +sidebar_label: "Rocket Chat"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Rocket.Chat
health/notifications/slack/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Slack"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md
3 +sidebar_label: "Slack"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Slack
health/notifications/smstools3/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "SMS Server Tools 3"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md
3 +sidebar_label: "SMS server"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # SMS Server Tools 3
health/notifications/stackpulse/README.md
+5 -1
@@ -2,7 +2,11 @@
2 title: "Send notifications to StackPulse"
3 description: "Send alerts to your StackPulse Netdata integration any time an anomaly or performance issue strikes a node in your infrastructure."
4 sidebar_label: "StackPulse"
5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/stackpulse/README.md
5 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/stackpulse/README.md"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup/Notification/Agent"
9 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
10 -->
11
12 # Send notifications to StackPulse
health/notifications/syslog/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Syslog"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md
3 +sidebar_label: "Syslog"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Syslog
health/notifications/telegram/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Telegram"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md
3 +sidebar_label: "Telegram"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Telegram
health/notifications/twilio/README.md
+6 -1
@@ -1,6 +1,11 @@
1 <!--
2 title: "Twilio"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md
3 +sidebar_label: "Twilio"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
11 # Twilio
health/notifications/web/README.md
+8 -3
@@ -1,9 +1,14 @@
1 <!--
2 -title: "Dashboard"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md
2 +title: "Pop up"
3 +sidebar_label: "Pop up notifications"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Setup/Notification/Agent"
8 +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
9 -->
10
6 -# Dashboard
11 +# Pop up notifications
12
13 The Netdata dashboard shows HTML notifications, when it is open.
14
ml/README.md
+9 -5
@@ -1,9 +1,13 @@
1 -<!--
2 -title: Configure machine learning (ML) powered anomaly detection
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/ml/README.md
4 -description: This is an in-depth look at how Netdata uses ML to detect anomalies.
5 -keywords: [machine learning, anomaly detection, Netdata ML]
1 +<!--
2 +title: "Configure machine learning (ML) powered anomaly detection"
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/ml/README.md"
4 +description: "This is an in-depth look at how Netdata uses ML to detect anomalies."
5 +sidebar_label: "Configure machine learning (ML) powered anomaly detection"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Setup"
9 -->
10 +
11 # Machine learning (ML) powered anomaly detection
12
13 ## Overview
packaging/PLATFORM_SUPPORT.md
+7 -1
@@ -1,6 +1,12 @@
1 <!--
2 title: "Netdata platform support policy"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/PLATFORM_SUPPORT.md
3 +sidebar_label: "Supported platforms"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/PLATFORM_SUPPORT.md"
5 +learn_status: "Published"
6 +sidebar_position: "30"
7 +learn_topic_type: "Getting started"
8 +learn_rel_path: "Getting started"
9 +learn_docs_purpose: "Present all the supported platform in the Netdata solution"
10 -->
11
12 # Netdata platform support policy
packaging/building-native-packages-locally.md
-1
@@ -2,7 +2,6 @@
2 title: How to build native (DEB/RPM) packages locally for testing
3 description: Instructions for developers who need to build native packages locally for testing.
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/building-native-packages-locally.md
5 -keywords: [Netdata native package, Netdata RPM, Netdata DEB, Testing native packages Netdata]
5 -->
6
7 # How to build native (DEB/RPM) packages locally for testing
packaging/docker/README.md
+6 -2
@@ -1,7 +1,11 @@
1 <!--
2 title: "Install Netdata with Docker"
3 -date: 2020-04-23
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/docker/README.md
3 +date: "2020-04-23"
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/docker/README.md"
5 +sidebar_label: "Install Netdata with Docker"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Install the Netdata Agent with Docker
packaging/installer/REINSTALL.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Reinstall the Netdata Agent"
3 description: "Troubleshooting installation issues or force an update of the Netdata Agent by reinstalling it using the same method you used during installation."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/REINSTALL.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/REINSTALL.md"
5 +sidebar_label: "Reinstall the Netdata Agent"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Reinstall the Netdata Agent
packaging/installer/UNINSTALL.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Uninstall Netdata"
3 description: "If you are no longer interested in using the Netdata Agent, use the self-contained uninstaller to remove all traces of binaries and configuration files."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/UNINSTALL.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/UNINSTALL.md"
5 +sidebar_label: "Uninstall Netdata"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Uninstall Netdata
packaging/installer/UPDATE.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Update the Netdata Agent"
3 description: "If you opted out of automatic updates, you need to update your Netdata Agent to the latest nightly or stable version."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/UPDATE.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/UPDATE.md"
5 +sidebar_label: "Update the Netdata Agent"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Update the Netdata Agent
packaging/installer/methods/kickstart.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Install Netdata with kickstart.sh"
3 description: "The kickstart.sh script installs Netdata from source, including all dependencies required to connect to Netdata Cloud, with a single command."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md"
5 +sidebar_label: "Install Netdata with kickstart.sh"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10 import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
11
packaging/installer/methods/kubernetes.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Deploy Kubernetes monitoring with Netdata"
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
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kubernetes.md"
5 +sidebar_label: "Deploy Kubernetes monitoring with Netdata"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Deploy Kubernetes monitoring with Netdata
packaging/installer/methods/macos.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "Install Netdata on macOS"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/macos.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/macos.md"
4 +sidebar_label: "Install Netdata on macOS"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Installation"
8 -->
9
10 # Install Netdata on macOS
packaging/installer/methods/manual.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Install Netdata on Linux from a Git checkout"
3 description: "Use the Netdata Agent source code from GitHub, plus helper scripts to set up your system, to install Netdata without packages or binaries."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/manual.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/manual.md"
5 +sidebar_label: "Install Netdata on Linux from a Git checkout"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Install Netdata on Linux from a Git checkout
packaging/installer/methods/offline.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Install Netdata on offline systems"
3 description: "Install the Netdata Agent on offline/air gapped systems to benefit from real-time, per-second monitoring without connecting to the internet."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/offline.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/offline.md"
5 +sidebar_label: "Install Netdata on offline systems"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Install Netdata on offline systems
packaging/installer/methods/packages.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Install Netdata using native DEB/RPM packages."
3 description: "Instructions for how to install Netdata using native DEB or RPM packages."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/packages.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/packages.md"
5 +sidebar_label: "Install Netdata using native DEB/RPM packages."
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Installing Netdata using native DEB or RPM packages.
packaging/installer/methods/source.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Manually build Netdata from source"
3 description: "Package maintainers and power users may be interested in manually building Netdata from source without using any of our installation scripts."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/source.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/source.md"
5 +sidebar_label: "Manually build Netdata from source"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Manually build Netdata from source
parser/README.md
+15 -10
@@ -1,3 +1,9 @@
1 +<!--
2 +title: "Parser"
3 +custom_edit_url: https://github.com/netdata/netdata/blob/master/parser/README.md
4 +-->
5 +
6 +
7 #### Introduction
8
9 The parser will be used to process streaming and plugins input as well as metadata
@@ -18,7 +24,8 @@ Usage
24
25 #### Functions
26
21 -----
27 +TODO:
28 +
29 ##### parse_init(RRDHOST *host, void *user, void *input, int flags)
30
31 Initialize an internal parser with the specified user defined data structure that will be shared across calls.
@@ -38,7 +45,6 @@ Output
45
46
47
41 -----
48 ##### parse_push(PARSER *parser, char *line)
49
50 Push a new line for processing
@@ -58,7 +64,7 @@ Returns
64 - 0 line added
65 - 1 error detected
66
61 -----
67 +
68 ##### parse_add_keyword(PARSER *parser, char *keyword, keyword_function callback_function)
69
70 The function will add callbacks for keywords. The callback function is defined as
@@ -74,9 +80,9 @@ Input
80 - keyword_function
81 - The callback that will handle the keyword processing
82 * The callback function should return one of the following
77 - * PARSER_RC_OK -- Callback was successful (continue with other callbacks)
78 - * PARSER_RC_STOP -- Stop processing callbacks (return OK)
79 - * PARSER_RC_ERROR -- Callback failed, exit
83 + * PARSER_RC_OK - Callback was successful (continue with other callbacks)
84 + * PARSER_RC_STOP - Stop processing callbacks (return OK)
85 + * PARSER_RC_ERROR - Callback failed, exit
86
87 Output
88 - The corresponding keyword and callback will be registered
@@ -86,7 +92,6 @@ Returns
92 - > 0 which is the number of callbacks associated with this keyword.
93
94
89 -----
95 ##### parser_next(PARSER *parser)
96 Return the next item to parse
97
@@ -101,7 +106,7 @@ Returns
106 - 0 Next item fetched successfully
107 - 1 No more items to parse
108
104 -----
109 +
110 ##### parser_action(PARSER *parser, char *input)
111 Return the next item to parse
112
@@ -118,7 +123,7 @@ Returns
123 - 0 Callbacks called successfully
124 - 1 Failed
125
121 -----
126 +
127 ##### parser_destroy(PARSER *parser)
128 Cleanup a previously allocated parser
129
@@ -132,7 +137,7 @@ Output
137 Returns
138 - none
139
135 -----
140 +
141 ##### parser_recover_input(PARSER *parser)
142 Cleanup a previously allocated parser
143
registry/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Registry"
3 description: "Netdata utilizes a central registry of machines/person GUIDs, URLs, and opt-in account information to provide unified cross-server dashboards."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/registry/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/registry/README.md"
5 +sidebar_label: "Registry"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Configuration"
9 -->
10
11 # Registry
web/api/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 title: "API"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/web/api/README.md"
4 +sidebar_label: "API"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Operations"
8 -->
9
10 # API
web/gui/custom/README.md
+7 -4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Custom dashboards"
3 description: "Build custom dashboards with key metrics from one or more nodes running the Netdata Agent and host them anywhere."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/custom/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/web/gui/custom/README.md"
5 +sidebar_label: "Custom dashboards"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations"
9 -->
10
11 # Custom dashboards
@@ -28,7 +32,7 @@ monitoring two servers on the same page:
32
33 ![image](https://cloud.githubusercontent.com/assets/2662304/14252187/d8d5f78e-fa8e-11e5-990d-99821d38c874.png)
34
31 ---
35 +
36
37 ## Web directory
38
@@ -72,7 +76,6 @@ header:
76 </html>
77 ```
78
75 ----
79
80 ## dashboard.js
81
@@ -163,7 +166,7 @@ that do not specify a Netdata server, add this before loading `dashboard.js`:
166 <script type="text/javascript">var netdataServer = "http://your.netdata.server:19999";</script>
167 ```
168
166 ----
169 +
170
171 ## Adding charts
172
web/server/README.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 title: "Web server"
3 description: "The Netdata Agent's local static-threaded web server serves dashboards and real-time visualizations with security and DDoS protection."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/web/server/README.md
4 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/web/server/README.md"
5 +sidebar_label: "Web server"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References/Configuration"
9 -->
10
11 # Web server