Docs, shorten too long titles, and add a description below (#14820)
shorten too long titles, and add a description below
Fotis Voutsas committed
Mar 29, 2023 at 19:20 UTC
6016c3b5cf5e8945e122de97d379bd8c28a40f37
8 files changed
+32
-101
collectors/ioping.plugin/README.md
+3
-13
@@ -1,16 +1,6 @@
1
-<!--
2
-title: "Monitor latency for directories/files/devices (ioping.plugin)"
3
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md"
4
-sidebar_label: "Latency monitoring (ioping.plugin)"
5
-learn_status: "Published"
6
-learn_topic_type: "References"
7
-learn_rel_path: "Integrations/Monitor/QoS"
8
--->
9
-
10
-# Monitor latency for directories/files/devices (ioping.plugin)
11
-
12
-The ioping plugin supports monitoring latency for any number of directories/files/devices,
13
-by pinging them with `ioping`.
1
+# Monitor I/O latency using ioping.plugin
2
+
3
+The ioping plugin supports monitoring I/O latency for any number of directories/files/devices, by pinging them with `ioping`.
4
5
A recent version of `ioping` is required (one that supports option `-N`).
6
The supplied plugin can install it, by running:
collectors/python.d.plugin/zscores/README.md
+3
-13
@@ -1,16 +1,6 @@
1
-<!--
2
-title: "zscores"
3
-description: "Use statistical anomaly detection to narrow your focus and shorten root cause analysis."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/zscores/README.md"
5
-sidebar_label: "zscores"
6
-learn_status: "Published"
7
-learn_topic_type: "References"
8
-learn_rel_path: "Integrations/Monitor/Netdata"
9
--->
10
-
11
-# Z-Scores - basic anomaly detection for your key metrics and charts
12
-
13
-Smoothed, rolling [Z-Scores](https://en.wikipedia.org/wiki/Standard_score) for selected metrics or charts.
1
+# Basic anomaly detection using Z-scores
2
+
3
+By using smoothed, rolling [Z-Scores](https://en.wikipedia.org/wiki/Standard_score) for selected metrics or charts you can narrow down your focus and shorten root cause analysis.
4
5
This collector uses the [Netdata rest api](https://github.com/netdata/netdata/blob/master/web/api/README.md) to get the `mean` and `stddev`
6
for each dimension on specified charts over a time range (defined by `train_secs` and `offset_secs`). For each dimension
docs/guides/collect-apache-nginx-web-logs.md
+5
-17
@@ -1,20 +1,8 @@
1
-<!--
2
-title: "Monitor Nginx or Apache web server log files with Netdata"
3
-sidebar_label: "Monitor Nginx or Apache web server log files with Netdata"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-apache-nginx-web-logs.md
5
-learn_status: "Published"
6
-learn_topic_type: "Tasks"
7
-learn_rel_path: "Miscellaneous"
8
--->
9
-
10
-# Monitor Nginx or Apache web server log files with Netdata
11
-
12
-Log files have been a critical resource for developers and system administrators who want to understand the health and
13
-performance of their web servers, and Netdata is taking important steps to make them even more valuable.
14
-
15
-By parsing web server log files with Netdata, and seeing the volume of redirects, requests, or server errors over time,
16
-you can better understand what's happening on your infrastructure. Too many bad requests? Maybe a recent deploy missed a
17
-few small SVG icons. Too many requests? Time to batten down the hatches—it's a DDoS.
1
+# Monitor Nginx or Apache web server log files
2
+
3
+Parsing web server log files with Netdata, revealing the volume of redirects, requests and other metrics, can give you a better overview of your infrastructure.
4
+
5
+Too many bad requests? Maybe a recent deploy missed a few small SVG icons. Too many requests? Time to batten down the hatches—it's a DDoS.
6
7
You can use the [LTSV log format](http://ltsv.org/), track TLS and cipher usage, and the whole parser is faster than
8
ever. In one test on a system with SSD storage, the collector consistently parsed the logs for 200,000 requests in
docs/guides/monitor/kubernetes-k8s-netdata.md
+3
-11
@@ -1,14 +1,6 @@
1
-<!--
2
-title: "Kubernetes monitoring with Netdata: Overview and visualizations"
3
-sidebar_label: "Kubernetes monitoring with Netdata: Overview and visualizations"
4
-description: "Learn how to navigate Netdata's Kubernetes monitoring features for visualizing the health and performance of a Kubernetes cluster with per-second granularity."
5
-image: /img/seo/guides/monitor/kubernetes-k8s-netdata.png
6
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/kubernetes-k8s-netdata.md
7
-learn_status: "Published"
8
-learn_rel_path: "Miscellaneous"
9
--->
10
-
11
-# Kubernetes monitoring with Netdata: Overview and visualizations
1
+# Kubernetes monitoring with Netdata
2
+
3
+This document gives an overview of what visualizations Netdata provides on Kubernetes deployments.
4
5
At Netdata, we've built Kubernetes monitoring tools that add visibility without complexity while also helping you
6
actively troubleshoot anomalies or outages. This guide walks you through each of the visualizations and offers best
docs/guides/monitor/lamp-stack.md
+3
-10
@@ -1,15 +1,8 @@
1
-<!--
2
-title: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata"
3
-sidebar_label: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata"
4
-description: "Set up robust LAMP stack monitoring (Linux, Apache, MySQL, PHP) in just a few minutes using a free, open-source monitoring tool that collects metrics every second."
5
-image: /img/seo/guides/monitor/lamp-stack.png
6
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/lamp-stack.md
7
-learn_status: "Published"
8
-learn_rel_path: "Miscellaneous"
9
--->
1
import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
2
12
-# LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata
3
+# LAMP stack monitoring with Netdata
4
+
5
+Set up robust LAMP stack monitoring (Linux, Apache, MySQL, PHP) in a few minutes using Netdata.
6
7
The LAMP stack is the "hello world" for deploying dynamic web applications. It's fast, flexible, and reliable, which
8
means a developer or sysadmin won't go far in their career without interacting with the stack and its services.
docs/guides/monitor/raspberry-pi-anomaly-detection.md
+3
-11
@@ -1,14 +1,6 @@
1
-<!--
2
-title: "Unsupervised anomaly detection for Raspberry Pi monitoring"
3
-sidebar_label: "Unsupervised anomaly detection for Raspberry Pi monitoring"
4
-description: "Use a low-overhead machine learning algorithm and an open-source monitoring tool to detect anomalous metrics on a Raspberry Pi."
5
-image: /img/seo/guides/monitor/raspberry-pi-anomaly-detection.png
6
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/raspberry-pi-anomaly-detection.md
7
-learn_status: "Published"
8
-learn_rel_path: "Miscellaneous"
9
--->
10
-
11
-# Unsupervised anomaly detection for Raspberry Pi monitoring
1
+# Anomaly detection for RPi monitoring
2
+
3
+Learn how to use a low-overhead machine learning algorithm alongside Netdata to detect anomalous metrics on a Raspberry Pi.
4
5
We love IoT and edge at Netdata, we also love machine learning. Even better if we can combine the two to ease the pain
6
of monitoring increasingly complex systems.
docs/guides/using-host-labels.md
+9
-15
@@ -1,18 +1,12 @@
1
-<!--
2
-title: "Use host labels to organize systems, metrics, and alarms"
3
-sidebar_label: "Use host labels to organize systems, metrics, and alarms"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/using-host-labels.md
5
-learn_status: "Published"
6
-learn_rel_path: "Operations"
7
--->
8
-
9
-# Use host labels to organize systems, metrics, and alarms
10
-
11
-When you use Netdata to monitor and troubleshoot an entire infrastructure, whether that's dozens or hundreds of systems,
12
-you need sophisticated ways of keeping everything organized. You need alarms that adapt to the system's purpose, or
13
-whether the parent or child in a streaming setup. You need properly-labeled metrics archiving so you can sort,
14
-correlate, and mash-up your data to your heart's content. You need to keep tabs on ephemeral Docker containers in a
15
-Kubernetes cluster.
1
+# Using host labels to organize your metrics
2
+
3
+When you use Netdata to monitor and troubleshoot an entire infrastructure, you need sophisticated ways of keeping everything organized.
4
+
5
+Some of the scenarios that host labels can be extremely useful are:
6
+
7
+- You need alarms that adapt to the system's purpose
8
+- You need properly-labeled metrics archiving so you can sort, correlate, and mash-up your data to your heart's content.
9
+- You need to keep tabs on ephemeral Docker containers in a Kubernetes cluster.
10
11
You need **host labels**: a powerful new way of organizing your Netdata-monitored systems. We introduced host labels in
12
[v1.20 of Netdata](https://blog.netdata.cloud/posts/release-1.20/), and they come pre-configured out of the box.
packaging/building-native-packages-locally.md
+3
-11
@@ -1,14 +1,6 @@
1
-<!--
2
-title: "How to build native (DEB/RPM) packages locally for testing"
3
-sidebar_label: "How to build native (DEB/RPM) packages locally for testing"
4
-description: Instructions for developers who need to build native packages locally for testing.
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/building-native-packages-locally.md
6
-learn_status: "Published"
7
-learn_topic_type: "References"
8
-learn_rel_path: "Installation/Package maintainers"
9
--->
10
-
11
-# How to build native (DEB/RPM) packages locally for testing
1
+# Build native (DEB/RPM) packages for testing
2
+
3
+This document provides instructions for developers who need to build native packages locally for testing.
4
5
## Requirements
6