c8559ef6b · cryptotaxi247/netdata-1

@@ -1,8 +1,8 @@

1 -# netdata [![Build Status](https://travis-ci.com/netdata/netdata.svg?branch=master)](https://travis-ci.com/netdata/netdata) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2231/badge)](https://bestpractices.coreinfrastructure.org/projects/2231) [![License: GPL v3+](https://img.shields.io/badge/License-GPL%20v3%2B-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

1 +# netdata [![Build Status](https://travis-ci.com/netdata/netdata.svg?branch=master)](https://travis-ci.com/netdata/netdata) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2231/badge)](https://bestpractices.coreinfrastructure.org/projects/2231) [![License: GPL v3+](https://img.shields.io/badge/License-GPL%20v3%2B-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Netdata,%20real-time%20performance%20and%20health%20monitoring,%20done%20right!&url=https://my-netdata.io/&via=linuxnetdata&hashtags=netdata,monitoring) [![analytics](http://www.google-analytics.com/collect?v=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Freadme&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()

2

3 [![Code Climate](https://codeclimate.com/github/netdata/netdata/badges/gpa.svg)](https://codeclimate.com/github/netdata/netdata) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a994873f30d045b9b4b83606c3eb3498)](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade) [![LGTM C](https://img.shields.io/lgtm/grade/cpp/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:cpp) [![LGTM JS](https://img.shields.io/lgtm/grade/javascript/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:javascript) [![LGTM PYTHON](https://img.shields.io/lgtm/grade/python/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:python)

4

5 -> *New to Netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*

5 +---

6

7 **Netdata** is a system for **distributed real-time performance and health monitoring**.

8

@@ -10,11 +10,64 @@ It provides **unparalleled insights**, **in real-time**, of everything happening

10

11 _Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** & **virtual** servers, **containers**, **IoT** devices), without disrupting their core function._

12

13 -Netdata currently runs on **Linux**, **FreeBSD**, and **MacOS**.

13 +Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **MacOS**.

14

15 -[![Twitter Follow](https://img.shields.io/twitter/follow/linuxnetdata.svg?style=social&label=New%20-%20stay%20in%20touch%20-%20follow%20netdata%20on%20twitter)](https://twitter.com/linuxnetdata) [![analytics](http://www.google-analytics.com/collect?v=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Freadme&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()

16 -

17 -## Why use Netdata?

15 +## Warning!

16 +People get **addicted to netdata**.

17 +Once you use it on your systems, **there is no going back**! *You have been warned...*

18 +

19 +![image](https://user-images.githubusercontent.com/2662304/48305662-9de82980-e537-11e8-9f5b-aa1a60fbb82f.png)

20 +

21 +## Contents

22 +

23 +1. [How it looks](#how-it-looks) - have a quick look at it

24 +2. [User base](#user-base) - who uses netdata?

25 +3. [Why Netdata](#why-netdata) - why people love netdata, how it compares with other solutions

26 +4. [Quick Start](#quick-start) - try it now on your systems

27 +5. [News](#news) - latest news about netdata

28 +6. [infographic](#infographic) - everything about netdata, in a page

29 +7. [Features](#features) - what features does it have

30 +8. [Visualization](#visualization) - unique visualization features

31 +9. [What does it monitor](#what-does-it-monitor) - which metrics it collects

32 +10. [Installation](#installation) - install it on all your systems

33 +11. [Documentation](#documentation) - read the docs

34 +12. [Community](#community) - disucss with others and get support

35 +13. [License](#license) - check the license of netdata

36 +

37 +

38 +## How it looks

39 +

40 +The following animated image, shows the top part of a typical netdata dashboard.

41 +

42 +![peek 2018-11-11 02-40](https://user-images.githubusercontent.com/2662304/48307727-9175c800-e55b-11e8-92d8-a581d60a4889.gif)

43 +

44 +*A typical netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive and **real-time**, optimized to get the work done!*

45 +

46 +> *We have a few online demos to check: [http://my-netdata.io](http://my-netdata.io)*

47 +

48 +## User base

49 +

50 +![cncf](https://www.cncf.io/wp-content/uploads/2016/09/logo_cncf.png)

51 +

52 +Netdata is in the [Cloud Native Computing Foundation (CNCF) landscape](https://landscape.cncf.io/grouping=no&sort=stars).

53 +Check the [CNCF TOC Netdata presentation](https://docs.google.com/presentation/d/18C8bCTbtgKDWqPa57GXIjB2PbjjpjsUNkLtZEz6YK8s/edit?usp=sharing).

54 +

55 +Netdata is a **robust** application. It has hundreds of thousands of users, all over the world.

56 +Check our [GitHub watchers list](https://github.com/netdata/netdata/watchers).

57 +You will find users working for: **Amazon**, **Atos**, **Baidu**, **Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**,

58 +**Elastic**, **EPAM Systems**, **Ericsson**, **Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**,

59 +**IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red Hat**, **SAP**, **Selectel**, **TicketMaster**,

60 +**Vimeo**, and many more!

61 +

62 +#### Docker pulls

63 +Docker pulls as reported by docker hub: [![netdata/netdata (official)](https://img.shields.io/docker/pulls/netdata/netdata.svg?label=netdata/netdata+%28official%29)](https://hub.docker.com/r/netdata/netdata/) [![firehol/netdata (deprecated)](https://img.shields.io/docker/pulls/firehol/netdata.svg?label=firehol/netdata+%28deprecated%29)](https://hub.docker.com/r/firehol/netdata/) [![titpetric/netdata (donated)](https://img.shields.io/docker/pulls/titpetric/netdata.svg?label=titpetric/netdata+%28third+party%29)](https://hub.docker.com/r/titpetric/netdata/)

64 +

65 +#### Anonymous global public netdata registry

66 +*Since May 16th 2016 (the date the [global public netdata registry](https://github.com/netdata/netdata/wiki/mynetdata-menu-item) was released):* [![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=null&value_color=blue&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Monitored Servers](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=null&value_color=orange&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Served](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)

67 +

68 +*in the last 24 hours:* [![New Users Today](http://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&after=-86400&options=unaligned&group=incremental-sum&label=new%20users%20today&units=null&value_color=blue&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![New Machines Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&group=incremental-sum&after=-86400&options=unaligned&label=servers%20added%20today&units=null&value_color=orange&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&after=-86400&group=incremental-sum&options=unaligned&label=sessions%20served%20today&units=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)

69 +

70 +## Why Netdata

71

72 Netdata is a monitoring agent you install on all your systems.

73

@@ -25,7 +78,7 @@ It is:

78 - a **metrics visualizer** - super fast, interactive, modern, optimized for anomaly detection

79 - an **alarms notification engine** - an advanced watchdog for detecting performance and availability issues

80

28 -All packaged together in a very flexible, extremely modular, distributed application.

81 +All the above, packaged together in a very flexible, extremely modular, distributed application.

82

83 This is how netdata compares to other monitoring solutions:

84

@@ -34,47 +87,41 @@ netdata|others (open-source and commercial)

87 **High resolution metrics** (1s granularity)|Low resolution metrics (10s granularity at best)

88 Monitors everything, **thousands of metrics per node**|Monitor just a few metrics

89 UI is super fast, optimized for **anomaly detection**|UI is good for just an abstract view

37 -**Meaningful presentation** for all metrics (educational)|You have to know the metrics before you start

38 -Install and get results **immediately**|A long preparation is required to get any useful results

39 -Use it to **troubleshooting** performance problems|Use them to get statistics of past performance

40 -**Kills the console** for tracing performance issues|The console is required for troubleshooting

41 -Requires **zero dedicated resources**|Require dedicated resources

90 +**Meaningful presentation**, to help you understand the metrics|You have to know the metrics before you start

91 +Install and get results **immediately**|Long preparation is required to get any useful results

92 +Use it for **troubleshooting** performance problems|Use them to get *statistics of past performance*

93 +**Kills the console** for tracing performance issues|The console is always required for troubleshooting

94 +Requires **zero dedicated resources**|Require large dedicated resources

95

43 -Netdata is **free**, super **fast**, very **easy**, completely **open**, **flexible** and integrate-able.

44 -It has been designed by **SysAdmins**, **DevOps** and **Developers** for troubleshooting performance problems, not just

45 -visualizing metrics.

46 -

47 -## Quick Start

96 +Netdata is **open-source**, **free**, super **fast**, very **easy**, completely **open**, extremely **efficient**,

97 +**flexible** and integrate-able.

98

49 -> **WARNING**:

50 -> People get adicted to **netdata**!

51 -> Once you install it and use it for a few minutes, **there is no going back**! You have been warned...

99 +It has been designed by **SysAdmins**, **DevOps** and **Developers** for troubleshooting performance problems,

100 +not just visualize metrics.

101

53 -![image](https://user-images.githubusercontent.com/2662304/48300888-9a2fb500-e4ed-11e8-89a6-33eb3f32d42e.png)

102 +## Quick Start

103

55 -You can quickly install netdata on a Linux server with the following:

56 -![](http://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0) ![](http://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-86400&label=today&units=installations&precision=0)

104 +You can quickly install netdata on a Linux box (physical, virtual, container, IoT) with the following command:

105

106 ```sh

107 # make sure you run `bash` for your shell

108 bash

109

62 -# install netdata, directly from github source

110 +# install netdata, directly from github sources

111 bash <(curl -Ss https://my-netdata.io/kickstart.sh)

112 ```

113 +![](http://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0) ![](http://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-86400&label=today&units=installations&precision=0)

114

66 -More installation methods can be found at the [installation page](https://github.com/netdata/netdata/wiki/Installation).

115 +The above command will:

116

68 -![image](https://user-images.githubusercontent.com/2662304/48301567-b127d480-e4f8-11e8-91db-9b416af5486c.png)

117 +1. install any required packages on your system (it will ask you to confirm before doing so),

118 +2. download netdata source to `/usr/src/netdata.git`

119 +3. compile it, install it and start it

120

121 +More installation methods and additional options can be found at the [installation page](https://github.com/netdata/netdata/wiki/Installation).

122

71 -## User base

72 -*Docker pulls* [![netdata/netdata (official)](https://img.shields.io/docker/pulls/netdata/netdata.svg?label=netdata/netdata+%28official%29)](https://hub.docker.com/r/netdata/netdata/) [![firehol/netdata (deprecated)](https://img.shields.io/docker/pulls/firehol/netdata.svg?label=firehol/netdata+%28deprecated%29)](https://hub.docker.com/r/firehol/netdata/) [![titpetric/netdata (donated)](https://img.shields.io/docker/pulls/titpetric/netdata.svg?label=titpetric/netdata+%28third+party%29)](https://hub.docker.com/r/titpetric/netdata/)

123 +![image](https://user-images.githubusercontent.com/2662304/48304090-fd384080-e51b-11e8-80ae-eecb03118dda.png)

124

74 -*Since May 16th 2016 (the date the [global public netdata registry](https://github.com/netdata/netdata/wiki/mynetdata-menu-item) was released):* [![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=null&value_color=blue&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Monitored Servers](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=null&value_color=orange&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Served](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)

75 -

76 -*in the last 24 hours:* [![New Users Today](http://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&after=-86400&options=unaligned&group=incremental-sum&label=new%20users%20today&units=null&value_color=blue&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![New Machines Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&group=incremental-sum&after=-86400&options=unaligned&label=servers%20added%20today&units=null&value_color=orange&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&after=-86400&group=incremental-sum&options=unaligned&label=sessions%20served%20today&units=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)

77 -

125 ## News

126

127 `Nov 6th, 2018` - **[netdata v1.11.0 released!](https://github.com/netdata/netdata/releases)**

@@ -98,19 +145,9 @@ More installation methods can be found at the [installation page](https://github

145 Netdata used to be a [firehol.org](https://firehol.org) project, accessible as `firehol/netdata`.

146

147 Netdata now has its own github organization `netdata`, so all github URLs are now `netdata/netdata`. The old github URLs, repo clones, forks, etc redirect automatically to the new repo.

101 -

102 ----

103 -

104 -![cncf](https://www.cncf.io/wp-content/uploads/2016/09/logo_cncf.png)

105 -

106 -`Jun 16, 2018` - **netdata in CNCF**

107 -

108 -Netdata is now at the [Cloud Native Computing Foundation (CNCF) landscape](https://landscape.cncf.io/grouping=no&sort=stars).

109 -

110 -Read the [netdata presentation](https://docs.google.com/presentation/d/18C8bCTbtgKDWqPa57GXIjB2PbjjpjsUNkLtZEz6YK8s/edit?usp=sharing) we gave at CNCF TOC on Sep 18, 2018.

148

149

113 -## netdata infographic

150 +## Infographic

151

152 This is a high level overview of netdata feature set and architecture.

153 Click it to to interact with it (it has direct links to documentation).

@@ -119,251 +156,251 @@ Click it to to interact with it (it has direct links to documentation).

156

157

158 ## Features

122 -

159

160 <img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>

161

126 -

127 - - **Stunning interactive bootstrap dashboards**

128 - mouse and touch friendly, in 2 themes: dark, light

129 -

130 - - **Amazingly fast**

131 - responds to all queries in less than 0.5 ms per metric,

132 - even on low-end hardware

133 -

134 - - **Highly efficient**

135 - collects thousands of metrics per server per second,

136 - with just 1% CPU utilization of a single core, a few MB of RAM and no disk I/O at all

137 -

138 - - **Sophisticated alerting**

139 - hundreds of alarms, **out of the box**!

140 - supports dynamic thresholds, hysteresis, alarm templates,

141 - multiple role-based notification methods (such as email, slack.com, flock.com,

142 - pushover.net, pushbullet.com, telegram.org, twilio.com, messagebird.com, kavenegar.com)

143 -

144 - - **Extensible**

145 - you can monitor anything you can get a metric for,

146 - using its Plugin API (anything can be a netdata plugin,

147 - BASH, python, perl, node.js, java, Go, ruby, etc)

148 -

149 - - **Embeddable**

150 - it can run anywhere a Linux kernel runs (even IoT)

151 - and its charts can be embedded on your web pages too

152 -

153 - - **Customizable**

154 - custom dashboards can be built using simple HTML (no javascript necessary)

155 -

156 - - **Zero configuration**

157 - auto-detects everything, it can collect up to 5000 metrics

158 - per server out of the box

159 -

160 - - **Zero dependencies**

161 - it is even its own web server, for its static web files and its web API

162 -

163 - - **Zero maintenance**

164 - you just run it, it does the rest

165 -

166 - - **scales to infinity**

167 - requiring minimal central resources

168 -

169 - - **several operating modes**

170 - autonomous host monitoring, headless data collector, forwarding proxy, store and forward proxy, central multi-host monitoring, in all possible configurations.

171 - Each node may have different metrics retention policy and run with or without health monitoring.

172 -

173 - - **time-series back-ends supported**

174 - can archive its metrics on `graphite`, `opentsdb`, `prometheus`, json document DBs, in the same or lower detail

175 - (lower: to prevent it from congesting these servers due to the amount of data collected)

176 -

177 -![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)

178 -

179 ----

180 -

181 -## What does it monitor?

182 -

183 -netdata collects several thousands of metrics per device.

184 -All these metrics are collected and visualized in real-time.

185 -

186 -> _Almost all metrics are auto-detected, without any configuration._

187 -

188 -This is a list of what it currently monitors:

189 -

190 -- **CPU**

191 - usage, interrupts, softirqs, frequency, total and per core, CPU states

192 -

193 -- **Memory**

194 - RAM, swap and kernel memory usage, KSM (Kernel Samepage Merging), NUMA

195 -

196 -- **Disks**

197 - per disk: I/O, operations, backlog, utilization, space, software RAID (md)

198 -

199 - ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)

200 -

201 -- **Network interfaces**

202 - per interface: bandwidth, packets, errors, drops

203 -

204 - ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)

205 -

206 -- **IPv4 networking**

207 - bandwidth, packets, errors, fragments,

208 - tcp: connections, packets, errors, handshake,

209 - udp: packets, errors,

210 - broadcast: bandwidth, packets,

211 - multicast: bandwidth, packets

212 -

213 -- **IPv6 networking**

214 - bandwidth, packets, errors, fragments, ECT,

215 - udp: packets, errors,

216 - udplite: packets, errors,

217 - broadcast: bandwidth,

218 - multicast: bandwidth, packets,

219 - icmp: messages, errors, echos, router, neighbor, MLDv2, group membership,

220 - break down by type

221 -

222 -- **Interprocess Communication - IPC**

223 - such as semaphores and semaphores arrays

224 -

225 -- **netfilter / iptables Linux firewall**

226 - connections, connection tracker events, errors

227 -

228 -- **Linux DDoS protection**

229 - SYNPROXY metrics

230 -

231 -- **fping** latencies

232 - for any number of hosts, showing latency, packets and packet loss

233 -

234 - ![image](https://cloud.githubusercontent.com/assets/2662304/20464811/9517d2b4-af57-11e6-8361-f6cc57541cd7.png)

235 -

236 -

237 -- **Processes**

238 - running, blocked, forks, active

239 -

240 -- **Entropy**

241 - random numbers pool, using in cryptography

242 -

243 -- **NFS file servers and clients**

244 - NFS v2, v3, v4: I/O, cache, read ahead, RPC calls

245 -

246 -- **Network QoS**

247 - the only tool that visualizes network `tc` classes in realtime

248 -

249 - ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)

250 -

251 -- **Linux Control Groups**

252 - containers: systemd, lxc, docker

253 -

254 -- **Applications**

255 - by grouping the process tree and reporting CPU, memory, disk reads,

256 - disk writes, swap, threads, pipes, sockets - per group

257 -

258 - ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)

259 -

260 -- **Users and User Groups resource usage**

261 - by summarizing the process tree per user and group,

262 - reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets

263 -

264 -- **Apache and lighttpd web servers**

265 - `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers

266 -

267 -- **Nginx web servers**

268 - `stub-status`, for multiple servers

269 -

270 -- **Tomcat**

271 - accesses, threads, free memory, volume

272 -

273 -- **web server log files**

274 - extracting in real-time, web server performance metrics and applying several health checks

275 -

276 -- **mySQL databases**

277 - multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues,

278 - tmp operations, connections, binlog metrics, threads, innodb metrics, and more

279 -

280 -- **Postgres databases**

281 - multiple servers, each showing: per database statistics (connections, tuples

282 - read - written - returned, transactions, locks), backend processes, indexes,

283 - tables, write ahead, background writer and more

284 -

285 -- **Redis databases**

286 - multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves

287 -

288 -- **couchdb**

289 - reads/writes, request methods, status codes, tasks, replication, per-db, etc

290 -

291 -- **mongodb**

292 - operations, clients, transactions, cursors, connections, asserts, locks, etc

293 -

294 -- **memcached databases**

295 - multiple servers, each showing: bandwidth, connections, items

296 -

297 -- **elasticsearch**

298 - search and index performance, latency, timings, cluster statistics, threads statistics, etc

299 -

300 -- **ISC Bind name servers**

301 - multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics

302 -

303 -- **NSD name servers**

304 - queries, zones, protocols, query types, transfers, etc.

305 -

306 -- **PowerDNS**

307 - queries, answers, cache, latency, etc.

308 -

309 -- **Postfix email servers**

310 - message queue (entries, size)

311 -

312 -- **exim email servers**

313 - message queue (emails queued)

314 -

315 -- **Dovecot** POP3/IMAP servers

316 -

317 -- **ISC dhcpd**

318 - pools utilization, leases, etc.

319 -

320 -- **IPFS**

321 - bandwidth, peers

322 -

323 -- **Squid proxy servers**

324 - multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests

325 -

326 -- **HAproxy**

327 - bandwidth, sessions, backends, etc

328 -

329 -- **varnish**

330 - threads, sessions, hits, objects, backends, etc

331 -

332 -- **OpenVPN**

333 - status per tunnel

334 -

335 -- **Hardware sensors**

336 - `lm_sensors` and `IPMI`: temperature, voltage, fans, power, humidity

337 -

338 -- **NUT and APC UPSes**

339 - load, charge, battery voltage, temperature, utility metrics, output metrics

340 -

341 -- **PHP-FPM**

342 - multiple instances, each reporting connections, requests, performance

343 -

344 -- **hddtemp**

345 - disk temperatures

346 -

347 -- **smartd**

348 - disk S.M.A.R.T. values

349 -

350 -- **SNMP devices**

351 - can be monitored too (although you will need to configure these)

352 -

353 -- **chrony**

354 - frequencies, offsets, delays, etc.

355 -

356 -- **beanstalkd**

357 - global and per tube monitoring

358 -

359 -- **statsd**

360 - [netdata is a fully featured statsd server](https://github.com/netdata/netdata/wiki/statsd)

361 -

362 -- **ceph**

363 - OSD usage, Pool usage, number of objects, etc.

364 -

162 +

163 +This is what you should expect from Netdata:

164 +

165 +### General

166 +- **1s granularity** - the highest possible resolution for all metrics.

167 +- **Unlimited metrics** - collects all the available metrics, the more the better.

168 +- **1% CPU utilization of a single core** - it is super fast, unbelievably optimized.

169 +- **A few MB of RAM** - by default it uses 25MB RAM. [You size it](database).

170 +- **Zero disk I/O** - while it runs, it does not load or save anything (except `error` and `access` logs).

171 +- **Zero configuration** - auto-detects everything, it can collect up to 10000 metrics per server out of the box.

172 +- **Zero maintenance** - You just run it, it does the rest.

173 +- **Zero dependencies** - it is even its own web server, for its static web files and its web API (though its plugins may require additional libraries, depending on the applications monitored).

174 +- **Scales to infinity** - you can install it on all your servers, containers, VMs and IoTs. Metrics are not centralized by default, so there is no limit.

175 +- **Several operating modes** - Autonomous host monitoring (the default), headless data collector, forwarding proxy, store and forward proxy, central multi-host monitoring, in all possible configurations. Each node may have different metrics retention policy and run with or without health monitoring.

176 +

177 +### Health Monitoring & Alarms

178 +- **Sophisticated alerting** - comes with hundreds of alarms, **out of the box**! Supports dynamic thresholds, hysteresis, alarm templates, multiple role-based notification methods.

179 +- **Notifications**: email, slack.com, flock.com, pushover.net, pushbullet.com, telegram.org, twilio.com, messagebird.com.

180 +

181 +### Integrations

182 +- **time-series dbs** - can archive its metrics to `graphite`, `opentsdb`, `prometheus`, json document DBs, in the same or lower resolution (lower: to prevent it from congesting these servers due to the amount of data collected).

183 +

184 +## Visualization

185 +

186 +- **Stunning interactive dashboards** - mouse, touchpad and touch-screen friendly in 2 themes: `slate` (dark) and `white`.

187 +- **Amazingly fast visualization** - responds to all queries in less than 1 ms per metric, even on low-end hardware.

188 +- **Visual anomaly detection** - the dashboards are optimized for detecting anomalies visually.

189 +- **Embeddable** - its charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence as a monitoring dashboard](https://github.com/netdata/netdata/wiki/Custom-Dashboard-with-Confluence).

190 +- **Customizable** - custom dashboards can be built using simple HTML (no javascript necessary).

191 +

192 +### Positive and negative values

193 +

194 +To improve clarity on charts, netdata dashboards present **positive** values for metrics representing `read`, `input`, `inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.

195 +

196 +![positive-and-negative-values](https://user-images.githubusercontent.com/2662304/48309090-7c5c6180-e57a-11e8-8e03-3a7538c14223.gif)

197 +

198 +*Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is negative.*

199 +

200 +### Non zero-based y-axis

201 +

202 +Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame.

203 +

204 +![non-zero-based](https://user-images.githubusercontent.com/2662304/48309139-3d2f1000-e57c-11e8-9a44-b91758134b00.gif)

205 +

206 +*A zero based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is selected.*

207 +

208 +### Charts are synchronized

209 +

210 +Charts on netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed at any time, and all other charts will follow.

211 +

212 +![charts-are-synchronized](https://user-images.githubusercontent.com/2662304/48309003-b4fb3b80-e578-11e8-86f6-f505c7059c15.gif)

213 +

214 +*Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the mouse pointer is over a chart.*

215 +

216 +> The visible time-frame (pan and zoom) is propagated from netdata server to netdata server, when navigating via the [`my-netdata` menu](registry#netdata-registry).

217 +

218 +

219 +### Highlighted time-frame

220 +

221 +To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `ALT` + `mouse selection`) on all charts.

222 +

223 +![highlighted-timeframe](https://user-images.githubusercontent.com/2662304/48311876-f9093300-e5ae-11e8-9c74-e3e291741990.gif)

224 +

225 +*A highlighted time-frame can be given by pressing `ALT` + `mouse selection` on any chart. Netdata will highlight the same range on all charts.*

226 +

227 +> Highlighted ranges are propagated from netdata server to netdata server, when navigating via the [`my-netdata` menu](registry#netdata-registry).

228 +

229 +

230 +## What does it monitor

231 +

232 +Netdata data collection is **extensible** - you can monitor anything you can get a metric for.

233 +Its [Plugin API](collectors/plugins.d) supports all programing languages (anything can be a netdata plugin, BASH, python, perl, node.js, java, Go, ruby, etc).

234 +

235 +- For better performance, most system related plugins (cpu, memory, disks, filesystems, networking, etc) have been written in `C`.

236 +- For faster development and easier contributions, most application related plugins (databases, web servers, etc) have been written in `python`.

237 +

238 +#### APM (Application Performance Monitoring)

239 +- **statsd** - [netdata is a fully featured statsd server](collectors/statsd.plugin).

240 +- **go_expvar** - collects metrics exposed by applications written in the Go programming language using the expvar package.

241 +- **Spring Boot** - monitors running Java Spring Boot applications that expose their metrics with the use of the Spring Boot Actuator included in Spring Boot library.

242 +

243 +#### System Resources

244 +- **CPU Utilization** - total and per core CPU usage.

245 +- **Interrupts** - total and per core CPU interrupts.

246 +- **SoftIRQs** - total and per core SoftIRQs.

247 +- **SoftNet** - total and per core SoftIRQs related to network activity.

248 +- **CPU Throttling** - collects per core CPU throttling.

249 +- **CPU Frequency** - collects the current CPU frequency.

250 +- **CPU Idle** - collects the time spent per processor state.

251 +- **IdleJitter** - measures CPU latency.

252 +- **Entropy** - random numbers pool, using in cryptography.

253 +- **Interprocess Communication - IPC** - such as semaphores and semaphores arrays.

254 +

255 +#### Memory

256 +- **ram** - collects info about RAM usage.

257 +- **swap** - collects info about swap memory usage.

258 +- **available memory** - collects the amount of RAM available for userspace processes.

259 +- **committed memory** - collects the amount of RAM committed to userspace processes.

260 +- **Page Faults** - collects the system page faults (major and minor).

261 +- **writeback memory** - collects the system dirty memory and writeback activity.

262 +- **huge pages** - collects the amount of RAM used for huge pages.

263 +- **KSM** - collects info about Kernel Same Merging (memory dedupper).

264 +- **Numa** - collects Numa info on systems that support it.

265 +- **slab** - collects info about the Linux kernel memory usage.

266 +

267 +#### Disks

268 +- **block devices** - per disk: I/O, operations, backlog, utilization, space, etc.

269 +- **BCACHE** - detailed performance of SSD caching devices.

270 +- **DiskSpace** - monitors disk space usage.

271 +- **mdstat** - software RAID.

272 +- **hddtemp** - disk temperatures.

273 +- **smartd** - disk S.M.A.R.T. values.

274 +- **device mapper** - naming disks.

275 +- **Veritas Volume Manager** - naming disks.

276 +- **megacli** - adapter, physical drives and battery stats.

277 +- **adaptec_raid** - logical and physical devices health metrics.

278 +

279 +#### Filesystems

280 +- **BTRFS** - detailed disk space allocation and usage.

281 +- **Ceph** - OSD usage, Pool usage, number of objects, etc.

282 +- **NFS file servers and clients** - NFS v2, v3, v4: I/O, cache, read ahead, RPC calls

283 +- **Samba** - performance metrics of Samba SMB2 file sharing.

284 +- **ZFS** - detailed performance and resource usage.

285 +

286 +#### Networking

287 +- **Network Stack** - everything about the networking stack (both IPv4 and IPv6 for all protocols: TCP, UDP, SCTP, UDPLite, ICMP, Multicast, Broadcast, etc), and all network interfaces (per interface: bandwidth, packets, errors, drops).

288 +- **Netfilter** - everything about the netfilter connection tracker.

289 +- **SynProxy** - collects performance data about the linux SYNPROXY (DDoS).

290 +- **NFacct** - collects accounting data from iptables.

291 +- **Network QoS** - the only tool that visualizes network `tc` classes in real-time

292 +- **FPing** - to measure latency and packet loss between any number of hosts.

293 +- **OpenVPN** - status per tunnel.

294 +- **ISC dhcpd** - pools utilization, leases, etc.

295 +- **AP** - collects Linux access point performance data (`hostapd`).

296 +- **SNMP** - SNMP devices can be monitored too (although you will need to configure these).

297 +- **port_check** - checks TCP ports for availability and response time.

298 +- **IPVS** - collects metrics from the Linux IPVS load balancer.

299 +

300 +#### Processes

301 +- **System Processes** - running, blocked, forks, active.

302 +- **Applications** - by grouping the process tree and reporting CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets - per process group.

303 +- **systemd** - monitors systemd services using CGROUPS.

304 +

305 +#### Users

306 +- **Users and User Groups resource usage** - by summarizing the process tree per user and group, reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets

307 +- **logind** - collects sessions, users and seats connected.

308 +

309 +#### Containers and VMs

310 +- **Containers** - all kinds of containers, using CGROUPS (systemd-nspawn, lxc, lxd, docker, kubernetes, etc).

311 +- **libvirt VMs** - all kinds of VMs, using CGROUPS.

312 +

313 +#### Web Servers

314 +- **Apache and lighttpd** - `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers.

315 +- **IPFS** - bandwidth, peers.

316 +- **LiteSpeed** - reads the litespeed rtreport files to collect metrics.

317 +- **Nginx** - `stub-status`, for multiple servers.

318 +- **Nginx+** - connects to multiple nginx_plus servers (local or remote) to collect real-time performance metrics.

319 +- **PHP-FPM** - multiple instances, each reporting connections, requests, performance, etc.

320 +- **Tomcat** - accesses, threads, free memory, volume, etc.

321 +- **web server `access.log` files** - extracting in real-time, web server and proxy performance metrics and applying several health checks, etc.

322 +- **http_check** - checks one or more web servers for HTTP status code and returned content.

323 +

324 +#### Proxies, Balancers, Accelerators

325 +- **HAproxy** - bandwidth, sessions, backends, etc.

326 +- **Squid** - multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests.

327 +- **Traefik** - connects to multiple traefik instances (local or remote) to collect API metrics (response status code, response time, average response time and server uptime).

328 +- **Varnish** - threads, sessions, hits, objects, backends, etc.

329 +

330 +#### Database Servers

331 +- **CouchDB** - reads/writes, request methods, status codes, tasks, replication, per-db, etc.

332 +- **MemCached** - multiple servers, each showing: bandwidth, connections, items, etc.

333 +- **MongoDB** - operations, clients, transactions, cursors, connections, asserts, locks, etc.

334 +- **MySQL and mariadb** - multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, and more.

335 +- **PostgreSQL** - multiple servers, each showing: per database statistics (connections, tuples read - written - returned, transactions, locks), backend processes, indexes, tables, write ahead, background writer and more.

336 +- **Redis** - multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves.

337 +- **RethinkDB** - connects to multiple rethinkdb servers (local or remote) to collect real-time metrics.

338 +

339 +#### Message Brokers

340 +- **beanstalkd** - global and per tube monitoring.

341 +- **rabbitmq** - performance and health metrics.

342 +

343 +#### Search and Indexing

344 +- **elasticsearch** - search and index performance, latency, timings, cluster statistics, threads statistics, etc.

345 +

346 +#### DNS Servers

347 +- **bind_rndc** - parses `named.stats` dump file to collect real-time performance metrics. All versions of bind after 9.6 are supported.

348 +- **dnsdist** - performance and health metrics.

349 +- **ISC Bind (named)** - multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics. All versions of bind after 9.9.10 are supported.

350 +- **NSD** - queries, zones, protocols, query types, transfers, etc.

351 +- **PowerDNS** - queries, answers, cache, latency, etc.

352 +- **unbound** - performance and resource usage metrics.

353 +- **dns_query_time** - DNS query time statistics.

354 +

355 +#### Time Servers

356 +- **chrony** - uses the `chronyc` command to collect chrony statistics (Frequency, Last offset, RMS offset, Residual freq, Root delay, Root dispersion, Skew, System time).

357 +- **ntpd** - connects to multiple ntpd servers (local or remote) to provide statistics of system variables and optional also peer variables.

358 +

359 +#### Mail Servers

360 +- **Dovecot** - POP3/IMAP servers.

361 +- **Exim** - message queue (emails queued).

362 +- **Postfix** - message queue (entries, size).

363 +

364 +#### Hardware Sensors

365 +- **IPMI** - enterprise hardware sensors and events.

366 +- **lm-sensors** - temperature, voltage, fans, power, humidity, etc.

367 +- **RPi** - Raspberry Pi temperature sensors.

368 +- **w1sensor** - collects data from connected 1-Wire sensors.

369 +

370 +#### UPSes

371 +- **apcupsd** - load, charge, battery voltage, temperature, utility metrics, output metrics

372 +- **NUT** - load, charge, battery voltage, temperature, utility metrics, output metrics

373 +

374 +#### Social Sharing Servers

375 +- **RetroShare** - connects to multiple retroshare servers (local or remote) to collect real-time performance metrics.

376 +

377 +#### Security

378 +- **Fail2Ban** - monitors the fail2ban log file to check all bans for all active jails.

379 +

380 +#### Authentication, Authorization, Accounting (AAA, RADIUS, LDAP) Servers

381 +- **FreeRadius** - uses the `radclient` command to provide freeradius statistics (authentication, accounting, proxy-authentication, proxy-accounting).

382 +

383 +#### Telephony Servers

384 +- **opensips** - connects to an opensips server (localhost only) to collect real-time performance metrics.

385 +

386 +#### Provisioning Systems

387 +- **Puppet** - connects to multiple Puppet Server and Puppet DB instances (local or remote) to collect real-time status metrics.

388 +

389 +#### Household Appliances

390 +- **SMA webbox** - connects to multiple remote SMA webboxes to collect real-time performance metrics of the photovoltaic (solar) power generation.

391 +- **Fronius** - connects to multiple remote Fronius Symo servers to collect real-time performance metrics of the photovoltaic (solar) power generation.

392 +- **StiebelEltron** - collects the temperatures and other metrics from your Stiebel Eltron heating system using their Internet Service Gateway (ISG web).

393 +

394 +#### Game Servers

395 +- **SpigotMC** - monitors Spigot Minecraft server ticks per second and number of online players using the Minecraft remote console.

396 +

397 +#### Distributed Computing

398 +- **BOINC** - monitors task states for local and remote BOINC client software using the remote GUI RPC interface. Also provides alarms for a handful of error conditions.

399 +

400 And you can extend it, by writing plugins that collect data from any source, using any computer language.

401

402 +---

403 +

404 ## Installation

405

406 Use our **[automatic installer](https://github.com/netdata/netdata/wiki/Installation)** to build and install it on your system.

@@ -387,9 +424,19 @@ It should run on **any Linux** system (including IoT). It has been tested on:

424 ## Documentation

425

426 Check the **[netdata wiki](https://github.com/netdata/netdata/wiki)**.

390 -

427 +

428 +

429 +## Community

430 +

431 +1. To report bugs, or get help, use [GitHub Issues](https://github.com/netdata/netdata/issues).

432 +2. Netdata has a [Facebook page](https://www.facebook.com/linuxnetdata/).

433 +3. Netdata has a [Twitter account](https://twitter.com/linuxnetdata).

434 +4. Netdata on [OpenHub](https://www.openhub.net/p/netdata).

435 +5. Netdata on [Repology](https://repology.org/metapackage/netdata/versions).

436 +6. Netdata on [StackShare](https://stackshare.io/netdata).

437 +

438 ## License

439

440 netdata is [GPLv3+](LICENSE).

394 -

395 -Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).

\ No newline at end of file

441 +

442 +Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).

Updated readme (#4604)