small improvements to README.md (#15658)
Co-authored-by: Emmanuel Vasilakis <mrzammler@gmail.com>
Ilya Mashchenko committed
Aug 1, 2023 at 12:00 UTC
0b5bc4c33936b4af6fb496ddd4feada1da01cb17
1 file changed
+39
-39
README.md
+39
-39
@@ -104,37 +104,37 @@ It scales nicely from just a single server to thousands of servers, even in comp
104
<details><summary>Click to see our immediate development plans and a summary view of the last 12 months' releases...</summary>
105
<br/>
106
107
-| What | Description | When | Status |
108
-|:----:|:-----------:|:----:|:------:|
109
-|WebRTC|Browser to Agent communication via WebRTC.|later|POC|
110
-|Advanced Troubleshooting|Expanded view of dashboard charts integrating Metrics Correlations, Anomaly Advisor, and many more.|later|interrupted|
111
-|Easy Custom<br/>Dashboards|Drag and drop charts to create custom dashboards on the fly, while troubleshooting!|next|planned|
112
-|More Customizability|Set default settings for all charts and views!|next|planned|
113
-|SystemD Journal|View the SystemD Journal of your systems on the dashboard.|soon|in progress|
114
-|UCUM Units|Migrate all metrics to the Unified Code for Units of Measure.|soon|in progress|
115
-|**Netdata Cloud<br/>On-Prem**|**Netdata Cloud available for On-Prem installation!**|**soon**|**in progress**|
116
-|Click to Activate|Configure Alerts and Data Collectors from the UI!|soon|in progress|
117
-|Integrations|Netdata Integrations Marketplace!|soon|finishing|
118
-|New Agent UI|Now Netdata Cloud and Netdata Agent share the same dashboard!|Jul<br/>2023|[v1.41](https://github.com/netdata/netdata/releases/tag/v1.41.0#v1410-one-dashboard)|
119
-|Summary Dashboards|High level tiles everywhere!|Jun<br/>2023|[v1.40](https://github.com/netdata/netdata/releases/tag/v1.40.0#v1400-visualization-summary-dashboards)|
120
-|Machine Learning|Multiple ML models per metric.|Jun<br/>2023|[v1.40](https://github.com/netdata/netdata/releases/tag/v1.40.0#v1400-ml-extended-training)|
121
-|SSL|Netdata Agent gets a new SSL layer.|Jun<br/>2023|[v1.40](https://github.com/netdata/netdata/releases/tag/v1.40.0#v1400-streaming)|
122
-|New Cloud UI|Filter, slice and dice any dataset from the UI! ML-first!|May<br/>2023|[v1.39](https://github.com/netdata/netdata/releases/tag/v1.39.0)|
123
-|Microsoft Windows|Monitor Windows hosts and apps!|May<br/>2023|[v1.39](https://github.com/netdata/netdata/releases/tag/v1.39.0#v1390-windows-support)|
124
-|Virtual Nodes|Go collectors can now be assigned to virtual nodes!|May<br/>2023|[v1.39](https://github.com/netdata/netdata/releases/tag/v1.39.0#v1390-virtual-nodes-and-custom-labels)|
125
-|DBENGINE v2|Faster, more reliable, far more scalable!|Feb<br/>2023|[v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0)|
126
-|Netdata Functions|Netdata beyond metrics! Monitoring anything!|Feb<br/>2023|[v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0#v1380-functions)|
127
-|Events Feed|Live feed of events about topology changes and alerts.|Feb<br/>2023|[v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0#v1380-feed)|
128
-|Role Based<br/>Access Control|More roles, offering finer control over access to infrastructure.|Feb<br/>2023|[v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0#v1380-rbac)|
129
-|Infinite Scalability|Streaming compression. Replication. Active-active clustering.|Nov<br/>2022|[v1.37](https://github.com/netdata/netdata/releases/tag/v1.37.0)|
130
-|Grafana Plugin|Netdata Cloud as a data source for Grafana.|Nov<br/>2022|[v1.37](https://github.com/netdata/netdata/releases/tag/v1.37.0#v1370-grafana-plugin)|
131
-|PostgreSQL|Completely rewritten, to reveal all the info, even at the table level.|Nov<br/>2022|[v1.37](https://github.com/netdata/netdata/releases/tag/v1.37.0#v1370-postgressql)|
132
-|Metrics Correlations|Advanced algorithms to find the needle in the haystack.|Aug<br/>2022|[v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0)|
133
-|Database Tiering|Netdata gets unlimited retention!|Aug<br/>2022|[v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0#v1360-tiering)|
134
-|Kubernetes|Monitor your Kubernetes workloads.|Aug<br/>2022|[v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0#v1360-kubernetes)|
135
-|Machine Learning|Anomaly Rate information on every chart.|Aug<br/>2022|[v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0#v1360-anomaly-rate-on-charts)|
136
-|Machine Learning|Anomaly Advisor! Bottom-up unsupervised anomaly detection.|Jun<br/>2022|[v1.35](https://github.com/netdata/netdata/releases/tag/v1.35.0#v1350-anomaly-advisor-ml)|
137
-|Machine Learning|Metrics Correlation on the Agent.|Jun<br/>2022|[v1.35](https://github.com/netdata/netdata/releases/tag/v1.35.0#v1350-metric-correlation-agent)|
107
+| What | Description | When | Status |
108
+|:-----------------------------:|:---------------------------------------------------------------------------------------------------:|:------------:|:-------------------------------------------------------------------------------------------------------:|
109
+| WebRTC | Browser to Agent communication via WebRTC. | later | POC |
110
+| Advanced Troubleshooting | Expanded view of dashboard charts integrating Metrics Correlations, Anomaly Advisor, and many more. | later | interrupted |
111
+| Easy Custom<br/>Dashboards | Drag and drop charts to create custom dashboards on the fly, while troubleshooting! | next | planned |
112
+| More Customizability | Set default settings for all charts and views! | next | planned |
113
+| SystemD Journal | View the SystemD Journal of your systems on the dashboard. | soon | in progress |
114
+| UCUM Units | Migrate all metrics to the Unified Code for Units of Measure. | soon | in progress |
115
+| **Netdata Cloud<br/>On-Prem** | **Netdata Cloud available for On-Prem installation!** | **soon** | **in progress** |
116
+| Click to Activate | Configure Alerts and Data Collectors from the UI! | soon | in progress |
117
+| Integrations | Netdata Integrations Marketplace! | soon | finishing |
118
+| New Agent UI | Now Netdata Cloud and Netdata Agent share the same dashboard! | Jul<br/>2023 | [v1.41](https://github.com/netdata/netdata/releases/tag/v1.41.0#v1410-one-dashboard) |
119
+| Summary Dashboards | High level tiles everywhere! | Jun<br/>2023 | [v1.40](https://github.com/netdata/netdata/releases/tag/v1.40.0#v1400-visualization-summary-dashboards) |
120
+| Machine Learning | Multiple ML models per metric. | Jun<br/>2023 | [v1.40](https://github.com/netdata/netdata/releases/tag/v1.40.0#v1400-ml-extended-training) |
121
+| SSL | Netdata Agent gets a new SSL layer. | Jun<br/>2023 | [v1.40](https://github.com/netdata/netdata/releases/tag/v1.40.0#v1400-streaming) |
122
+| New Cloud UI | Filter, slice and dice any dataset from the UI! ML-first! | May<br/>2023 | [v1.39](https://github.com/netdata/netdata/releases/tag/v1.39.0) |
123
+| Microsoft Windows | Monitor Windows hosts and apps! | May<br/>2023 | [v1.39](https://github.com/netdata/netdata/releases/tag/v1.39.0#v1390-windows-support) |
124
+| Virtual Nodes | Go collectors can now be assigned to virtual nodes! | May<br/>2023 | [v1.39](https://github.com/netdata/netdata/releases/tag/v1.39.0#v1390-virtual-nodes-and-custom-labels) |
125
+| DBENGINE v2 | Faster, more reliable, far more scalable! | Feb<br/>2023 | [v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0) |
126
+| Netdata Functions | Netdata beyond metrics! Monitoring anything! | Feb<br/>2023 | [v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0#v1380-functions) |
127
+| Events Feed | Live feed of events about topology changes and alerts. | Feb<br/>2023 | [v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0#v1380-feed) |
128
+| Role Based<br/>Access Control | More roles, offering finer control over access to infrastructure. | Feb<br/>2023 | [v1.38](https://github.com/netdata/netdata/releases/tag/v1.38.0#v1380-rbac) |
129
+| Infinite Scalability | Streaming compression. Replication. Active-active clustering. | Nov<br/>2022 | [v1.37](https://github.com/netdata/netdata/releases/tag/v1.37.0) |
130
+| Grafana Plugin | Netdata Cloud as a data source for Grafana. | Nov<br/>2022 | [v1.37](https://github.com/netdata/netdata/releases/tag/v1.37.0#v1370-grafana-plugin) |
131
+| PostgreSQL | Completely rewritten, to reveal all the info, even at the table level. | Nov<br/>2022 | [v1.37](https://github.com/netdata/netdata/releases/tag/v1.37.0#v1370-postgressql) |
132
+| Metrics Correlations | Advanced algorithms to find the needle in the haystack. | Aug<br/>2022 | [v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0) |
133
+| Database Tiering | Netdata gets unlimited retention! | Aug<br/>2022 | [v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0#v1360-tiering) |
134
+| Kubernetes | Monitor your Kubernetes workloads. | Aug<br/>2022 | [v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0#v1360-kubernetes) |
135
+| Machine Learning | Anomaly Rate information on every chart. | Aug<br/>2022 | [v1.36](https://github.com/netdata/netdata/releases/tag/v1.36.0#v1360-anomaly-rate-on-charts) |
136
+| Machine Learning | Anomaly Advisor! Bottom-up unsupervised anomaly detection. | Jun<br/>2022 | [v1.35](https://github.com/netdata/netdata/releases/tag/v1.35.0#v1350-anomaly-advisor-ml) |
137
+| Machine Learning | Metrics Correlation on the Agent. | Jun<br/>2022 | [v1.35](https://github.com/netdata/netdata/releases/tag/v1.35.0#v1350-metric-correlation-agent) |
138
139
</details>
140
@@ -156,7 +156,7 @@ It scales nicely from just a single server to thousands of servers, even in comp
156
157
### 1. **Install Netdata everywhere** :v:
158
159
- Netdata can be installed on all Linux, MacOS, and FreeBSD systems. We provide binary packages for the most popular operating systems and package managers.
159
+ Netdata can be installed on all Linux, macOS, and FreeBSD systems. We provide binary packages for the most popular operating systems and package managers.
160
161
- 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).
162
- Install with [Docker](https://learn.netdata.cloud/docs/installing/docker).<br/>
@@ -207,7 +207,7 @@ It scales nicely from just a single server to thousands of servers, even in comp
207
208
You can also use Netdata Parents to:
209
210
- - Offload your production systems (the parents runs ML, alerts, queries, etc for all their children)
210
+ - Offload your production systems (the parents run ML, alerts, queries, etc. for all their children)
211
- Secure your production systems (the parents accept user connections, for all their children)
212
213
### 5. **Connect to Netdata Cloud** :cloud:
@@ -287,7 +287,7 @@ When using Netdata Parents, all the functions of a Netdata Agent (except data co
287
The core of Netdata is developed in C. We have our own `libnetdata`, that provides:
288
289
- **`DICTIONARY`**<br/>
290
- A high-performance algorithm to maintain both indexed and ordered pools of structures Netdata needs. For indexing it uses JudyHS arrays, 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/libnetdata/dictionary).
290
+ 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/libnetdata/dictionary).
291
292
- **`ARAL`**<br/>
293
ARray ALlocator (ARAL) is used to minimize the system allocations made by Netdata. ARAL is optimized for peak performance when multi-threaded. 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/libnetdata/aral).
@@ -595,7 +595,7 @@ Netdata is a widely adopted project...
595
<details><summary>Click to see detailed answer ...</summary>
596
<br/> <br/>
597
598
-Browse the [Netdata stargazers on Github](https://github.com/netdata/netdata/stargazers) to discover users from renowned companies and enterprises, such as AMD, Amazon, Baidu, Cisco, Delta, Facebook, IBM, Intel, Netflix, Qualcomm, Riot Games, SAP, Samsung, Unity, Valve, and many others.
598
+Browse the [Netdata stargazers on GitHub](https://github.com/netdata/netdata/stargazers) to discover users from renowned companies and enterprises, such as AMD, Amazon, Baidu, Cisco, Delta, Facebook, IBM, Intel, Netflix, Qualcomm, Riot Games, SAP, Samsung, Unity, Valve, and many others.
599
600
Netdata also enjoys significant usage in academia, with notable institutions including New York University, Columbia University, New Jersey University, among several others.
601
@@ -644,7 +644,7 @@ Netdata is an inclusive open-source project and community. Please read our [Code
644
Join the Netdata community:
645
646
- Chat with us and other community members on [Discord](https://discord.com/invite/mPZ6WZKKG2).
647
-- Start a discussion on [Github discussions](https://github.com/netdata/netdata/discussions).
647
+- Start a discussion on [GitHub discussions](https://github.com/netdata/netdata/discussions).
648
- Open a topic to our [community forums](https://community.netdata.cloud).
649
650
> **Meet Up** :people_holding_hands::people_holding_hands::people_holding_hands:<br/>
@@ -669,10 +669,10 @@ What is a contribution? All the following are highly valuable to Netdata:
669
670
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.
671
672
-4. **Support other community members**<br/>
673
- 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!
672
+3. **Support other community members**<br/>
673
+ 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!
674
675
-5. **Add or improve integrations you need**<br/>
675
+4. **Add or improve integrations you need**<br/>
676
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.
677
678
General information about contributions: