diff options
| author | Joel Hans <joel@netdata.cloud> | 2020-10-20 11:04:55 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-20 11:04:55 -0700 |
| commit | 3a700ac4b9ab800e075acffeb551a547085f7dd8 (patch) | |
| tree | eaa400b52504882096f992e6f36cbdd7d0542458 | |
| parent | 4ed573ca506bd7f59c74eba72aaeb3047a7b9a72 (diff) | |
Rewrite the repository's main README (#10108)
* Rewrite README
* Updated news and a few tweaks
| -rw-r--r-- | README.md | 584 |
1 files changed, 151 insertions, 433 deletions
@@ -1,160 +1,132 @@ -<!-- ---- -title: "Netdata" -date: 2020-05-01 -custom_edit_url: https://github.com/netdata/netdata/edit/master/README.md ---- ---> +<p align="center"><a href="https://netdata.cloud"><img src="https://user-images.githubusercontent.com/1153921/95268672-a3665100-07ec-11eb-8078-db619486d6ad.png" alt="Netdata" width="300" /></a></p> + +<h3 align="center">The best monitoring and troubleshooting for systems, containers, applications, and infrastructure. <br />Preconfigured, opinionated, and always real-time.</h3> +<br /> +<p align="center"> + <a href="https://github.com/netdata/netdata/releases/latest"><img src="https://img.shields.io/github/release/netdata/netdata.svg" alt="Latest release"></a> + <a href="https://travis-ci.com/netdata/netdata"><img src="https://travis-ci.com/netdata/netdata.svg?branch=master" alt="Build status"></a> + <a href="https://bestpractices.coreinfrastructure.org/projects/2231"><img src="https://bestpractices.coreinfrastructure.org/projects/2231/badge" alt="CII Best Practices"></a> + <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPL%20v3%2B-blue.svg" alt="License: GPL v3+"></a> + <a href="<>"><img src="https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Freadme&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3" alt="analytics"></a> + <br /> + <a href="https://codeclimate.com/github/netdata/netdata"><img src="https://codeclimate.com/github/netdata/netdata/badges/gpa.svg" alt="Code Climate"></a> + <a href="https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/a994873f30d045b9b4b83606c3eb3498" alt="Codacy"></a> + <a href="https://lgtm.com/projects/g/netdata/netdata/context:cpp"><img src="https://img.shields.io/lgtm/grade/cpp/g/netdata/netdata.svg?logo=lgtm" alt="LGTM C"></a> + <a href="https://lgtm.com/projects/g/netdata/netdata/context:javascript"><img src="https://img.shields.io/lgtm/grade/javascript/g/netdata/netdata.svg?logo=lgtm" alt=""LGTM JS></a> + <a href="https://lgtm.com/projects/g/netdata/netdata/context:python"><img src="https://img.shields.io/lgtm/grade/python/g/netdata/netdata.svg?logo=lgtm" alt="LGTM PYTHON"></a> +</p> + +<img src="https://user-images.githubusercontent.com/1153921/95269366-1b814680-07ee-11eb-8ff4-c1b0b8758499.png" alt="---" style="max-width: 100%;" /> + +Netdata's **distributed, real-time monitoring Agent** collects thousands of metrics from systems, hardware, containers, +and applications with zero configuration. It runs permanently on all your physical/virtual servers, containers, cloud +deployments, and edge/IoT devices. + +You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container platforms (Kubernetes +clusters, Docker), and many other operating systems (FreeBSD, macOS). No `sudo` required. + +Netdata is designed by system administrators, DevOps engineers, and developers to collect everything, help you visualize +metrics, troubleshoot complex performance problems, and make data interoperable with the rest of your monitoring stack. + +People get addicted to Netdata. Once you use it on your systems, there's no going back! _You've been warned..._ + + + +> **[Latest release](https://github.com/netdata/netdata/releases/latest): v1.26.0, October 14, 2020** +> +> The v1.26.0 release of the Netdata Agent brings exciting new collectors written in Go, a new integration with the +> DevOps startup StackPulse, and massive improvements to the way users navigate Netdata's documentation. We've also +> added compatibility with an exciting new feature that's coming soon to Netdata Cloud—stay tuned! This release contains +> 3 new collectors, 1 new notifcation method, 21 improvements, 13 documentation updates, and 12 bug fixes. + +## Menu + +- [Features](#features) +- [Get Netdata](#get-netdata) +- [How it works](#how-it-works) +- [Documentation](#documentation) +- [Community](#community) +- [Contribute](#contribute) +- [License](#license) +- [Is it any good?](#is-it-any-good) -# Netdata [](https://travis-ci.com/netdata/netdata) [](https://bestpractices.coreinfrastructure.org/projects/2231) [](https://www.gnu.org/licenses/gpl-3.0) [](<>) - -[](https://codeclimate.com/github/netdata/netdata) -[](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade) -[](https://lgtm.com/projects/g/netdata/netdata/context:cpp) -[](https://lgtm.com/projects/g/netdata/netdata/context:javascript) -[](https://lgtm.com/projects/g/netdata/netdata/context:python) - ---- - -Netdata is **distributed, real-time performance and health monitoring** for systems and applications. It is a -highly-optimized monitoring agent you install on all your systems and containers. - -Netdata provides **unparalleled insights**, in **real-time**, of everything happening on the systems it's running on -(including web servers, databases, applications), using **highly interactive web dashboards**. - -A highly-efficient database **stores long-term historical metrics for days, weeks, or months**, all at 1-second -granularity. Run this long-term storage autonomously, or integrate Netdata with your existing monitoring toolchains -(Prometheus, Graphite, OpenTSDB, Kafka, Grafana, and more). - -Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** and **virtual** servers, -**containers**, **IoT** devices), without disrupting their core function. - -Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **macOS**, along with -other systems derived from them, such as **Kubernetes** and **Docker**. - -Netdata is not hosted by the CNCF but is the fourth most starred open-source project in the [Cloud Native Computing -Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars). - ---- - -People get **addicted to Netdata**. Once you use it on your systems, **there is no going back**! _You've been warned..._ - - - -[](https://twitter.com/intent/tweet?text=Netdata,%20real-time%20performance%20and%20health%20monitoring,%20done%20right!&url=https://my-netdata.io/&via=linuxnetdata&hashtags=netdata,monitoring) - -## Contents - -1. [What does it look like?](#what-does-it-look-like) - Take a quick tour through the dashboard -2. [Our userbase](#user-base) - Enterprises we help monitor and our userbase -3. [Quickstart](#quickstart) - How to try it now on your systems -4. [Why Netdata](#why-netdata) - Why people love Netdata and how it compares with other solutions -5. [News](#news) - The latest news about Netdata -6. [How Netdata works](#how-it-works) - A high-level diagram of how Netdata works -7. [Infographic](#infographic) - Everything about Netdata in a single graphic -8. [Features](#features) - How you'll use Netdata on your systems -9. [Visualization](#visualization) - Learn about visual anomaly detection -10. [What Netdata monitors](#what-netdata-monitors) - See which apps/services Netdata auto-detects -11. [Documentation](#documentation) - Read the documentation -12. [Community](#community) - Discuss Netdata with others and get support -13. [License](#license) - Check Netdata's licencing -14. [Is it any good?](#is-it-any-good) - Yes. -15. [Is it awesome?](#is-it-awesome) - Yes. - -## What does it look like? - -The following animated GIF shows the top part of a typical Netdata dashboard. - - - -> A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse -> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive, -> **real-time**, and optimized to get the work done! - -Want to try Netdata before you install? See our [live -demo](https://london.my-netdata.io/default.html#menu_system_submenu_cpu;theme=slate;help=true). - -## User base - -Netdata is used by hundreds of thousands of users all over the world. Check our [GitHub watchers -list](https://github.com/netdata/netdata/watchers). You will find people working for **Amazon**, **Atos**, **Baidu**, -**Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**, **Elastic**, **EPAM Systems**, **Ericsson**, -**Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**, **IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red -Hat**, **SAP**, **Selectel**, **TicketMaster**, **Vimeo**, and many more! - -### Docker pulls - -We provide Docker images for the most common architectures. These are statistics reported by Docker Hub: - -[](https://hub.docker.com/r/netdata/netdata/) -[](https://hub.docker.com/r/firehol/netdata/) -[](https://hub.docker.com/r/titpetric/netdata/) - -### Registry - -When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata -registry](/registry/README.md). This is a web browser feature and it allows us to count the number of unique users and -unique Netdata servers installed. The following information comes from the global public Netdata registry we run: - -[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) -[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) -[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) - -_In the last 24 hours:_<br/> [](https://registry.my-netdata.io/#menu_netdata_submenu_registry) -[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) -[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) +## Features -## Quickstart + - - +Here's what you can expect from Netdata: -To install Netdata from source on any Linux system (physical, virtual, container, IoT, edge), including all dependencies -required to connect to Netdata Cloud, and get _automatic nightly updates_, run the following as your normal user: +- **1s granularity**: The highest possible resolution for all metrics. +- **Unlimited metrics**: Netdata collects all the available metrics—the more, the better. +- **1% CPU utilization of a single core**: It's unbelievably optimized. +- **A few MB of RAM**: The highly-efficient database engine stores per-second metrics in RAM and then "spills" + historical metrics to disk long-term storage. +- **Minimal disk I/O**: While running, Netdata only writes historical metrics and reads `error` and `access` logs. +- **Zero configuration**: Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the + box. +- **Zero maintenance**: You just run it. Netdata does the rest. +- **Stunningly fast, interactive visualizations**: The dashboard responds to queries in less than 1ms per metric to + synchronize charts as you pan through time, zoom in on anomalies, and more. +- **Visual anomaly detection**: Our UI/UX emphasizes the relationships between charts to help you detect the root + cause of anomalies. +- **Scales to infinity**: You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not + centralized by default, so there is no limit. +- **Several operating modes**: Autonomous host monitoring (the default), headless data collector, forwarding proxy, + store and forward proxy, central multi-host monitoring, in all possible configurations. Use diferent metrics + retention polocies per node and run with or without health monitoring. + +Netdata works with tons of applications, notifications platforms, and other time-series databases: + +- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and + immediately visualize them into meaningful charts designed for troubleshooting. See [everything we + support](https://learn.netdata.cloud/docs/agent/collectors/collectors). +- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite + platform](https://learn.netdata.cloud/docs/monitor/enable-notifications) to inform you of anomalies just seconds + after they affect your node. +- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and + Cloud-based databases](https://learn.netdata.cloud/docs/export/external-databases) for best-in-class + interoperability. + +> 💡 **Want to leverage the monitoring power of Netdata across entire infrastructure**? View metrics from +> any number of distributed nodes in a single interface and unlock even more +> [features](https://learn.netdata.cloud/docs/overview/why-netdata) with [Netdata +> Cloud](https://learn.netdata.cloud/docs/overview/what-is-netdata#netdata-cloud). + +## Get Netdata + +<p align="center"> + <a href="https://registry.my-netdata.io/#menu_netdata_submenu_registry"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=M&value_color=blue&precision=2÷=1000000&v43" alt="User base"></a> + <a href="https://registry.my-netdata.io/#menu_netdata_submenu_registry"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=k÷=1000&value_color=orange&precision=2&v43" alt="Servers monitored"></a> + <a href="https://registry.my-netdata.io/#menu_netdata_submenu_registry"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=M&value_color=yellowgreen&precision=2÷=1000000&v43" alt="Sessions served"></a> + <a href="https://hub.docker.com/r/netdata/netdata"><img src="https://frankfurt.my-netdata.io/api/v1/badge.svg?chart=dockerhub.pulls_sum÷=1000000&precision=1&units=M&label=docker+hub+pulls" alt="Docker Hub pulls"></a> + <br /> + <a href="https://registry.my-netdata.io/#menu_netdata_submenu_registry"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&after=-86400&options=unaligned&group=incremental-sum&label=new%20users%20today&units=null&value_color=blue&precision=0&v42" alt="New users today"></a> + <a href="https://registry.my-netdata.io/#menu_netdata_submenu_registry"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&group=incremental-sum&after=-86400&options=unaligned&label=servers%20added%20today&units=null&value_color=orange&precision=0&v42" alt="New machines today"></a> + <a href="https://registry.my-netdata.io/#menu_netdata_submenu_registry"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&after=-86400&group=incremental-sum&options=unaligned&label=sessions%20served%20today&units=null&value_color=yellowgreen&precision=0&v42" alt="Sessions today"></a> + <a href="https://hub.docker.com/r/netdata/netdata"><img src="https://frankfurt.my-netdata.io/api/v1/badge.svg?chart=dockerhub.pulls_sum÷=1000&precision=1&units=k&label=docker+hub+pulls&after=-86400&group=incremental-sum&label=docker%20hub%20pulls%20today" alt="Docker Hub pulls today"></a> +</p> + +To install Netdata from source on most Linux systems (physical, virtual, container, IoT, edge), run our [one-line +installation script](https://learn.netdata.cloud/docs/agent/packaging/installer/methods/packages). This script downloads +and builds all dependencies, including those required to connect to [Netdata Cloud](https://netdata.cloud/cloud) if you +choose, and enables [automatic nightly +updates](https://learn.netdata.cloud/docs/agent/packaging/installer#nightly-vs-stable-releases) and [anonymous +statistics](https://learn.netdata.cloud/docs/agent/anonymous-statistics). ```bash -# make sure you run `bash` for your shell -bash - -# install Netdata directly from GitHub source bash <(curl -Ss https://my-netdata.io/kickstart.sh) ``` -Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read -about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md) page. - -The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for -_actively_ contributing to Netdata's future. - -To learn more about the pros and cons of using _nightly_ vs. _stable_ releases, see our [notice about the two options](/packaging/installer/README.md#nightly-vs-stable-releases). +To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`. -The above command will: +### Docker -- Install any required packages on your system (it will ask you to confirm before doing so) -- Compile it, install it, and start it. +You can also try out Netdata's capabilities in a [Docker +container](https://learn.netdata.cloud/docs/agent/packaging/docker/): -More installation methods and additional options can be found at the [installation -page](/packaging/installer/README.md). - -To try Netdata in a Docker container, run this: - -```sh +```bash docker run -d --name=netdata \ -p 19999:19999 \ -v netdataconfig:/etc/netdata \ @@ -171,310 +143,51 @@ docker run -d --name=netdata \ netdata/netdata ``` -For more information about running Netdata in Docker, check the [docker installation page](/packaging/docker/README.md). - - - -From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read -more about the information collected and how to opt-out, check the [anonymous statistics -page](/docs/anonymous-statistics.md). - -## Why Netdata - -Netdata has a quite different approach to monitoring. - -Netdata is a monitoring agent you install on all your systems. It is: - -- A **metrics collector** for system and application metrics (including web servers, databases, containers, and much - more), -- A **long-term metrics database** that stores recent metrics in memory and "spills" historical metrics to disk for - efficient long-term storage, -- A super fast, interactive, and modern **metrics visualizer** optimized for anomaly detection, -- And an **alarms notification engine** for detecting performance and availability issues. - -All the above, are packaged together in a very flexible, extremely modular, distributed application. - -This is how Netdata compares to other monitoring solutions: - -| Netdata | others (open-source and commercial) | -| :-------------------------------------------------------------- | :--------------------------------------------------------------- | -| **High resolution metrics** (1s granularity) | Low resolution metrics (10s granularity at best) | -| Monitors everything, **thousands of metrics per node** | Monitor just a few metrics | -| UI is super fast, optimized for **anomaly detection** | UI is good for just an abstract view | -| **Long-term, autonomous storage** at one-second granularity | Centralized metrics in an expensive data lake at 10s granularity | -| **Meaningful presentation**, to help you understand the metrics | You have to know the metrics before you start | -| Install and get results **immediately** | Long preparation is required to get any useful results | -| Use it for **troubleshooting** performance problems | Use them to get _statistics of past performance_ | -| **Kills the console** for tracing performance issues | The console is always required for troubleshooting | -| Requires **zero dedicated resources** | Require large dedicated resources | - -Netdata is **open-source**, **free**, super **fast**, very **easy**, completely **open**, extremely **efficient**, -**flexible** and integrate-able. - -It has been designed by **system administrators**, **DevOps engineers**, and **developers** for to not just visualize -metrics, but also troubleshoot complex performance problems. - -## News - -`August 10, 2020`- **[Netdata v1.24.0 released!](https://github.com/netdata/netdata/releases/tag/v1.24.0)** - -The v1.24.0 release of the Netdata Agent brings enhancements to the breadth of metrics we collect with a new Prometheus/OpenMetrics collector and enhanced storage and querying with a new multi-host database mode. - -`July 16, 2020` - **[Netdata v1.23.2 released!](https://github.com/netdata/netdata/releases/tag/v1.23.2)** - -Release v1.23.2 of the Netdata Agent is a patch for one significant issue. - -PR [#9491](https://github.com/netdata/netdata/pull/9491) fixed a buffer overrun vulnerability in Netdata's JSON parsing -code. This vulnerability could be used to crash Agents remotely, and in some circumstances, could be used in an -arbitrary code execution (ACE) exploit. - -We strongly encourage all Netdata users to update their nodes to v1.23.2 as soon as possible. - -This release also contains additional bug fixes and improvements. - -`July 1, 2020` - **[Netdata v1.23.1 released!](https://github.com/netdata/netdata/releases/tag/v1.23.1)** - -Release v1.23.1 of the Netdata Agent is a patch for two significant issues. - -PR [#9436](https://github.com/netdata/netdata/pull/9436) fixed an issue where dimensions were marked obsolete and -archived simultaneously, which caused segmentation faults. We're grateful to [marioem](https://github.com/marioem), who -first reported the issue, and other members of the Netdata community who contributed their insights and valuable log -information, which we used to diagnose and fix the bug. - -PR [#9428](https://github.com/netdata/netdata/pull/9428) fixed a significant issue with duplicate alarm IDs, which -caused issues in how alarms were sent and displayed in Netdata Cloud. +To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`. -This release also contains a few additional bug fixes that were not fully reviewed before the release of v1.23.0. +### Other operating systems -`June 24, 2020` - **[Netdata v1.23.0 released!](https://github.com/netdata/netdata/releases/tag/v1.23.0)** +See our documentation for [additional operating +systems](/packaging/installer/README.md#have-a-different-operating-system-or-want-to-try-another-method), including +[Kubernetes](/packaging/installer/methods/kubernetes.md), [`.deb`/`.rpm` +packages](/packaging/installer/methods/packages.md), and more. -The v1.23.0 release of the Netdata Agent is all about unlocking new depths of visibility for your applications, -services, and systems. We have Kubernetes service discovery, new eBPF metrics like virtual filesystem switch and -bandwidth per process out of the Linux kernel at _event frequency_, more interoperability with your monitoring stack -thanks to a new exporting engine, and much more. +### Post-installation -This release contains 2 new collectors, 1 new exporting connector, 1 new alarm notification method, 55 improvements, 45 -documentation updates, and 40 bug fixes. - -Our [service discovery collector](https://github.com/netdata/agent-service-discovery/) **detects Kubernetes (k8s) pods -and immediately collects metrics from _22 different services_** as the associated pods are created, destroyed, and -scaled. Service discovery is installed when you use our [Helm chart](https://github.com/netdata/helmchart), which means -you can now collect and visualize service-, pod-, Kubelet-, kube-proxy-, and node-level k8s metrics with one `helm -install` command and zero configuration. All our Kubernetes monitoring components are open source and free for clusters -of any size. - -Our low-level [Linux kernel monitoring via eBPF](https://learn.netdata.cloud/docs/agent/collectors/ebpf.plugin/) is now -supercharged. Thanks to an integration with -[`apps.plugin`](https://learn.netdata.cloud/docs/agent/collectors/apps.plugin), you can now **monitor how a specific -application interacts with the Linux kernel**. This update also includes new metrics, such as virtual filesystem switch, -bandwidth per process, and much more. Netdata collects these metrics at an event frequency, even better than our famous -1s granularity, so that you can debug applications or anomalies with pinpoint accuracy. The eBPF collector is also now -installed and enabled by default except on [static -builds](https://learn.netdata.cloud/docs/agent/packaging/installer/methods/kickstart-64). - -Read our [guide on troubleshooting apps with eBPF -metrics](https://learn.netdata.cloud/guides/troubleshoot/monitor-debug-applications-ebpf/) for more details. - -Netdata is now more interoperable with your existing monitoring stack thanks to the [**exporting -engine**](https://learn.netdata.cloud/docs/agent/exporting/), which replaces the backends system. You can now export to -multiple external databases through Graphite, Google Cloud Pub/Sub, Prometheus remote write, MongoDB, and JSON -connectors, plus others. Send metrics as soon as they're collected to enrich single pane of glass views or analyze -Netdata's metrics with machine learning. - -Read our guide on [exporting metrics to -Graphite](https://learn.netdata.cloud/guides/export/export-netdata-metrics-graphite) for specifics on just one of many -pipelines you can set up to archive your Netdata metrics. - -We're also releasing an improvement for the availability of your monitoring and metrics: **persistent metadata**. The -Agent now writes metadata to disk alongside metrics to allow access to non-active charts from Netdata Cloud and enable -future features. - -We added some enhancements to our documentation site, including a new [guides -section](https://learn.netdata.cloud/guides). We'll continue to populate with more use case- and scenario-based content -to help you monitor, troubleshoot, visualize, and export your Netdata metrics. - ---- - -See more news and previous releases at our [blog](https://www.netdata.cloud/blog/) or our [releases -page](https://github.com/netdata/netdata/releases). +When you're finished with installation, check out our +[single-node](https://learn.netdata.cloud/docs/quickstart/single-node) or +[infrastructure](https://learn.netdata.cloud/docs/quickstart/infrastructure) monitoring quickstart guides based on your +use case. Then, see our [documentation](https://learn.netdata.cloud/docs) for the full picture. ## How it works Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for concurrent operations on the metrics. - - -This is how it works: - -| Function | Description | Documentation | -| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | -| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) | -| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) | -| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) | -| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) | -| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`exporting`](/docs/export/external-databases.md) | -| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) | + The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric. ## Infographic -This is a high level overview of Netdata feature set and architecture. Click it to to interact with it (it has direct -links to our documentation). - -[](https://my-netdata.io/infographic.html) - -## Features - - - -This is what you should expect from Netdata: - -### General - -- **1s granularity** - The highest possible resolution for all metrics. -- **Unlimited metrics** - Netdata collects all the available metrics—the more, the better. -- **1% CPU utilization of a single core** - It's unbelievably optimized. -- **A few MB of RAM** - The highly-efficient database engine stores per-second metrics in RAM and then "spills" - historical metrics to disk long-term storage. -- **Minimal disk I/O** - While running, Netdata only writes historical metrics and reads `error` and `access` logs. -- **Zero configuration** - Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the - box. -- **Zero maintenance** - You just run it. Netdata does the rest. -- **Zero dependencies** - Netdata runs a custom web server for its static web files and its web API (though its - plugins may require additional libraries, depending on the applications monitored). -- **Scales to infinity** - You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not - centralized by default, so there is no limit. -- **Several operating modes** - Autonomous host monitoring (the default), headless data collector, forwarding proxy, - store and forward proxy, central multi-host monitoring, in all possible configurations. Each node may have different - metrics retention policies and run with or without health monitoring. - -### Health Monitoring & Alarms - -- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic - thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more. -- **Notifications**: [alerta.io](/health/notifications/alerta/), [amazon sns](/health/notifications/awssns/), - [discordapp.com](/health/notifications/discord/), [email](/health/notifications/email/), - [flock.com](/health/notifications/flock/), [hangouts](/health/notifications/hangouts/), - [irc](/health/notifications/irc/), [kavenegar.com](/health/notifications/kavenegar/), - [messagebird.com](/health/notifications/messagebird/), [pagerduty.com](/health/notifications/pagerduty/), - [prowl](/health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/), - [pushover.net](/health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/), - [slack.com](/health/notifications/slack/), [smstools3](/health/notifications/smstools3/), - [syslog](/health/notifications/syslog/), [telegram.org](/health/notifications/telegram/), - [twilio.com](/health/notifications/twilio/), [web](/health/notifications/web/) and [custom - notifications](/health/notifications/custom/). - -### Integrations - -- **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS - Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting - these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which - allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**, - **Splunk**, **VictoriaMetrics** and a lot of other [storage - providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage). - -## Visualization - -- **Stunning interactive dashboards** - Our dashboard is mouse-, touchpad-, and touch-screen friendly in 2 themes: - `slate` (dark) and `white`. -- **Amazingly fast visualization** - Even on low-end hardware, the dashboard responds to all queries in less than 1 ms - per metric. -- **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect - anomalies visually. -- **Embeddable** - Charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence - as a monitoring dashboard](/web/gui/confluence/README.md). -- **Customizable** - You can build custom dashboards using simple HTML. No JavaScript needed! - -### Positive and negative values - -To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`, -`inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`. - - +This is a high-level overview of Netdata features and architecture. Click on it to view an interactive version, which +has links to our documentation. -_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is -negative._ - -### Autoscaled y-axis - -Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame. - - - -_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is -selected._ - -### Charts are synchronized - -Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed -at any time, and all other charts will follow. - - - -_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the -mouse pointer is over a chart._ - -### Highlighted time-frame - -To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse -selection`) on all charts. - - - -_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the -same range on all charts._ - -## What Netdata monitors - -Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics -jocs, such as CPU, memory, disks, filesystems, networking, and more. We call these **collectors**, and they're managed -by [**plugins**](/collectors/plugins.d/README.md), which support a variety of programming languages, including Go and -Python. - -Popular collectors include **Nginx**, **Apache**, **MySQL**, **statsd**, **cgroups** (containers, Docker, Kubernetes, -LXC, and more), **Traefik**, **web server `access.log` files**, and much more. - -See the **full list of [supported collectors](/collectors/COLLECTORS.md)**. - -Netdata's data collection is **extensible**, which means you can monitor anything you can get a metric for. You can even -write a collector for your custom application using our [plugin API](/collectors/plugins.d/README.md). +[](https://my-netdata.io/infographic.html) ## Documentation -The Netdata documentation is at <https://docs.netdata.cloud>, but you can also find each page inside of Netdata's -repository itself in Markdown (`.md`) files. You can find all our documentation by navigating the repository. - -Here is a quick list of notable documents: - -| Directory | Description | -| :---------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- | -| [`installer`](/packaging/installer/README.md) | Instructions to install Netdata on your systems. | -| [`docker`](/packaging/docker/README.md) | Instructions to install Netdata using docker. | -| [`daemon`](/daemon/README.md) | Information about the Netdata daemon and its configuration. | -| [`collectors`](/collectors |