mirror of
https://github.com/netdata/netdata.git
synced 2025-04-06 06:25:32 +00:00
Make the title metadata H1 in all markdown files (#14625)
* make the title metadta the H1 * Update collectors/python.d.plugin/zscores/README.md * Update libnetdata/ebpf/README.md * Update ml/README.md * Update libnetdata/string/README.md --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
This commit is contained in:
parent
380e2b261b
commit
e9af618081
45 changed files with 60 additions and 35 deletions
aclk
cli
collectors
README.md
apps.plugin
cgroups.plugin
cups.plugin
diskspace.plugin
ebpf.plugin
freebsd.plugin
ioping.plugin
nfacct.plugin
perf.plugin
proc.plugin
python.d.plugin
statsd.plugin
database
docs
Demo-Sites.md
category-overview-pages
cloud
dashboard
guides/monitor
monitor
exporting/prometheus/remote_write
health/notifications/web
libnetdata
packaging
web/api
|
@ -9,7 +9,7 @@ learn_topic_type: "Tasks"
|
|||
learn_rel_path: "Configuration"
|
||||
-->
|
||||
|
||||
# Agent-cloud link (ACLK)
|
||||
# Agent-Cloud link (ACLK)
|
||||
|
||||
The Agent-Cloud link (ACLK) is the mechanism responsible for securely connecting a Netdata Agent to your web browser
|
||||
through Netdata Cloud. The ACLK establishes an outgoing secure WebSocket (WSS) connection to Netdata Cloud on port
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Operations"
|
||||
-->
|
||||
|
||||
# Netdata CLI
|
||||
# Netdata Agent CLI
|
||||
|
||||
The `netdatacli` executable provides a simple way to control the Netdata agent's operation.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Concepts"
|
||||
-->
|
||||
|
||||
# Collecting metrics
|
||||
# Collectors
|
||||
|
||||
When Netdata starts, and with zero configuration, it auto-detects thousands of data sources and immediately collects
|
||||
per-second metrics.
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/System metrics"
|
||||
-->
|
||||
|
||||
# apps.plugin
|
||||
# Application monitoring (apps.plugin)
|
||||
|
||||
`apps.plugin` breaks down system resource usage to **processes**, **users** and **user groups**.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/Virtualized environments/Containers"
|
||||
-->
|
||||
|
||||
# cgroups.plugin
|
||||
# Monitor Cgroups (cgroups.plugin)
|
||||
|
||||
You can monitor containers and virtual machines using **cgroups**.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/Remotes/Devices"
|
||||
-->
|
||||
|
||||
# cups.plugin
|
||||
# Printers (cups.plugin)
|
||||
|
||||
`cups.plugin` collects Common Unix Printing System (CUPS) metrics.
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/System metrics"
|
||||
-->
|
||||
|
||||
# diskspace.plugin
|
||||
# Monitor disk (diskspace.plugin)
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/System metrics"
|
||||
-->
|
||||
|
||||
# eBPF monitoring with Netdata
|
||||
# Kernel traces/metrics (eBPF) monitoring with Netdata
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/System metrics"
|
||||
-->
|
||||
|
||||
# freebsd.plugin
|
||||
# FreeBSD system metrics (freebsd.plugin)
|
||||
|
||||
Collects resource usage and performance data on FreeBSD systems
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/QoS"
|
||||
-->
|
||||
|
||||
# ioping.plugin
|
||||
# Monitor latency for directories/files/devices (ioping.plugin)
|
||||
|
||||
The ioping plugin supports monitoring latency for any number of directories/files/devices,
|
||||
by pinging them with `ioping`.
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/Networking"
|
||||
-->
|
||||
|
||||
# nfacct.plugin
|
||||
# Monitor Netfilter statistics (nfacct.plugin)
|
||||
|
||||
`nfacct.plugin` collects Netfilter statistics.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/System metrics"
|
||||
-->
|
||||
|
||||
# perf.plugin
|
||||
# Monitor CPU performance statistics (perf.plugin)
|
||||
|
||||
`perf.plugin` collects system-wide CPU performance statistics from Performance Monitoring Units (PMU) using
|
||||
the `perf_event_open()` system call.
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/System metrics"
|
||||
-->
|
||||
|
||||
# proc.plugin
|
||||
# OS provided metrics (proc.plugin)
|
||||
|
||||
- `/proc/net/dev` (all network interfaces for all their values)
|
||||
- `/proc/diskstats` (all disks for all their values)
|
||||
|
|
|
@ -6,7 +6,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Integrations/Monitor/Netdata"
|
||||
-->
|
||||
|
||||
# Alarms - graphing Netdata alarm states over time
|
||||
# Alarms
|
||||
|
||||
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).
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/QoS"
|
||||
-->
|
||||
|
||||
# Online changepoint detection with Netdata
|
||||
# Online change point detection with Netdata
|
||||
|
||||
This collector uses the Python [changefinder](https://github.com/shunsukeaihara/changefinder) library to
|
||||
perform [online](https://en.wikipedia.org/wiki/Online_machine_learning) [changepoint detection](https://en.wikipedia.org/wiki/Change_detection)
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Integrations/Monitor/Mock Collectors"
|
||||
-->
|
||||
|
||||
# Example
|
||||
# Example module in Python
|
||||
|
||||
You can add custom data collectors using Python.
|
||||
|
||||
|
|
|
@ -7,6 +7,8 @@ learn_status: "Published"
|
|||
learn_rel_path: "Integrations/Monitor/Anything"
|
||||
-->
|
||||
|
||||
# StatsD
|
||||
|
||||
[StatsD](https://github.com/statsd/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.
|
||||
|
@ -317,7 +319,6 @@ For example, if you want to monitor the application `myapp` using StatsD and Net
|
|||
private charts = no
|
||||
gaps when not collected = no
|
||||
history = 60
|
||||
# memory mode = ram
|
||||
|
||||
[dictionary]
|
||||
m1 = metric1
|
||||
|
|
|
@ -6,7 +6,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Integrations/Monitor/apps"
|
||||
-->
|
||||
|
||||
# K6 Load Testing monitoring with Netdata
|
||||
# K6 load test monitoring with Netdata
|
||||
|
||||
Monitors the impact of load testing experiments performed with [K6](https://k6.io/).
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_topic_type: "Concepts"
|
|||
learn_rel_path: "Concepts"
|
||||
-->
|
||||
|
||||
# DBENGINE
|
||||
# Database engine
|
||||
|
||||
DBENGINE is the time-series database of Netdata.
|
||||
|
||||
|
|
|
@ -8,4 +8,4 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Developers/Database"
|
||||
-->
|
||||
|
||||
# RAM modes
|
||||
# RAM database modes
|
||||
|
|
|
@ -9,7 +9,7 @@ learn_rel_path: "Getting started"
|
|||
sidebar_position: "90"
|
||||
-->
|
||||
|
||||
# Demo sites
|
||||
# Live demos
|
||||
|
||||
See the live Netdata Cloud demo with rooms for specific use cases at **https://app.netdata.cloud/spaces/netdata-demo**
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_rel_path: "Integrations"
|
|||
sidebar_position: 60
|
||||
-->
|
||||
|
||||
# Netdata Integrations
|
||||
# Integrations
|
||||
|
||||
Netdata's ability to monitor out of the box every potentially useful aspect of a node's operation is unparalleled.
|
||||
But Netdata also provides out of the box, meaningful charts and alerts for hundreds of applications, with the ability
|
||||
|
|
|
@ -8,6 +8,8 @@ learn_topic_type: "Tasks"
|
|||
learn_rel_path: "Operations"
|
||||
-->
|
||||
|
||||
# Anomaly Advisor
|
||||
|
||||
import ReactPlayer from 'react-player'
|
||||
|
||||
The Anomaly Advisor feature lets you quickly surface potentially anomalous metrics and charts related to a particular highlight window of
|
||||
|
|
|
@ -9,6 +9,8 @@ learn_rel_path: "Concepts"
|
|||
learn_docs_purpose: "Present the Netdata Events feed."
|
||||
-->
|
||||
|
||||
# Events feed
|
||||
|
||||
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.
|
||||
|
||||
## What are the available events?
|
||||
|
|
|
@ -8,6 +8,8 @@ learn_topic_type: "Tasks"
|
|||
learn_rel_path: "Operations"
|
||||
-->
|
||||
|
||||
# Metric Correlations
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
|
|
@ -9,6 +9,8 @@ learn_rel_path: "Concepts"
|
|||
learn_docs_purpose: "Explain what are Netdata Plans"
|
||||
-->
|
||||
|
||||
# Netdata Plans
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
|
|
@ -9,6 +9,8 @@ learn_rel_path: "Concepts"
|
|||
learn_docs_purpose: "Present the Netdata Functions what these are and why they should be used."
|
||||
-->
|
||||
|
||||
# Netdata Functions
|
||||
|
||||
Netdata Agent collectors are able to expose functions that can be executed in run-time and on-demand. These will be
|
||||
executed on the node - host where the function is made
|
||||
available.
|
||||
|
|
|
@ -9,6 +9,8 @@ learn_rel_path: "Operations"
|
|||
learn_docs_purpose: "Instructions on how to use Functions"
|
||||
-->
|
||||
|
||||
# Run-time troubleshooting with Functions
|
||||
|
||||
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.
|
||||
These routines can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself.
|
||||
|
||||
|
|
|
@ -10,6 +10,8 @@ learn_topic_type: "Tasks"
|
|||
learn_rel_path: "Operations/Visualizations"
|
||||
-->
|
||||
|
||||
# Build new dashboards
|
||||
|
||||
With Netdata Cloud, you can build new dashboards that target your infrastructure's unique needs. Put key metrics from
|
||||
any number of distributed systems in one place for a bird's eye view of your infrastructure.
|
||||
|
||||
|
|
|
@ -8,6 +8,8 @@ learn_topic_type: "Concepts"
|
|||
learn_rel_path: "Operations/Visualizations"
|
||||
-->
|
||||
|
||||
# Kubernetes visualizations
|
||||
|
||||
Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in
|
||||
the default [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) dashboard.
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ learn_topic_type: "Tasks"
|
|||
learn_rel_path: "Operations"
|
||||
-->
|
||||
|
||||
# Import, export, and print snapshots
|
||||
# Import, export, and print a snapshot
|
||||
|
||||
Netdata can export snapshots of the contents of your dashboard at a given time, which you can then import into any other
|
||||
node running Netdata. Or, you can create a print-ready version of your dashboard to save to PDF or actually print to
|
||||
|
|
|
@ -8,6 +8,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Operations"
|
||||
-->
|
||||
|
||||
# Machine learning (ML) powered anomaly detection
|
||||
|
||||
|
||||
## Overview
|
||||
|
|
|
@ -7,9 +7,9 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/moni
|
|||
learn_status: "Published"
|
||||
learn_rel_path: "Miscellaneous"
|
||||
-->
|
||||
import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
|
||||
|
||||
# Monitor Pi-hole (and a Raspberry Pi) with Netdata
|
||||
# Monitor Pi-hole (and a Raspberry Pi) with Netdataimport { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
|
||||
|
||||
|
||||
Between intrusive ads, invasive trackers, and vicious malware, many techies and homelab enthusiasts are advancing their
|
||||
networks' security and speed with a tiny computer and a powerful piece of software: [Pi-hole](https://pi-hole.net/).
|
||||
|
|
|
@ -8,6 +8,8 @@ learn_status: "Published"
|
|||
learn_rel_path: "Miscellaneous"
|
||||
-->
|
||||
|
||||
# Unsupervised anomaly detection for Raspberry Pi monitoring
|
||||
|
||||
We love IoT and edge at Netdata, we also love machine learning. Even better if we can combine the two to ease the pain
|
||||
of monitoring increasingly complex systems.
|
||||
|
||||
|
@ -63,7 +65,6 @@ Now you're ready to enable the collector and [restart Netdata](https://github.co
|
|||
|
||||
```bash
|
||||
sudo ./edit-config python.d.conf
|
||||
# set `anomalies: no` to `anomalies: yes`
|
||||
|
||||
# restart netdata
|
||||
sudo systemctl restart netdata
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Integrations/Notify"
|
||||
-->
|
||||
|
||||
# Enable alert notifications
|
||||
# Alert notifications
|
||||
|
||||
Netdata offers two ways to receive alert notifications on external platforms. These methods work independently _or_ in
|
||||
parallel, which means you can enable both at the same time to send alert notifications to any number of endpoints.
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Integrations/Export"
|
||||
-->
|
||||
|
||||
# Prometheus remote write exporting connector
|
||||
# Export metrics to Prometheus remote write providers
|
||||
|
||||
The Prometheus remote write exporting connector uses the exporting engine to send Netdata metrics to your choice of more
|
||||
than 20 external storage providers for long-term archiving and further analysis.
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_rel_path: "Integrations/Notify/Agent alert notifications"
|
|||
learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
|
||||
-->
|
||||
|
||||
# Broser pop up agent alert notifications
|
||||
# Browser pop up agent alert notifications
|
||||
|
||||
The Netdata dashboard shows HTML notifications, when it is open.
|
||||
|
||||
|
|
|
@ -6,3 +6,5 @@ learn_status: "Published"
|
|||
learn_topic_type: "References"
|
||||
learn_rel_path: "Developers/libnetdata"
|
||||
-->
|
||||
|
||||
# Clocks
|
|
@ -7,6 +7,8 @@ learn_topic_type: "Tasks"
|
|||
learn_rel_path: "Developers/libnetdata"
|
||||
-->
|
||||
|
||||
# Locks
|
||||
|
||||
## How to trace netdata locks
|
||||
|
||||
To enable tracing rwlocks in netdata, compile netdata by setting `CFLAGS="-DNETDATA_TRACE_RWLOCKS=1"`, like this:
|
||||
|
|
|
@ -7,7 +7,9 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Developers/Database"
|
||||
-->
|
||||
|
||||
#### Introduction
|
||||
# Parser
|
||||
|
||||
## Introduction
|
||||
|
||||
Generic parser that is used to register keywords and a corresponding function that will be executed when that
|
||||
keyword is encountered in the command stream (either from plugins or via streaming)
|
||||
|
|
|
@ -9,7 +9,7 @@ learn_rel_path: "Installation"
|
|||
learn_docs_purpose: "Present all the supported platform in the Netdata solution"
|
||||
-->
|
||||
|
||||
# Netdata platform support policy
|
||||
# Platform support policy
|
||||
|
||||
Netdata defines three tiers of official support:
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_rel_path: "Installation/Installation methods"
|
|||
sidebar_position: 20
|
||||
-->
|
||||
|
||||
# Installing Netdata using native DEB or RPM packages.
|
||||
# Install Netdata using native DEB/RPM packages.
|
||||
|
||||
For most common Linux distributions that use either DEB or RPM packages, Netdata provides pre-built native packages
|
||||
for current releases in-line with
|
||||
|
|
|
@ -8,7 +8,7 @@ learn_rel_path: "Installation/Installation methods"
|
|||
sidebar_position: 30
|
||||
-->
|
||||
|
||||
# Netdata static binary packages
|
||||
# Netdata static binary build
|
||||
|
||||
We publish pre-built static builds of Netdata for Linux systems. Currently, these are published for 64-bit x86, ARMv7,
|
||||
AArch64, and POWER8+ hardware. These static builds are able to operate in a mostly self-contained manner and only
|
||||
|
|
|
@ -7,7 +7,7 @@ learn_topic_type: "References"
|
|||
learn_rel_path: "Developers/Web/Api/Exporters"
|
||||
-->
|
||||
|
||||
# shell exporter
|
||||
# Shell exporter
|
||||
|
||||
Shell scripts can now query Netdata:
|
||||
|
||||
|
|
|
@ -6,7 +6,7 @@ learn_status: "Published"
|
|||
learn_rel_path: "Integrations/Export"
|
||||
-->
|
||||
|
||||
# Database Queries
|
||||
# REST API for Database Queries
|
||||
|
||||
The Netdata database can be queried with the `/api/v1/data` and `/api/v1/badge.svg` REST API methods.
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue