]> arthur.barton.de Git - netdata.git/blobdiff - README.md
updated README.md for the 1.3.0 release
[netdata.git] / README.md
index abb45e53295d87283ad6267ff010ce15df56db08..759d4e93e2a6ef5d08cab35f2a3d8ff5ff52ab1f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,35 @@
-# netdata
+[![Build Status](https://travis-ci.org/firehol/netdata.svg?branch=master)](https://travis-ci.org/firehol/netdata)
+<a href="https://scan.coverity.com/projects/firehol-netdata"><img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/9140/badge.svg"/></a>
+[![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&v41)](https://registry.my-netdata.io/#netdata_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&v41)](https://registry.my-netdata.io/#netdata_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&v41)](https://registry.my-netdata.io/#netdata_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&v41)](https://registry.my-netdata.io/#netdata_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&v41)](https://registry.my-netdata.io/#netdata_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&v41)](https://registry.my-netdata.io/#netdata_registry)
 
-#### 180.000+ views, 50.000+ visitors, 15.000+ downloads, 8.000+ github stars, 400+ forks, 7 days!
 
-And it still runs with 1.000+ git downloads... per day!
+# netdata
 
-**[check what our users say about netdata](https://github.com/firehol/netdata/issues/148)**.
+> Aug 28th, 2016
+>
+> [netdata v1.3.0 released!](https://github.com/firehol/netdata/releases)
+>
+> - netdata has **[health monitoring / alarms](https://github.com/firehol/netdata/wiki/health-monitoring)**!
+> - netdata **[generates badges](https://github.com/firehol/netdata/wiki/Generating-Badges)** that can be embeded anywhere!
+> - netdata plugins are now written in python!
+> - new plugins: redis, memcached, nginx_log, ipfs, apache_cache
+
+---
 
-Thank you!
+> May 16th, 2016
+>
+> [netdata v1.2.0 released!](https://github.com/firehol/netdata/releases)
+>
+> - 30% faster!
+> - **[netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item)**, the first step towards scaling out performance monitoring!
+> - real-time Linux Containers monitoring!
+> - dozens of additional new features, optimizations, bug-fixes
 
 ---
 
@@ -18,7 +41,7 @@ This is the default dashboard of **netdata**:
  - 300+ charts out of the box, 2000+ metrics monitored!
  - zero configuration, zero maintenance, zero dependencies!
 
-Live demo: [http://netdata.firehol.org](http://netdata.firehol.org)
+Live demo: [http://my-netdata.io](http://my-netdata.io)
 
 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
 
@@ -32,14 +55,14 @@ It tries to visualize the **truth of now**, in its **greatest detail**, so that
 
 This is what you get:
 
-- **Stunning bootstrap dashboards**, out of the box
+- **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)
-- **Embeddable**, it can run anywhere a Linux kernel runs and its charts can be embedded on your web pages too
+- **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 (even IoT) and its charts can be embedded on your web pages too
 
 ---
 
@@ -51,7 +74,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,7 +88,7 @@ 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)
 
@@ -77,37 +100,47 @@ This is what it currently monitors (most with zero configuration):
 
    ![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 server** mod-status (v2.2, v2.4) and cache log statistics (multiple servers)
 
-- **Nginx web server** stub-status
+- **Nginx web server** 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 server** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
 
 - **Postfix email server** message queue (entries, size)
 
-- **Squid proxy server** (clients bandwidth and requests, servers bandwidth and requests) 
+- **exim email server** message queue (emails queued)
+
+- **IPFS** (Bandwidth, Peers)
+
+- **Squid proxy server** (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)
 
-Any number of **SNMP devices** can be monitored, 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.
 
 ---
 
@@ -118,7 +151,7 @@ Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installa
 It should run on **any Linux** system. It has been tested on:
 
 - Gentoo
-- ArchLinux
+- Arch Linux
 - Ubuntu / Debian
 - CentOS
 - Fedora
@@ -132,14 +165,3 @@ It should run on **any Linux** system. It has been tested on:
 ## Documentation
 
 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
-
-
-## Git sources
-
-You are looking at a version of the sources extracted directly from git.
-If you want a version of the source package where `configure` and any
-documentation has been built for you, please get an official
-[netdata package download](https://firehol.org/download/netdata/).
-The `unsigned/master` folder tracks the head of the git tree and
-released packages are also available.
-