X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=README.md;h=240ab32be600590da0c7072e5da0076b261595f0;hb=e498c0f39ea9a142d6cc3112cee4cac2060ba2d7;hp=7f16a342c392f3014e86e72648083e3adbd7b158;hpb=09fad4060d8291b26493e70c5e0297684d4a6439;p=netdata.git
diff --git a/README.md b/README.md
index 7f16a342..240ab32b 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
-# netdata [](https://travis-ci.org/firehol/netdata) [](https://scan.coverity.com/projects/firehol-netdata) [](https://hub.docker.com/r/titpetric/netdata/)
+# netdata [](https://travis-ci.org/firehol/netdata) [](https://scan.coverity.com/projects/firehol-netdata) [](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=firehol/netdata&utm_campaign=Badge_Grade) [](https://codeclimate.com/github/firehol/netdata) [](https://hub.docker.com/r/titpetric/netdata/) [](https://twitter.com/linuxnetdata)
+> *New to netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*
-> New to netdata? Live demo: [http://my-netdata.io](http://my-netdata.io)
+**netdata** is a system for **distributed real-time performance and health monitoring**.
+It provides **unparalleled insights, in real-time**, of everything happening on the
+system it runs (including applications such as web and database servers), using
+**modern interactive web dashboards**.
-**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.
+_netdata is **fast** and **efficient**, designed to permanently run on all systems
+(**physical** & **virtual** servers, **containers**, **IoT** devices), without
+disrupting their core function._
---
-**netdata** user and installation base, as reported by the [global public netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item):
+## User base
+*Since May 16th 2016 (the date the [global public netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item) was released):*
[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
+*in the last 24 hours:*
[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
---
@@ -17,125 +25,216 @@
## News
-
+Netdata is featured at GitHub's State Of The Octoverse 2016
+
-> `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)
+`Jan 22nd, 2017` - **[netdata v1.5.0 released!](https://github.com/firehol/netdata/releases)**
+
+ - netdata now runs on **FreeBSD** and **MacOS**
+ - netdata now supports **Graphite**, **OpenTSDB**, **Prometheus** and compatible backends
+ - netdata now monitors **systemd Services**
+ - new plugins: fping, postgres, varnish, elasticsearch, haproxy, freeradius, mdstat, ISC dhcpd, fail2ban, openvpn, NUMA memory, CPU Idle States, gunicorn, ECC memory errors, IPC semaphores, uptime
+ - improved plugins: netfilter conntrack, mysql/mariadb, ipfs, cpufreq, hddtemp, sensors, nginx, nginx_log, phpfpm, redis, dovecot, containers and cgroups, disk space, apps.plugin, tc (QoS) and almost all internal plugins (memory, IPv4 and IPv6, network interfaces, QoS, etc)
+ - dozens of new and improved alarms (including performance monitoring alarms for mysql)
+ - new alarm notifications: messagebird.com, pagerduty.com, pushbullet.com, twilio.com, hipchat, kafka
+ - dozens more improvements and performance optimizations
---
-## At a glance
+## Features
-**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!
+ - **Stunning interactive bootstrap dashboards**
+ mouse and touch friendly, in 2 themes: dark, light
+
+ - **Amazingly fast**
+ responds to all queries in less than 0.5 ms per metric,
+ even on low-end hardware
+
+ - **Highly efficient**
+ collects thousands of metrics per server per second,
+ with just 1% CPU utilization of a single core, a few MB of RAM and no disk I/O at all
+
+ - **Sophisticated alarming**
+ supports dynamic thresholds, hysteresis, alarm templates,
+ multiple role-based notification methods (such as email, slack.com,
+ pushover.net, pushbullet.com, telegram.org, twilio.com, messagebird.com)
+
+ - **Extensible**
+ 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, ruby, etc)
+
+ - **Embeddable**
+ it can run anywhere a Linux kernel runs (even IoT)
+ and its charts can be embedded on your web pages too
+
+ - **Customizable**
+ custom dashboards can be built using simple HTML (no javascript necessary)
+
+ - **Zero configuration**
+ auto-detects everything, it can collect up to 5000 metrics
+ per server out of the box
+
+ - **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
+
+ - **scales to infinity**
+ requiring minimal central resources
+
+ - **back-ends supported**
+ can archive its metrics on `graphite` or `opentsdb`, in the same or lower detail
+ (lower: to prevent it from congesting these servers due to the amount of data collected)
---
-## Features
-
-This is what you get:
+## What does it monitor?
-- **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.
+netdata monitors several thousands of metrics per device.
+All these metrics are collected and visualized in real-time.
----
+> _Almost all metrics are auto-detected, without any configuration._
-## What does it monitor?
+This is a list of what it currently monitors:
-This is what it currently monitors (most with zero configuration):
+- **CPU**
+ usage, interrupts, softirqs, frequency, total and per core
-- **CPU usage, interrupts, softirqs and frequency** (total and per core)
+- **Memory**
+ RAM, swap and kernel memory usage, KSM (Kernel Samepage Merging), NUMA
-- **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
-
-- **Disks** (per disk: I/O, operations, backlog, utilization, space, etc)
+- **Disks**
+ per disk: I/O, operations, backlog, utilization, space
-- **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
+- **Network interfaces**
+ per interface: bandwidth, packets, errors, drops
-- **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
+- **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
+
+- **Interprocess Communication - IPC**
+ such as semaphores and semaphores arrays
+
+- **netfilter / iptables Linux firewall**
+ connections, connection tracker events, errors
-- **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)
+- **Linux DDoS protection**
+ SYNPROXY metrics
-- **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
+- **fping** latencies
+ for any number of hosts, showing latency, packets and packet loss
-- **Linux DDoS protection** (SYNPROXY metrics)
+ 
-- **Processes** (running, blocked, forks, active, etc)
-- **Entropy** (random numbers pool, using in cryptography)
+- **Processes**
+ running, blocked, forks, active
-- **NFS file servers and clients**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
+- **Entropy**
+ random numbers pool, using in cryptography
-- **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
+- **NFS file servers and clients**
+ NFS v2, v3, v4: I/O, cache, read ahead, RPC calls
+
+- **Network QoS**
+ the only tool that visualizes network `tc` classes in realtime
-- **Linux Control Groups** (containers), systemd, lxc, docker, etc
+- **Linux Control Groups**
+ containers: systemd, lxc, docker
-- **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
+- **Applications**
+ by grouping the process tree and reporting CPU, memory, disk reads,
+ disk writes, swap, threads, pipes, sockets - per group
-- **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)
+- **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
+
+- **Apache and lighttpd web servers**
+ `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers
+
+- **Nginx web servers**
+ `stub-status`, for multiple servers
-- **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too)
+- **Tomcat**
+ accesses, threads, free memory, volume
-- **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, and more
-- **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
+- **Postgres databases**
+ multiple servers, each showing: per database statistics (connections, tuples
+ read - written - returned, transactions, locks), backend processes, indexes,
+ tables, write ahead, background writer and more
-- **Redis databases** (multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves)
+- **Redis databases**
+ multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves
-- **memcached databases** (multiple servers, each showing: bandwidth, connections, items, etc)
+- **memcached databases**
+ multiple servers, each showing: bandwidth, connections, items
-- **ISC Bind name servers** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
+- **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 servers**
+ message queue (entries, size)
-- **exim email servers** message queue (emails queued)
+- **exim email servers**
+ message queue (emails queued)
-- **IPFS** (Bandwidth, Peers)
+- **Dovecot** POP3/IMAP servers
-- **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests)
+- **IPFS**
+ bandwidth, peers
-- **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
+- **Squid proxy servers**
+ multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests
-- **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
+- **Hardware sensors**
+ temperature, voltage, fans, power, humidity
-- **Tomcat** (accesses, threads, free memory, volume)
+- **NUT and APC UPSes**
+ load, charge, battery voltage, temperature, utility metrics, output metrics
-- **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
+- **PHP-FPM**
+ multiple instances, each reporting connections, requests, performance
-- **hddtemp** (disk temperatures)
+- **hddtemp**
+ disk temperatures
-- **SNMP devices** can be monitored too (although you will need to configure these)
+- **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.
@@ -153,7 +252,7 @@ It should run on **any Linux** system (including IoT). It has been tested on:
- Debian
- Fedora
- Gentoo
-- OpenSuse
+- openSUSE
- PLD Linux
- RedHat Enterprise Linux
- SUSE