e9af61808 · cryptotaxi247/netdata-1

aclk/README.md

+1 -1

@@ -9,7 +9,7 @@ learn_topic_type: "Tasks"

9 learn_rel_path: "Configuration"

10 -->

11

12 -# Agent-cloud link (ACLK)

12 +# Agent-Cloud link (ACLK)

13

14 The Agent-Cloud link (ACLK) is the mechanism responsible for securely connecting a Netdata Agent to your web browser

15 through Netdata Cloud. The ACLK establishes an outgoing secure WebSocket (WSS) connection to Netdata Cloud on port

cli/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_status: "Published"

7 learn_rel_path: "Operations"

8 -->

9

10 -# Netdata CLI

10 +# Netdata Agent CLI

11

12 The `netdatacli` executable provides a simple way to control the Netdata agent's operation.

13

collectors/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_status: "Published"

7 learn_rel_path: "Concepts"

8 -->

9

10 -# Collecting metrics

10 +# Collectors

11

12 When Netdata starts, and with zero configuration, it auto-detects thousands of data sources and immediately collects

13 per-second metrics.

collectors/apps.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/System metrics"

8 -->

9

10 -# apps.plugin

10 +# Application monitoring (apps.plugin)

11

12 `apps.plugin` breaks down system resource usage to **processes**, **users** and **user groups**.

13

collectors/cgroups.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/Virtualized environments/Containers"

8 -->

9

10 -# cgroups.plugin

10 +# Monitor Cgroups (cgroups.plugin)

11

12 You can monitor containers and virtual machines using **cgroups**.

13

collectors/cups.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/Remotes/Devices"

8 -->

9

10 -# cups.plugin

10 +# Printers (cups.plugin)

11

12 `cups.plugin` collects Common Unix Printing System (CUPS) metrics.

13

collectors/diskspace.plugin/README.md

+1 -1

@@ -8,7 +8,7 @@ learn_topic_type: "References"

8 learn_rel_path: "Integrations/Monitor/System metrics"

9 -->

10

11 -# diskspace.plugin

11 +# Monitor disk (diskspace.plugin)

12

13 This plugin monitors the disk space usage of mounted disks, under Linux. The plugin requires Netdata to have execute/search permissions on the mount point itself, as well as each component of the absolute path to the mount point.

14

collectors/ebpf.plugin/README.md

+1 -1

@@ -8,7 +8,7 @@ learn_topic_type: "References"

8 learn_rel_path: "Integrations/Monitor/System metrics"

9 -->

10

11 -# eBPF monitoring with Netdata

11 +# Kernel traces/metrics (eBPF) monitoring with Netdata

12

