@cryptotaxi247 / netdata-1 / commits / 10e261314

docs: fix grammar in readme (#18799)

Ilya Mashchenko committed Oct 17, 2024 at 11:18 UTC 10e261314675b073f11eaf4e053e9b174425d5c6
1 file changed +193 -195
README.md
+193 -195
@@ -1,4 +1,3 @@
1 -
1 <p align="center">
2 <a href="https://www.netdata.cloud#gh-light-mode-only">
3 <img src="https://www.netdata.cloud/img/readme-images/netdata_readme_logo_light.png" alt="Netdata" width="300"/>
@@ -7,7 +6,7 @@
6 <img src="https://www.netdata.cloud/img/readme-images/netdata_readme_logo_dark.png" alt="Netdata" width="300"/>
7 </a>
8 </p>
10 -<h3 align="center">Monitor your servers, containers, and applications,<br/>in high-resolution and in real-time.</h3>
9 +<h3 align="center">Monitor your servers, containers, and applications<br/>in high-resolution and in real-time.</h3>
10
11 <br />
12 <p align="center">
@@ -38,36 +37,36 @@ Netdata provides **A.I. insights** for all monitored data, training machine lear
37
38 ### The Netdata Ecosystem
39
41 -Netdata is built on three core components:
42 -
43 -1. **Netdata Agent** (usually called just "Netdata"): This open-source component is the heart of the Netdata ecosystem, handling data collection, storage (embedded database), querying, machine learning, exporting, and alerting of observability data. All observability data and features a Netdata ecosystem offers, are managed by the Netdata Agent. It runs in physical and virtual servers, cloud environments, Kubernetes clusters, and edge/IoT devices and is carefully optimized to have _**zero impact**_ on production systems and applications.
44 -
45 - <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/Netdata%20Agent%20License-GPL%20v3%2B-blue.svg" alt="Netdata Agent License: GPL v3+"></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://scan.coverity.com/projects/netdata-netdata?tab=overview"><img alt="Coverity Scan" src="https://img.shields.io/coverity/scan/netdata"></a>
46 -
47 -2. **Netdata Cloud**: Enhancing the Netdata Agent, Netdata Cloud offers enterprise features such as user management, role-based access control, horizontal scalability, alert and notification management, access from anywhere, and more. Netdata Cloud does **not** centralize or store observability data.
48 -
49 - _Netdata Cloud is a commercial product, available as an on-premises installation, or a SaaS solution, with a free community tier._
50 -
51 -3. **Netdata UI**: The user interface that powers all dashboards, data visualization, and configuration.
52 -
53 - _While closed-source, it is free to use with both Netdata Agents and Netdata Cloud, via their public APIs. It is included in the binary packages offered by Netdata and its latest version is publicly available via a CDN._
54 -
55 - <a href="https://github.com/netdata/netdata/blob/master/src/web/gui/v2/LICENSE.md"><img src="https://img.shields.io/badge/Netdata%20UI%20License%20-NCUL1-blue.svg" alt="Netdata UI License: NCUL1"></a>
56 -
40 +Netdata is built on three core parts:
41 +
42 +1. **Netdata Agent** (usually called just "Netdata"): This open-source component is the heart of the Netdata ecosystem, handling data collection, storage (embedded database), querying, machine learning, exporting, and alerting of observability data. All observability data and features a Netdata ecosystem offers, are managed by the Netdata Agent. It runs in physical and virtual servers, cloud environments, Kubernetes clusters, and edge/IoT devices and is carefully optimized to have _**zero impact**_ on production systems and applications.
43 +
44 + <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/Netdata%20Agent%20License-GPL%20v3%2B-blue.svg" alt="Netdata Agent License: GPL v3+"></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://scan.coverity.com/projects/netdata-netdata?tab=overview"><img alt="Coverity Scan" src="https://img.shields.io/coverity/scan/netdata"></a>
45 +
46 +2. **Netdata Cloud**: Enhancing the Netdata Agent, Netdata Cloud offers enterprise features such as user management, role-based access control, horizontal scalability, alert and notification management, access from anywhere, and more. Netdata Cloud does **not** centralize or store observability data.
47 +
48 + _Netdata Cloud is a commercial product, available as an on-premises installation, or a SaaS solution, with a free community tier._
49 +
50 +3. **Netdata UI**: The user interface that powers all dashboards, data visualization, and configuration.
51 +
52 + _While closed-source, it is free to use with both Netdata Agents and Netdata Cloud, via their public APIs. It is included in the binary packages offered by Netdata, and its latest version is publicly available via CDN._
53 +
54 + <a href="https://github.com/netdata/netdata/blob/master/src/web/gui/v2/LICENSE.md"><img src="https://img.shields.io/badge/Netdata%20UI%20License%20-NCUL1-blue.svg" alt="Netdata UI License: NCUL1"></a>
55 +
56 Netdata scales effortlessly from a single server to thousands, even in complex, multi-cloud or hybrid environments, with the ability to retain data for years.
57
58 ### Key characteristics of the Netdata Agent
59
60 - :boom: **Collects data from 800+ integrations**<br/>
61 Operating system metrics, container metrics, virtual machines, hardware sensors, applications metrics, OpenMetrics exporters, StatsD, and logs. OpenTelemetry is on its way to be included (currently being developed)...
63 -
62 +
63 - :muscle: **Real-Time, Low-Latency, High-Resolution**<br/>
64 All data are collected per second and are made available on the APIs for visualization, immediately after data collection (1-second latency, data collection to visualization).
65
66 - :face_in_clouds: **AI across the board**<br/>
67 Trains multiple Machine-Learning (ML) models at the edge, for each metric collected and uses AI to detect anomalies based on the past behavior of each metric.
68
70 -- :scroll: **systemd-journald Logs**<br/>
69 +- :scroll: **systemd-journald Logs**<br/>
70 Includes tools to efficiently convert plain text log (text, csv, logfmt, json) files to structured systemd-journald entries (`log2journal`, `systemd-cat-native`) and queries systemd-journal files directly enabling powerful logs visualization dashboards. The Netdata Agents eliminate the need to centralize logs and provide all the functions to work with logs directly at the edge.
71
72 - :star: **Lego like, Observability Pipelines**<br/>
@@ -87,7 +86,6 @@ Netdata scales effortlessly from a single server to thousands, even in complex,
86 - :star: **Open and Extensible**<br/>
87 Netdata is a modular platform that can be extended in all possible ways, and it also integrates nicely with other monitoring solutions.
88
90 -
89 ### What can be monitored with the Netdata Agent
90
91 Netdata monitors all the following:
@@ -106,8 +104,8 @@ Netdata monitors all the following:
104 | **VMs** (from the host)<small><br/>KVM, qemu, libvirt, Proxmox, etc</small> | Yes<small><br/>`cgroups`</small> | - | - | Yes<small><br/>`Hyper-V`</small> |
105 | **Synthetic Checks**<small><br/>Test APIs, TCP ports, Ping, Certificates, etc</small> | Yes | Yes | Yes | Yes |
106 | **Packaged Applications**<small><br/>nginx, apache, postgres, redis, mongodb,<br/>and hundreds more</small> | Yes | Yes | Yes | Yes |
109 -| **Cloud Provider Infrastructure**<small><br/>AWS, GCP, Azure, and more</small> | Yes | Yes | Yes | Yes |
110 -| **Custom Applications**<small><br/>OpenMetrics, StatsD and soon OpenTelemetry</small> | Yes | Yes | Yes | Yes |
107 +| **Cloud Provider Infrastructure**<small><br/>AWS, GCP, Azure, and more</small> | Yes | Yes | Yes | Yes |
108 +| **Custom Applications**<small><br/>OpenMetrics, StatsD and soon OpenTelemetry</small> | Yes | Yes | Yes | Yes |
109
110 When the Netdata Agent runs on Linux, it monitors every kernel feature available, providing full coverage of all kernel technologies that can be monitored.
111
@@ -133,10 +131,10 @@ Dec 11, 2023: [University of Amsterdam published a study](https://twitter.com/IM
131 1. **The impact of monitoring on the energy efficiency of Docker-based systems**
132 2. **The impact of monitoring on Docker-based systems?**
133
136 -- 🚀 Netdata excels in energy efficiency: **"... Netdata being the most energy-efficient tool ..."**, as the study says.
137 -- 🚀 Netdata excels in CPU Usage, RAM Usage and Execution Time, and has a similar impact in Network Traffic as Prometheus.
134 +- 🚀 Netdata excels in energy efficiency: **"... Netdata is the most energy-efficient tool ..."**, as the study says.
135 +- 🚀 Netdata excels in CPU Usage, RAM Usage and Execution Time, and has a similar impact on Network Traffic as Prometheus.
136
139 -The study did not normalize the results based on the number of metrics collected. Given that Netdata usually collects significantly more metrics than the other tools, Netdata managed to outperform the other tools, while ingesting a much higher number of metrics. [Read the full study here](https://www.ivanomalavolta.com/files/papers/ICSOC_2023.pdf).
137 +The study didn’t normalize the results based on the number of metrics collected. Given that Netdata usually collects significantly more metrics than the other tools, Netdata managed to outperform the other tools, while ingesting a much higher number of metrics. [Read the full study here](https://www.ivanomalavolta.com/files/papers/ICSOC_2023.pdf).
138
139 ---
140
@@ -203,86 +201,86 @@ On the same workload, Netdata uses **35% less CPU**, **49% less RAM**, **12% les
201 </p>
202
203 ### 1. **Install Netdata everywhere** :v:
206 -
207 - Netdata can be installed on all Linux, macOS, FreeBSD (and soon on Windows) systems. We provide binary packages for the most popular operating systems and package managers.
204
209 - - Install on [Ubuntu, Debian CentOS, Fedora, Suse, Red Hat, Arch, Alpine, Gentoo, even BusyBox](https://learn.netdata.cloud/docs/installing/one-line-installer-for-all-linux-systems).
210 - - Install with [Docker](/packaging/docker/README.md).<br/>
211 - Netdata is a [Verified Publisher on DockerHub](https://hub.docker.com/r/netdata/netdata) and our users enjoy free unlimited DockerHub pulls :heart_eyes:.
212 - - Install on [macOS](https://learn.netdata.cloud/docs/installing/macos) :metal:.
213 - - Install on [FreeBSD](https://learn.netdata.cloud/docs/installing/freebsd) and [pfSense](https://learn.netdata.cloud/docs/installing/pfsense).
214 - - Install [from source](https://learn.netdata.cloud/docs/installing/build-the-netdata-agent-yourself/compile-from-source-code) ![github downloads](https://img.shields.io/github/downloads/netdata/netdata/total?color=success&logo=github)
215 - - For Kubernetes deployments [check here](https://learn.netdata.cloud/docs/installation/install-on-specific-environments/kubernetes/).
205 +Netdata can be installed on all Linux, macOS, FreeBSD (and soon on Windows) systems. We provide binary packages for the most popular operating systems and package managers.
206 +
207 +- Install on [Ubuntu, Debian CentOS, Fedora, Suse, Red Hat, Arch, Alpine, Gentoo, even BusyBox](https://learn.netdata.cloud/docs/installing/one-line-installer-for-all-linux-systems).
208 +- Install with [Docker](/packaging/docker/README.md).<br/>
209 + Netdata is a [Verified Publisher on DockerHub](https://hub.docker.com/r/netdata/netdata) and our users enjoy free unlimited DockerHub pulls :heart_eyes:.
210 +- Install on [macOS](https://learn.netdata.cloud/docs/installing/macos) :metal:.
211 +- Install on [FreeBSD](https://learn.netdata.cloud/docs/installing/freebsd) and [pfSense](https://learn.netdata.cloud/docs/installing/pfsense).
212 +- Install [from source](https://learn.netdata.cloud/docs/installing/build-the-netdata-agent-yourself/compile-from-source-code) ![github downloads](https://img.shields.io/github/downloads/netdata/netdata/total?color=success&logo=github)
213 +- For Kubernetes deployments [check here](https://learn.netdata.cloud/docs/installation/install-on-specific-environments/kubernetes/).
214
217 - Check also the [Netdata Deployment Guides](https://learn.netdata.cloud/docs/deployment-guides/) to decide how to deploy it in your infrastructure.
215 +Check also the [Netdata Deployment Guides](https://learn.netdata.cloud/docs/deployment-guides/) to decide how to deploy it in your infrastructure.
216
219 - By default, you will have immediately available a local dashboard. Netdata starts a web server for its dashboard at port `19999`. Open up your web browser of choice and
220 -navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If installed on localhost, you can access it through `http://localhost:19999`.
217 +By default, you will have immediately available a local dashboard. Netdata starts a web server for its dashboard at port `19999`. Open up your web browser of choice and
218 +navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If installed on localhost, you can access it through `http://localhost:19999`.
219
222 - _Note: the binary packages we provide, install Netdata UI automatically. Netdata UI is closed-source, but free to use with Netdata Agents and Netdata Cloud._
220 +_Note: the binary packages we provide, install Netdata UI automatically. Netdata UI is closed-source, but free to use with Netdata Agents and Netdata Cloud._
221
222 ### 2. **Configure Collectors** :boom:
223
226 - 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 to get access to the metrics.
227 -
228 - - For a detailed list of the 800+ collectors available, check [this guide](https://learn.netdata.cloud/docs/data-collection/).
229 - - To monitor Windows servers and applications use [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/system-metrics/windows-machines).<br/><small>Note that Netdata on Windows is at its final release stage, so at the next Netdata release Netdata will natively support Windows.</small>
230 - - To monitor SNMP devices check [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/networking/snmp).
224 +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 to get access to the metrics.
225 +
226 +- For a detailed list of the 800+ collectors available, check [this guide](https://learn.netdata.cloud/docs/data-collection/).
227 +- To monitor Windows servers and applications, use [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/system-metrics/windows-machines).<br/><small>Note that Netdata on Windows is at its final release stage, so at the next Netdata release Netdata will natively support Windows.</small>
228 +- To monitor SNMP devices, check [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/networking/snmp).
229
230 ### 3. **Configure Alert Notifications** :bell:
231
234 - Netdata comes with hundreds of pre-configured alerts, that automatically check your metrics, immediately after they start getting collected.
232 +Netdata comes with hundreds of pre-configured alerts that automatically check your metrics immediately after they start getting collected.
233
236 - Netdata can dispatch alert notifications to multiple third party systems, including: `email`, `Alerta`, `AWS SNS`, `Discord`, `Dynatrace`, `flock`, `gotify`, `IRC`, `Matrix`, `MessageBird`, `Microsoft Teams`, `ntfy`, `OPSgenie`, `PagerDuty`, `Prowl`, `PushBullet`, `PushOver`, `RocketChat`, `Slack`, `SMS tools`, `Syslog`, `Telegram`, `Twilio`.
234 +Netdata can dispatch alert notifications to multiple third party systems, including: `email`, `Alerta`, `AWS SNS`, `Discord`, `Dynatrace`, `flock`, `gotify`, `IRC`, `Matrix`, `MessageBird`, `Microsoft Teams`, `ntfy`, `OPSgenie`, `PagerDuty`, `Prowl`, `PushBullet`, `PushOver`, `RocketChat`, `Slack`, `SMS tools`, `Syslog`, `Telegram`, `Twilio`.
235
238 - By default, Netdata will send e-mail notifications, if there is a configured MTA on the system.
236 +By default, Netdata will send e-mail notifications if there is a configured MTA on the system.
237
238 ### 4. **Configure Netdata Parents** :family:
239
242 - Optionally, configure one or more Netdata Parents. 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.
243 -
244 - Netdata Parents provide:
245 -
246 - - **Infrastructure level dashboards, at `http://parent.server.ip:19999/`.**<br/>
247 -
248 - Each Netdata Agent has an API listening at the TCP port 19999 of each server.
249 - When you hit that port with a web browser (e.g. `http://server.ip:19999/`), the Netdata Agent UI is presented.
250 - When the Netdata Agent is also a Parent, the UI of the Parent includes data for all nodes that stream metrics to that Parent.
251 -
252 - - **Increased retention for all metrics of all your nodes.**<br/>
253 -
254 - Each Netdata Agent maintains each own database of metrics. But Parents can be given additional resources to maintain a much longer database than
255 - individual Netdata Agents.
256 -
257 - - **Central configuration of alerts and dispatch of notifications.**<br/>
258 -
259 - Using Netdata Parents, all the alert notifications integrations can be configured only once, at the Parent and they can be disabled at the Netdata Agents.
260 -
261 - You can also use Netdata Parents to:
262 -
263 - - Offload your production systems (the parents run ML, alerts, queries, etc. for all their children)
264 - - Secure your production systems (the parents accept user connections, for all their children)
240 +Optionally, configure one or more Netdata Parents. 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.
241 +
242 +Netdata Parents provide:
243 +
244 +- **Infrastructure level dashboards, at `http://parent.server.ip:19999/`.**<br/>
245 +
246 + Each Netdata Agent has an API listening at the TCP port 19999 of each server.
247 + When you hit that port with a web browser (e.g. `http://server.ip:19999/`), the Netdata Agent UI is presented.
248 + When the Netdata Agent is also a Parent, the UI of the Parent includes data for all nodes that stream metrics to that Parent.
249 +
250 +- **Increased retention for all metrics of all your nodes.**<br/>
251 +
252 + Each Netdata Agent maintains each own database of metrics. But Parents can be given additional resources to maintain a much longer database than
253 + individual Netdata Agents.
254 +
255 +- **Central configuration of alerts and dispatch of notifications.**<br/>
256 +
257 + Using Netdata Parents, all the alert notifications integrations can be configured only once at the Parent and they can be disabled at the Netdata Agents.
258 +
259 +You can also use Netdata Parents to:
260 +
261 +- Offload your production systems (the parents run ML, alerts, queries, etc. for all their children)
262 +- Secure your production systems (the parents accept user connections for all their children)
263
264 ### 5. **Connect to Netdata Cloud** :cloud:
265
268 - [Sign-in](https://app.netdata.cloud/sign-in) to [Netdata Cloud](https://www.netdata.cloud/) and claim your Netdata Agents and Parents.
269 - If you connect your Netdata Parents, there is no need to connect your Netdata Agents. They will be connected via the Parents.
270 -
271 - When your Netdata nodes are connected to Netdata Cloud, you can (on top of the above):
272 -
273 - - Access your Netdata agents from anywhere
274 - - Access sensitive Netdata agent features (like "Netdata Functions": processes, systemd-journal)
275 - - Organize your infra in spaces and Rooms
276 - - Create, manage, and share **custom dashboards**
277 - - Invite your team and assign roles to them (Role Based Access Control - RBAC)
278 - - Get infinite horizontal scalability (multiple independent Netdata Agents are viewed as one infra)
279 - - Configure alerts from the UI
280 - - Configure data collection from the UI
281 - - Netdata Mobile App notifications
282 -
283 - :love_you_gesture: Netdata Cloud does not prevent you from using your Netdata Agents and Parents directly, and vice versa.<br/>
284 -
285 - :ok_hand: Your metrics are still stored in your network when you connect your Netdata Agents and Parents to Netdata Cloud.
266 +[Sign-in](https://app.netdata.cloud/sign-in) to [Netdata Cloud](https://www.netdata.cloud/) and claim your Netdata Agents and Parents.
267 +If you connect your Netdata Parents, there is no need to connect your Netdata Agents. They will be connected via the Parents.
268 +
269 +When your Netdata nodes are connected to Netdata Cloud, you can (on top of the above):
270 +
271 +- Access your Netdata agents from anywhere
272 +- Access sensitive Netdata agent features (like "Netdata Functions": processes, systemd-journal)
273 +- Organize your infra in spaces and Rooms
274 +- Create, manage, and share **custom dashboards**
275 +- Invite your team and assign roles to them (Role-Based Access Control)
276 +- Get infinite horizontal scalability (multiple independent Netdata Agents are viewed as one infra)
277 +- Configure alerts from the UI
278 +- Configure data collection from the UI
279 +- Netdata Mobile App notifications
280 +
281 +:love_you_gesture: Netdata Cloud doesn’t prevent you from using your Netdata Agents and Parents directly, and vice versa.<br/>
282 +
283 +:ok_hand: Your metrics are still stored in your network when you connect your Netdata Agents and Parents to Netdata Cloud.
284
285 <hr class="solid">
286
@@ -304,26 +302,26 @@ Each Netdata Agent can perform the following functions:
302
303 Netdata also collects your custom application metrics by scraping OpenMetrics exporters, or via StatsD.
304
307 - It can convert web server log files to metrics and apply ML and alerts to them, in real-time.
305 + It can convert web server log files to metrics and apply ML and alerts to them in real-time.
306
307 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.
310 -
308 +
309 2. **`STORE` metrics to a database**<br/>
312 - 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/src/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.
313 -
310 + 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/src/database/engine#readme) for storing the data in a very efficient manner, allowing Netdata to have less than one byte per sample on disk and amazingly fast queries.
311 +
312 3. **`LEARN` the behavior of metrics** (ML)<br/>
313 Trains multiple Machine-Learning (ML) models per metric to learn the behavior of each metric individually. Netdata uses the `kmeans` algorithm and creates by default a model per metric per hour, based on the values collected for that metric over the last 6 hours. The trained models are persisted to disk.
316 -
314 +
315 4. **`DETECT` anomalies in metrics** (ML)<br/>
316 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.
317
318 5. **`CHECK` metrics and trigger alert notifications**<br/>
321 - Uses its configured alerts (you can configure your own) to check the metrics for common issues and uses notifications plugins to send alert notifications.
319 + Uses its configured alerts (you can configure your own) to check the metrics for common issues and uses notification plugins to send alert notifications.
320
321 6. **`STREAM` metrics to other Netdata Agents**<br/>
322 Push metrics in real-time to Netdata Parents.
323
326 -7. **`ARCHIVE` metrics to 3rd party databases**<br/>
324 +7. **`ARCHIVE` metrics to third party databases**<br/>
325 Export metrics to industry standard time-series databases, like `Prometheus`, `InfluxDB`, `OpenTSDB`, `Graphite`, etc.
326
327 8. **`QUERY` metrics and present dashboards**<br/>
@@ -337,28 +335,28 @@ When using Netdata Parents, all the functions of a Netdata Agent (except data co
335 The core of Netdata is developed in C. We have our own `libnetdata`, that provides:
336
337 - **`DICTIONARY`**<br/>
340 - A high-performance algorithm to maintain both indexed and ordered pools of structures Netdata needs. It uses JudyHS arrays for indexing, although it is modular: any hashtable or tree can be integrated into it. Despite being in C, dictionaries follow object-oriented programming principles, so there are constructors, destructors, automatic memory management, garbage collection, and more. For more see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/dictionary).
341 -
338 + A high-performance algorithm to maintain both indexed and ordered pools of structures Netdata needs. It uses JudyHS arrays for indexing, although it is modular: any hashtable or tree can be integrated into it. Despite being in C, dictionaries follow object-oriented programming principles, so there are constructors, destructors, automatic memory management, garbage collection, and more. For more, see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/dictionary).
339 +
340 - **`ARAL`**<br/>
343 - ARray ALlocator (ARAL) is used to minimize the system allocations made by Netdata. ARAL is optimized for maximum multithreaded performance. It also allows all structures that use it to be allocated in memory-mapped files (shared memory) instead of RAM. For more see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/aral).
341 + ARray ALlocator (ARAL) is used to minimize the system allocations made by Netdata. ARAL is optimized for maximum multithreaded performance. It also allows all structures that use it to be allocated in memory-mapped files (shared memory) instead of RAM. For more, see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/aral).
342
343 - **`PROCFILE`**<br/>
346 - A high-performance `/proc` (but also any) file parser and text tokenizer. It achieves its performance by keeping files open and adjusting its buffers to read the entire file in one call (which is also required by the Linux kernel). For more see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/procfile).
344 + A high-performance `/proc` (but also any) file parser and text tokenizer. It achieves its performance by keeping files open and adjusting its buffers to read the entire file in one call (which is also required by the Linux kernel). For more, see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/procfile).
345
346 - **`STRING`**<br/>
349 - A string internet mechanism, for string deduplication and indexing (using JudyHS arrays), optimized for multithreaded usage. For more see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/string).
347 + A string internet mechanism, for string deduplication and indexing (using JudyHS arrays), optimized for multithreaded usage. For more, see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/string).
348
349 - **`ARL`**<br/>
352 - Adaptive Resortable List (ARL), is a very fast list iterator, that keeps the expected items on the list in the same order they are found in input list. So, the first iteration is somewhat slower, but all the following iterations are perfectly aligned for best performance. For more see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/adaptive_resortable_list).
350 + Adaptive Resortable List (ARL) is a very fast list iterator, that keeps the expected items on the list in the same order they are found in an input list. So, the first iteration is somewhat slower, but all the following iterations are perfectly aligned for the best performance. For more, see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/adaptive_resortable_list).
351
352 - **`BUFFER`**<br/>
355 - A flexible text buffer management system that allows Netdata to automatically handle dynamically sized text buffer allocations. The same mechanism is used for generating consistent JSON output by the Netdata APIs. For more see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/buffer).
353 + A flexible text buffer management system that allows Netdata to automatically handle dynamically sized text buffer allocations. The same mechanism is used for generating consistent JSON output by the Netdata APIs. For more, see [here](https://github.com/netdata/netdata/tree/master/src/libnetdata/buffer).
354
355 - **`SPINLOCK`**<br/>
356 Like POSIX `MUTEX` and `RWLOCK` but a lot faster, based on atomic operations, with significantly smaller memory impact, while being portable.
357
358 - **`PGC`**<br/>
361 - A caching layer that can be used to cache any kind of time-related data, with automatic indexing (based on a tree of JudyL arrays), memory management, evictions, flushing, pressure management. This is extensively used in `dbengine`. For more see [here](/src/database/engine/README.md).
359 + A caching layer that can be used to cache any kind of time-related data, with automatic indexing (based on a tree of JudyL arrays), memory management, evictions, flushing, pressure management. This is extensively used in `dbengine`. For more, see [here](/src/database/engine/README.md).
360
361 The above, and many more, allow Netdata developers to work on the application fast and with confidence. Most of the business logic in Netdata is a work of mixing the above.
362
@@ -375,19 +373,19 @@ Of course, it is! We do our best to ensure it is!
373 <details><summary>Click to see detailed answer ...</summary>
374 &nbsp;<br/>&nbsp;<br/>
375
378 -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:
376 +We understand that Netdata is a software piece installed on millions of production systems across the world. So, it is important for us, Netdata to be as secure as possible:
377
380 - - We follow the [Open Source Security Foundation](https://bestpractices.coreinfrastructure.org/en/projects/2231) best practices.
381 - - We have given great attention to detail when it comes to security design. Check out our [security design](/docs/security-and-privacy-design/README.md).
382 - - Netdata is a popular open-source project and is frequently tested by many security analysts.
383 - - Check also our [security policies and advisories published so far](https://github.com/netdata/netdata/security).
378 +- We follow the [Open Source Security Foundation](https://bestpractices.coreinfrastructure.org/en/projects/2231) best practices.
379 +- We have given great attention to detail when it comes to security design. Check out our [security design](/docs/security-and-privacy-design/README.md).
380 +- Netdata is a popular open-source project and is frequently tested by many security analysts.
381 +- Check also our [security policies and advisories published so far](https://github.com/netdata/netdata/security).
382
383 &nbsp;<br/>&nbsp;<br/>
384 </details>
385
386 ### :cyclone: Will Netdata consume significant resources on my servers?
387
390 -No. It will not! We promise this will be fast!
388 +No, it will not! We promise this will be fast!
389
390 <details><summary>Click to see detailed answer ...</summary>
391 &nbsp;<br/>&nbsp;<br/>
@@ -396,11 +394,11 @@ Although each Netdata Agent is a complete monitoring solution packed into a sing
394
395 This is what you should expect:
396
399 - - For production systems, each Netdata Agent with default settings (everything enabled, ML, Health, DB) should consume about 5% CPU utilization of one core and about 150 MiB or RAM.
397 +- For production systems, each Netdata Agent with default settings (everything enabled, ML, Health, DB) should consume about 5% CPU utilization of one core and about 150 MiB or RAM.
398 +
399 + By using a Netdata parent and streaming all metrics to that parent, you can disable ML & health and use an ephemeral DB (like `alloc`) on the children, leading to utilization of about 1% CPU of a single core and 100 MiB of RAM. Of course, these depend on how many metrics are collected.
400
401 - By using a Netdata parent and streaming all metrics to that parent, you can disable ML & health and use an ephemeral DB (like `alloc`) on the children, leading to utilization of about 1% CPU of a single core and 100 MiB of RAM. Of course, these depend on how many metrics are collected.
402 -
403 - - 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.
401 +- 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.
402
403 Netdata has extensive internal instrumentation to help us reveal how the resources consumed are used. All these are available in the "Netdata Monitoring" section of the dashboard. Depending on your use case, there are many options to optimize resource consumption.
404
@@ -416,18 +414,18 @@ As much as you need!
414 <details><summary>Click to see detailed answer ...</summary>
415 &nbsp;<br/>&nbsp;<br/>
416
419 -Netdata supports **tiering**, to downsample past data and save disk space. With default settings, it has 3 tiers:
417 +Netdata supports **tiering**, to downsample past data and save disk space. With default settings, it has three tiers:
418
421 - 1. `tier 0`, with high resolution, per-second, data.
422 - 2. `tier 1`, mid-resolution, per minute, data.
423 - 3. `tier 2`, low-resolution, per hour, data.
419 +1. `tier 0`, with high resolution, per-second, data.
420 +2. `tier 1`, mid-resolution, per minute, data.
421 +3. `tier 2`, low-resolution, per hour, data.
422
425 -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.
423 +All tiers are updated in parallel during data collection. 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.
424
425 &nbsp;<br/>&nbsp;<br/>
426 </details>
427
430 -### :rocket: Does it scale? I have really a lot of servers!
428 +### :rocket: Does it scale? I really have a lot of servers!
429
430 Netdata is designed to scale and can handle large volumes of data.
431
@@ -437,11 +435,11 @@ Netdata is a distributed monitoring solution. You can scale it to infinity by sp
435
436 With the streaming feature of the Agent, we can support monitoring ephemeral servers but also allow the creation of "monitoring islands" where metrics are aggregated to a few servers (Netdata Parents) for increased retention, or for offloading production systems.
437
440 - - :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 several million metrics collected per second, to ensure it is reliable, stable, and robust at scale.
441 -
442 - - :rocket: In addition, Netdata Cloud provides virtually unlimited horizontal scalability. It "merges" all the Netdata parents you have into one unified infrastructure at query time. 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!
438 +- :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 several million metrics collected per second, to ensure it is reliable, stable, and robust at scale.
439
444 -Example: the following chart comes from a single Netdata Parent. As you can see on it, 244 nodes stream to it metrics of about 20k running containers. On this specific chart there are 3 dimensions per container, so a total of about 60k time-series queries are executed to present it.
440 +- :rocket: In addition, Netdata Cloud provides virtually unlimited horizontal scalability. It "merges" all the Netdata parents you have into one unified infrastructure at query time. 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!
441 +
442 +Example: the following chart comes from a single Netdata Parent. As you can see on it, 244 nodes stream to it metrics of about 20k running containers. On this specific chart, there are three dimensions per container, so a total of about 60k time-series queries are executed to present it.
443
444 ![image](https://github.com/netdata/netdata/assets/2662304/33db4aed-86af-4018-a547-e70643308f25)
445
@@ -465,10 +463,10 @@ Health Alerts and Machine-Learning run queries to evaluate their expressions and
463
464 To make Netdata not use the disks at all, we suggest the following:
465
468 - 1. Use database mode `alloc` or `ram` to disable writing metric data to disk.
469 - 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.
470 - 3. Disable ML and health on this node. The Netdata Parent will do them for this node.
471 - 4. Use the Netdata Parent to access the dashboard.
466 +1. Use database mode `alloc` or `ram` to disable writing metric data to disk.
467 +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.
468 +3. Disable ML and health on this node. The Netdata Parent will do them for this node.
469 +4. Use the Netdata Parent to access the dashboard.
470
471 Using the above, the Netdata Agent on your production system will not use a disk.
472
@@ -479,30 +477,30 @@ Using the above, the Netdata Agent on your production system will not use a disk
477
478 Netdata is a "ready to use" monitoring solution. Prometheus and Grafana are tools to build your own monitoring solution.
479
482 -Netdata is also a lot faster, requires significantly less resources and puts almost no stress on the server it runs. For a performance comparison check [this blog](https://blog.netdata.cloud/netdata-vs-prometheus-performance-analysis/).
480 +Netdata is also a lot faster, requires significantly fewer resources and puts almost no stress on the server it runs. For a performance comparison check [this blog](https://blog.netdata.cloud/netdata-vs-prometheus-performance-analysis/).
481
482 <details><summary>Click to see detailed answer ...</summary>
483 &nbsp;<br/>&nbsp;<br/>
484
485 First, we have to say that Prometheus as a time-series database and Grafana as a visualizer are excellent tools for what they do.
486
489 -However, we believe that such a setup is missing a key element: A Prometheus and Grafana setup assumes that you know everything about the metrics you collect and you understand deeply how they are structured, they should be queried and visualized.
487 +However, we believe that such a setup is missing a key element: A Prometheus and Grafana setup assumes that you know everything about the metrics you collect, and you understand deeply how they’re structured, they should be queried and visualized.
488
491 -In reality, this setup has a lot of problems. The vast number of technologies, operating systems, and applications we use in our modern stacks, makes it impossible for any single person to know and understand everything about anything. We get testimonials regularly from Netdata users across the biggest enterprises, that Netdata manages to reveal issues, anomalies and problems they were not aware of and they didn't even have the means to find or troubleshoot.
489 +In reality, this setup has a lot of problems. The vast number of technologies, operating systems, and applications we use in our modern stacks makes it impossible for any single person to know and understand everything about anything. We get testimonials regularly from Netdata users across the biggest enterprises, that Netdata manages to reveal issues, anomalies and problems they weren’t aware of, and they didn't even have the means to find or troubleshoot.
490
491 So, the biggest difference of Netdata to Prometheus, and Grafana, is that we decided that the tool needs to have a much better understanding of the components, the applications, and the metrics it monitors.
492
495 - - When compared to Prometheus, Netdata needs for each metric much more than just a name, some labels, and a value over time. A metric in Netdata is a structured entity that correlates with other metrics in a certain way and has specific attributes that depict how it should be organized, treated, queried, and visualized. We call this the NIDL (Nodes, Instances, Dimensions, Labels) framework.
493 +- When compared to Prometheus, Netdata needs for each metric much more than just a name, some labels, and a value over time. A metric in Netdata is a structured entity that correlates with other metrics in a certain way and has specific attributes that depict how it should be organized, treated, queried, and visualized. We call this the NIDL (Nodes, Instances, Dimensions, Labels) framework.
494
497 - Maintaining such an index is a challenge: first, because the raw metrics collected do not provide this information, so we have to add it, and second because we need to maintain this index for the lifetime of each metric, which with our current database retention, it is usually more than a year.
495 + Maintaining such an index is a challenge: first, because the raw metrics collected do not provide this information, so we have to add it, and second because we need to maintain this index for the lifetime of each metric, which with our current database retention, it is usually more than a year.
496
499 - At the same time, Netdata provides better retention than Prometheus due to database tiering, scales easier than Prometheus due to streaming, supports anomaly detection and it has a metrics scoring engine to find the needle in the haystack when needed.
497 + At the same time, Netdata provides better retention than Prometheus due to database tiering, scales easier than Prometheus due to streaming, supports anomaly detection, and it has a metrics scoring engine to find the needle in the haystack when needed.
498
501 - - When compared to Grafana, Netdata is fully automated. Grafana has more customization capabilities than Netdata, but Netdata presents fully functional dashboards by itself and most importantly it gives you the means to understand, analyze, filter, slice and dice the data without the need for you to edit queries or be aware of any peculiarities the underlying metrics may have.
499 +- When compared to Grafana, Netdata is fully automated. Grafana has more customization capabilities than Netdata, but Netdata presents fully functional dashboards by itself, and most importantly, it gives you the means to understand, analyze, filter, slice and dice the data without the need for you to edit queries or be aware of any peculiarities the underlying metrics may have.
500
503 - Furthermore, to help you when you need to find the needle in the haystack, Netdata has advanced troubleshooting tools provided by the Netdata metrics scoring engine, that allows it to score metrics based on their anomaly rate, their differences or similarities for any given time frame.
501 + Furthermore, to help you when you need to find the needle in the haystack, Netdata has advanced troubleshooting tools provided by the Netdata metrics scoring engine, that allows it to score metrics based on their anomaly rate, their differences or similarities for any given time frame.
502
505 -Still, if you are already familiar with Prometheus and Grafana, Netdata integrates nicely with them, and we have reports from users who use Netdata with Prometheus and Grafana in production.
503 +Still, if you’re already familiar with Prometheus and Grafana, Netdata integrates nicely with them, and we have reports from users who use Netdata with Prometheus and Grafana in production.
504
505 &nbsp;<br/>&nbsp;<br/>
506 </details>
@@ -514,11 +512,11 @@ With Netdata your data are always on-prem and your metrics are always high-resol
512 <details><summary>Click to see detailed answer ...</summary>
513 &nbsp;<br/>&nbsp;<br/>
514
517 -Most commercial monitoring providers face a significant challenge: they centralize all metrics to their infrastructure and this is, inevitably, expensive. It leads them to one or more of the following:
515 +Most commercial monitoring providers face a significant challenge: they centralize all metrics to their infrastructure, and this is, inevitably, expensive. It leads them to one or more of the following:
516
519 - 1. be unrealistically expensive
520 - 2. limit the number of metrics they collect
521 - 3. limit the resolution of the metrics they collect
517 +1. be unrealistically expensive
518 +2. limit the number of metrics they collect
519 +3. limit the resolution of the metrics they collect
520
521 As a result, they try to find a balance: collect the least possible data, but collect enough to have something useful out of it.
522
@@ -528,33 +526,33 @@ This is why Netdata trains multiple machine-learning models per metric, based ex
526
527 This is also why Netdata alerts are attached to components (instances) and are configured with dynamic thresholds and rolling windows, instead of static values.
528
531 -The distributed nature of Netdata helps scale this approach: your data is spread inside your infrastructure, as close to the edge as possible. Netdata is not one data lane. Each Netdata Agent is a data lane and all of them together build a massive distributed metrics processing pipeline that ensures all your infrastructure components and applications are monitored and operating as they should.
529 +The distributed nature of Netdata helps scale this approach: your data is spread inside your infrastructure, as close to the edge as possible. Netdata is not one data lane. Each Netdata Agent is a data lane, and all of them together build a massive distributed metrics processing pipeline that ensures all your infrastructure components and applications are monitored and operating as they should.
530
531 &nbsp;<br/>&nbsp;<br/>
532 </details>
533
534 ### :raised_eyebrow: How is Netdata different from Nagios, Icinga, Zabbix, etc.?
535
538 -Netdata offers real-time, comprehensive monitoring and the ability to monitor everything, without any custom configuration required.
536 +Netdata offers real-time, comprehensive monitoring and the ability to monitor everything without any custom configuration required.
537
538 <details><summary>Click to see detailed answer ...</summary>
539 &nbsp;<br/>&nbsp;<br/>
540
543 -While Nagios, Icinga, Zabbix, and other similar tools are powerful and highly customizable, they can be complex to set up and manage. Their flexibility often comes at the cost of ease-of-use, especially for users who are not systems administrators or do not have extensive experience with these tools. Additionally, these tools generally require you to know what you want to monitor in advance and configure it explicitly.
541 +While Nagios, Icinga, Zabbix, and other similar tools are powerful and highly customizable, they can be complex to set up and manage. Their flexibility often comes at the cost of ease-of-use, especially for users who aren’t systems administrators or don’t have extensive experience with these tools. Additionally, these tools generally require you to know what you want to monitor in advance and configure it explicitly.
542
545 -Netdata, on the other hand, takes a different approach. It provides a "ready to use" monitoring solution with a focus on simplicity and comprehensiveness. It automatically detects and starts monitoring many different system metrics and applications out-of-the-box, without any need for custom configuration.
543 +Netdata, on the other hand, takes a different approach. It provides a "ready to use" monitoring solution with a focus on simplicity and comprehensiveness. It automatically detects and starts monitoring many different system metrics and applications out-of-the-box, without any need for custom configuration.
544
545 In comparison to these traditional monitoring tools, Netdata:
546
549 - - Provides real-time, high-resolution metrics, as opposed to the often minute-level granularity that tools like Nagios, Icinga, and Zabbix provide.
547 +- Provides real-time, high-resolution metrics, as opposed to the often minute-level granularity that tools like Nagios, Icinga, and Zabbix provide.
548
551 - - Automatically generates meaningful, organized, and interactive visualizations of the collected data. Unlike other tools, where you have to manually create and organize graphs and dashboards, Netdata takes care of this for you.
549 +- Automatically generates meaningful, organized, and interactive visualizations of the collected data. Unlike other tools, where you have to manually create and organize graphs and dashboards, Netdata takes care of this for you.
550
553 - - Applies machine learning to each individual metric to detect anomalies, providing more insightful and relevant alerts than static thresholds.
551 +- Applies machine learning to each individual metric to detect anomalies, providing more insightful and relevant alerts than static thresholds.
552
555 - - Is designed to be distributed, so your data is spread inside your infrastructure, as close to the edge as possible. This approach is more scalable and avoids the potential bottleneck of a single centralized server.
553 +- Designed to be distributed, so your data is spread inside your infrastructure, as close to the edge as possible. This approach is more scalable and avoids the potential bottleneck of a single centralized server.
554
557 - - Has a more modern and user-friendly interface, making it easy for anyone, not just experienced administrators, to understand the health and performance of their systems.
555 +- Has a more modern and user-friendly interface, allowing anyone, not just experienced administrators, to easily assess the health and performance of their systems.
556
557 Even if you're already using Nagios, Icinga, Zabbix, or similar tools, you can use Netdata alongside them to augment your existing monitoring capabilities with real-time insights and user-friendly dashboards.
558
@@ -563,7 +561,7 @@ Even if you're already using Nagios, Icinga, Zabbix, or similar tools, you can u
561
562 ### :flushed: I feel overwhelmed by the amount of information in Netdata. What should I do?
563
566 -Netdata is designed to provide comprehensive insights, but we understand that the richness of information might sometimes feel overwhelming. Here are some tips on how to navigate and utilize Netdata effectively...
564 +Netdata is designed to provide comprehensive insights, but we understand that the richness of information might sometimes feel overwhelming. Here are some tips on how to navigate and use Netdata effectively...
565
566 <details><summary>Click to see detailed answer ...</summary>
567 &nbsp;<br/>&nbsp;<br/>
@@ -572,20 +570,20 @@ Netdata is indeed a very comprehensive monitoring tool. It's designed to provide
570
571 Here are some suggestions on how to manage and navigate this wealth of information:
572
575 - 1. **Start with the Metrics Dashboard**<br/>
576 - Netdata's Metrics Dashboard provides a high-level summary of your system's status. We have added summary tiles on almost every section, you reveal the information that is more important. This is a great place to start, as it can help you identify any major issues or trends at a glance.
573 +1. **Start with the Metrics Dashboard**<br/>
574 + Netdata's Metrics Dashboard provides a high-level summary of your system's status. We have added summary tiles on almost every section, you reveal the information that is more important. This is a great place to start, as it can help you identify any major issues or trends at a glance.
575
578 - 2. **Use the Search Feature**<br/>
579 - If you're looking for specific information, you can use the search feature to find the relevant metrics or charts. This can help you avoid scrolling through all the data.
576 +2. **Use the Search Feature**<br/>
577 + If you're looking for specific information, you can use the search feature to find the relevant metrics or charts. This can help you avoid scrolling through all the data.
578
581 - 3. **Customize your Dashboards**<br/>
582 - Netdata allows you to create custom dashboards, which can help you focus on the metrics that are most important to you. Sign-in to Netdata and there you can have your custom dashboards. (coming soon to the agent dashboard too)
579 +3. **Customize your Dashboards**<br/>
580 + Netdata allows you to create custom dashboards, which can help you focus on the metrics that are most important to you. Sign-in to Netdata and there you can have your custom dashboards. (coming soon to the agent dashboard too)
581
584 - 4. **Leverage Netdata's Anomaly Detection**<br/>
585 - Netdata uses machine learning to detect anomalies in your metrics. This can help you identify potential issues before they become major problems. We have added an `AR` button above the dashboard table of contents to reveal the anomaly rate per section so that you can easily spot what could need your attention.
582 +4. **Leverage Netdata's Anomaly Detection**<br/>
583 + Netdata uses machine learning to detect anomalies in your metrics. This can help you identify potential issues before they become major problems. We have added an `AR` button above the dashboard table of contents to reveal the anomaly rate per section so that you can spot what could need your attention.
584
587 - 5. **Take Advantage of Netdata's Documentation and Blogs**<br/>
588 - Netdata has extensive documentation that can help you understand the different metrics and how to interpret them. You can also find tutorials, guides, and best practices there.
585 +5. **Take Advantage of Netdata's Documentation and Blogs**<br/>
586 + Netdata has extensive documentation that can help you understand the different metrics and how to interpret them. You can also find tutorials, guides, and best practices there.
587
588 Remember, it's not necessary to understand every single metric or chart right away. Netdata is a powerful tool, and it can take some time to fully explore and understand all of its features. Start with the basics and gradually delve into more complex metrics as you become more comfortable with the tool.
589
@@ -596,23 +594,23 @@ Remember, it's not necessary to understand every single metric or chart right aw
594
595 Netdata Cloud delivers the full suite of features and functionality that Netdata offers, including a free community tier.
596
599 -While our default onboarding process encourages users to take advantage of Netdata Cloud, including a complimentary one-month trial of our full business product, it is not mandatory. Users have the option to bypass this process entirely and still utilize the Netdata Agents along with the Netdata UI, without the need to sign up for Netdata Cloud.
597 +While our default onboarding process encourages users to take advantage of Netdata Cloud, including a complimentary one-month trial of our full business product, it is not mandatory. Users can bypass this process entirely and still use the Netdata Agents along with the Netdata UI, without the need to sign up for Netdata Cloud.
598
599 <details><summary>Click to see detailed answer ...</summary>
600 &nbsp;<br/>&nbsp;<br/>
601
604 -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:
602 +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:
603
606 - 1. Access your infrastructure from anywhere.
607 - 2. Have SSO to protect sensitive features.
608 - 3. Customizable (custom dashboards and other settings are persisted when you are signed in to Netdata Cloud)
609 - 4. Configuration of Alerts and Data Collection from the UI
610 - 5. Security (role-based access control - RBAC).
611 - 6. Horizontal Scalability ("blend" multiple independent parents in one uniform infrastructure)
612 - 7. Central Dispatch of Alert Notifications (even when multiple independent parents are involved)
613 - 8. Mobile App for Alert Notifications
604 +1. Access your infrastructure from anywhere.
605 +2. Have SSO to protect sensitive features.
606 +3. Customizable (custom dashboards and other settings are persisted when you’re signed in to Netdata Cloud)
607 +4. Configuration of Alerts and Data Collection from the UI
608 +5. Security (Role-Based Access Control).
609 +6. Horizontal Scalability ("blend" multiple independent parents in one uniform infrastructure)
610 +7. Central Dispatch of Alert Notifications (even when multiple independent parents are involved)
611 +8. Mobile App for Alert Notifications
612
615 -We encourage you to support Netdata by buying a Netdata Cloud subscription. A successful Netdata is a Netdata that evolves and gets improved to provide a simpler, faster and easier monitoring for all of us.
613 +We encourage you to support Netdata by buying a Netdata Cloud subscription. A successful Netdata is a Netdata that evolves and gets improved to provide simpler, faster and easier monitoring for all of us.
614
615 For organizations that need a fully on-prem solution, we provide Netdata Cloud for on-prem installation. [Contact us for more information](mailto:info@netdata.cloud).
616
@@ -628,11 +626,11 @@ Should you wish to disable telemetry, instructions for doing so are provided in
626 <details><summary>Click to see detailed answer ...</summary>
627 &nbsp;<br/>&nbsp;<br/>
628
631 -Netdata is in a constant state of growth and evolution. The decisions that guide this development are ideally rooted in data. By analyzing anonymous telemetry data, we can answer questions such as: "What features are being used frequently?", "How do we prioritize between potential new features?" and "What elements of Netdata are most important to our users?"
629 +Netdata is in a constant state of growth and evolution. The decisions that guide this development are ideally rooted in data. By analyzing anonymous telemetry data, we can answer questions such as "What features are being used frequently?", "How do we prioritize between potential new features?" and "What elements of Netdata are most important to our users?"
630
631 By leaving anonymous telemetry enabled, users indirectly contribute to shaping Netdata's roadmap, providing invaluable information that helps us prioritize our efforts for the project and the community.
632
635 -We are aware that for privacy or regulatory reasons, not all environments can allow telemetry. To cater to this, we have simplified the process of disabling telemetry:
633 +We are aware that for privacy or regulatory reasons, not all environments can allow telemetry. To cater to this, we’ve simplified the process of disabling telemetry:
634
635 - During installation, you can append `--disable-telemetry` to our `kickstart.sh` script, or
636 - Create the file `/etc/netdata/.opt-out-from-anonymous-statistics` and then restart Netdata.
@@ -641,7 +639,7 @@ These steps will disable the anonymous telemetry for your Netdata installation.
639
640 Please note, even with telemetry disabled, Netdata still requires a [Netdata Registry](https://learn.netdata.cloud/docs/configuring/securing-netdata-agents/registry) for alert notifications' Call To Action (CTA) functionality. When you click an alert notification, it redirects you to the Netdata Registry, which then directs your web browser to the specific Netdata Agent that issued the alert for further troubleshooting. The Netdata Registry learns the URLs of your agents when you visit their dashboards.
641
644 -Any Netdata Agent can act as a Netdata Registry. Simply designate one Netdata Agent as your registry, and our global Netdata Registry will no longer be in use. For further information on this, please refer to [this guide](https://learn.netdata.cloud/docs/configuring/securing-netdata-agents/registry).
642 +Any Netdata Agent can act as a Netdata Registry. Designate one Netdata Agent as your registry, and our global Netdata Registry will no longer be in use. For further information on this, please refer to [this guide](https://learn.netdata.cloud/docs/configuring/securing-netdata-agents/registry).
643
644 &nbsp;<br/>&nbsp;<br/>
645 </details>
@@ -657,13 +655,13 @@ Browse the [Netdata stargazers on GitHub](https://github.com/netdata/netdata/sta
655
656 Netdata also enjoys significant usage in academia, with notable institutions including New York University, Columbia University, New Jersey University, Seoul National University, University College London, among several others.
657
660 -And, Netdata is also used by numerous governmental organizations worldwide.
658 +And, Netdata is also used by many governmental organizations worldwide.
659
660 In a nutshell, Netdata proves invaluable for:
661
662 - **Infrastructure intensive organizations**<br/>
663 Such as hosting/cloud providers and companies with hundreds or thousands of nodes, who require a high-resolution, real-time monitoring solution for a comprehensive view of all their components and applications.
666 -
664 +
665 - **Technology operators**<br/>
666 Those in need of a standardized, comprehensive solution for round-the-clock operations. Netdata not only facilitates operational automation and provides controlled access for their operations engineers, but also enhances skill development over time.
667
@@ -699,14 +697,14 @@ However, as a privately funded company, we also need to monetize our open-source
697
698 Traditionally, open-source projects have often used the open-core model, where a basic version of the software is open-source, and additional features are reserved for a commercial, closed-source version. This approach can limit access to advanced innovations, as most of these remain closed-source.
699
702 -At Netdata, we take a slightly different path. We don't create a separate enterprise version of our product. Instead, all users—whether commercial or not—utilize the same Netdata Agent, ensuring that all our observability innovations are always open-source.
700 +At Netdata, we take a slightly different path. We don't create a separate enterprise version of our product. Instead, all users - both commercial and non-commercial - use the same Netdata Agent, ensuring that all of our observability innovations are always open source.
701
702 To experience the full capabilities of the Netdata ecosystem, users need to combine the open-source components with our closed-source offerings. The complete product still remains free to use.
703
704 The closed-source components include:
705
708 -- **Netdata UI**: This is closed-source but free to use with the Netdata Agents and Netdata Cloud. It’s also publicly available via a CDN.
709 -- **Netdata Cloud**: A commercial product available both as an on-premises installation and as a SaaS solution, with a free community tier.
706 +- **Netdata UI**: This is closed-source but free to use with the Netdata Agents and Netdata Cloud. It’s also publicly available via a CDN.
707 +- **Netdata Cloud**: A commercial product available both as an on-premises installation and as a SaaS solution, with a free community tier.
708
709 By balancing open-source and closed-source components, we ensure that all users have access to our innovations while sustaining our ability to grow and innovate as a company.
710
@@ -724,7 +722,7 @@ Netdata generates revenue from these activities:
722
723 1. **Netdata Cloud Subscriptions**<br/>
724 Direct funding for our project's vision comes from users subscribing to Netdata Cloud's advanced features.
727 -
725 +
726 2. **Netdata Cloud On-Prem or Private**<br/>
727 Purchasing the on-premises or private versions of Netdata Cloud supports our financial growth.
728
@@ -737,11 +735,11 @@ Our Open-Source Community and the free access to Netdata Cloud, contribute to Ne
735 Feedback, especially issues and bug reports, is invaluable. It steers us towards a more resilient and efficient product. This, too, isn't a revenue source but is pivotal for our project's evolution.
736
737 - **Anonymous Telemetry Insights**<br/>
740 - Users who keep anonymous telemetry enabled, help us make data informed decisions in refining and enhancing Netdata. This isn't a revenue stream, but knowing which features are used and how, contributes in building a better product for everyone.
738 + Users who keep anonymous telemetry enabled, help us make data informed decisions on refining and enhancing Netdata. This isn't a revenue stream, but knowing which features are used and how, contributes in building a better product for everyone.
739
742 -We don't monetize, directly or indirectly, users' or "device heuristics" data. Any data collected from community members are exclusively used for the purposes stated above.
740 +We don't monetize, directly or indirectly, users' or "device heuristics" data. Any data collected from community members is exclusively used for the purposes stated above.
741
744 -Netdata grows financially when technology intensive organizations and operators, need - due to regulatory or business requirements - the entire Netdata suite on-prem or private, bundled with top-tier support. It is a win-win case for all parties involved: these companies get a battle tested, robust and reliable solution, while the broader community that helps us build this product, enjoys it at no cost.
742 +Netdata grows financially when technology intensive organizations and operators need - due to regulatory or business requirements - the entire Netdata suite on-prem or private, bundled with top-tier support. It is a win-win case for all parties involved: these companies get a battle tested, robust and reliable solution, while the broader community that helps us build this product enjoys it at no cost.
743
744 &nbsp;<br/>&nbsp;<br/>
745 </details>
@@ -787,7 +785,7 @@ Contributions are essential to the success of open-source projects. In other wor
785
786 What is a contribution? All the following are highly valuable to Netdata:
787
790 -1. **Let us know of the best-practices you believe should be standardized**<br/>
788 +1. **Let us know of the best practices you believe should be standardized**<br/>
789 Netdata should out-of-the-box detect as many infrastructure issues as possible. By sharing your knowledge and experiences, you help us build a monitoring solution that has baked into it all the best-practices about infrastructure monitoring.
790
791 2. **Let us know if Netdata is not perfect for your use case**<br/>
@@ -796,10 +794,10 @@ What is a contribution? All the following are highly valuable to Netdata:
794 Although we can't implement everything imaginable, we try to prioritize development on use-cases that are common to our community, are in the same direction we want Netdata to evolve and are aligned with our roadmap.
795
796 3. **Support other community members**<br/>
799 - Join our community on GitHub, Discord and Reddit. Generally, Netdata is relatively easy to set up and configure, but still people may need a little push in the right direction to use it effectively. Supporting other members is a great contribution by itself!
797 + Join our community on GitHub, Discord, and Reddit. Generally, Netdata is relatively easy to set up and configure, but still people may need a little push in the right direction to use it effectively. Supporting other members is a great contribution by itself!
798
799 4. **Add or improve integrations you need**<br/>
802 - Integrations tend to be easier and simpler to develop. If you would like to contribute your code to Netdata, we suggest that you start with the integrations you need, which Netdata does not currently support.
800 + Integrations tend to be easier and simpler to develop. If you would like to contribute your code to Netdata, we suggest that you start with the integrations you need, which Netdata doesn’t currently support.
801
802 General information about contributions:
803
@@ -812,14 +810,14 @@ instructions on building each Netdata component from the source and preparing a
810
811 ## License
812
815 -The Netdata ecosystem is comprised of three key components:
813 +The Netdata ecosystem consists of three key parts:
814 +
815 +- **Netdata Agent**: The heart of the Netdata ecosystem, the Netdata Agent is an open-source tool that must be installed on all systems monitored by Netdata. It offers a wide range of essential features, including data collection via various plugins, an embedded high-performance time-series database (dbengine), unsupervised anomaly detection powered by edge-trained machine learning, alerting and notifications, as well as query and scoring engines with associated APIs. Additionally, it supports exporting data to third-party monitoring systems, among other capabilities.
816 +
817 + The Netdata Agent is released under the [GPLv3+ license](https://github.com/netdata/netdata/blob/master/LICENSE) and redistributes several other open-source tools and libraries, which are listed in the [Netdata Agent third-party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).
818 +
819 +- **Netdata Cloud**: A commercial, closed-source component, Netdata Cloud enhances the capabilities of the open-source Netdata Agent by providing horizontal scalability, centralized alert notification dispatch (including a mobile app), user management, role-based access control, and other enterprise-grade features. It is available both as a SaaS solution and for on-premises deployment, with a free-to-use community tier also offered.
820
817 -- **Netdata Agent**: The heart of the Netdata ecosystem, the Netdata Agent is an open-source tool that must be installed on all systems monitored by Netdata. It offers a wide range of essential features, including data collection via various plugins, an embedded high-performance time-series database (dbengine), unsupervised anomaly detection powered by edge-trained machine learning, alerting and notifications, as well as query and scoring engines with associated APIs. Additionally, it supports exporting data to third-party monitoring systems, among other capabilities.
818 -
819 - The Netdata Agent is released under the [GPLv3+ license](https://github.com/netdata/netdata/blob/master/LICENSE) and redistributes several other open-source tools and libraries, which are listed in the [Netdata Agent third-party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).
820 -
821 -- **Netdata Cloud**: A commercial, closed-source component, Netdata Cloud enhances the capabilities of the open-source Netdata Agent by providing horizontal scalability, centralized alert notification dispatch (including a mobile app), user management, role-based access control, and other enterprise-grade features. It is available both as a SaaS solution and for on-premises deployment, with a free-to-use community tier also offered.
822 -
823 -- **Netdata UI**: The Netdata UI is closed-source, and handles all visualization and dashboard functionalities related to metrics, logs and other collected data, as well as the central configuration and management of the Netdata ecosystem. It serves both the Netdata Agent and Netdata Cloud. The Netdata UI is distributed in binary form with the Netdata Agent and is publicly accessible via a CDN, licensed under the [Netdata Cloud UI License 1 (NCUL1)](https://github.com/netdata/netdata/blob/master/src/web/gui/v2/LICENSE.md). It integrates third-party open-source components, detailed in the [Netdata UI third-party licenses](https://github.com/netdata/netdata/blob/master/src/web/gui/v2/3D_PARTY_LICENSES.txt).
821 +- **Netdata UI**: The Netdata UI is closed-source, and handles all visualization and dashboard functionalities related to metrics, logs and other collected data, as well as the central configuration and management of the Netdata ecosystem. It serves both the Netdata Agent and Netdata Cloud. The Netdata UI is distributed in binary form with the Netdata Agent and is publicly accessible via a CDN, licensed under the [Netdata Cloud UI License 1 (NCUL1)](https://github.com/netdata/netdata/blob/master/src/web/gui/v2/LICENSE.md). It integrates third-party open-source components, detailed in the [Netdata UI third-party licenses](https://github.com/netdata/netdata/blob/master/src/web/gui/v2/3D_PARTY_LICENSES.txt).
822
825 -The binary installation packages provided by Netdata include the Netdata Agent and the Netdata UI. Since the Netdata Agent is open-source, it is frequently packaged by third parties (e.g. Linux Distributions) excluding the closed-source components (Netdata UI is not included). While their packages can still be useful in providing the necessary back-ends and the APIs of a fully functional monitoring solution, we recommend using the installation packages we provide to experience the full feature set of Netdata.
823 +The binary installation packages provided by Netdata include the Netdata Agent and the Netdata UI. Since the Netdata Agent is open-source, it is frequently packaged by third parties (e.g., Linux Distributions) excluding the closed-source components (Netdata UI is not included). While their packages can still be useful in providing the necessary back-ends and the APIs of a fully functional monitoring solution, we recommend using the installation packages we provide to experience the full feature set of Netdata.