]> arthur.barton.de Git - netdata.git/blobdiff - README.md
Merge pull request #1094 from ktsaou/master
[netdata.git] / README.md
index 59360d455f1f082ae8bd8c466ec9eef80559c878..df288b0cb95853dfbde5c1b5a9a3d106edbaae63 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,45 +1,60 @@
-# netdata
+# netdata [![Build Status](https://travis-ci.org/firehol/netdata.svg?branch=master)](https://travis-ci.org/firehol/netdata) [![Coverity Scan Build Status](https://scan.coverity.com/projects/9140/badge.svg)](https://scan.coverity.com/projects/firehol-netdata) [![Docker Pulls](https://img.shields.io/docker/pulls/titpetric/netdata.svg)](https://hub.docker.com/r/titpetric/netdata/)
 
-#### 230.000+ views, 62.000+ visitors, 18.500+ downloads, 9.500+ github stars, 500+ forks, 14 days!
+> *New to netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*
 
-And it still runs with 700+ git downloads... per day!
+**netdata** is a system for **real-time performance and health monitoring**!
+It provides **unparalleled insights, in real-time, with interactive web dashboards**, of everything happening on the system it runs, including supported applications.
 
-**[Check what our users say about netdata](https://github.com/firehol/netdata/issues/148)**.
-
-Thank you!
+_netdata is designed to permanently run on all systems (**physical** & **virtual** servers, **containers**, **IoT** devices), without disrupting the applications running on them._
 
 ---
 
-**Real-time performance monitoring, done right!**
-
-This is the default dashboard of **netdata**:
 
- - real-time, per second updates, snappy refreshes!
- - 300+ charts out of the box, 2000+ metrics monitored!
- - zero configuration, zero maintenance, zero dependencies!
+## User base
 
-Live demo: [http://netdata.firehol.org](http://netdata.firehol.org)
+*Since May 16th 2016 (the time the [global public netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item) was released):*<br/>
+[![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)
 
-![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
+*in the last 24 hours:*<br/>
+[![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)
 
 ---
 
-## Features
+## News
+
+<p align="center">
+<a href="https://octoverse.github.com/" target="_blank"><img src="https://cloud.githubusercontent.com/assets/2662304/18795170/ec321f32-81cb-11e6-92a8-d03492f0b00d.png"/></a>
+</p>
+
+`Oct 4th, 2016` - **[netdata v1.4.0 released!](https://github.com/firehol/netdata/releases)**
+
+ - the **fastest** netdata ever (with a better look too)!
+ - improved **IoT** and **containers** support!
+ - **alarms** improved in almost every way!
+ - new plugins:  softnet netdev, extended TCP metrics, UDPLite, NFS v2, v3 client (server was there already), NFS v4 server & client, APCUPSd, RetroShare
+ - improved plugins: mysql, cgroups, hddtemp, sensors, phpfm, tc (QoS)
 
-**netdata** is a highly optimized Linux daemon providing **real-time performance monitoring for Linux systems, Applications, SNMP devices, over the web**!
+---
 
-It tries to visualize the **truth of now**, in its **greatest detail**, so that you can get insights of what is happening now and what just happened, on your systems and applications.
+## Features
 
-This is what you get:
+<p align="center">
+<img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>
+</p>
+
+ - **Stunning interactive bootstrap dashboards**<br/>2 themes are provided: dark, light
+ - **Blazingly fast visualization**<br/>responds to all queries in less than 0.5 ms per metric, even on low-end hardware
+ - **Highly efficient data collection**<br/>collects thousands of metrics per server per second, with just 1% CPU utilization of a single core on modern hardware
+ - **Sophisticated alarming**<br/>supports dynamic thresholds, hysteresis, templating, multiple notification methods
+ - **Extensible**<br/>you can monitor anything you can get a metric for, using its Plugin API (anything can be a netdata plugin, BASH, python, perl, node.js, java, Go, etc)
+ - **Zero configuration**<br/>auto-detects everything, out of the box it can detect up to 5000 metrics per server
+ - **Zero dependencies**<br/>it is even its own web server, for its static web files and its web API
+ - **Zero maintenance**<br/>you just run it, it does the rest
+ - **Embeddable**<br/>it can run anywhere a Linux kernel runs (even IoT) and its charts can be embedded on your web pages too
+ - **Custom dashboards**<br/>that can be built using simple HTML (no javascript necessary)
+ - **scales to infinity**<br/>requiring minimal central resources!
 
-- **Stunning bootstrap dashboards**, out of the box (themable: dark, light)
-- **Blazingly fast** and **super efficient**, mostly written in C (for default installations, expect just 2% of a single core CPU usage and a few MB of RAM)
-- **Zero configuration** - you just install it and it autodetects everything
-- **Zero dependencies**, it is its own web server for its static web files and its web API
-- **Zero maintenance**, you just run it, it does the rest
-- **Custom dashboards** that can be built using simple HTML (no javascript necessary)
-- **Extensible**, you can monitor anything you can get a metric for, using its Plugin API (anything can be a netdata plugin - from BASH to node.js, so you can easily monitor any application, any API)
-- **Embeddable**, it can run anywhere a Linux kernel runs and its charts can be embedded on your web pages too
+![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
 
 ---
 
@@ -51,7 +66,7 @@ This is what it currently monitors (most with zero configuration):
 
 - **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
 
-- **Disks** (per disk: I/O, operations, backlog, utilization, etc)
+- **Disks** (per disk: I/O, operations, backlog, utilization, space, etc)
 
    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
 
@@ -65,70 +80,88 @@ This is what it currently monitors (most with zero configuration):
 
 - **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
 
-- **Linux anti-DDoS protection** (SYNPROXY metrics)
+- **Linux DDoS protection** (SYNPROXY metrics)
 
 - **Processes** (running, blocked, forks, active, etc)
 
 - **Entropy** (random numbers pool, using in cryptography)
 
-- **NFS file servers**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
+- **NFS file servers and clients**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
 
 - **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
 
    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
 
+- **Linux Control Groups** (containers), systemd, lxc, docker, etc
+
 - **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
 
    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
 
 - **Users and User Groups resource usage**, by summarizing the process tree per user and group (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
 
-- **Apache web server** mod-status (v2.2, v2.4)
+- **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too)
 
-- **Nginx web server** stub-status
+- **Nginx web servers** stub-status (multiple servers)
 
 - **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
 
-- **ISC Bind name server** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
+- **Redis databases** (multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves)
+
+- **memcached databases** (multiple servers, each showing: bandwidth, connections, items, etc)
+
+- **ISC Bind name servers** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
+
+- **Postfix email servers** message queue (entries, size)
 
-- **Postfix email server** message queue (entries, size)
+- **exim email servers** message queue (emails queued)
 
-- **Squid proxy server** (clients bandwidth and requests, servers bandwidth and requests) 
+- **IPFS** (Bandwidth, Peers)
+
+- **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests)
 
 - **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
 
-- **NUT UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
+- **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
 
-- **SNMP devices** can be monitored too (although you will need to configure these)
+- **Tomcat** (accesses, threads, free memory, volume)
 
-And you can extend it, by writing plugins that collect data from any source, using any computer language.
+- **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
 
----
+- **hddtemp** (disk temperatures)
 
-## Still not convinced?
+- **SNMP devices** can be monitored too (although you will need to configure these)
 
-Read **[Why netdata?](https://github.com/firehol/netdata/wiki/Why-netdata%3F)**
+And you can extend it, by writing plugins that collect data from any source, using any computer language.
 
 ---
 
 ## Installation
 
-Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system
+Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system.
 
-It should run on **any Linux** system. It has been tested on:
+It should run on **any Linux** system (including IoT). It has been tested on:
 
-- Gentoo
-- ArchLinux
-- Ubuntu / Debian
+- Alpine
+- Arch Linux
 - CentOS
+- Debian
 - Fedora
+- Gentoo
+- OpenSuse
+- PLD Linux
 - RedHat Enterprise Linux
 - SUSE
-- Alpine Linux
-- PLD Linux
+- Ubuntu
 
 ---
 
 ## Documentation
 
 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
+
+## License
+
+netdata is GPLv3+.
+
+It re-distributes other open-source tools and libraries. Please check its [License Statement](https://github.com/firehol/netdata/blob/master/LICENSE.md).