Update README.md
Costa Tsaousis committed
Jul 18, 2023 at 17:48 UTC
4bcce5b3061c1654af085b59fb4fd090ec8b94fb
1 file changed
+20
-10
README.md
+20
-10
@@ -65,7 +65,7 @@ Netdata collects metrics per second and presents them in beautiful low-latency d
65
66
<hr class="solid">
67
68
-## Quick Start
68
+## Getting Started
69
70
<p align="center">
71
<a href="https://registry.my-netdata.io/#menu_netdata_submenu_registry"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=M&value_color=blue&precision=2÷=1000000&options=unaligned&v44" alt="User base"></a>
@@ -84,7 +84,8 @@ Netdata collects metrics per second and presents them in beautiful low-latency d
84
Netdata can be installed on all Linux, MacOS, and FreeBSD systems. We provide binary packages for the most popular operating systems and package managers.
85
86
- 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).
87
- - Install with [Docker](https://learn.netdata.cloud/docs/installing/docker). Netdata is a [Verified Publisher on DockerHub](https://hub.docker.com/r/netdata/netdata) and our users enjoy free unlimited DockerHub pulls :heart_eyes:.
87
+ - Install with [Docker](https://learn.netdata.cloud/docs/installing/docker).<br/>
88
+ Netdata is a [Verified Publisher on DockerHub](https://hub.docker.com/r/netdata/netdata) and our users enjoy free unlimited DockerHub pulls :heart_eyes:.
89
- Install on [MacOS](https://learn.netdata.cloud/docs/installing/macos) :metal:.
90
- Install on [FreeBSD](https://learn.netdata.cloud/docs/installing/freebsd) and [pfSense](https://learn.netdata.cloud/docs/installing/pfsense).
91
- Install [from source](https://learn.netdata.cloud/docs/installing/build-the-netdata-agent-yourself/compile-from-source-code)
@@ -94,13 +95,21 @@ Netdata collects metrics per second and presents them in beautiful low-latency d
95
96
Netdata auto-detects and auto-discovers most operating system data sources and applications. However, many data sources require some manual configuration, usually to allow Netdata get access to the metrics.
97
97
- - For a detailed list of all data collectors, check [this guide](https://learn.netdata.cloud/docs/data-collection/).
98
+ - For a detailed list of the 800+ collectors available, check [this guide](https://learn.netdata.cloud/docs/data-collection/).
99
- To monitor Windows servers and applications use [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/system-metrics/windows-machines).
100
- To monitor SNMP devices check [this guide](https://learn.netdata.cloud/docs/data-collection/monitor-anything/networking/snmp).
101
101
-### 3. **Configure Netdata Parents** :family:
102
+### 3. **Configure Alert Notifications** :bell:
103
103
- 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.
104
+ Netdata comes with hundreds of pre-configured alerts, that are automatically start checking your metrics immediately after they get collected.
105
+
106
+ Netdata will 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`, `StackPulse`, `Syslog`, `Telegram`, `Twilio`.
107
+
108
+ By default, Netdata will start sending e-mail notifications, if there is a configured MTA on the systems it is installed.
109
+
110
+### 4. **Configure Netdata Parents** :family:
111
+
112
+ 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.
113
114
Netdata Parents provide:
115
@@ -117,19 +126,19 @@ Netdata collects metrics per second and presents them in beautiful low-latency d
126
127
- **Central configuration of alerts and dispatch of notifications.**<br/>
128
120
- Netdata Agents and Parents can dispatch alert notifications 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`, `StackPulse`, `Syslog`, `Telegram`, `Twilio`.
121
- Using Netdata Parents, all these integrations can be configured only once, at the Parent.
129
+ 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.
130
131
You can also use Netdata Parents to:
132
133
- Offload your production systems (the parents runs ML, alerts, queries, etc for all its children)
134
- Secure your production systems (the parents accept user connections, for all its children)
135
128
-### 4. **Connect your Parents to Netdata Cloud** :cloud:
136
+### 5. **Connect your Netdata to Netdata Cloud** :cloud:
137
130
- Optionally, [sign-in](https://app.netdata.cloud/sign-in) to [Netdata Cloud](https://www.netdata.cloud/) and claim your Netdata Parents.
138
+ Optionally, [sign-in](https://app.netdata.cloud/sign-in) to [Netdata Cloud](https://www.netdata.cloud/) and claim your Netdata Agents and Parents.
139
+ If you connect your Netdata Parents, there is no need to connect your Netdata Agents. They will be connected via the Parents.
140
132
- When your parents are connected to Netdata Cloud, you can (on top of the above):
141
+ When your Netdata are connected to Netdata Cloud, you can (on top of the above):
142
143
- Organize your infra in spaces and rooms
144
- Create, manage, and share **custom dashboards**
@@ -141,6 +150,7 @@ Netdata collects metrics per second and presents them in beautiful low-latency d
150
- Netdata Mobile App notifications (coming soon)
151
152
:love_you_gesture: Netdata Cloud does not prevent you from using your Netdata Agents and Parents directly, and vice versa.<br/>
153
+
154
:ok_hand: Your metrics are still stored in your network when you connect your Netdata Agents and Parents to Netdata Cloud.
155
156
## How it works