diff options
| author | Joel Hans <joel@netdata.cloud> | 2020-06-04 07:12:48 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-04 07:12:48 -0700 |
| commit | 78ca668e50d88670f8aaf4d2434e325f705f975c (patch) | |
| tree | 418f27c298dd093ff7ef033c970da92686d196aa /README.md | |
| parent | b1c96ce59d2eb7e46b35609b03715c9c15243aa6 (diff) | |
Cleanup of main README and registry doc (#9265)
* Cleanup README and remove old link
* Additional cleanup
* One more alignment
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 10 insertions, 9 deletions
@@ -37,7 +37,7 @@ Netdata is **fast** and **efficient**, designed to permanently run on all system Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **macOS**, along with other systems derived from them, such as **Kubernetes** and **Docker**. -Netdata is not hosted by the CNCF but is the 3rd most starred open-source project in the [Cloud Native Computing +Netdata is not hosted by the CNCF but is the fourth most starred open-source project in the [Cloud Native Computing Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars). --- @@ -78,7 +78,8 @@ action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98 > wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive, > **real-time**, and optimized to get the work done! -Want to see Netdata live? Check out any of our [live demos](https://www.netdata.cloud/#live-demo). +Want to try Netdata before you install? See our [live +demo](https://london.my-netdata.io/default.html#menu_system_submenu_cpu;theme=slate;help=true). ## User base @@ -254,12 +255,12 @@ This is how it works: | Function | Description | Documentation | | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | -| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) | -| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) | -| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) | -| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) | -| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`backends`](/backends/README.md) | -| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) | +| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) | +| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) | +| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) | +| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) | +| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`exporting`](/docs/export/README.md) | +| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) | The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric. @@ -405,7 +406,7 @@ Here is a quick list of notable documents: | [`collectors`](/collectors/README.md) | Information about data collection plugins. | | [`health`](/health/README.md) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. | | [`streaming`](/streaming/README.md) | How to build hierarchies of Netdata servers, by streaming metrics between them. | -| [`backends`](/backends/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. | +| [`exporting`](/docs/export/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. | | [`web/api`](/web/api/README.md) | Learn how to query the Netdata API and the queries it supports. | | [`web/api/badges`](/web/api/badges/README.md) | Learn how to generate badges (SVG images) from live data. | | [`web/gui/custom`](/web/gui/custom/README.md) | Learn how to create custom Netdata dashboards. | |