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>
This commit is contained in:
Fotis Voutsas
GitHub
parent
f4d017ccf7
commit
0541c97e53
|
|
@ -1,8 +1,12 @@
|
|||
<!--
|
||||
title: "Agent-Cloud link (ACLK)"
|
||||
description: "The Agent-Cloud link (ACLK) is the mechanism responsible for connecting a Netdata agent to Netdata Cloud."
|
||||
date: 2020-05-11
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/aclk/README.md
|
||||
date: "2020-05-11"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/aclk/README.md"
|
||||
sidebar_label: "Agent-Cloud link (ACLK)"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup"
|
||||
-->
|
||||
|
||||
# Agent-cloud link (ACLK)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "Connect Agent to Cloud"
|
||||
description: "Connecting a Netdata Agent, running on a distributed node, to Netdata Cloud securely via the encrypted Agent-Cloud link (ACLK)."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/claim/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/claim/README.md"
|
||||
sidebar_label: "Connect Agent to Cloud"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup"
|
||||
-->
|
||||
|
||||
# Connect Agent to Cloud
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "Netdata CLI"
|
||||
description: "The Netdata Agent includes a command-line experience for reloading health configuration, reopening log files, halting the daemon, and more."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/cli/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/cli/README.md"
|
||||
sidebar_label: "Agent CLI"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References"
|
||||
-->
|
||||
|
||||
# Netdata CLI
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
<!--
|
||||
title: "Supported collectors list"
|
||||
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."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md"
|
||||
sidebar_label: "Supported collectors list"
|
||||
-->
|
||||
|
||||
# Supported collectors list
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
<!--
|
||||
title: "Collecting metrics"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/README.md"
|
||||
id: "collectors-ref"
|
||||
sidebar_label: "Plugins Reference"
|
||||
-->
|
||||
|
||||
# Collecting metrics
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Collectors configuration reference"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md"
|
||||
sidebar_label: "Collectors configuration"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup"
|
||||
-->
|
||||
|
||||
# Collectors configuration reference
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "apps.plugin"
|
||||
sidebar_label: "Application monitoring (apps.plugin)"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/README.md
|
||||
title: "Application monitoring (apps.plugin)"
|
||||
sidebar_label: "Application monitoring "
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/README.md"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# apps.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "cgroups.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md
|
||||
title: "Monitor Cgroups (cgroups.plugin)"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md"
|
||||
sidebar_label: "Monitor Cgroups"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Virtualized environments/Containers"
|
||||
-->
|
||||
|
||||
# cgroups.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "charts.d.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/README.md"
|
||||
sidebar_label: "charts.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Developers/Collectors"
|
||||
-->
|
||||
|
||||
# charts.d.plugin
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Access point monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/ap/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/ap/README.md"
|
||||
sidebar_label: "Access points"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Remotes/Devices"
|
||||
-->
|
||||
|
||||
# Access point monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "APC UPS monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/apcupsd/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/apcupsd/README.md"
|
||||
sidebar_label: "APC UPS"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Remotes/Devices"
|
||||
-->
|
||||
|
||||
# APC UPS monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Example"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/example/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/example/README.md"
|
||||
sidebar_label: "example-charts.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Mock Collectors"
|
||||
-->
|
||||
|
||||
# Example
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Libreswan IPSec tunnel monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/libreswan/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/libreswan/README.md"
|
||||
sidebar_label: "Libreswan IPSec tunnels"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Networking"
|
||||
-->
|
||||
|
||||
# Libreswan IPSec tunnel monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "UPS/PDU monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/nut/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/nut/README.md"
|
||||
sidebar_label: "UPS/PDU"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Remotes/Devices"
|
||||
-->
|
||||
|
||||
# UPS/PDU monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "OpenSIPS monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/opensips/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/opensips/README.md"
|
||||
sidebar_label: "OpenSIPS"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Networking"
|
||||
-->
|
||||
|
||||
# OpenSIPS monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Linux machine sensors monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/sensors/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/sensors/README.md"
|
||||
sidebar_label: "lm-sensors"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Devices"
|
||||
-->
|
||||
|
||||
# Linux machine sensors monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
<!--
|
||||
title: "checks.plugin"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/checks.plugin/README.md"
|
||||
sidebar_label: "checks.plugin"
|
||||
learn_status: "Unpublished"
|
||||
-->
|
||||
|
||||
# checks.plugin
|
||||
|
||||
A debugging plugin (by default it is disabled)
|
||||
|
||||
|
||||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "cups.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md
|
||||
title: "Printers (cups.plugin)"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md"
|
||||
sidebar_label: "cups.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Remotes/Devices"
|
||||
-->
|
||||
|
||||
# cups.plugin
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "diskspace.plugin"
|
||||
title: "Monitor disk (diskspace.plugin)"
|
||||
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."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md"
|
||||
sidebar_label: "Disks"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# diskspace.plugin
|
||||
|
|
|
|||
|
|
@ -1,9 +1,11 @@
|
|||
<!--
|
||||
title: "eBPF monitoring with Netdata"
|
||||
description: "Use Netdata's extended Berkeley Packet Filter (eBPF) collector to monitor kernel-level metrics about your
|
||||
complex applications with per-second granularity."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ebpf.plugin/README.md
|
||||
sidebar_label: "eBPF"
|
||||
title: "Kernel traces/metrics (eBPF) monitoring with Netdata"
|
||||
description: "Use Netdata's extended Berkeley Packet Filter (eBPF) collector to monitor kernel-level metrics about yourcomplex applications with per-second granularity."
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/ebpf.plugin/README.md"
|
||||
sidebar_label: "Kernel traces/metrics (eBPF)"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# eBPF monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "freebsd.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md
|
||||
title: "FreeBSD system metrics (freebsd.plugin)"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md"
|
||||
sidebar_label: "FreeBSD system metrics (freebsd.plugin)"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# freebsd.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "freeipmi.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md"
|
||||
sidebar_label: "freeipmi.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Devices"
|
||||
-->
|
||||
|
||||
# freeipmi.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "idlejitter.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md"
|
||||
sidebar_label: "idlejitter.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/QoS"
|
||||
-->
|
||||
|
||||
# idlejitter.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "ioping.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md
|
||||
title: "Monitor latency for directories/files/devices (ioping.plugin)"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md"
|
||||
sidebar_label: "Latency monitoring (ioping.plugin)"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/QoS"
|
||||
-->
|
||||
|
||||
# ioping.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "macos.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md"
|
||||
sidebar_label: "macos.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# macos.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "nfacct.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md
|
||||
title: "Monitor Netfilter statistics (nfacct.plugin)"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md"
|
||||
sidebar_label: "Netfilter statistics (nfacct.plugin)"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Networking"
|
||||
-->
|
||||
|
||||
# nfacct.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "perf.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md
|
||||
title: "Monitor CPU performance statistics (perf.plugin)"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md"
|
||||
sidebar_label: "CPU performance statistics (perf.plugin)"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# perf.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "External plugins overview"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/plugins.d/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/plugins.d/README.md"
|
||||
sidebar_label: "plugins.d"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/plugins.d"
|
||||
-->
|
||||
|
||||
# External plugins overview
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "proc.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md
|
||||
title: "OS provided metrics (proc.plugin)"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md"
|
||||
sidebar_label: "OS provided metrics (proc.plugin)"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# proc.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "python.d.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/README.md"
|
||||
sidebar_label: "python.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Developers/Collectors"
|
||||
-->
|
||||
|
||||
# python.d.plugin
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Adaptec RAID controller monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/adaptec_raid/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/adaptec_raid/README.md"
|
||||
sidebar_label: "Adaptec RAID"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Hardware"
|
||||
-->
|
||||
|
||||
# Adaptec RAID controller monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
<!--
|
||||
title: "Alarms"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/alarms/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/alarms/README.md"
|
||||
sidebar_label: "alarms"
|
||||
learn_status: "Unpublished"
|
||||
learn_topic_type: "References"
|
||||
-->
|
||||
|
||||
# Alarms - graphing Netdata alarm states over time
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "AM2320 sensor monitoring with netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/am2320/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/am2320/README.md"
|
||||
sidebar_label: "AM2320"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Remotes/Devices"
|
||||
-->
|
||||
|
||||
# AM2320 sensor monitoring with netdata
|
||||
|
|
|
|||
|
|
@ -1,8 +1,12 @@
|
|||
<!--
|
||||
title: "Anomaly detection with Netdata"
|
||||
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."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/anomalies/README.md
|
||||
sidebar_url: Anomalies
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/anomalies/README.md"
|
||||
sidebar_url: "Anomalies"
|
||||
sidebar_label: "anomalies"
|
||||
learn_status: "Unpublished"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Misc"
|
||||
-->
|
||||
|
||||
# Anomaly detection with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Beanstalk monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/beanstalk/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/beanstalk/README.md"
|
||||
sidebar_label: "Beanstalk"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Message brokers"
|
||||
-->
|
||||
|
||||
# Beanstalk monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "ISC Bind monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/bind_rndc/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/bind_rndc/README.md"
|
||||
sidebar_label: "ISC Bind"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# ISC Bind monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "BOINC monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/boinc/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/boinc/README.md"
|
||||
sidebar_label: "BOINC"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Distributed computing"
|
||||
-->
|
||||
|
||||
# BOINC monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "CEPH monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ceph/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ceph/README.md"
|
||||
sidebar_label: "CEPH"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Storage"
|
||||
-->
|
||||
|
||||
# CEPH monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "Online change point detection with Netdata"
|
||||
description: "Use ML-driven change point detection to narrow your focus and shorten root cause analysis."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/changefinder/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/changefinder/README.md"
|
||||
sidebar_label: "changefinder"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/QoS"
|
||||
-->
|
||||
|
||||
# Online changepoint detection with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Dovecot monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/dovecot/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/dovecot/README.md"
|
||||
sidebar_label: "Dovecot"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# Dovecot monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Example"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/example/README.md
|
||||
title: "Example module in Python"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/example/README.md"
|
||||
sidebar_label: "Example module in Python"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Mock Collectors"
|
||||
-->
|
||||
|
||||
# Example
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Exim monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/exim/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/exim/README.md"
|
||||
sidebar_label: "Exim"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# Exim monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Fail2ban monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/fail2ban/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/fail2ban/README.md"
|
||||
sidebar_label: "Fail2ban"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Apps"
|
||||
-->
|
||||
|
||||
# Fail2ban monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Gearman monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/gearman/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/gearman/README.md"
|
||||
sidebar_label: "Gearman"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Distributed computing"
|
||||
-->
|
||||
|
||||
# Gearman monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Go applications monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/go_expvar/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/go_expvar/README.md"
|
||||
sidebar_label: "Go applications"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Application Performance Monitoring"
|
||||
-->
|
||||
|
||||
# Go applications monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "HAProxy monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/haproxy/README.md
|
||||
sidebar_label: "HAProxy"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/haproxy/README.md"
|
||||
sidebar_label: "haproxy-python.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# HAProxy monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Hard drive temperature monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hddtemp/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hddtemp/README.md"
|
||||
sidebar_label: "Hard drive temperature"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Hardware"
|
||||
-->
|
||||
|
||||
# Hard drive temperature monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "HP Smart Storage Arrays monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hpssa/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/hpssa/README.md"
|
||||
sidebar_label: "HP Smart Storage Arrays"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Storage"
|
||||
-->
|
||||
|
||||
# HP Smart Storage Arrays monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Icecast monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/icecast/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/icecast/README.md"
|
||||
sidebar_label: "Icecast"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Networking"
|
||||
-->
|
||||
|
||||
# Icecast monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "IPFS monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ipfs/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ipfs/README.md"
|
||||
sidebar_label: "IPFS"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Storage"
|
||||
-->
|
||||
|
||||
# IPFS monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "LiteSpeed monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/litespeed/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/litespeed/README.md"
|
||||
sidebar_label: "LiteSpeed"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Application Performance Monitoring"
|
||||
-->
|
||||
|
||||
# LiteSpeed monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "MegaRAID controller monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/megacli/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/megacli/README.md"
|
||||
sidebar_label: "MegaRAID controllers"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Devices"
|
||||
-->
|
||||
|
||||
# MegaRAID controller monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Memcached monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/memcached/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/memcached/README.md"
|
||||
sidebar_label: "Memcached"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Databases"
|
||||
-->
|
||||
|
||||
# Memcached monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Monit monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/monit/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/monit/README.md"
|
||||
sidebar_label: "Monit"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Storage"
|
||||
-->
|
||||
|
||||
# Monit monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "NSD monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nsd/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nsd/README.md"
|
||||
sidebar_label: "NSD"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Networking"
|
||||
-->
|
||||
|
||||
# NSD monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "NTP daemon monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ntpd/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ntpd/README.md"
|
||||
sidebar_label: "NTP daemon"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Qos"
|
||||
-->
|
||||
|
||||
# NTP daemon monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Nvidia GPU monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nvidia_smi/README.md
|
||||
sidebar_label: "Nvidia GPUs"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nvidia_smi/README.md"
|
||||
sidebar_label: "nvidia_smi-python.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Devices"
|
||||
-->
|
||||
|
||||
# Nvidia GPU monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "OpenLDAP monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/openldap/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/openldap/README.md"
|
||||
sidebar_label: "OpenLDAP"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Networking"
|
||||
-->
|
||||
|
||||
# OpenLDAP monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "OracleDB monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/oracledb/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/oracledb/README.md"
|
||||
sidebar_label: "OracleDB"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Databases"
|
||||
-->
|
||||
|
||||
# OracleDB monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Postfix monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/postfix/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/postfix/README.md"
|
||||
sidebar_label: "Postfix"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# Postfix monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "ProxySQL monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/proxysql/README.md
|
||||
sidebar_label: "ProxySQL"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/proxysql/README.md"
|
||||
sidebar_label: "proxysql-python.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Databases"
|
||||
-->
|
||||
|
||||
# ProxySQL monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Puppet monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/puppet/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/puppet/README.md"
|
||||
sidebar_label: "Puppet"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Provisioning tools"
|
||||
-->
|
||||
|
||||
# Puppet monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "RabbitMQ monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rabbitmq/README.md
|
||||
sidebar_label: "RabbitMQ"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rabbitmq/README.md"
|
||||
sidebar_label: "rabbitmq-python.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Message brokers"
|
||||
-->
|
||||
|
||||
# RabbitMQ monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "RethinkDB monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rethinkdbs/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rethinkdbs/README.md"
|
||||
sidebar_label: "RethinkDB"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Databases"
|
||||
-->
|
||||
|
||||
# RethinkDB monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "RetroShare monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/retroshare/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/retroshare/README.md"
|
||||
sidebar_label: "RetroShare"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Apm"
|
||||
-->
|
||||
|
||||
# RetroShare monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Riak KV monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/riakkv/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/riakkv/README.md"
|
||||
sidebar_label: "Riak KV"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Databases"
|
||||
-->
|
||||
|
||||
# Riak KV monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Samba monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/samba/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/samba/README.md"
|
||||
sidebar_label: "Samba"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Apps"
|
||||
-->
|
||||
|
||||
# Samba monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Linux machine sensors monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/sensors/README.md
|
||||
sidebar_label: "Linux machine sensors"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/sensors/README.md"
|
||||
sidebar_label: "sensors-python.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Devices"
|
||||
-->
|
||||
|
||||
# Linux machine sensors monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Storage devices monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/smartd_log/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/smartd_log/README.md"
|
||||
sidebar_label: "S.M.A.R.T. attributes"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Devices"
|
||||
-->
|
||||
|
||||
# Storage devices monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "SpigotMC monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/spigotmc/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/spigotmc/README.md"
|
||||
sidebar_label: "SpigotMC"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# SpigotMC monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Squid monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/squid/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/squid/README.md"
|
||||
sidebar_label: "Squid"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# Squid monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Apache Tomcat monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tomcat/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tomcat/README.md"
|
||||
sidebar_label: "Tomcat"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# Apache Tomcat monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Tor monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tor/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tor/README.md"
|
||||
sidebar_label: "Tor"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Apps"
|
||||
-->
|
||||
|
||||
# Tor monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Traefik monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/traefik/README.md
|
||||
sidebar_label: "Traefik"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/traefik/README.md"
|
||||
sidebar_label: "traefik-python.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# Traefik monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "uWSGI monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/uwsgi/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/uwsgi/README.md"
|
||||
sidebar_label: "uWSGI"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# uWSGI monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "Varnish Cache monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/varnish/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/varnish/README.md"
|
||||
sidebar_label: "Varnish Cache"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Webapps"
|
||||
-->
|
||||
|
||||
# Varnish Cache monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
<!--
|
||||
title: "1-Wire Sensors monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/w1sensor/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/w1sensor/README.md"
|
||||
sidebar_label: "1-Wire sensors"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Remotes/Devices"
|
||||
-->
|
||||
|
||||
# 1-Wire Sensors monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "zscores"
|
||||
description: "Use statistical anomaly detection to narrow your focus and shorten root cause analysis."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/zscores/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/zscores/README.md"
|
||||
sidebar_label: "zscores"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Uncategorized"
|
||||
-->
|
||||
|
||||
# Z-Scores - basic anomaly detection for your key metrics and charts
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "slabinfo.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md"
|
||||
sidebar_label: "slabinfo.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# slabinfo.plugin
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "statsd.plugin"
|
||||
description: "The Netdata Agent is a fully-featured StatsD server that collects metrics from any custom application and visualizes them in real-time."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/README.md"
|
||||
sidebar_label: "statsd.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Apm"
|
||||
-->
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<!--
|
||||
title: "Asterisk monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/asterisk.md
|
||||
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/asterisk.md"
|
||||
sidebar_label: "Asterisk"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Apm/Statsd"
|
||||
-->
|
||||
|
||||
# Asterisk monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<!--
|
||||
title: "K6 load test monitoring with Netdata"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/k6.md
|
||||
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/k6.md"
|
||||
sidebar_label: "K6 Load Testing"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Apm/Statsd"
|
||||
-->
|
||||
|
||||
# K6 Load Testing monitoring with Netdata
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "tc.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md"
|
||||
sidebar_label: "tc.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Networking"
|
||||
-->
|
||||
|
||||
# tc.plugin
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "timex.plugin"
|
||||
description: "Monitor the system clock synchronization state."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/timex.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/timex.plugin/README.md"
|
||||
sidebar_label: "timex.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/System metrics"
|
||||
-->
|
||||
|
||||
# timex.plugin
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "xenstat.plugin"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/xenstat.plugin/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/xenstat.plugin/README.md"
|
||||
sidebar_label: "xenstat.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Collectors references/Virtualized environments/Virtualize hosts"
|
||||
-->
|
||||
|
||||
# xenstat.plugin
|
||||
|
|
|
|||
|
|
@ -0,0 +1,773 @@
|
|||
# Docs Development Guidelines
|
||||
|
||||
Welcome to our docs developer guidelines!
|
||||
|
||||
We store documentation related to Netdata inside of the [`netdata/netdata` repository](https://github.com/netdata/netdata) on GitHub.
|
||||
|
||||
The Netdata team aggregates and publishes all documentation at [learn.netdata.cloud](/) using
|
||||
[Docusaurus](https://v2.docusaurus.io/) over at the [`netdata/learn` repository](https://github.com/netdata/learn).
|
||||
|
||||
## Before you get started
|
||||
|
||||
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).
|
||||
|
||||
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).
|
||||
|
||||
### Netdata's Documentation structure
|
||||
|
||||
Netdata's documentation is separated into 5 categories.
|
||||
|
||||
- **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.
|
||||
- Stored in **WIP**
|
||||
- Published in **WIP**
|
||||
- **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.
|
||||
- Stored in the `/docs/concepts` directory in the `netdata/netdata` repository.
|
||||
- Published in **WIP**
|
||||
- **Tasks**: This section's purpose is to break down any operation into a series of fundamental tasks for the Netdata solution.
|
||||
- Stored in the `/docs/tasks` directory in the `netdata/netdata` repository.
|
||||
- Published in **WIP**
|
||||
- **References**: This section’s purpose is to explain thoroughly every part of Netdata. That covers settings, configurations and so on.
|
||||
- Stored near the component they refer to.
|
||||
- Published in **WIP**
|
||||
- **Collectors References**: This section’s purpose is to explain thoroughly every collector that Netdata supports and it's configuration options.
|
||||
- Stored in stored near the collector they refer to.
|
||||
- Published in **WIP**
|
||||
|
||||
## How to contribute
|
||||
|
||||
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.
|
||||
|
||||
Click on the **Edit this page** button on any published document on [Netdata Learn](https://learn.netdata.cloud). Each
|
||||
page has two of these buttons: One beneath the table of contents, and another at the end of the document, which take you
|
||||
to GitHub's code editor. Make your suggested changes, keeping the [Netdata style guide](#styling-guide)
|
||||
in mind, and use the ***Preview changes*** button to ensure your Markdown syntax works as expected.
|
||||
|
||||
Under the **Commit changes** header, write descriptive title for your requested change. Click the **Commit changes**
|
||||
button to initiate your pull request (PR).
|
||||
|
||||
Jump down to our instructions on [PRs](#making-a-pull-request) for your next steps.
|
||||
|
||||
### Edit locally
|
||||
|
||||
Editing documentation locally is the preferred method for complex changes that span multiple documents or change the documentation's style or structure.
|
||||
|
||||
Create a fork of the Netdata Agent repository by visit the [Netdata repository](https://github.com/netdata/netdata) and clicking on the **Fork** button.
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
### Making a pull request
|
||||
|
||||
Pull requests (PRs) should be concise and informative. See our [PR guidelines](/contribute/handbook#pr-guidelines) for specifics.
|
||||
|
||||
- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50 characters.
|
||||
- The description should explain what was changed and why. Verify that you tested any code or processes that you are trying to change.
|
||||
|
||||
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.
|
||||
|
||||
After merging your PR, the Netdata team rebuilds the [documentation site](https://learn.netdata.cloud) to publish the changed documentation.
|
||||
|
||||
## Writing Docs
|
||||
|
||||
We have three main types of Docs: **References**, **Concepts** and **Tasks**.
|
||||
|
||||
### Metadata Tags
|
||||
|
||||
|
||||
All of the Docs however have what we call "metadata" tags. these help to organize the document upon publishing.
|
||||
|
||||
So let's go through the different necessary metadata tags to get a document properly published on Learn:
|
||||
|
||||
- Docusaurus Specific:\
|
||||
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.
|
||||
- `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.
|
||||
- `description: "The description of the file"`: Here we give a description of what this file is about.
|
||||
- `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.
|
||||
- Netdata Learn specific:
|
||||
- `learn_status: "..."`
|
||||
- The options for this tag are:
|
||||
- `"published"`
|
||||
- `"unpublished"`
|
||||
- `learn_topic_type: "..."`
|
||||
- The options for this tag are:
|
||||
- `"Getting Started"`
|
||||
- `"Concepts"`
|
||||
- `"Tasks"`
|
||||
- `"References"`
|
||||
- `"Collectors References"`
|
||||
- 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.
|
||||
- `learn_rel_path: "/example/"`
|
||||
- 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 `"/"`.
|
||||
- ⚠️ 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.
|
||||
|
||||
While Docusaurus can make use of more metadata tags than the above, these are the minimum we require to publish the file on Learn.
|
||||
|
||||
### Doc Templates
|
||||
|
||||
These are the templates we use for our Documentation files:
|
||||
|
||||
<details>
|
||||
<summary>Reference Docs</summary>
|
||||
|
||||
The template that is used for Reference files is:
|
||||
|
||||
```
|
||||
<!--
|
||||
title: "Apache monitoring with Netdata"
|
||||
description: "Monitor the health and performance of Apache web servers with zero configuration, per-second metric granularity, and interactive visualizations."
|
||||
custom_edit_url: https://github.com/netdata/go.d.plugin/edit/master/modules/apache/README.md
|
||||
learn_topic_type: "Collector References"
|
||||
learn_rel_path: "/sample_category"
|
||||
learn_status: "published"
|
||||
-->
|
||||
```
|
||||
|
||||
## Configuration files
|
||||
|
||||
### Data collection
|
||||
|
||||
```
|
||||
go.d/apache.conf
|
||||
```
|
||||
|
||||
To make changes, see `the ./edit-config task <link>`
|
||||
|
||||
### Alerts
|
||||
|
||||
none
|
||||
|
||||
## Requirements to run this module
|
||||
|
||||
- none
|
||||
|
||||
## Requirement on the monitored application
|
||||
|
||||
- `Apache` with enabled [`mod_status`](https://httpd.apache.org/docs/2.4/mod/mod_status.html)
|
||||
|
||||
## Auto detection
|
||||
|
||||
### Single node installation
|
||||
|
||||
. . . we autodetect localhost:port and what configurations are defaults
|
||||
|
||||
### Kubernetes installations
|
||||
|
||||
. . . Service discovery, click here
|
||||
|
||||
## Metrics
|
||||
|
||||
Columns: Context | description (of the context) | units (of the context) | dimensions | alerts
|
||||
|
||||
- Requests in `requests/s`
|
||||
- Connections in `connections`
|
||||
- Async Connections in `connections`
|
||||
- Scoreboard in `connections`
|
||||
- Bandwidth in `kilobits/s`
|
||||
- Workers in `workers`
|
||||
- Lifetime Average Number Of Requests Per Second in `requests/s`
|
||||
- Lifetime Average Number Of Bytes Served Per Second in `KiB/s`
|
||||
- Lifetime Average Response Size in `KiB`
|
||||
|
||||
### Labels
|
||||
|
||||
just like <https://github.com/netdata/go.d.plugin/tree/master/modules/k8s_state#labels>
|
||||
|
||||
## Alerts
|
||||
|
||||
collapsible content for every alert, just like the alert guides
|
||||
|
||||
## Configuration options
|
||||
|
||||
Table with all the configuration options available.
|
||||
|
||||
Columns: name | description | default
|
||||
|
||||
## Configuration example
|
||||
|
||||
Needs only `url` to server's `server-status?auto`. Here is an example for 2 servers:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
- name: local
|
||||
url: http://127.0.0.1/server-status?auto
|
||||
- name: remote
|
||||
url: http://203.0.113.10/server-status?auto
|
||||
```
|
||||
|
||||
For all available options please see
|
||||
module [configuration file](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/apache.conf).
|
||||
|
||||
## Troubleshoot
|
||||
|
||||
backlink to the task to run this module in debug mode
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Task Docs</summary>
|
||||
|
||||
The template that is used for Task files is:
|
||||
|
||||
```
|
||||
<!--
|
||||
title: "Task title"
|
||||
description: "Task description"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Tasks/sampletask.md
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "/sample_category"
|
||||
learn_status: "published"
|
||||
-->
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
A small description of the Task.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Describe all the information that the user needs to know before proceeding with the task.
|
||||
|
||||
## Context
|
||||
|
||||
Describe the background information of the Task, the purpose of the Task, and what will the user achieve by completing it.
|
||||
|
||||
## Steps
|
||||
|
||||
A task consists of steps, here provide the actions needed from the user, so he can complete the task correctly.
|
||||
|
||||
## Result
|
||||
|
||||
Describe the expected output/ outcome of the result.
|
||||
|
||||
## Example
|
||||
|
||||
Provide any examples needed for the Task
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Concept Docs</summary>
|
||||
|
||||
The template of the Concept files is:
|
||||
|
||||
```
|
||||
<!--
|
||||
title: "Concept title"
|
||||
description: "Concept description"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Concepts/sampleconcept.md
|
||||
learn_topic_type: "Concepts"
|
||||
learn_rel_path: "/sample_category"
|
||||
learn_status: "published"
|
||||
-->
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
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.
|
||||
|
||||
</details>
|
||||
|
||||
## Styling Guide
|
||||
|
||||
The *Netdata style guide* establishes editorial guidelines for any writing produced by the Netdata team or the Netdata
|
||||
community, including documentation, articles, in-product UX copy, and more. Both internal Netdata teams and external
|
||||
contributors to any of Netdata's open-source projects should reference and adhere to this style guide as much as
|
||||
possible.
|
||||
|
||||
Netdata's writing should **empower** and **educate**. You want to help people understand Netdata's value, encourage them
|
||||
to learn more, and ultimately use Netdata's products to democratize monitoring in their organizations. To achieve these
|
||||
goals, your writing should be:
|
||||
|
||||
- **Clear**. Use simple words and sentences. Use strong, direct, and active language that encourages readers to action.
|
||||
- **Concise**. Provide solutions and answers as quickly as possible. Give users the information they need right now,
|
||||
along with opportunities to learn more.
|
||||
- **Universal**. Think of yourself as a guide giving a tour of Netdata's products, features, and capabilities to a
|
||||
diverse group of users. Write to reach the widest possible audience.
|
||||
|
||||
You can achieve these goals by reading and adhering to the principles outlined below.
|
||||
|
||||
## Voice and tone
|
||||
|
||||
One way we write empowering, educational content is by using a consistent voice and an appropriate tone.
|
||||
|
||||
*Voice* is like your personality, which doesn't really change day to day.
|
||||
|
||||
*Tone* is how you express your personality. Your expression changes based on your attitude or mood, or based on who
|
||||
you're around. In writing, your reflect tone in your word choice, punctuation, sentence structure, or even the use of
|
||||
emoji.
|
||||
|
||||
The same idea about voice and tone applies to organizations, too. Our voice shouldn't change much between two pieces of
|
||||
content, no matter who wrote each, but the tone might be quite different based on who we think is reading.
|
||||
|
||||
For example, a [blog post](https://www.netdata.cloud/blog/) and a [press release](https://www.netdata.cloud/news/)
|
||||
should have a similar voice, despite most often being written by different people. However, blog posts are relaxed and
|
||||
witty, while press releases are focused and academic. You won't see any emoji in a press release.
|
||||
|
||||
### Voice
|
||||
|
||||
Netdata's voice is authentic, passionate, playful, and respectful.
|
||||
|
||||
- **Authentic** writing is honest and fact-driven. Focus on Netdata's strength while accurately communicating what
|
||||
Netdata can and cannot do, and emphasize technical accuracy over hard sells and marketing jargon.
|
||||
- **Passionate** writing is strong and direct. Be a champion for the product or feature you're writing about, and let
|
||||
your unique personality and writing style shine.
|
||||
- **Playful** writing is friendly, thoughtful, and engaging. Don't take yourself too seriously, as long as it's not at
|
||||
the expense of Netdata or any of its users.
|
||||
- **Respectful** writing treats people the way you want to be treated. Prioritize giving solutions and answers as
|
||||
quickly as possible.
|
||||
|
||||
### Tone
|
||||
|
||||
Netdata's tone is fun and playful, but clarity and conciseness comes first. We also tend to be informal, and aren't
|
||||
afraid of a playful joke or two.
|
||||
|
||||
While we have general standards for voice and tone, we do want every individual's unique writing style to reflect in
|
||||
published content.
|
||||
|
||||
## Universal communication
|
||||
|
||||
Netdata is a global company in every sense, with employees, contributors, and users from around the world. We strive to
|
||||
communicate in a way that is clear and easily understood by everyone.
|
||||
|
||||
Here are some guidelines, pointers, and questions to be aware of as you write to ensure your writing is universal. Some
|
||||
of these are expanded into individual sections in the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
|
||||
|
||||
- Would this language make sense to someone who doesn't work here?
|
||||
- Could someone quickly scan this document and understand the material?
|
||||
- Create an information hierarchy with key information presented first and clearly called out to improve scannability.
|
||||
- Avoid directional language like "sidebar on the right of the page" or "header at the top of the page" since
|
||||
presentation elements may adapt for devices.
|
||||
- Use descriptive links rather than "click here" or "learn more".
|
||||
- Include alt text for images and image links.
|
||||
- Ensure any information contained within a graphic element is also available as plain text.
|
||||
- Avoid idioms that may not be familiar to the user or that may not make sense when translated.
|
||||
- Avoid local, cultural, or historical references that may be unfamiliar to users.
|
||||
- Prioritize active, direct language.
|
||||
- Avoid referring to someone's age unless it is directly relevant; likewise, avoid referring to people with age-related
|
||||
descriptors like "young" or "elderly."
|
||||
- Avoid disability-related idioms like "lame" or "falling on deaf ears." Don't refer to a person's disability unless
|
||||
it’s directly relevant to what you're writing.
|
||||
- Don't call groups of people "guys." Don't call women "girls."
|
||||
- Avoid gendered terms in favor of neutral alternatives, like "server" instead of "waitress" and "businessperson"
|
||||
instead of "businessman."
|
||||
- When writing about a person, use their communicated pronouns. When in doubt, just ask or use their name. It's OK to
|
||||
use "they" as a singular pronoun.
|
||||
|
||||
> Some of these guidelines were adapted from MailChimp under the Creative Commons license.
|
||||
|
||||
## Language, grammar, and mechanics
|
||||
|
||||
To ensure Netdata's writing is clear, concise, and universal, we have established standards for language, grammar, and
|
||||
certain writing mechanics. However, if you're writing about Netdata for an external publication, such as a guest blog
|
||||
post, follow that publication's style guide or standards, while keeping the [preferred spelling of Netdata
|
||||
terms](#netdata-specific-terms) in mind.
|
||||
|
||||
### Active voice
|
||||
|
||||
Active voice is more concise and easier to understand compared to passive voice. When using active voice, the subject of
|
||||
the sentence is action. In passive voice, the subject is acted upon. A famous example of passive voice is the phrase
|
||||
"mistakes were made."
|
||||
|
||||
| | |
|
||||
| --------------- | ----------------------------------------------------------------------------------------- |
|
||||
| Not recommended | When an alarm is triggered by a metric, a notification is sent by Netdata. |
|
||||
| **Recommended** | When a metric triggers an alarm, Netdata sends a notification to your preferred endpoint. |
|
||||
|
||||
### Second person
|
||||
|
||||
Use the second person ("you") to give instructions or "talk" directly to users.
|
||||
|
||||
In these situations, avoid "we," "I," "let's," and "us," particularly in documentation. The "you" pronoun can also be
|
||||
implied, depending on your sentence structure.
|
||||
|
||||
One valid exception is when a member of the Netdata team or community wants to write about said team or community.
|
||||
|
||||
| | |
|
||||
| ------------------------------ | ------------------------------------------------------------ |
|
||||
| Not recommended | To install Netdata, we should try the one-line installer... |
|
||||
| **Recommended** | To install Netdata, you should try the one-line installer... |
|
||||
| **Recommended**, implied "you" | To install Netdata, try the one-line installer... |
|
||||
|
||||
### "Easy" or "simple"
|
||||
|
||||
Using words that imply the complexity of a task or feature goes against our policy of [universal
|
||||
communication](#universal-communication). If you claim that a task is easy and the reader struggles to complete it, you
|
||||
may inadvertently discourage them.
|
||||
|
||||
However, if you give users two options and want to relay that one option is genuinely less complex than another, be
|
||||
specific about how and why.
|
||||
|
||||
For example, don't write, "Netdata's one-line installer is the easiest way to install Netdata." Instead, you might want
|
||||
to say, "Netdata's one-line installer requires fewer steps than manually installing from source."
|
||||
|
||||
### Slang, metaphors, and jargon
|
||||
|
||||
A particular word, phrase, or metaphor you're familiar with might not translate well to the other cultures featured
|
||||
among Netdata's global community. We recommended you avoid slang or colloquialisms in your writing.
|
||||
|
||||
In addition, don't use abbreviations that have not yet been defined in the content. See our section on
|
||||
[abbreviations](#abbreviations-acronyms-and-initialisms) for additional guidance.
|
||||
|
||||
If you must use industry jargon, such as "mean time to resolution," define the term as clearly and concisely as you can.
|
||||
|
||||
> Netdata helps you reduce your organization's mean time to resolution (MTTR), which is the average time the responsible
|
||||
> team requires to repair a system and resolve an ongoing incident.
|
||||
|
||||
### Spelling
|
||||
|
||||
While the Netdata team is mostly *not* American, we still aspire to use American spelling whenever possible, as it is
|
||||
the standard for the monitoring industry.
|
||||
|
||||
See the [word list](#word-list) for spellings of specific words.
|
||||
|
||||
### Capitalization
|
||||
|
||||
Follow the general [English standards](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for
|
||||
capitalization. In summary:
|
||||
|
||||
- Capitalize the first word of every new sentence.
|
||||
- Don't use uppercase for emphasis. (Netdata is the BEST!)
|
||||
- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
|
||||
Docker, Apache, NGINX)
|
||||
- Avoid camel case (NetData) or all caps (NETDATA).
|
||||
|
||||
Whenever you refer to the company Netdata, Inc., or the open-source monitoring agent the company develops, capitalize
|
||||
**Netdata**.
|
||||
|
||||
However, if you are referring to a process, user, or group on a Linux system, use lowercase and fence the word in an
|
||||
inline code block: `` `netdata` ``.
|
||||
|
||||
| | |
|
||||
| --------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| Not recommended | The netdata agent, which spawns the netdata process, is actively maintained by netdata, inc. |
|
||||
| **Recommended** | The Netdata Agent, which spawns the `netdata` process, is actively maintained by Netdata, Inc. |
|
||||
|
||||
#### Capitalization of document titles and page headings
|
||||
|
||||
Document titles and page headings should use sentence case. That means you should only capitalize the first word.
|
||||
|
||||
If you need to use the name of a brand, software, product, and company, capitalize it according to their official
|
||||
guidelines.
|
||||
|
||||
Also, don't put a period (`.`) or colon (`:`) at the end of a title or header.
|
||||
|
||||
| | |
|
||||
| --------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| Not recommended | Getting Started Guide <br />Service Discovery and Auto-Detection: <br />Install netdata with docker |
|
||||
| **Recommended** | Getting started guide <br />Service discovery and auto-detection <br />Install Netdata with Docker |
|
||||
|
||||
### Abbreviations (acronyms and initialisms)
|
||||
|
||||
Use abbreviations (including [acronyms and initialisms](https://www.dictionary.com/e/acronym-vs-abbreviation/)) in
|
||||
documentation when one exists, when it's widely accepted within the monitoring/sysadmin community, and when it improves
|
||||
the readability of a document.
|
||||
|
||||
When introducing an abbreviation to a document for the first time, give the reader both the spelled-out version and the
|
||||
shortened version at the same time. For example:
|
||||
|
||||
> 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.
|
||||
|
||||
You can also use abbreviations in a document's title to keep the title short and relevant. If you do this, you should
|
||||
still introduce the spelled-out name alongside the abbreviation as soon as possible.
|
||||
|
||||
### Clause order
|
||||
|
||||
When instructing users to take action, give them the context first. By placing the context in an initial clause at the
|
||||
beginning of the sentence, users can immediately know if they want to read more, follow a link, or skip ahead.
|
||||
|
||||
| | |
|
||||
| --------------- | ------------------------------------------------------------------------------ |
|
||||
| Not recommended | Read the reference guide if you'd like to learn more about custom dashboards. |
|
||||
| **Recommended** | If you'd like to learn more about custom dashboards, read the reference guide. |
|
||||
|
||||
### Oxford comma
|
||||
|
||||
The Oxford comma is the comma used after the second-to-last item in a list of three or more items. It appears just
|
||||
before "and" or "or."
|
||||
|
||||
| | |
|
||||
| --------------- | ---------------------------------------------------------------------------- |
|
||||
| Not recommended | Netdata can monitor RAM, disk I/O, MySQL queries per second and lm-sensors. |
|
||||
| **Recommended** | Netdata can monitor RAM, disk I/O, MySQL queries per second, and lm-sensors. |
|
||||
|
||||
### Future releases or features
|
||||
|
||||
Do not mention future releases or upcoming features in writing unless they have been previously communicated via a
|
||||
public roadmap.
|
||||
|
||||
In particular, documentation must describe, as accurately as possible, the Netdata Agent _as of the [latest
|
||||
commit](https://github.com/netdata/netdata/commits/master) in the GitHub repository_. For Netdata Cloud, documentation
|
||||
must reflect the *current state* of [production](https://app.netdata.cloud).
|
||||
|
||||
### Informational links
|
||||
|
||||
Every link should clearly state its destination. Don't use words like "here" to describe where a link will take your
|
||||
reader.
|
||||
|
||||
| | |
|
||||
| --------------- | ------------------------------------------------------------------------------------------ |
|
||||
| Not recommended | To install Netdata, click [here](/docs/agent/packaging/installer). |
|
||||
| **Recommended** | To install Netdata, read the [installation instructions](/docs/agent/packaging/installer). |
|
||||
|
||||
Use links as often as required to provide necessary context. Blog posts and guides require less hyperlinks than
|
||||
documentation. See the section on [linking between documentation](#linking-between-documentation) for guidance on the
|
||||
Markdown syntax and path structure of inter-documentation links.
|
||||
|
||||
### Contractions
|
||||
|
||||
Contractions like "you'll" or "they're" are acceptable in most Netdata writing. They're both authentic and playful, and
|
||||
reinforce the idea that you, as a writer, are guiding users through a particular idea, process, or feature.
|
||||
|
||||
Contractions are generally not used in press releases or other media engagements.
|
||||
|
||||
### Emoji
|
||||
|
||||
Emoji can add fun and character to your writing, but should be used sparingly and only if it matches the content's tone
|
||||
and desired audience.
|
||||
|
||||
### Switching Linux users
|
||||
|
||||
Netdata documentation often suggests that users switch from their normal user to the `netdata` user to run specific
|
||||
commands. Use the following command to instruct users to make the switch:
|
||||
|
||||
```bash
|
||||
sudo su -s /bin/bash netdata
|
||||
```
|
||||
|
||||
### Hostname/IP address of a node
|
||||
|
||||
Use `NODE` instead of an actual or example IP address/hostname when referencing the process of navigating to a dashboard
|
||||
or API endpoint in a browser.
|
||||
|
||||
| | |
|
||||
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 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. |
|
||||
| **Recommended** | Navigate to `http://NODE:19999` in your browser to see Netdata's dashboard. |
|
||||
|
||||
If you worry that `NODE` doesn't provide enough context for the user, particularly in documentation or guides designed
|
||||
for beginners, you can provide an explanation:
|
||||
|
||||
> With the Netdata Agent running, visit `http://NODE:19999/api/v1/info` in your browser, replacing `NODE` with the IP
|
||||
> address or hostname of your Agent.
|
||||
|
||||
### Paths and running commands
|
||||
|
||||
When instructing users to run a Netdata-specific command, don't assume the path to said command, because not every
|
||||
Netdata Agent installation will have commands under the same paths. When applicable, help them navigate to the correct
|
||||
path, providing a recommendation or instructions on how to view the running configuration, which includes the correct
|
||||
paths.
|
||||
|
||||
For example, the [configuration](/docs/configure/nodes) doc first teaches users how to find the Netdata config
|
||||
directory and navigate to it, then runs commands from the `/etc/netdata` path so that the instructions are more
|
||||
universal.
|
||||
|
||||
Don't include full paths, beginning from the system's root (`/`), as these might not work on certain systems.
|
||||
|
||||
| | |
|
||||
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
|
||||
| **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`. |
|
||||
|
||||
### `sudo`
|
||||
|
||||
Include `sudo` before a command if you believe most Netdata users will need to elevate privileges to run it. This makes
|
||||
our writing more universal, and users on `sudo`-less systems are generally already aware that they need to run commands
|
||||
differently.
|
||||
|
||||
For example, most users need to use `sudo` with the `edit-config` script, because the Netdata config directory is owned
|
||||
by the `netdata` user. Same goes for restarting the Netdata Agent with `systemctl`.
|
||||
|
||||
| | |
|
||||
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Not recommended | Run `edit-config netdata.conf` to configure the Netdata Agent. <br />Run `systemctl restart netdata` to restart the Netdata Agent. |
|
||||
| **Recommended** | Run `sudo edit-config netdata.conf` to configure the Netdata Agent. <br />Run `sudo systemctl restart netdata` to restart the Netdata Agent. |
|
||||
|
||||
## Markdown syntax
|
||||
|
||||
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.
|
||||
|
||||
The following sections describe situations in which a specific syntax is required.
|
||||
|
||||
### Syntax standards (`remark-lint`)
|
||||
|
||||
The Netdata team uses [`remark-lint`](https://github.com/remarkjs/remark-lint) for Markdown code styling.
|
||||
|
||||
- Use a maximum of 120 characters per line.
|
||||
- Begin headings with hashes, such as `# H1 heading`, `## H2 heading`, and so on.
|
||||
- Use `_` for italics/emphasis.
|
||||
- Use `**` for bold.
|
||||
- Use dashes `-` to begin an unordered list, and put a single space after the dash.
|
||||
- Tables should be padded so that pipes line up vertically with added whitespace.
|
||||
|
||||
If you want to see all the settings, open the
|
||||
[`remarkrc.js`](https://github.com/netdata/netdata/blob/master/.remarkrc.js) file in the `netdata/netdata` repository.
|
||||
|
||||
### MDX and markdown
|
||||
|
||||
While writing in Docusaurus, you might want to take leverage of it's features that are supported in MDX formatted files.
|
||||
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.
|
||||
|
||||
In detail:
|
||||
|
||||
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).
|
||||
|
||||
You can use markdown syntax for every other styling you want to do except Admonitions:
|
||||
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.
|
||||
|
||||
### Frontmatter
|
||||
|
||||
Every document must begin with frontmatter, followed by an H1 (`#`) heading.
|
||||
|
||||
Unlike typical Markdown frontmatter, Netdata uses HTML comments (`<!--`, `-->`) to begin and end the frontmatter block.
|
||||
These HTML comments are later converted into typical frontmatter syntax when building [Netdata
|
||||
Learn](https://learn.netdata.cloud).
|
||||
|
||||
Frontmatter *must* contain the following variables:
|
||||
|
||||
- A `title` that quickly and distinctly describes the document's content.
|
||||
- A `description` that elaborates on the purpose or goal of the document using no less than 100 characters and no more
|
||||
than 155 characters.
|
||||
- A `custom_edit_url` that links directly to the GitHub URL where another user could suggest additional changes to the
|
||||
published document.
|
||||
|
||||
Some documents, like the Ansible guide and others in the `/docs/guides` folder, require an `image` variable as well. In
|
||||
this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of the path to the document in question. End
|
||||
the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
|
||||
|
||||
For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
|
||||
Ansible](/guides/deploy/ansible).
|
||||
|
||||
```markdown
|
||||
<!--
|
||||
title: Deploy Netdata with Ansible
|
||||
description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
|
||||
image: /img/seo/guides/deploy/ansible.png
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
|
||||
-->
|
||||
|
||||
# Deploy Netdata with Ansible
|
||||
|
||||
...
|
||||
```
|
||||
|
||||
Questions about frontmatter in documentation? [Ask on our community
|
||||
forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
|
||||
|
||||
### Admonitions
|
||||
|
||||
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).
|
||||
|
||||
We encourage the use of **Note** admonitions to provide important supplemental information to a user within a task step, reference item, or concept passage.
|
||||
|
||||
Additionally, you should use a **Caution** admonition to provide necessary information to present any risk to a user's setup or data.
|
||||
|
||||
**Danger** admonitions should be avoided, as these admonitions are typically applied to reduce physical or bodily harm to an individual.
|
||||
|
||||
### Linking between documentation
|
||||
|
||||
Documentation should link to relevant pages whenever it's relevant and provides valuable context to the reader.
|
||||
|
||||
Links should always reference the full path to the document, beginning at the root of the Netdata Agent repository
|
||||
(`/`), and ending with the `.md` file extension. Avoid relative links or traversing up directories using `../`.
|
||||
|
||||
For example, if you want to link to our node configuration document, link to `/docs/configure/nodes.md`. To reference
|
||||
the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`.
|
||||
|
||||
### References to UI elements
|
||||
|
||||
When referencing a user interface (UI) element in Netdata, reference the label text of the link/button with Markdown's
|
||||
(`**bold text**`) tag.
|
||||
|
||||
```markdown
|
||||
Click the **Sign in** button.
|
||||
```
|
||||
|
||||
Avoid directional language whenever possible. Not every user can use instructions like "look at the top-left corner" to
|
||||
find their way around an interface, and interfaces often change between devices. If you must use directional language,
|
||||
try to supplement the text with an [image](#images).
|
||||
|
||||
### Images
|
||||
|
||||
Don't rely on images to convey features, ideas, or instructions. Accompany every image with descriptive alt text.
|
||||
|
||||
In Markdown, use the standard image syntax, ``, and place the alt text between the brackets `[]`. Here's an example
|
||||
using our logo:
|
||||
|
||||
```markdown
|
||||
|
||||
```
|
||||
|
||||
Reference in-product text, code samples, and terminal output with actual text content, not screen captures or other
|
||||
images. Place the text in an appropriate element, such as a blockquote or code block, so all users can parse the
|
||||
information.
|
||||
|
||||
### Syntax highlighting
|
||||
|
||||
Our documentation site at [learn.netdata.cloud](https://learn.netdata.cloud) uses
|
||||
[Prism](https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting) for syntax highlighting. Netdata
|
||||
documentation will use the following for the most part: `c`, `python`, `js`, `shell`, `markdown`, `bash`, `css`, `html`,
|
||||
and `go`. If no language is specified, Prism tries to guess the language based on its content.
|
||||
|
||||
Include the language directly after the three backticks (```` ``` ````) that start the code block. For highlighting C
|
||||
code, for example:
|
||||
|
||||
````c
|
||||
```c
|
||||
inline char *health_stock_config_dir(void) {
|
||||
char buffer[FILENAME_MAX + 1];
|
||||
snprintfz(buffer, FILENAME_MAX, "%s/health.d", netdata_configured_stock_config_dir);
|
||||
return config_get(CONFIG_SECTION_DIRECTORIES, "stock health config", buffer);
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
And the prettified result:
|
||||
|
||||
```c
|
||||
inline char *health_stock_config_dir(void) {
|
||||
char buffer[FILENAME_MAX + 1];
|
||||
snprintfz(buffer, FILENAME_MAX, "%s/health.d", netdata_configured_stock_config_dir);
|
||||
return config_get(CONFIG_SECTION_DIRECTORIES, "stock health config", buffer);
|
||||
}
|
||||
```
|
||||
|
||||
Prism also supports titles and line highlighting. See the [Docusaurus
|
||||
documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
|
||||
|
||||
## Word list
|
||||
|
||||
The following tables describe the standard spelling, capitalization, and usage of words found in Netdata's writing.
|
||||
|
||||
### Netdata-specific terms
|
||||
|
||||
| Term | Definition |
|
||||
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **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. |
|
||||
| **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*. |
|
||||
| **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. |
|
||||
| **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. | |
|
||||
| **Netdata community** | Contributors to any of Netdata's [open-source projects](/contribute/projects), members of the [community forum](https://community.netdata.cloud/). |
|
||||
| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
|
||||
| **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. |
|
||||
| **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. |
|
||||
| **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. |
|
||||
| **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. |
|
||||
| **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. |
|
||||
|
||||
### Other technical terms
|
||||
|
||||
| Term | Definition |
|
||||
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **filesystem** | Use instead of *file system*. |
|
||||
| **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). |
|
||||
| **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. |
|
||||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "Netdata daemon"
|
||||
date: 2020-04-29
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/README.md
|
||||
date: "2020-04-29"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/daemon/README.md"
|
||||
sidebar_label: "Netdata daemon"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Configuration"
|
||||
-->
|
||||
|
||||
# Netdata daemon
|
||||
|
|
|
|||
|
|
@ -1,7 +1,12 @@
|
|||
<!--
|
||||
title: "Daemon configuration"
|
||||
description: "The Netdata Agent's daemon is installed preconfigured to collect thousands of metrics every second, but is highly configurable for real-world workloads."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/config/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/daemon/config/README.md"
|
||||
sidebar_label: "Daemon"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "References"
|
||||
learn_rel_path: "References/Configuration"
|
||||
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"
|
||||
-->
|
||||
|
||||
# Daemon configuration
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "Database"
|
||||
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."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/database/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/database/README.md"
|
||||
sidebar_label: "Database"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup"
|
||||
-->
|
||||
|
||||
# Database
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!--
|
||||
title: "Database engine"
|
||||
description: "Netdata's highly-efficient database engine use both RAM and disk for distributed, long-term storage of per-second metrics."
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/database/engine/README.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/database/engine/README.md"
|
||||
sidebar_label: "Database engine"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Concepts"
|
||||
learn_rel_path: "Concepts"
|
||||
-->
|
||||
|
||||
# DBENGINE
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Netdata via apache's mod_proxy"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md"
|
||||
sidebar_label: "Netdata via apache's mod_proxy"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup/Expose local dashboard through proxy"
|
||||
-->
|
||||
|
||||
# Netdata via apache's mod_proxy
|
||||
|
|
@ -35,7 +39,6 @@ Also, enable the rewrite module:
|
|||
sudo a2enmod rewrite
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Netdata on an existing virtual host
|
||||
|
||||
|
|
@ -314,7 +317,7 @@ or
|
|||
bind to = ::1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
You can also use a unix domain socket. This will also provide a faster route between apache and Netdata:
|
||||
|
||||
|
|
@ -338,7 +341,7 @@ At the apache side, prepend the 2nd argument to `ProxyPass` with `unix:/tmp/netd
|
|||
ProxyPass "/netdata/" "unix:/tmp/netdata.sock|http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
If your apache server is not on localhost, you can set:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Netdata via Caddy"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-caddy.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-caddy.md"
|
||||
sidebar_label: "Netdata via Caddy"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup/Expose local dashboard through proxy"
|
||||
-->
|
||||
|
||||
# Netdata via Caddy
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Running Netdata behind H2O"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-h2o.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-h2o.md"
|
||||
sidebar_label: "Running Netdata behind H2O"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup/Expose local dashboard through proxy"
|
||||
-->
|
||||
|
||||
# Running Netdata behind H2O
|
||||
|
|
@ -142,7 +146,7 @@ If your H2O server is on `localhost`, you can use this to ensure external access
|
|||
bind to = 127.0.0.1 ::1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
You can also use a unix domain socket. This will provide faster communication between H2O and Netdata as well:
|
||||
|
||||
|
|
@ -157,7 +161,7 @@ In the H2O configuration, use a line like the following to connect to Netdata vi
|
|||
proxy.reverse.url http://[unix:/run/netdata/netdata.sock]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
If your H2O server is not on localhost, you can set:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Netdata via HAProxy"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-haproxy.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-haproxy.md"
|
||||
sidebar_label: "Netdata via HAProxy"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup/Expose local dashboard through proxy"
|
||||
-->
|
||||
|
||||
# Netdata via HAProxy
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Netdata via lighttpd v1.4.x"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-lighttpd.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-lighttpd.md"
|
||||
sidebar_label: "Netdata via lighttpd v1.4.x"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup/Expose local dashboard through proxy"
|
||||
-->
|
||||
|
||||
# Netdata via lighttpd v1.4.x
|
||||
|
|
@ -27,7 +31,7 @@ $SERVER["socket"] == ":19998" {
|
|||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
If the only thing the server is exposing via the web is Netdata (and thus no suburl rewriting required),
|
||||
then you can get away with just
|
||||
|
|
@ -51,7 +55,7 @@ auth.require = ( "" => ( "method" => "digest",
|
|||
|
||||
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).
|
||||
|
||||
---
|
||||
|
||||
|
||||
It seems that lighttpd (or some versions of it), fail to proxy compressed web responses.
|
||||
To solve this issue, disable web response compression in Netdata.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
<!--
|
||||
title: "Running Netdata behind Nginx"
|
||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-nginx.md
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/Running-behind-nginx.md"
|
||||
sidebar_label: "Running Netdata behind Nginx"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Setup/Expose local dashboard through proxy"
|
||||
-->
|
||||
|
||||
# Running Netdata behind Nginx
|
||||
|
|
@ -212,7 +216,7 @@ If your Nginx is on `localhost`, you can use this to protect your Netdata:
|
|||
bind to = 127.0.0.1 ::1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
You can also use a unix domain socket. This will also provide a faster route between Nginx and Netdata:
|
||||
|
||||
|
|
@ -232,7 +236,6 @@ upstream backend {
|
|||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
If your Nginx server is not on localhost, you can set:
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,112 @@
|
|||
---
|
||||
title: "Alert notifications"
|
||||
description: "Configure Netdata Cloud to send notifications to your team whenever any node on your infrastructure triggers a pre-configured or custom alert threshold."
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx"
|
||||
sidebar_label: "Alert notifications"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Operations"
|
||||
---
|
||||
|
||||
import Callout from '@site/src/components/Callout'
|
||||
|
||||
Netdata Cloud can send centralized alert notifications to your team whenever a node enters a warning, critical, or
|
||||
unreachable state. By enabling notifications, you ensure no alert, on any node in your infrastructure, goes unnoticed by
|
||||
you or your team.
|
||||
|
||||
If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending
|
||||
you a flood protection notification. Getting one of these notifications is a good signal of health or performance issues
|
||||
on that node.
|
||||
|
||||
Netdata Cloud currently supports email notifications. We're working on additional endpoints and functionality.
|
||||
|
||||
Admins must enable alert notifications for their [Space(s)](#manage-alert-notifications-for-a-space). All users in a
|
||||
Space can then personalize their notifications settings from within their [account
|
||||
menu](#manage-alert-notifications-per-user).
|
||||
|
||||
<Callout type="notice">
|
||||
|
||||
Centralized alert notifications from Netdata Cloud is a independent process from [notifications from
|
||||
Netdata](/docs/monitor/enable-notifications). You can enable one or the other, or both, based on your needs. However,
|
||||
the alerts you see in Netdata Cloud are based on those streamed from your Netdata-monitoring nodes. If you want to tweak
|
||||
or add new alert that you see in Netdata Cloud, and receive via centralized alert notifications, you must
|
||||
[configure](/docs/monitor/configure-alarms) each node's alert watchdog.
|
||||
|
||||
</Callout>
|
||||
|
||||
## Manage alert notifications for a Space
|
||||
|
||||
To enable notifications for a Space, click **Manage Space** in the [Space](/docs/cloud/spaces) management area.
|
||||
|
||||
|
||||
|
||||
In the modal, click on the **Notifications** tab. This menu option is visible only to administrators.
|
||||
|
||||
|
||||
|
||||
Click on the toggle to enable or disable a notification method.
|
||||
|
||||
## Manage alert notifications per user
|
||||
|
||||
You, and other individual users in your Space, can also enable and disable notification methods.
|
||||
|
||||
Click on your profile icon at the top-right of the Cloud UI to open your account menu, then **Profile** in the dropdown.
|
||||
Click on the **Notifications** tab in the panel that appears.
|
||||
|
||||
|
||||
|
||||
Enable or disable notification methods with the toggle buttons.
|
||||
|
||||
Select which the notifications you want to receive from each War Room:
|
||||
|
||||
- **All alerts and unreachable**: Receive notifications for all changes in alert status: critical, warning, and
|
||||
cleared. In addition, receive notifications for any node that enters an unreachable state.
|
||||
- **All alerts**: Receive notifications for all changes in alert status: critical, warning, and cleared.
|
||||
- **Critical only**: Receive notifications only for critical alerts.
|
||||
- **No notifications**: Receive no notifications for nodes in this War Room.
|
||||
|
||||
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.
|
||||
|
||||
## Flood protection
|
||||
|
||||
If a node has too many state changes like firing too many alerts or going from reachable to unreachable, Netdata Cloud
|
||||
enables flood protection. As long as a node is in flood protection mode, Netdata Cloud does not send notifications about
|
||||
this node. Even with flood protection active, it is possible to access the node directly, either via Netdata Cloud or
|
||||
the local Agent dashboard at `http://NODE:19999`.
|
||||
|
||||
## Anatomy of an alert notification
|
||||
|
||||
Email alarm notifications show the following information:
|
||||
|
||||
- The Space's name
|
||||
- The node's name
|
||||
- Alarm status: critical, warning, cleared
|
||||
- Previous alarm status
|
||||
- Time at which the alarm triggered
|
||||
- Chart context that triggered the alarm
|
||||
- Name and information about the triggered alarm
|
||||
- Alarm value
|
||||
- Total number of warning and critical alerts on that node
|
||||
- Threshold for triggering the given alarm state
|
||||
- Calculation or database lookups that Netdata uses to compute the value
|
||||
- Source of the alarm, including which file you can edit to configure this alarm on an individual node
|
||||
|
||||
Email notifications also feature a **Go to Node** button, which takes you directly to the offending chart for that node
|
||||
within Cloud's embedded dashboards.
|
||||
|
||||
Here's an example email notification for the `ram_available` chart, which is in a critical state:
|
||||
|
||||
|
||||
|
||||
## What's next?
|
||||
|
||||
Netdata Cloud's alarm notifications feature leverages the alarms configuration on each node in your infrastructure. If
|
||||
you'd like to tweak any of these alarms, or even add new ones based on your needs, read our [health
|
||||
quickstart](/docs/monitor/configure-alarms).
|
||||
|
||||
You can also [view active alarms](/docs/cloud/alerts-notifications/view-active-alerts) in Netdata Cloud for an instant
|
||||
visualization of the health of your infrastructure.
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: "Alerts smartboard"
|
||||
description: ""
|
||||
type: "reference"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.mdx"
|
||||
sidebar_label: "Alerts smartboard"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Operations"
|
||||
---
|
||||
|
||||
The Alerts view gives you a high level of availability and performance information for every node you're
|
||||
monitoring with Netdata Cloud. We expect it to become the "home base" for many Netdata Cloud users who want to instantly
|
||||
understand what's going on with their infrastructure and exactly where issues might be.
|
||||
|
||||
The Alerts view is available entirely for free to all users and for any number of nodes.
|
||||
|
||||
## Alerts table and filtering
|
||||
|
||||
The Alerts view shows all active alerts in your War Room, including the alert's name, the most recent value, a
|
||||
timestamp of when it became active, and the relevant node.
|
||||
|
||||
You can use the checkboxes in the filter pane on the right side of the screen to filter the alerts displayed in the table
|
||||
by Status, Class, Type & Componenet, Role, Operating System, or Node.
|
||||
|
||||
Click on any of the alert names to see the alert.
|
||||
|
||||
## View active alerts
|
||||
|
||||
In the `Active` subtab, you can see exactly how many **critical** and **warning** alerts are active across your nodes.
|
||||
|
||||
## View configured alerts
|
||||
|
||||
You can view all the configured alerts on all the agents that belong to a War Room in the `Alert Configurations` subtab.
|
||||
From within the Alerts view, you can click the `Alert Configurations` subtab to see a high level view of the states of
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
title: "View active alerts"
|
||||
description: "Track the health of your infrastructure in one place by taking advantage of the powerful health monitoring watchdog running on every node."
|
||||
type: "how-to"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx"
|
||||
sidebar_label: "View active alerts"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Operations"
|
||||
---
|
||||
|
||||
Netdata Cloud receives information about active alerts on individual nodes in your infrastructure and updates the
|
||||
interface based on those status changes.
|
||||
|
||||
Netdata Cloud doesn't produce alerts itself but rather receives and aggregates alerts from each node in your
|
||||
infrastructure based on their configuration. Every node comes with hundreds of pre-configured alerts that have been
|
||||
tested by Netdata's community of DevOps engineers and SREs, but you may want to customize existing alerts or create new
|
||||
ones entirely.
|
||||
|
||||
Read our doc on [health alerts](/docs/monitor/configure-alarms) to learn how to tweak existing alerts or create new
|
||||
health entities based on the specific needs of your infrastructure. By taking charge of alert configuration, you'll
|
||||
ensure Netdata Cloud always delivers the most relevant alerts about the well-being of your nodes.
|
||||
|
||||
## View all active alerts
|
||||
|
||||
The [Alerts Smartboard](/docs/cloud/alerts-notifications/smartboard) provides a high-level interface for viewing the
|
||||
number of critical or warning alerts and where they are in your infrastructure.
|
||||
|
||||
|
||||
|
||||
Click on the **Alerts** tab in any War Room to open the Smartboard. Alternatively, click on any of the alert badges in
|
||||
the [Nodes view](/docs/cloud/visualize/nodes) to jump to the Alerts Smartboard.
|
||||
|
||||
From here, filter active alerts using the **critical** or **warning** boxes, or hover over a box in the [nodes
|
||||
map](/docs/cloud/alerts-notifications/smartboard#nodes-map) to see a popup node-specific alert information.
|
||||
|
||||
## View alerts in context with charts
|
||||
|
||||
If you click on any of the alerts, either in a nodes map popup or the alerts table, Netdata Cloud navigates you to the
|
||||
single-node dashboard and scrolls to the relevant chart. Netdata Cloud also draws a highlight and the value at the
|
||||
moment your node triggered this alert.
|
||||
|
||||
|
||||
|
||||
You can then [select this area](/docs/dashboard/interact-charts#select) with `Alt/⌘ + mouse selection` to highlight the
|
||||
alerted timeframe while you explore other charts for root cause analysis.
|
||||
|
||||
Or, select the area and run [Metric Correlations](/docs/cloud/insights/metric-correlations) to filter the single-node
|
||||
dashboard to only those charts most likely to be connected to the alert.
|
||||
|
||||
## What's next?
|
||||
|
||||
Learn more about the features of the Smartboard in its [reference](/docs/cloud/alerts-notifications/smartboard) doc. To
|
||||
stay notified of active alerts, enable [centralized alert notifications](/docs/cloud/alerts-notifications/notifications)
|
||||
from Netdata Cloud.
|
||||
|
||||
If you're through with setting up alerts, it might be time to [invite your
|
||||
team](/docs/cloud/manage/invite-your-team).
|
||||
|
||||
Check out our recommendations on organizing and using [Spaces](/docs/cloud/spaces) and [War
|
||||
Rooms](/docs/cloud/war-rooms) to streamline your processes once you find an alert in Netdata Cloud.
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: "Test the New Cloud Architecture"
|
||||
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."
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/beta-architecture/new-architecture.md"
|
||||
---
|
||||
|
||||
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
|
||||
to be among the first users to try these changes to our Cloud architecture and provide feedback.
|
||||
|
||||
The backend architecture changes should offer notable improvements in reliability and stability in Netdata Cloud,
|
||||
but more importantly, it allows us to develop new features and enhanced functionality, including features and enhancements
|
||||
that you have specifically requested. Features that will be developed on the new architecture include:
|
||||
|
||||
- Parent/Child Cloud relationships
|
||||
- Alert logs
|
||||
- Alert management
|
||||
- Much more
|
||||
|
||||
## Enabling the new architecture
|
||||
|
||||
To enable the new architecture, first ensure that you have installed the latest Netdata version following
|
||||
[our guide](https://learn.netdata.cloud/docs/get-started/). Then, you or your administrator will need to retrieve the Space IDs
|
||||
within Netdata Cloud by clicking `Manage Space` in the left pane, selecting the `Space` tab, and copying the value in the `Space Id` field.
|
||||
You can then send an email to [beta@Netdata.cloud](mailto:beta@netdata.cloud) requesting to be included in our beta testers, and include
|
||||
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
|
||||
invitation, you can also just reply to the invitation with your Space IDs in the body of the reply.
|
||||
|
||||
Feel free to send the Space IDs for multiple spaces to test the new infrastructure on each of them.
|
||||
|
||||
## Reporting issues
|
||||
|
||||
After you are set up with the new architecture changes, we ask that you report any issues you encounter in our
|
||||
[designated Discord channel](https://discord.gg/dGzdemHwHh). This feedback
|
||||
will help us ensure the highest performance of the new architecture and expedite the development and release
|
||||
of the aforementioned enhancements and features.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue