Rewrite the repository's main README (#10108)
* Rewrite README * Updated news and a few tweaks
Joel Hans committed
Oct 20, 2020 at 11:04 UTC
3a700ac4b9ab800e075acffeb551a547085f7dd8
1 file changed
+151
-433
README.md
+151
-433
@@ -1,160 +1,132 @@
1
-<!--
2
----
3
-title: "Netdata"
4
-date: 2020-05-01
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/README.md
6
----
7
--->
1
+<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>
2
+
3
+<h3 align="center">The best monitoring and troubleshooting for systems, containers, applications, and infrastructure. <br />Preconfigured, opinionated, and always real-time.</h3>
4
+<br />
5
+<p align="center">
6
+ <a href="https://github.com/netdata/netdata/releases/latest"><img src="https://img.shields.io/github/release/netdata/netdata.svg" alt="Latest release"></a>
7
+ <a href="https://travis-ci.com/netdata/netdata"><img src="https://travis-ci.com/netdata/netdata.svg?branch=master" alt="Build status"></a>
8
+ <a href="https://bestpractices.coreinfrastructure.org/projects/2231"><img src="https://bestpractices.coreinfrastructure.org/projects/2231/badge" alt="CII Best Practices"></a>
9
+ <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>
10
+ <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>
11
+ <br />
12
+ <a href="https://codeclimate.com/github/netdata/netdata"><img src="https://codeclimate.com/github/netdata/netdata/badges/gpa.svg" alt="Code Climate"></a>
13
+ <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>
14
+ <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>
15
+ <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>
16
+ <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>
17
+</p>
18
+
19
+<img src="https://user-images.githubusercontent.com/1153921/95269366-1b814680-07ee-11eb-8ff4-c1b0b8758499.png" alt="---" style="max-width: 100%;" />
20
+
21
+Netdata's **distributed, real-time monitoring Agent** collects thousands of metrics from systems, hardware, containers,
22
+and applications with zero configuration. It runs permanently on all your physical/virtual servers, containers, cloud
23
+deployments, and edge/IoT devices.
24
+
25
+You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container platforms (Kubernetes
26
+clusters, Docker), and many other operating systems (FreeBSD, macOS). No `sudo` required.
27
+
28
+Netdata is designed by system administrators, DevOps engineers, and developers to collect everything, help you visualize
29
+metrics, troubleshoot complex performance problems, and make data interoperable with the rest of your monitoring stack.
30
+
31
+People get addicted to Netdata. Once you use it on your systems, there's no going back! _You've been warned..._
32
+
33
+
35
+
36
+> **[Latest release](https://github.com/netdata/netdata/releases/latest): v1.26.0, October 14, 2020**
37
+>
38
+> The v1.26.0 release of the Netdata Agent brings exciting new collectors written in Go, a new integration with the
39
+> DevOps startup StackPulse, and massive improvements to the way users navigate Netdata's documentation. We've also
40
+> added compatibility with an exciting new feature that's coming soon to Netdata Cloud—stay tuned! This release contains
41
+> 3 new collectors, 1 new notifcation method, 21 improvements, 13 documentation updates, and 12 bug fixes.
42
+
43
+## Menu
44
+
45
+- [Features](#features)
46
+- [Get Netdata](#get-netdata)
47
+- [How it works](#how-it-works)
48
+- [Documentation](#documentation)
49
+- [Community](#community)
50
+- [Contribute](#contribute)
51
+- [License](#license)
52
+- [Is it any good?](#is-it-any-good)
53
9
-# Netdata [](https://travis-ci.com/netdata/netdata) [](https://bestpractices.coreinfrastructure.org/projects/2231) [](https://www.gnu.org/licenses/gpl-3.0) [](<>)
10
-
11
-[](https://codeclimate.com/github/netdata/netdata)
13
-[](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade)
15
-[](https://lgtm.com/projects/g/netdata/netdata/context:cpp)
17
-[](https://lgtm.com/projects/g/netdata/netdata/context:javascript)
19
-[](https://lgtm.com/projects/g/netdata/netdata/context:python)
21
-
22
----
23
-
24
-Netdata is **distributed, real-time performance and health monitoring** for systems and applications. It is a
25
-highly-optimized monitoring agent you install on all your systems and containers.
26
-
27
-Netdata provides **unparalleled insights**, in **real-time**, of everything happening on the systems it's running on
28
-(including web servers, databases, applications), using **highly interactive web dashboards**.
29
-
30
-A highly-efficient database **stores long-term historical metrics for days, weeks, or months**, all at 1-second
31
-granularity. Run this long-term storage autonomously, or integrate Netdata with your existing monitoring toolchains
32
-(Prometheus, Graphite, OpenTSDB, Kafka, Grafana, and more).
33
-
34
-Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** and **virtual** servers,
35
-**containers**, **IoT** devices), without disrupting their core function.
36
-
37
-Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **macOS**, along with
38
-other systems derived from them, such as **Kubernetes** and **Docker**.
39
-
40
-Netdata is not hosted by the CNCF but is the fourth most starred open-source project in the [Cloud Native Computing
41
-Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars).
42
-
43
----
44
-
45
-People get **addicted to Netdata**. Once you use it on your systems, **there is no going back**! _You've been warned..._
46
-
47
-
48
-
49
-[](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)
51
-
52
-## Contents
53
-
54
-1. [What does it look like?](#what-does-it-look-like) - Take a quick tour through the dashboard
55
-2. [Our userbase](#user-base) - Enterprises we help monitor and our userbase
56
-3. [Quickstart](#quickstart) - How to try it now on your systems
57
-4. [Why Netdata](#why-netdata) - Why people love Netdata and how it compares with other solutions
58
-5. [News](#news) - The latest news about Netdata
59
-6. [How Netdata works](#how-it-works) - A high-level diagram of how Netdata works
60
-7. [Infographic](#infographic) - Everything about Netdata in a single graphic
61
-8. [Features](#features) - How you'll use Netdata on your systems
62
-9. [Visualization](#visualization) - Learn about visual anomaly detection
63
-10. [What Netdata monitors](#what-netdata-monitors) - See which apps/services Netdata auto-detects
64
-11. [Documentation](#documentation) - Read the documentation
65
-12. [Community](#community) - Discuss Netdata with others and get support
66
-13. [License](#license) - Check Netdata's licencing
67
-14. [Is it any good?](#is-it-any-good) - Yes.
68
-15. [Is it awesome?](#is-it-awesome) - Yes.
69
-
70
-## What does it look like?
71
-
72
-The following animated GIF shows the top part of a typical Netdata dashboard.
73
-
74
-
76
-
77
-> A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse
78
-> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive,
79
-> **real-time**, and optimized to get the work done!
80
-
81
-Want to try Netdata before you install? See our [live
82
-demo](https://london.my-netdata.io/default.html#menu_system_submenu_cpu;theme=slate;help=true).
83
-
84
-## User base
85
-
86
-Netdata is used by hundreds of thousands of users all over the world. Check our [GitHub watchers
87
-list](https://github.com/netdata/netdata/watchers). You will find people working for **Amazon**, **Atos**, **Baidu**,
88
-**Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**, **Elastic**, **EPAM Systems**, **Ericsson**,
89
-**Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**, **IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red
90
-Hat**, **SAP**, **Selectel**, **TicketMaster**, **Vimeo**, and many more!
91
-
92
-### Docker pulls
93
-
94
-We provide Docker images for the most common architectures. These are statistics reported by Docker Hub:
95
-
96
-[](https://hub.docker.com/r/netdata/netdata/)
98
-[](https://hub.docker.com/r/firehol/netdata/)
100
-[](https://hub.docker.com/r/titpetric/netdata/)
102
-
103
-### Registry
104
-
105
-When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata
106
-registry](/registry/README.md). This is a web browser feature and it allows us to count the number of unique users and
107
-unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
108
-
109
-[](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
111
-[](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
113
-[](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
115
-
116
-_In the last 24 hours:_<br/> [](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
118
-[](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
120
-[](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
54
+## Features
55
123
-## Quickstart
56
+
58
125
-
126
-
59
+Here's what you can expect from Netdata:
60
128
-To install Netdata from source on any Linux system (physical, virtual, container, IoT, edge), including all dependencies
129
-required to connect to Netdata Cloud, and get _automatic nightly updates_, run the following as your normal user:
61
+- **1s granularity**: The highest possible resolution for all metrics.
62
+- **Unlimited metrics**: Netdata collects all the available metrics—the more, the better.
63
+- **1% CPU utilization of a single core**: It's unbelievably optimized.
64
+- **A few MB of RAM**: The highly-efficient database engine stores per-second metrics in RAM and then "spills"
65
+ historical metrics to disk long-term storage.
66
+- **Minimal disk I/O**: While running, Netdata only writes historical metrics and reads `error` and `access` logs.
67
+- **Zero configuration**: Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the
68
+ box.
69
+- **Zero maintenance**: You just run it. Netdata does the rest.
70
+- **Stunningly fast, interactive visualizations**: The dashboard responds to queries in less than 1ms per metric to
71
+ synchronize charts as you pan through time, zoom in on anomalies, and more.
72
+- **Visual anomaly detection**: Our UI/UX emphasizes the relationships between charts to help you detect the root
73
+ cause of anomalies.
74
+- **Scales to infinity**: You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not
75
+ centralized by default, so there is no limit.
76
+- **Several operating modes**: Autonomous host monitoring (the default), headless data collector, forwarding proxy,
77
+ store and forward proxy, central multi-host monitoring, in all possible configurations. Use diferent metrics
78
+ retention polocies per node and run with or without health monitoring.
79
+
80
+Netdata works with tons of applications, notifications platforms, and other time-series databases:
81
+
82
+- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
83
+ immediately visualize them into meaningful charts designed for troubleshooting. See [everything we
84
+ support](https://learn.netdata.cloud/docs/agent/collectors/collectors).
85
+- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
86
+ platform](https://learn.netdata.cloud/docs/monitor/enable-notifications) to inform you of anomalies just seconds
87
+ after they affect your node.
88
+- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
89
+ Cloud-based databases](https://learn.netdata.cloud/docs/export/external-databases) for best-in-class
90
+ interoperability.
91
+
92
+> 💡 **Want to leverage the monitoring power of Netdata across entire infrastructure**? View metrics from
93
+> any number of distributed nodes in a single interface and unlock even more
94
+> [features](https://learn.netdata.cloud/docs/overview/why-netdata) with [Netdata
95
+> Cloud](https://learn.netdata.cloud/docs/overview/what-is-netdata#netdata-cloud).
96
+
97
+## Get Netdata
98
+
99
+<p align="center">
100
+ <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>
101
+ <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>
102
+ <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>
103
+ <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>
104
+ <br />
105
+ <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>
106
+ <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>
107
+ <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>
108
+ <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>
109
+</p>
110
+
111
+To install Netdata from source on most Linux systems (physical, virtual, container, IoT, edge), run our [one-line
112
+installation script](https://learn.netdata.cloud/docs/agent/packaging/installer/methods/packages). This script downloads
113
+and builds all dependencies, including those required to connect to [Netdata Cloud](https://netdata.cloud/cloud) if you
114
+choose, and enables [automatic nightly
115
+updates](https://learn.netdata.cloud/docs/agent/packaging/installer#nightly-vs-stable-releases) and [anonymous
116
+statistics](https://learn.netdata.cloud/docs/agent/anonymous-statistics).
117
118
```bash
132
-# make sure you run `bash` for your shell
133
-bash
134
-
135
-# install Netdata directly from GitHub source
119
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
120
```
121
139
-Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read
140
-about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md) page.
141
-
142
-The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for
143
-_actively_ contributing to Netdata's future.
144
-
145
-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).
122
+To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`.
123
147
-The above command will:
124
+### Docker
125
149
-- Install any required packages on your system (it will ask you to confirm before doing so)
150
-- Compile it, install it, and start it.
126
+You can also try out Netdata's capabilities in a [Docker
127
+container](https://learn.netdata.cloud/docs/agent/packaging/docker/):
128
152
-More installation methods and additional options can be found at the [installation
153
-page](/packaging/installer/README.md).
154
-
155
-To try Netdata in a Docker container, run this:
156
-
157
-```sh
129
+```bash
130
docker run -d --name=netdata \
131
-p 19999:19999 \
132
-v netdataconfig:/etc/netdata \
@@ -171,310 +143,51 @@ docker run -d --name=netdata \
143
netdata/netdata
144
```
145
174
-For more information about running Netdata in Docker, check the [docker installation page](/packaging/docker/README.md).
175
-
176
-
177
-
178
-From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read
179
-more about the information collected and how to opt-out, check the [anonymous statistics
180
-page](/docs/anonymous-statistics.md).
181
-
182
-## Why Netdata
183
-
184
-Netdata has a quite different approach to monitoring.
185
-
186
-Netdata is a monitoring agent you install on all your systems. It is:
187
-
188
-- A **metrics collector** for system and application metrics (including web servers, databases, containers, and much
189
- more),
190
-- A **long-term metrics database** that stores recent metrics in memory and "spills" historical metrics to disk for
191
- efficient long-term storage,
192
-- A super fast, interactive, and modern **metrics visualizer** optimized for anomaly detection,
193
-- And an **alarms notification engine** for detecting performance and availability issues.
194
-
195
-All the above, are packaged together in a very flexible, extremely modular, distributed application.
196
-
197
-This is how Netdata compares to other monitoring solutions:
198
-
199
-| Netdata | others (open-source and commercial) |
200
-| :-------------------------------------------------------------- | :--------------------------------------------------------------- |
201
-| **High resolution metrics** (1s granularity) | Low resolution metrics (10s granularity at best) |
202
-| Monitors everything, **thousands of metrics per node** | Monitor just a few metrics |
203
-| UI is super fast, optimized for **anomaly detection** | UI is good for just an abstract view |
204
-| **Long-term, autonomous storage** at one-second granularity | Centralized metrics in an expensive data lake at 10s granularity |
205
-| **Meaningful presentation**, to help you understand the metrics | You have to know the metrics before you start |
206
-| Install and get results **immediately** | Long preparation is required to get any useful results |
207
-| Use it for **troubleshooting** performance problems | Use them to get _statistics of past performance_ |
208
-| **Kills the console** for tracing performance issues | The console is always required for troubleshooting |
209
-| Requires **zero dedicated resources** | Require large dedicated resources |
210
-
211
-Netdata is **open-source**, **free**, super **fast**, very **easy**, completely **open**, extremely **efficient**,
212
-**flexible** and integrate-able.
213
-
214
-It has been designed by **system administrators**, **DevOps engineers**, and **developers** for to not just visualize
215
-metrics, but also troubleshoot complex performance problems.
216
-
217
-## News
218
-
219
-`August 10, 2020`- **[Netdata v1.24.0 released!](https://github.com/netdata/netdata/releases/tag/v1.24.0)**
220
-
221
-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.
222
-
223
-`July 16, 2020` - **[Netdata v1.23.2 released!](https://github.com/netdata/netdata/releases/tag/v1.23.2)**
224
-
225
-Release v1.23.2 of the Netdata Agent is a patch for one significant issue.
226
-
227
-PR [#9491](https://github.com/netdata/netdata/pull/9491) fixed a buffer overrun vulnerability in Netdata's JSON parsing
228
-code. This vulnerability could be used to crash Agents remotely, and in some circumstances, could be used in an
229
-arbitrary code execution (ACE) exploit.
230
-
231
-We strongly encourage all Netdata users to update their nodes to v1.23.2 as soon as possible.
232
-
233
-This release also contains additional bug fixes and improvements.
234
-
235
-`July 1, 2020` - **[Netdata v1.23.1 released!](https://github.com/netdata/netdata/releases/tag/v1.23.1)**
236
-
237
-Release v1.23.1 of the Netdata Agent is a patch for two significant issues.
238
-
239
-PR [#9436](https://github.com/netdata/netdata/pull/9436) fixed an issue where dimensions were marked obsolete and
240
-archived simultaneously, which caused segmentation faults. We're grateful to [marioem](https://github.com/marioem), who
241
-first reported the issue, and other members of the Netdata community who contributed their insights and valuable log
242
-information, which we used to diagnose and fix the bug.
243
-
244
-PR [#9428](https://github.com/netdata/netdata/pull/9428) fixed a significant issue with duplicate alarm IDs, which
245
-caused issues in how alarms were sent and displayed in Netdata Cloud.
146
+To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`.
147
247
-This release also contains a few additional bug fixes that were not fully reviewed before the release of v1.23.0.
148
+### Other operating systems
149
249
-`June 24, 2020` - **[Netdata v1.23.0 released!](https://github.com/netdata/netdata/releases/tag/v1.23.0)**
150
+See our documentation for [additional operating
151
+systems](/packaging/installer/README.md#have-a-different-operating-system-or-want-to-try-another-method), including
152
+[Kubernetes](/packaging/installer/methods/kubernetes.md), [`.deb`/`.rpm`
153
+packages](/packaging/installer/methods/packages.md), and more.
154
251
-The v1.23.0 release of the Netdata Agent is all about unlocking new depths of visibility for your applications,
252
-services, and systems. We have Kubernetes service discovery, new eBPF metrics like virtual filesystem switch and
253
-bandwidth per process out of the Linux kernel at _event frequency_, more interoperability with your monitoring stack
254
-thanks to a new exporting engine, and much more.
155
+### Post-installation
156
256
-This release contains 2 new collectors, 1 new exporting connector, 1 new alarm notification method, 55 improvements, 45
257
-documentation updates, and 40 bug fixes.
258
-
259
-Our [service discovery collector](https://github.com/netdata/agent-service-discovery/) **detects Kubernetes (k8s) pods
260
-and immediately collects metrics from _22 different services_** as the associated pods are created, destroyed, and
261
-scaled. Service discovery is installed when you use our [Helm chart](https://github.com/netdata/helmchart), which means
262
-you can now collect and visualize service-, pod-, Kubelet-, kube-proxy-, and node-level k8s metrics with one `helm
263
-install` command and zero configuration. All our Kubernetes monitoring components are open source and free for clusters
264
-of any size.
265
-
266
-Our low-level [Linux kernel monitoring via eBPF](https://learn.netdata.cloud/docs/agent/collectors/ebpf.plugin/) is now
267
-supercharged. Thanks to an integration with
268
-[`apps.plugin`](https://learn.netdata.cloud/docs/agent/collectors/apps.plugin), you can now **monitor how a specific
269
-application interacts with the Linux kernel**. This update also includes new metrics, such as virtual filesystem switch,
270
-bandwidth per process, and much more. Netdata collects these metrics at an event frequency, even better than our famous
271
-1s granularity, so that you can debug applications or anomalies with pinpoint accuracy. The eBPF collector is also now
272
-installed and enabled by default except on [static
273
-builds](https://learn.netdata.cloud/docs/agent/packaging/installer/methods/kickstart-64).
274
-
275
-Read our [guide on troubleshooting apps with eBPF
276
-metrics](https://learn.netdata.cloud/guides/troubleshoot/monitor-debug-applications-ebpf/) for more details.
277
-
278
-Netdata is now more interoperable with your existing monitoring stack thanks to the [**exporting
279
-engine**](https://learn.netdata.cloud/docs/agent/exporting/), which replaces the backends system. You can now export to
280
-multiple external databases through Graphite, Google Cloud Pub/Sub, Prometheus remote write, MongoDB, and JSON
281
-connectors, plus others. Send metrics as soon as they're collected to enrich single pane of glass views or analyze
282
-Netdata's metrics with machine learning.
283
-
284
-Read our guide on [exporting metrics to
285
-Graphite](https://learn.netdata.cloud/guides/export/export-netdata-metrics-graphite) for specifics on just one of many
286
-pipelines you can set up to archive your Netdata metrics.
287
-
288
-We're also releasing an improvement for the availability of your monitoring and metrics: **persistent metadata**. The
289
-Agent now writes metadata to disk alongside metrics to allow access to non-active charts from Netdata Cloud and enable
290
-future features.
291
-
292
-We added some enhancements to our documentation site, including a new [guides
293
-section](https://learn.netdata.cloud/guides). We'll continue to populate with more use case- and scenario-based content
294
-to help you monitor, troubleshoot, visualize, and export your Netdata metrics.
295
-
296
----
297
-
298
-See more news and previous releases at our [blog](https://www.netdata.cloud/blog/) or our [releases
299
-page](https://github.com/netdata/netdata/releases).
157
+When you're finished with installation, check out our
158
+[single-node](https://learn.netdata.cloud/docs/quickstart/single-node) or
159
+[infrastructure](https://learn.netdata.cloud/docs/quickstart/infrastructure) monitoring quickstart guides based on your
160
+use case. Then, see our [documentation](https://learn.netdata.cloud/docs) for the full picture.
161
162
## How it works
163
164
Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for
165
concurrent operations on the metrics.
166
306
-
307
-
308
-This is how it works:
309
-
310
-| Function | Description | Documentation |
311
-| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |
312
-| **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) |
313
-| **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) |
314
-| **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) |
315
-| **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) |
316
-| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`exporting`](/docs/export/external-databases.md) |
317
-| **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) |
167
+
169
170
The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric.
171
172
## Infographic
173
323
-This is a high level overview of Netdata feature set and architecture. Click it to to interact with it (it has direct
324
-links to our documentation).
325
-
326
-[](https://my-netdata.io/infographic.html)
327
-
328
-## Features
329
-
330
-
331
-
332
-This is what you should expect from Netdata:
333
-
334
-### General
335
-
336
-- **1s granularity** - The highest possible resolution for all metrics.
337
-- **Unlimited metrics** - Netdata collects all the available metrics—the more, the better.
338
-- **1% CPU utilization of a single core** - It's unbelievably optimized.
339
-- **A few MB of RAM** - The highly-efficient database engine stores per-second metrics in RAM and then "spills"
340
- historical metrics to disk long-term storage.
341
-- **Minimal disk I/O** - While running, Netdata only writes historical metrics and reads `error` and `access` logs.
342
-- **Zero configuration** - Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the
343
- box.
344
-- **Zero maintenance** - You just run it. Netdata does the rest.
345
-- **Zero dependencies** - Netdata runs a custom web server for its static web files and its web API (though its
346
- plugins may require additional libraries, depending on the applications monitored).
347
-- **Scales to infinity** - You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not
348
- centralized by default, so there is no limit.
349
-- **Several operating modes** - Autonomous host monitoring (the default), headless data collector, forwarding proxy,
350
- store and forward proxy, central multi-host monitoring, in all possible configurations. Each node may have different
351
- metrics retention policies and run with or without health monitoring.
352
-
353
-### Health Monitoring & Alarms
354
-
355
-- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic
356
- thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more.
357
-- **Notifications**: [alerta.io](/health/notifications/alerta/), [amazon sns](/health/notifications/awssns/),
358
- [discordapp.com](/health/notifications/discord/), [email](/health/notifications/email/),
359
- [flock.com](/health/notifications/flock/), [hangouts](/health/notifications/hangouts/),
360
- [irc](/health/notifications/irc/), [kavenegar.com](/health/notifications/kavenegar/),
361
- [messagebird.com](/health/notifications/messagebird/), [pagerduty.com](/health/notifications/pagerduty/),
362
- [prowl](/health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/),
363
- [pushover.net](/health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/),
364
- [slack.com](/health/notifications/slack/), [smstools3](/health/notifications/smstools3/),
365
- [syslog](/health/notifications/syslog/), [telegram.org](/health/notifications/telegram/),
366
- [twilio.com](/health/notifications/twilio/), [web](/health/notifications/web/) and [custom
367
- notifications](/health/notifications/custom/).
368
-
369
-### Integrations
370
-
371
-- **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS
372
- Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting
373
- these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which
374
- allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**,
375
- **Splunk**, **VictoriaMetrics** and a lot of other [storage
376
- providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage).
377
-
378
-## Visualization
379
-
380
-- **Stunning interactive dashboards** - Our dashboard is mouse-, touchpad-, and touch-screen friendly in 2 themes:
381
- `slate` (dark) and `white`.
382
-- **Amazingly fast visualization** - Even on low-end hardware, the dashboard responds to all queries in less than 1 ms
383
- per metric.
384
-- **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect
385
- anomalies visually.
386
-- **Embeddable** - Charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence
387
- as a monitoring dashboard](/web/gui/confluence/README.md).
388
-- **Customizable** - You can build custom dashboards using simple HTML. No JavaScript needed!
389
-
390
-### Positive and negative values
391
-
392
-To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`,
393
-`inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.
394
-
395
-
174
+This is a high-level overview of Netdata features and architecture. Click on it to view an interactive version, which
175
+has links to our documentation.
176
398
-_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is
399
-negative._
400
-
401
-### Autoscaled y-axis
402
-
403
-Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame.
404
-
405
-
407
-
408
-_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is
409
-selected._
410
-
411
-### Charts are synchronized
412
-
413
-Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed
414
-at any time, and all other charts will follow.
415
-
416
-
418
-
419
-_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the
420
-mouse pointer is over a chart._
421
-
422
-### Highlighted time-frame
423
-
424
-To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse
425
-selection`) on all charts.
426
-
427
-
429
-
430
-_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the
431
-same range on all charts._
432
-
433
-## What Netdata monitors
434
-
435
-Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics
436
-jocs, such as CPU, memory, disks, filesystems, networking, and more. We call these **collectors**, and they're managed
437
-by [**plugins**](/collectors/plugins.d/README.md), which support a variety of programming languages, including Go and
438
-Python.
439
-
440
-Popular collectors include **Nginx**, **Apache**, **MySQL**, **statsd**, **cgroups** (containers, Docker, Kubernetes,
441
-LXC, and more), **Traefik**, **web server `access.log` files**, and much more.
442
-
443
-See the **full list of [supported collectors](/collectors/COLLECTORS.md)**.
444
-
445
-Netdata's data collection is **extensible**, which means you can monitor anything you can get a metric for. You can even
446
-write a collector for your custom application using our [plugin API](/collectors/plugins.d/README.md).
177
+[](https://my-netdata.io/infographic.html)
179
180
## Documentation
181
450
-The Netdata documentation is at <https://docs.netdata.cloud>, but you can also find each page inside of Netdata's
451
-repository itself in Markdown (`.md`) files. You can find all our documentation by navigating the repository.
452
-
453
-Here is a quick list of notable documents:
454
-
455
-| Directory | Description |
456
-| :---------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- |
457
-| [`installer`](/packaging/installer/README.md) | Instructions to install Netdata on your systems. |
458
-| [`docker`](/packaging/docker/README.md) | Instructions to install Netdata using docker. |
459
-| [`daemon`](/daemon/README.md) | Information about the Netdata daemon and its configuration. |
460
-| [`collectors`](/collectors/README.md) | Information about data collection plugins. |
461
-| [`health`](/health/README.md) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. |
462
-| [`streaming`](/streaming/README.md) | How to build hierarchies of Netdata servers, by streaming metrics between them. |
463
-| [`exporting`](/docs/export/external-databases.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
464
-| [`web/api`](/web/api/README.md) | Learn how to query the Netdata API and the queries it supports. |
465
-| [`web/api/badges`](/web/api/badges/README.md) | Learn how to generate badges (SVG images) from live data. |
466
-| [`web/gui/custom`](/web/gui/custom/README.md) | Learn how to create custom Netdata dashboards. |
467
-| [`web/gui/confluence`](/web/gui/confluence/README.md) | Learn how to create Netdata dashboards on Atlassian's Confluence. |
182
+Netdata's documentation is available at [**Netdata Learn**](https://learn.netdata.cloud).
183
469
-You can also check all the other directories. Most of them have plenty of documentation.
184
+This site also hosts a number of [guides](https://learn.netdata.cloud/guides) to help newer users better understand how
185
+to collect metrics, troubleshoot via charts, export to external databases, and more.
186
187
## Community
188
473
-We recently launched the [Netdata Community](https://community.netdata.cloud). You can find most of us there! It's also a good place to ask questions, find resources, or learn what features or fixes we are working on next.
474
-
475
-We welcome [contributions](/CONTRIBUTING.md). Feel free to join the team!
476
-
477
-To report bugs or get help, use [GitHub's issues](https://github.com/netdata/netdata/issues).
189
+You can find most of the Netdata team in our [community forum](https://community.netdata.cloud). It's the best place to
190
+ask questions, find resources, and get to know the Netdata team.
191
192
You can also find Netdata on:
193
@@ -484,11 +197,20 @@ You can also find Netdata on:
197
- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/)
198
- [Repology](https://repology.org/metapackage/netdata/versions)
199
487
-## License
200
+## Contribute
201
489
-Netdata is [GPLv3+](/LICENSE).
202
+We welcome [contributions](/CONTRIBUTING.md) to our code and to our
203
+[documentation](/docs/contributing/contributing-documentation.md). Feel free to join the team!
204
491
-Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](/REDISTRIBUTED.md).
205
+To report bugs or get help, use [GitHub's issues](https://github.com/netdata/netdata/issues).
206
+
207
+Package maintainers should read the guide on [building Netdata from source](/packaging/installer/methods/source.md) for
208
+instructions on building each Netdata component from source and preparing a package.
209
+
210
+## License
211
+
212
+The Netdata Agent is [GPLv3+](/LICENSE). Netdata re-distributes other open-source tools and libraries. Please check the
213
+[third party licenses](/REDISTRIBUTED.md).
214
215
## Is it any good?
216
@@ -501,7 +223,3 @@ _When people first hear about a new product, they frequently ask if it is any go
223
> the answer shall be “yes.".
224
225
So, we follow the tradition...
504
-
505
-## Is it awesome?
506
-
507
-[These people](https://github.com/netdata/netdata/stargazers) seem to like it.