Update README.md (#15044)
Costa Tsaousis committed
Jul 15, 2023 at 17:15 UTC
f0a56c507e3a936bfeef797af78eb9b937840a22
1 file changed
+181
-148
README.md
+181
-148
@@ -1,6 +1,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">Netdata is high-fidelity infrastructure monitoring and troubleshooting.<br />Open-source, free, preconfigured, opinionated, and always real-time.</h3>
3
+<h3 align="center">Monitor your servers, containers, and applications, in high-resolution and in real-time.</h3>
4
+
5
<br />
6
<p align="center">
7
<a href="https://github.com/netdata/netdata/"><img src="https://img.shields.io/github/stars/netdata/netdata?style=social" alt="GitHub Stars"></a>
@@ -15,208 +16,240 @@
16
</p>
17
<hr class="solid">
18
19
+Netdata collects metrics per-second and presents them in beatiful low-latency dashboards. It is designed to run on all your physical and virtual servers, cloud deployments, kubernetes clusters and edge/IoT devices, to monitor everything you run.
20
+
21
+- :boom: **Collects metrics from 800+ integrations**<br/>
22
+ Operating system metrics, container metrics, virtual machines, hardware sensors, applications metrics, OpenMetrics exporters, StatsD and logs.
23
+
24
+- :muscle: **Real-Time, Low-Latency, High-Resolution**<br/>
25
+ All metrics are collected per-second, and are on the dashboard immediately after data collection. Netdata is designed to be fast.
26
+
27
+- :face_in_clouds: **Unsupervised Anomaly Detection (ML)**<br/>
28
+ Trains multiple ML models for each metric collected and detects anomalies based on the past behavior of each metric individually.
29
+
30
+- :fire: **Powerful Visualization**<br/>
31
+ Clear and precise visualuzation that allows you to quickly understand any dataset, but also to filter, slice and dice the data directly on the dashboard, without the need to learn any query language.
32
+
33
+- :bell: **Out of box Alerts**<br/>
34
+ Comes with hundreds of alerts out of the box to detect common issues and pitfalls, revealing issues that can easily go unnoticed.
35
+
36
+- :sunglasses: **Low Maintenance**<br/>
37
+ Fully automated in every aspect: automated dashboards, out of the box alerts, auto-detection and auto-discovery of metrics, easy configuration.
38
+
39
+- :star: **Open and Extensible**<br/>
40
+ Netdata is a modular platform that can be extented in all possible ways and it also integrates nicely with other monitoring solutions.
41
+
42
<p align="center">
19
- Netdata is a member of the Cloud Native Computing Foundation (CNCF), and it is the 3rd most starred project in the <a href="https://landscape.cncf.io/card-mode?grouping=no&sort=stars">CNCF landscape</a>
20
- <br />
43
<img src="https://raw.githubusercontent.com/cncf/artwork/master/other/cncf/horizontal/white/cncf-white.svg" alt="CNCF" width="300">
44
+ <br />
45
+ Netdata actively supports and is a member of the Cloud Native Computing Foundation (CNCF)<br />
46
+ <br/>
47
+ ...and due to your love :heart:, it is the 3rd most :star:'d project in the <a href="https://landscape.cncf.io/card-mode?grouping=no&sort=stars">CNCF landscape</a>!
48
</p>
49
24
-<img src="https://user-images.githubusercontent.com/1153921/95269366-1b814680-07ee-11eb-8ff4-c1b0b8758499.png" alt="---" style="max-width: 100%;" />
50
+<hr class="solid">
51
26
-Netdata is a distributed, real-time, performance and health monitoring platform for systems, hardware, containers and applications, collecting thousands of useful metrics with zero configuration needed. It runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices, and is perfectly safe to install on your systems mid-incident without any preparation.
52
+
53
28
-The Netdata [Agent](https://github.com/netdata/netdata) is an enormously powerful, **Open-Sourced**, **Single Node** health monitoring and performance troubleshooting tool.
29
-It gives you the ability to automatically identify processes, collect and store metrics locally and even more - visualize all metrics without any configuration (of course you can tweak it later on if you need).
54
+<hr class="solid">
55
31
-[Netdata Cloud](https://www.netdata.cloud) is a hosted web interface that gives you **Free**, real-time visibility into your **Entire Infrastructure** with secure access to your Netdata Agents. It provides an ability to automatically route your requests to the most relevant agents to display your metrics, based on the stored metadata (Agents topology, what metrics are collected on specific Agents as well as the retention information for each metric).
56
+> :bulb: **Important Note**<br/>
57
+> People get addicted to Netdata. **Once you use it on your systems, there's no going back!**<br/>
58
+> _You have been warned..._<br/>
59
33
-It gives you some extra features, like [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md), [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.md), [anomaly rates on every chart](https://blog.netdata.cloud/anomaly-rate-in-every-chart/) and much more.
60
+<hr class="solid">
61
35
-Try it for yourself right now by checking out the Netdata Cloud [demo space](https://app.netdata.cloud/spaces/netdata-demo/rooms/all-nodes/overview) (No sign up or login needed).
62
+## Quick Start
63
37
-Netdata's mission is to help more people troubleshoot ever more complex IT infrastructures, this is why our **free** [community plan](https://www.netdata.cloud/pricing) gives you ability to monitor unlimited number of Nodes, Containers and Metrics (custom or built-in).
64
+<p align="center">
65
+ <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&options=unaligned&v44" alt="User base"></a>
66
+ <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&options=unaligned&v44" alt="Servers monitored"></a>
67
+ <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&options=unaligned&v44" alt="Sessions served"></a>
68
+ <a href="https://hub.docker.com/r/netdata/netdata"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=dockerhub.pulls_sum÷=1000000&precision=1&units=M&label=docker+hub+pulls&options=unaligned&v44" alt="Docker Hub pulls"></a>
69
+ <br />
70
+ <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&options=unaligned&v44" alt="New users today"></a>
71
+ <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&v44" alt="New machines today"></a>
72
+ <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&v44" alt="Sessions today"></a>
73
+ <a href="https://hub.docker.com/r/netdata/netdata"><img src="https://registry.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&options=unaligned&v44" alt="Docker Hub pulls today"></a>
74
+</p>
75
39
-Due to the distributed nature of Netdata, and to ensure high-availability of your monitoring system, please check our [Data Replication](https://www.netdata.cloud/blog/why-is-data-replication-important) recommendations to increase the data availability.
76
+### 1. **Install Netdata Agents everywhere** :v:
77
+
78
+ Netdata can be installed on all Linux, MacOS and FreeBSD systems. We provide binary packages for the most popular operating systems and package managers.
79
41
-You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container platforms (Kubernetes
42
-clusters, Docker), and many other operating systems (FreeBSD, macOS). No `sudo` required.
80
+ - Install on [Ubuntu, Debiam CentOS, Arch, Alpine, Gentoo](https://learn.netdata.cloud/docs/installing/one-line-installer-for-all-linux-systems).
81
+ - Install with [Docker](https://learn.netdata.cloud/docs/installing/docker). Netdata is a [Verified Publisher on DockerHub](https://hub.docker.com/r/netdata/netdata) and our users enjoy free unlimited DockerHub pulls :heart_eyes:.
82
+ - Install on [MacOS](https://learn.netdata.cloud/docs/installing/macos) :metal:.
83
+ - Install on [FreeBSD](https://learn.netdata.cloud/docs/installing/freebsd) and [pfSense](https://learn.netdata.cloud/docs/installing/pfsense).
84
+ - Install [from source](https://learn.netdata.cloud/docs/installing/build-the-netdata-agent-yourself/compile-from-source-code)
85
+ - For Kubernetes deployments [check here](https://learn.netdata.cloud/docs/installation/install-on-specific-environments/kubernetes/).
86
44
-Netdata is designed by system administrators, DevOps engineers, and developers to collect everything, help you visualize
45
-metrics, troubleshoot complex performance problems, and make data interoperable with the rest of your monitoring stack.
87
+### 2. **Configure Collectors** :boom:
88
47
-People get addicted to Netdata. Once you use it on your systems, there's no going back! _You've been warned..._
89
+ Netdata auto-detects and auto-discovers most operating system data sources and applications. However, many data sources require some manual configuration, usually to allow Netdata get access to the metrics.
90
+
91
+ - For a detailed list of all data collectors, check [this guide](https://learn.netdata.cloud/docs/data-collection/).
92
+ - To monitor Windows servers and applications use [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/system-metrics/windows-machines).
93
+ - To monitor SNMP devices check [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/networking/snmp).
94
49
-
95
+### 3. **Configure Netdata Parents** :family:
96
52
-## Menu
97
+ A Netdata Parent is a Netdata Agent that has been configured to accept [streaming connections](https://learn.netdata.cloud/docs/streaming/streaming-configuration-reference) from other Netdata agents.
98
+
99
+ Netdata Parents provide:
100
54
-- [Features](#features)
55
-- [Get Netdata](#get-netdata)
56
- - [Infrastructure view](#infrastructure-view)
57
- - [Single node view](#single-node-view)
58
- - [Docker](#docker)
59
- - [Other operating systems](#other-operating-systems)
60
- - [Post-installation](#post-installation)
61
- - [Netdata Cloud](#netdata-cloud)
62
-- [How it works](#how-it-works)
63
-- [Infographic](#infographic)
64
-- [Documentation](#documentation)
65
-- [Community](#community)
66
-- [Contribute](#contribute)
67
-- [License](#license)
68
-- [Is it any good?](#is-it-any-good)
101
+ - Infrastructure level dashboards, at `http://parent.server.ip:19999/`
102
+ - Increased retention for all metrics of all your nodes
103
+ - Central configuration of alerts and dispatch of notifications
104
70
-## Features
105
+ You can also use Netdata Parents to:
106
72
-
107
+ - Offload your production systems (the parents runs ML, alerts, queries, etc for all its children)
108
+ - Secure your production systems (the parents accept user connections, for all its children)
109
75
-Here's what you can expect from Netdata:
110
+### 4. **Connect your Parents to Netdata Cloud** :cloud:
111
77
-- **1s granularity**: The highest possible resolution for all metrics.
78
-- **Unlimited metrics**: Netdata collects all the available metrics—the more, the better.
79
-- **1% CPU utilization of a single core**: It's unbelievably optimized.
80
-- **A few MB of RAM**: The highly-efficient database engine stores per-second metrics in RAM and then "spills"
81
- historical metrics to disk long-term storage.
82
-- **Minimal disk I/O**: While running, Netdata only writes historical metrics and reads `error` and `access` logs.
83
-- **Zero configuration**: Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the
84
- box.
85
-- **Zero maintenance**: You just run it. Netdata does the rest.
86
-- **Stunningly fast, interactive visualizations**: The dashboard responds to queries in less than 1ms per metric to
87
- synchronize charts as you pan through time, zoom in on anomalies, and more.
88
-- **Visual anomaly detection**: Our UI/UX emphasizes the relationships between charts to help you detect the root
89
- cause of anomalies.
90
-- **Machine learning (ML) features out of the box**: Unsupervised ML-based [anomaly detection](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.md), every second, every metric, zero-config! [Metric correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to help with short-term change detection. And other [additional](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/anomaly-detection.md) ML-based features to help make your life easier.
91
-- **Scales to infinity**: You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not
92
- centralized by default, so there is no limit.
93
-- **Several operating modes**: Autonomous host monitoring (the default), headless data collector, forwarding proxy,
94
- store and forward proxy, central multi-host monitoring, in all possible configurations. Use different metrics
95
- retention policies per node and run with or without health monitoring.
112
+ Optionally, sign-up to Netdata Cloud and claim your Netdata Parents.
113
+
114
+ When your parents are connected to Netdata Cloud, you can (on top of the above):
115
97
-Netdata works with tons of applications, notifications platforms, and other time-series databases:
116
+ - Organize your infra in spaces and rooms
117
+ - Create, manage and share **custom dashboards**
118
+ - Invite your team and assign roles to them (Role Based Access Control - RBAC)
119
+ - Access Netdata Functions (processes top from the UI and more)
120
+ - Get infinite horizontal scalability (multiple independent parents are viewed as one infra)
121
+ - Centrally configure alerts (coming soon)
122
+ - Centrally configure data collection (coming soon)
123
+ - Netdata Mobile App notifications (coming soon)
124
99
-- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
100
- immediately visualize them into meaningful charts designed for troubleshooting. See [everything we
101
- support](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
102
-- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
103
- platform](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to inform you of anomalies just seconds
104
- after they affect your node.
105
-- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
106
- Cloud-based databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) for best-in-class
107
- interoperability.
125
+ :love_you_gesture: Netdata Cloud does not prevent you from using your Netdata Agents and Parents directly, and vice versa.<br/>
126
+ :ok_hand: Your metrics are still stored in your network when you connect your Netdata Agents and Parent to Netdata Cloud.
127
109
-> 💡 **Want to leverage the monitoring power of Netdata across entire infrastructure**? View metrics from
110
-> any number of distributed nodes in a single interface and unlock even more
111
-> [features](https://github.com/netdata/netdata/blob/master/docs/overview/why-netdata.md) with [Netdata
112
-> Cloud](https://learn.netdata.cloud/docs/overview/what-is-netdata#netdata-cloud).
128
+## How it works
129
114
-## Get Netdata
130
+Netdata is built around a **modular metrics processing pipeline**.
131
116
-<p align="center">
117
- <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&options=unaligned&v44" alt="User base"></a>
118
- <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&options=unaligned&v44" alt="Servers monitored"></a>
119
- <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&options=unaligned&v44" alt="Sessions served"></a>
120
- <a href="https://hub.docker.com/r/netdata/netdata"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=dockerhub.pulls_sum÷=1000000&precision=1&units=M&label=docker+hub+pulls&options=unaligned&v44" alt="Docker Hub pulls"></a>
121
- <br />
122
- <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&options=unaligned&v44" alt="New users today"></a>
123
- <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&v44" alt="New machines today"></a>
124
- <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&v44" alt="Sessions today"></a>
125
- <a href="https://hub.docker.com/r/netdata/netdata"><img src="https://registry.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&options=unaligned&v44" alt="Docker Hub pulls today"></a>
126
-</p>
132
+Each Netdata Agent can perform the following functions:
133
128
-### Infrastructure view
134
+1. **COLLECT**<br/>
135
+ Uses [internal](https://github.com/netdata/netdata/tree/master/collectors) and [external](https://github.com/netdata/go.d.plugin/tree/master/modules) plugins to collect data from their sources.
136
130
-Due to the distributed nature of the Netdata ecosystem, it is recommended to setup not only one Netdata Agent on your production system, but also an additional Netdata Agent acting as a [Parent](https://github.com/netdata/netdata/blob/master/streaming/README.md). A local Netdata Agent (child), without any database or alarms, collects metrics and sends them to another Netdata Agent (parent). The same parent can collect data for any number of child nodes and serves as a centralized health check engine for each child by triggering alerts on their behalf.
137
+ Netdata auto-detects and collects almost everything from the operating system: including CPU, Interrupts, Memory, Disks, Mount Points, Filesystems, Network Stack, Network Interfaces, Containers, VMs, Processes, SystemD Units, Linux Performance Metrics, Linux eBPF, Hardware Sensors, IPMI, and more.
138
132
-
139
+ It collects application metrics from applications: postgresql, mysql/mariadb, redis, mongodb, nginx, apache, and hundreds more.
140
134
-Get started by [signing in](https://app.netdata.cloud/?utm_source=website&utm_content=top_navigation_sign_up) to Netdata.cloud and follow the setup guide.
141
+ Netdata also collects your custom application metrics by scraping OpenMetrics exporters, or via StatsD.
142
136
-Community version is free to use forever. No restriction on number of nodes, clusters or metrics. Unlimited alerts.
143
+ It can convert web server log files to metrics and apply ML and alerts to them, in real-time.
144
138
-#### Claiming existing Agents
145
+ And it also supports synthetic tests / white box tests, so you can ping servers, check API responses, or even check filesystem files and directories to generate metrics, train ML and run alerts and notifications on their status.
146
+
147
+3. **STORE**<br/>
148
+ Uses database engine plugins to store the collected data, either in memory and/or on disk. We have developed our own [`dbengine`](https://github.com/netdata/netdata/tree/master/database/engine#readme) for storing the data in a very efficient manner, allowing Netdata to have less than 1 byte per sample on disk and amazingly fast queries.
149
+
150
+4. **LEARN** (ML)<br/>
151
+ Trains multiple Machine-Learning (ML) models per metric to learn the behavior of each metric individually.
152
+
153
+5. **DETECT** (ML)<br/>
154
+ Uses the trained machine learning (ML) models to detect outliers and mark collected samples as **anomalies**. Netdata stores anomaly information together with each sample and also streams it to Netdata Parents, so that the anomaly is also available at query time for the whole retention of each metric.
155
140
-You can easily [connect (claim)](https://github.com/netdata/netdata/blob/master/claim/README.md) your existing Agents to the Cloud to unlock features for free and to find weaknesses before they turn into outages.
156
+6. **CHECK**<br/>
157
+ Uses its configured alerts to check the metrics for common issues and send alert notifications.
158
142
-### Single Node view
159
+7. **STREAM**<br/>
160
+ Push metrics in real-time to Netdata Parents.
161
144
-In case you do not need the infrastructure view of you system you can install standalone Agent and enjoy the local dashboard.
162
+8. **ARCHIVE**<br/>
163
+ Export metrics to industry standard time-series databases, like `prometheus`, `influxdb`, `opentsdb`, `graphite`, etc.
164
146
-To install Netdata from source on most Linux systems (physical, virtual, container, IoT, edge), run our [one-line
147
-installation script](https://learn.netdata.cloud/docs/agent/packaging/installer/methods/packages). This script downloads
148
-and builds all dependencies, including those required to connect to [Netdata Cloud](https://netdata.cloud/cloud) if you
149
-choose, and enables [automatic nightly
150
-updates](https://learn.netdata.cloud/docs/agent/packaging/installer#nightly-vs-stable-releases) and [anonymous
151
-statistics](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md).
152
-<!-- candidate for reuse -->
153
-```bash
154
-wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
155
-```
165
+9. **QUERY**<br/>
166
+ Provide an API to query the data and present interactive dashboards to users.
167
157
-To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`.
168
+When using Netdata Parents, all the functions of a Netdata Agent (except data collection) can be delegated to Parents to offload production systems.
169
159
-### Docker
170
161
-You can also try out Netdata's capabilities in a [Docker
162
-container](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md):
171
+## FAQ
172
164
-```bash
165
-docker run -d --name=netdata \
166
- -p 19999:19999 \
167
- -v netdataconfig:/etc/netdata \
168
- -v netdatalib:/var/lib/netdata \
169
- -v netdatacache:/var/cache/netdata \
170
- -v /etc/passwd:/host/etc/passwd:ro \
171
- -v /etc/group:/host/etc/group:ro \
172
- -v /proc:/host/proc:ro \
173
- -v /sys:/host/sys:ro \
174
- -v /etc/os-release:/host/etc/os-release:ro \
175
- --restart unless-stopped \
176
- --cap-add SYS_PTRACE \
177
- --security-opt apparmor=unconfined \
178
- netdata/netdata
179
-```
173
+### :shield: Is this secure?
174
181
-To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`.
175
+Of course it is! We give our best for it to be!
176
183
-### Other operating systems
177
+We understand that Netdata is a software piece that is installed on millions of production systems across the world. So, it is important for us, Netdata to be as secure as possible:
178
185
-See our documentation for [additional operating
186
-systems](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#have-a-different-operating-system-or-want-to-try-another-method), including
187
-[Kubernetes](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md), [`.deb`/`.rpm`
188
-packages](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md#native-packages), and more.
179
+ - We follow the [Open Source Security Foundation](https://bestpractices.coreinfrastructure.org/en/projects/2231) best practices.
180
+ - We have given great attention to detail when it comes to security design. Check out our [security design](https://learn.netdata.cloud/docs/architecture/security-and-privacy-design).
181
+ - Netdata is a popular open source project and is frequently tested by many security analysts.
182
+ - Check also our [security polices and advisories published so far](https://github.com/netdata/netdata/security).
183
190
-### Post-installation
184
+### :cyclone: Will this consume a lot of resources on my servers?
185
192
-When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
193
-[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
186
+No. It will not! We promise this will be fast!
187
195
-Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
188
+Although each Netdata Agent is a complete monitoring solution packed into a single application, and despite the fact that Netdata collects **every metric every single second** and trains **multiple ML models** per metric, you will find that Netdata has amazing performance! In many cases it outperforms other monitoring solutions that have singificantly less features or far smaller data collection rate.
189
197
-Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
198
-solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
199
-external databases, and more.
190
+This is what you should expect:
191
201
-## How it works
192
+ - For production systems, each Netdata Agent with default settings (everything enabled, ML, Health, DB) should consume about 5% CPU utilization of single core and about 150 MiB or RAM. By using a Netdata parent and streaming all metrics to that parent, you can disable ML, health and use an ephemeral DB mode (like `alloc`) on the children, leading to a utilization of about 1% CPU of a single core and 100 MiB of RAM. Of course, these depend on how many metrics are collected.
193
+ - For Netdata Parents, for about 1 to 2 million metrics, all collected every second, we suggest a server with 16 cores and 32GB RAM. Less than half of it will be used for data collection and ML. The rest will be available for queries.
194
+
195
+Netdata has extensive internal instrumentation to help us reveal how the resources consumed are used. All these are available at the "Netdata Monitoring" section of the dashboard. Depending on your use case, there are many options to optimize resource consumption.
196
+
197
+Even if you need to run Netdata on extremely weak embedded or IoT systems, you will find that Netdata can be tuned to be very performant.
198
+
199
+### :scroll: How much retention can I have?
200
+
201
+As much as you need!
202
+
203
+Netdata supports **tiering**, to downsample past data and save disk space. With default settings it has 3 tiers:
204
+
205
+ 1. `tier 0`, with high resolution, per-second, data.
206
+ 2. `tier 1`, mid-resolution, per minute, data.
207
+ 3. `tier 2`, low-resolution, per hour, data.
208
+
209
+All tiers are updated in parallel during data collection. Just increase the disk space you give to Netdata to get a longer history for your metrics. Tiers are automatically chosen at query time depending on the time-frame and the resolution requested.
210
+
211
+### :rocket: Does it scale? I have really a lot of servers!
212
+
213
+Yes, of course it does!
214
+
215
+ - :airplane: Netdata Parents provide great vertical scalability, so you can have as big parents as the CPU, RAM and Disk resources you can dedicate to them. In our lab we constantly stress test Netdata Parents with about 2 million metrics collected per second.
216
+ - :rocket: On top of them, Netdata Cloud provides virtually unlimited horizontal scalability, "merging" at query time all the parents you have, into one huge uniform infrastructure. Netdata Cloud itself is probably the biggest single installation monitoring platform ever created, currently monitoring about 100k online servers with about 10k servers changing state (added/removed) per day!
217
+
218
+### :floppy_disk: My production servers are very sensitive in disk I/O. Can I use Netdata?
219
+
220
+Yes, you can!
221
+
222
+We suggest the following:
223
+
224
+ 1. Use database mode `alloc` or `ram` to disable writing metric data to disk.
225
+ 2. Configure streaming to push in real-time all metrics to a Netdata Parent. The Netdata Parent will maintain metrics on disk for this node.
226
+ 3. Disable ML and health on this node. The Netdata Parent will do them for this node.
227
+ 4. Use the Netdata Parent to access the dashboard.
228
+
229
+Using the above, the Netdata Agent on your production system will not need a disk.
230
+
231
+### :cloud: Do I have to subscribe to Netdata Cloud?
232
+
233
+No. But we hope you will find it useful.
234
203
-Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for
204
-concurrent operations on the metrics.
235
+The Netdata Agent dashboard and the Netdata Cloud dashboard are the same. Still Netdata Cloud provides additional features, that the Netdata Agent is not capable of. These include:
236
206
-
237
+ 1. Customizability (custom dashboards and other settings are persisted when you are signed-in to Netdata Cloud)
238
+ 2. Central Configuration of Alerts and Data Collection (coming soon)
239
+ 3. Security (role based access control - RBAC).
240
+ 4. Horizontal Scalability ("blend" multiple independent parents in one uniform infrastructure)
241
+ 5. Central Dispatch of Alert Notifications (even when multiple independent parents are involved)
242
+ 6. Mobile App for Alert Notifications (coming soon)
243
209
-The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric.
244
+So, although it is not required, you can get the most out of your Netdata installation by using Netdata Cloud.
245
211
-## Infographic
246
+### :office: Who uses Netdata?
247
213
-This is a high-level overview of Netdata features and architecture. Click on it to view an interactive version, which
214
-has links to our documentation.
248
+Netdata is a very popular project. By checking [the stargazers on github]([https://github.com/netdata/netdata/](https://github.com/netdata/netdata/stargazers)) you will find people from quite popular companies including: SAP, Qualcomm, IBM, Amazon, Intel, AMD, Unity, Baidu, Cisco, Samsung, Netflix, Facebook and hundreds more.
249
216
-[](https://my-netdata.io/infographic.html)
250
+Netdata is also popular in universities, including New York University, Columbia University, New Jersey University, and dozens more.
251
219
-## Documentation
252
+## :book: Documentation
253
254
Netdata's documentation is available at [**Netdata Learn**](https://learn.netdata.cloud).
255