13 The Netdata Agent provides many [eBPF](https://ebpf.io/what-is-ebpf/) programs to help you troubleshoot and debug how applications interact with the Linux kernel. The `ebpf.plugin` uses [tracepoints, trampoline, and2 kprobes](#how-netdata-collects-data-using-probes-and-tracepoints) to collect a wide array of high value data about the host that would otherwise be impossible to capture.

14

collectors/freebsd.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/System metrics"

8 -->

9

10 -# freebsd.plugin

10 +# FreeBSD system metrics (freebsd.plugin)

11

12 Collects resource usage and performance data on FreeBSD systems

13

collectors/ioping.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/QoS"

8 -->

9

10 -# ioping.plugin

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

collectors/nfacct.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/Networking"

8 -->

9

10 -# nfacct.plugin

10 +# Monitor Netfilter statistics (nfacct.plugin)

11

12 `nfacct.plugin` collects Netfilter statistics.

13

collectors/perf.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/System metrics"

8 -->

9

10 -# perf.plugin

10 +# Monitor CPU performance statistics (perf.plugin)

11

12 `perf.plugin` collects system-wide CPU performance statistics from Performance Monitoring Units (PMU) using

13 the `perf_event_open()` system call.

collectors/proc.plugin/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/System metrics"

8 -->

9

10 -# proc.plugin

10 +# OS provided metrics (proc.plugin)

11

12 - `/proc/net/dev` (all network interfaces for all their values)

13 - `/proc/diskstats` (all disks for all their values)

collectors/python.d.plugin/alarms/README.md

+1 -1

@@ -6,7 +6,7 @@ learn_status: "Published"

6 learn_rel_path: "Integrations/Monitor/Netdata"

7 -->

8

9 -# Alarms - graphing Netdata alarm states over time

9 +# Alarms

10

11 This collector creates an 'Alarms' menu with one line plot showing alarm states over time. Alarm states are mapped to integer values according to the below default mapping. Any alarm status types not in this mapping will be ignored (Note: This mapping can be changed by editing the `status_map` in the `alarms.conf` file). If you would like to learn more about the different alarm statuses check out the docs [here](https://learn.netdata.cloud/docs/agent/health/reference#alarm-statuses).

12

collectors/python.d.plugin/changefinder/README.md

+1 -1

@@ -8,7 +8,7 @@ learn_topic_type: "References"

8 learn_rel_path: "Integrations/Monitor/QoS"

9 -->

10

11 -# Online changepoint detection with Netdata

11 +# Online change point detection with Netdata

12

13 This collector uses the Python [changefinder](https://github.com/shunsukeaihara/changefinder) library to

14 perform [online](https://en.wikipedia.org/wiki/Online_machine_learning) [changepoint detection](https://en.wikipedia.org/wiki/Change_detection)

collectors/python.d.plugin/example/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Integrations/Monitor/Mock Collectors"

8 -->

9

10 -# Example

10 +# Example module in Python

11

12 You can add custom data collectors using Python.

13

collectors/statsd.plugin/README.md

+2 -1

@@ -7,6 +7,8 @@ learn_status: "Published"

7 learn_rel_path: "Integrations/Monitor/Anything"

8 -->

9

10 +# StatsD

11 +

12 [StatsD](https://github.com/statsd/statsd) is a system to collect data from any application. Applications send metrics to it,

13 usually via non-blocking UDP communication, and StatsD servers collect these metrics, perform a few simple calculations on

14 them and push them to backend time-series databases.

@@ -317,7 +319,6 @@ For example, if you want to monitor the application `myapp` using StatsD and Net

319 private charts = no

320 gaps when not collected = no

321 history = 60

320 -# memory mode = ram

322

323 [dictionary]

324 m1 = metric1

collectors/statsd.plugin/k6.md

+1 -1

@@ -6,7 +6,7 @@ learn_status: "Published"

6 learn_rel_path: "Integrations/Monitor/apps"

7 -->

8

9 -# K6 Load Testing monitoring with Netdata

9 +# K6 load test monitoring with Netdata

10

11 Monitors the impact of load testing experiments performed with [K6](https://k6.io/).

12

database/engine/README.md

+1 -1

@@ -8,7 +8,7 @@ learn_topic_type: "Concepts"

8 learn_rel_path: "Concepts"

9 -->

10

11 -# DBENGINE

11 +# Database engine

12

13 DBENGINE is the time-series database of Netdata.

14

database/ram/README.md

+1 -1

@@ -8,4 +8,4 @@ learn_topic_type: "References"

8 learn_rel_path: "Developers/Database"

9 -->

10

11 -# RAM modes

\ No newline at end of file

11 +# RAM database modes

docs/Demo-Sites.md

+1 -1

@@ -9,7 +9,7 @@ learn_rel_path: "Getting started"

9 sidebar_position: "90"

10 -->

11

12 -# Demo sites

12 +# Live demos

13

14 See the live Netdata Cloud demo with rooms for specific use cases at **https://app.netdata.cloud/spaces/netdata-demo**

15

docs/category-overview-pages/integrations-overview.md

+1 -1

@@ -8,7 +8,7 @@ learn_rel_path: "Integrations"

8 sidebar_position: 60

9 -->

10

11 -# Netdata Integrations

11 +# Integrations

12

13 Netdata's ability to monitor out of the box every potentially useful aspect of a node's operation is unparalleled.

14 But Netdata also provides out of the box, meaningful charts and alerts for hundreds of applications, with the ability

docs/cloud/insights/anomaly-advisor.md

+2

@@ -8,6 +8,8 @@ learn_topic_type: "Tasks"

8 learn_rel_path: "Operations"

9 -->

10

11 +# Anomaly Advisor

12 +

13 import ReactPlayer from 'react-player'

14

15 The Anomaly Advisor feature lets you quickly surface potentially anomalous metrics and charts related to a particular highlight window of

docs/cloud/insights/events-feed.md

+2

@@ -9,6 +9,8 @@ learn_rel_path: "Concepts"

9 learn_docs_purpose: "Present the Netdata Events feed."

10 -->

11

12 +# Events feed

13 +

14 Netdata Cloud provides the Events feed which is a powerful feature that tracks events that happen on your infrastructure, or in your Space. The feed lets you investigate events that occurred in the past, which is invaluable for troubleshooting. Common use cases are ones like when a node goes offline, and you want to understand what events happened before that. A detailed event history can also assist in attributing sudden pattern changes in a time series to specific changes in your environment.

15

16 ## What are the available events?

docs/cloud/insights/metric-correlations.md

+2

@@ -8,6 +8,8 @@ learn_topic_type: "Tasks"

8 learn_rel_path: "Operations"

9 -->

10

11 +# Metric Correlations

12 +

13 The Metric Correlations (MC) feature lets you quickly find metrics and charts related to a particular window of interest that you want to explore further. By displaying the standard Netdata dashboard, filtered to show only charts that are relevant to the window of interest, you can get to the root cause sooner.

14

15 Because Metric Correlations uses every available metric from your infrastructure, with as high as 1-second granularity, you get the most accurate insights using every possible metric.

docs/cloud/manage/plans.md

+2

@@ -9,6 +9,8 @@ learn_rel_path: "Concepts"

9 learn_docs_purpose: "Explain what are Netdata Plans"

10 -->

11

12 +# Netdata Plans

13 +

14 At Netdata, we believe in providing free and unrestricted access to high-quality monitoring solutions, and our commitment to this principle will not change. We offer our free SaaS offering - what we call **Community plan** - and Open Source Agent, which features unlimited nodes and users, unlimited metrics, and retention, providing real-time, high-fidelity, out-of-the-box infrastructure monitoring for packaged applications, containers, and operating systems.

15

16 We also provide paid subscriptions that designed to provide additional features and capabilities for businesses that need tighter and customizable integration of the free monitoring solution to their processes. These are divided into three different plans: **Pro**, **Business**, and **Enterprise**. Each plan will offers a different set of features and capabilities to meet the needs of businesses of different sizes and with different monitoring requirements.

docs/cloud/netdata-functions.md

+2

@@ -9,6 +9,8 @@ learn_rel_path: "Concepts"

9 learn_docs_purpose: "Present the Netdata Functions what these are and why they should be used."

10 -->

11

12 +# Netdata Functions

13 +

14 Netdata Agent collectors are able to expose functions that can be executed in run-time and on-demand. These will be

15 executed on the node - host where the function is made

16 available.

docs/cloud/runtime-troubleshooting-with-functions.md

+2

@@ -9,6 +9,8 @@ learn_rel_path: "Operations"

9 learn_docs_purpose: "Instructions on how to use Functions"

10 -->

11

12 +# Run-time troubleshooting with Functions

13 +

14 Netdata Functions feature allows you to execute on-demand a pre-defined routine on a node where a Netdata Agent is running. These routines are exposed by a given collector.

15 These routines can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself.

16

docs/cloud/visualize/dashboards.md

+2

@@ -10,6 +10,8 @@ learn_topic_type: "Tasks"

10 learn_rel_path: "Operations/Visualizations"

11 -->

12

13 +# Build new dashboards

14 +

15 With Netdata Cloud, you can build new dashboards that target your infrastructure's unique needs. Put key metrics from

16 any number of distributed systems in one place for a bird's eye view of your infrastructure.

17

docs/cloud/visualize/kubernetes.md

+2

@@ -8,6 +8,8 @@ learn_topic_type: "Concepts"

8 learn_rel_path: "Operations/Visualizations"

9 -->

10

11 +# Kubernetes visualizations

12 +

13 Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in

14 the default [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) dashboard.

15

docs/dashboard/import-export-print-snapshot.md

+1 -1

@@ -12,7 +12,7 @@ learn_topic_type: "Tasks"

12 learn_rel_path: "Operations"

13 -->

14

15 -# Import, export, and print snapshots

15 +# Import, export, and print a snapshot

16

17 Netdata can export snapshots of the contents of your dashboard at a given time, which you can then import into any other

18 node running Netdata. Or, you can create a print-ready version of your dashboard to save to PDF or actually print to

docs/guides/monitor/anomaly-detection.md

+1

@@ -8,6 +8,7 @@ learn_status: "Published"

8 learn_rel_path: "Operations"

9 -->

10

11 +# Machine learning (ML) powered anomaly detection

12

13

14 ## Overview

docs/guides/monitor/pi-hole-raspberry-pi.md

+2 -2

@@ -7,9 +7,9 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/moni

7 learn_status: "Published"

8 learn_rel_path: "Miscellaneous"

9 -->

10 -import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'

10

12 -# Monitor Pi-hole (and a Raspberry Pi) with Netdata

11 +# Monitor Pi-hole (and a Raspberry Pi) with Netdataimport { OneLineInstallWget } from '@site/src/components/OneLineInstall/'

12 +

13

14 Between intrusive ads, invasive trackers, and vicious malware, many techies and homelab enthusiasts are advancing their

15 networks' security and speed with a tiny computer and a powerful piece of software: [Pi-hole](https://pi-hole.net/).

docs/guides/monitor/raspberry-pi-anomaly-detection.md

+2 -1

@@ -8,6 +8,8 @@ learn_status: "Published"

8 learn_rel_path: "Miscellaneous"

9 -->

10

11 +# Unsupervised anomaly detection for Raspberry Pi monitoring

12 +

13 We love IoT and edge at Netdata, we also love machine learning. Even better if we can combine the two to ease the pain

14 of monitoring increasingly complex systems.

15

@@ -63,7 +65,6 @@ Now you're ready to enable the collector and [restart Netdata](https://github.co

65

66 ```bash

67 sudo ./edit-config python.d.conf

66 -# set `anomalies: no` to `anomalies: yes`

68

69 # restart netdata

70 sudo systemctl restart netdata

docs/monitor/enable-notifications.md

+1 -1

@@ -7,7 +7,7 @@ learn_status: "Published"

7 learn_rel_path: "Integrations/Notify"

8 -->

9

10 -# Enable alert notifications

10 +# Alert notifications

11

12 Netdata offers two ways to receive alert notifications on external platforms. These methods work independently _or_ in

13 parallel, which means you can enable both at the same time to send alert notifications to any number of endpoints.

exporting/prometheus/remote_write/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_status: "Published"

7 learn_rel_path: "Integrations/Export"

8 -->

9

10 -# Prometheus remote write exporting connector

10 +# Export metrics to Prometheus remote write providers

11

12 The Prometheus remote write exporting connector uses the exporting engine to send Netdata metrics to your choice of more

13 than 20 external storage providers for long-term archiving and further analysis.

health/notifications/web/README.md

+1 -1

@@ -8,7 +8,7 @@ learn_rel_path: "Integrations/Notify/Agent alert notifications"

8 learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"

9 -->

10

11 -# Broser pop up agent alert notifications

11 +# Browser pop up agent alert notifications

12

13 The Netdata dashboard shows HTML notifications, when it is open.

14

libnetdata/clocks/README.md

+2

@@ -6,3 +6,5 @@ learn_status: "Published"

6 learn_topic_type: "References"

7 learn_rel_path: "Developers/libnetdata"

8 -->

9 +

10 +# Clocks

\ No newline at end of file

libnetdata/locks/README.md

+2

@@ -7,6 +7,8 @@ learn_topic_type: "Tasks"

7 learn_rel_path: "Developers/libnetdata"

8 -->

9

10 +# Locks

11 +

12 ## How to trace netdata locks

13

14 To enable tracing rwlocks in netdata, compile netdata by setting `CFLAGS="-DNETDATA_TRACE_RWLOCKS=1"`, like this:

libnetdata/parser/README.md

+3 -1

@@ -7,7 +7,9 @@ learn_topic_type: "References"

7 learn_rel_path: "Developers/Database"

8 -->

9

10 -#### Introduction

10 +# Parser

11 +

12 +## Introduction

13

14 Generic parser that is used to register keywords and a corresponding function that will be executed when that

15 keyword is encountered in the command stream (either from plugins or via streaming)

packaging/PLATFORM_SUPPORT.md

+1 -1

@@ -9,7 +9,7 @@ learn_rel_path: "Installation"

9 learn_docs_purpose: "Present all the supported platform in the Netdata solution"

10 -->

11

12 -# Netdata platform support policy

12 +# Platform support policy

13

14 Netdata defines three tiers of official support:

15

packaging/installer/methods/packages.md

+1 -1

@@ -8,7 +8,7 @@ learn_rel_path: "Installation/Installation methods"

8 sidebar_position: 20

9 -->

10

11 -# Installing Netdata using native DEB or RPM packages.

11 +# Install Netdata using native DEB/RPM packages.

12

13 For most common Linux distributions that use either DEB or RPM packages, Netdata provides pre-built native packages

14 for current releases in-line with

packaging/makeself/README.md

+1 -1

@@ -8,7 +8,7 @@ learn_rel_path: "Installation/Installation methods"

8 sidebar_position: 30

9 -->

10

11 -# Netdata static binary packages

11 +# Netdata static binary build

12

13 We publish pre-built static builds of Netdata for Linux systems. Currently, these are published for 64-bit x86, ARMv7,

14 AArch64, and POWER8+ hardware. These static builds are able to operate in a mostly self-contained manner and only

web/api/exporters/shell/README.md

+1 -1

@@ -7,7 +7,7 @@ learn_topic_type: "References"

7 learn_rel_path: "Developers/Web/Api/Exporters"

8 -->

9

10 -# shell exporter

10 +# Shell exporter

11

12 Shell scripts can now query Netdata:

13

web/api/queries/README.md

+1 -1

@@ -6,7 +6,7 @@ learn_status: "Published"

6 learn_rel_path: "Integrations/Export"

7 -->

8

9 -# Database Queries

9 +# REST API for Database Queries

10

11 The Netdata database can be queried with the `/api/v1/data` and `/api/v1/badge.svg` REST API methods.

12

Make the title metadata H1 in all markdown files (#14625)