]> arthur.barton.de Git - netdata.git/blobdiff - README.md
Merge pull request #1080 from ktsaou/master
[netdata.git] / README.md
old mode 100755 (executable)
new mode 100644 (file)
index d7e97a5..cbecfff
--- a/README.md
+++ b/README.md
-# 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/)
 
-**Real-time performance monitoring, done right!**
+> New to netdata? Live demo: [http://my-netdata.io](http://my-netdata.io)
 
-![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
+**netdata** is a highly optimized Linux daemon providing **real-time performance and health monitoring for Linux systems, applications and SNMP devices, over the web**! It has been designed to permanently run on all systems, without disrupting the applications running on them.
 
 ---
 
-## Features
+**netdata** user and installation base, as reported by the [global public netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item):
+
+[![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)
+
+[![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)
+
+---
+
+## 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)
+
+---
+
+## At a glance
 
-**netdata** is a highly optimized Linux daemon providing **real-time performance monitoring for Linux systems, Applications, SNMP devices, over the web**!
+<p align="center">
+<img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>
+</p>
 
-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.
+**netdata** visualizes 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:
+
+ - real-time, per second updates, snappy refreshes!
+ - 300+ charts out of the box, 2000+ metrics monitored!
+ - zero configuration, zero maintenance, zero dependencies!
+ - dozens of health monitoring alarms, out of the box!
+
+![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
+
+---
+
+## Features
 
 This is what you get:
 
-1. **Beautiful out of the box** bootstrap dashboards
-2. **Custom dashboards** that can be built using simple HTML (no javascript necessary)
-3. **Blazingly fast** and **super efficient**, written in C (for default installations, expect just 2% of a single core CPU usage and a few MB of RAM)
-3. **Zero configuration** - you just install it and it autodetects everything
-4. **Zero dependencies**, it is its own web server for its static web files and its web API
-4. **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)
-7. **Embeddable**, it can run anywhere a Linux kernel runs
+- **Stunning bootstrap dashboards**, out of the box (theme-able: 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 auto-detects everything
+- **Zero dependencies**, it is even 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 python and node.js, so you can easily monitor any application, any API)
+- **Embeddable**, it can run anywhere a Linux kernel runs (even IoT) and its charts can be embedded on your web pages too
+- **Powerful alarms and notifications**, it can send alarms as email, slack.com messages, pushover.net mobile push notifications, telegram.org messages, and more.
 
 ---
 
-## What it monitors?
+## What does it monitor?
 
 This is what it currently monitors (most with zero configuration):
 
-1. **CPU usage, interrupts, softirqs and frequency** (total and per core)
-2. **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
-3. **Disk I/O** (per disk: bandwidth, operations, backlog, utilization, etc)
+- **CPU usage, interrupts, softirqs and frequency** (total and per core)
+
+- **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
+
+- **Disks** (per disk: I/O, operations, backlog, utilization, space, etc)
 
    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
 
-4. **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
+- **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
 
    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
 
-5. **IPv4 networking** (packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
-6. **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
-7. **Processes** (running, blocked, forks, active, etc)
-8. **Entropy**
-9. **NFS file servers**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
-10. **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
+- **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
+
+- **IPv6 networking** (bandwidth, packets, errors, fragments, ECT, udp: packets, errors, udplite: packets, errors, broadcast: bandwidth, multicast: bandwidth, packets, icmp: messages, errors, echos, router, neighbor, MLDv2, group membership, break down by type)
+
+- **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
+
+- **Linux DDoS protection** (SYNPROXY metrics)
+
+- **Processes** (running, blocked, forks, active, etc)
+
+- **Entropy** (random numbers pool, using in cryptography)
+
+- **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
 
-11. **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, 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)
 
-12. **Apache web server** mod-status (v2.2, v2.4)
-13. **Nginx web server** stub-status
-14. **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
-15. **ISC Bind name server** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
-16. **Postfix email server** message queue (entries, size)
-17. **Squid proxy server** (clients bandwidth and requests, servers bandwidth and requests) 
-18. **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
-19. **NUT UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
+- **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)
 
-Any number of **SNMP devices** can be monitored, although you will need to configure these.
+- **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too)
 
-And you can extend it, by writing plugins that collect data from any source, using any computer language.
+- **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)
+
+- **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)
+
+- **exim email servers** message queue (emails queued)
+
+- **IPFS** (Bandwidth, Peers)
 
-## Still not convinced?
+- **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests)
 
-Read **[Why netdata?](https://github.com/firehol/netdata/wiki/Why-netdata%3F)**
+- **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
+
+- **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
+
+- **Tomcat** (accesses, threads, free memory, volume)
+
+- **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
+
+- **hddtemp** (disk temperatures)
+
+- **SNMP devices** can be monitored too (although you will need to configure these)
+
+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. We have tested it 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
+- Ubuntu
 
 ---
 
@@ -91,3 +167,8 @@ It should run on any Linux system. We have tested it on:
 
 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).