diff options
| author | Lennart Weller <lhw@ring0.de> | 2017-01-24 15:21:09 +0000 |
|---|---|---|
| committer | Lennart Weller <lhw@ring0.de> | 2017-01-24 15:21:09 +0000 |
| commit | 3ed3b02ed96ddab1c084811f3579b3a2aec83e04 (patch) | |
| tree | 7a61ab288ae47800c4f11be5677d6ad8288dcd98 /README.md | |
| parent | New upstream version 1.4.0+dfsg (diff) | |
| download | netdata-3ed3b02ed96ddab1c084811f3579b3a2aec83e04.tar.xz netdata-3ed3b02ed96ddab1c084811f3579b3a2aec83e04.zip | |
New upstream version 1.5.0+dfsgupstream/1.5.0+dfsg
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 278 |
1 files changed, 189 insertions, 89 deletions
@@ -1,148 +1,240 @@ -[](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> -[](https://hub.docker.com/r/titpetric/netdata/) +# netdata [](https://travis-ci.org/firehol/netdata) [](https://scan.coverity.com/projects/firehol-netdata) [](https://codeclimate.com/github/firehol/netdata) [](https://hub.docker.com/r/titpetric/netdata/) +> *New to netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)* -[](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) +**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**. -[](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) +_netdata is **fast** and **efficient**, designed to permanently run on all systems +(**physical** & **virtual** servers, **containers**, **IoT** devices), without +disrupting their core function._ +--- -# netdata - -> 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) +## User base ---- +*Since May 16th 2016 (the date the [global public netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item) was released):*<br/> +[](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) -> 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 +*in the last 24 hours:*<br/> +[](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) --- -**Real-time performance and health monitoring, done right!** +## News -This is the default dashboard of **netdata**: +<p align="center"> +Netdata is featured at <b><a href="https://octoverse.github.com/" target="_blank">GitHub's State Of The Octoverse 2016</a></b><br/> +<a href="https://octoverse.github.com/" target="_blank"><img src="https://cloud.githubusercontent.com/assets/2662304/21743260/23ebe62c-d507-11e6-80c0-76b95f53e464.png"/></a> +</p> - - 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! +`Jan 22nd, 2017` - **[netdata v1.5.0 released!](https://github.com/firehol/netdata/releases)** -Live demo: [http://my-netdata.io](http://my-netdata.io) - - + - 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 --- ## Features -**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. +<p align="center"> +<img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/> +</p> + + - **Stunning interactive bootstrap dashboards**<br/> + mouse and touch friendly, in 2 themes: dark, light + + - **Amazingly fast**<br/> + responds to all queries in less than 0.5 ms per metric, + even on low-end hardware + + - **Highly efficient**<br/> + 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**<br/> + 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**<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, ruby, etc) + + - **Embeddable**<br/> + it can run anywhere a Linux kernel runs (even IoT) + and its charts can be embedded on your web pages too + + - **Customizable**<br/> + custom dashboards can be built using simple HTML (no javascript necessary) + + - **Zero configuration**<br/> + auto-detects everything, it can collect up to 5000 metrics + per server out of the box + + - **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 + + - **scales to infinity**<br/> + requiring minimal central resources + + - **back-ends supported**<br/> + 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) -This is what you get: - -- **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 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 + --- ## What does it monitor? -This is what it currently monitors (most with zero configuration): +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._ -- **CPU usage, interrupts, softirqs and frequency** (total and per core) +This is a list of what it currently monitors: -- **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper) +- **CPU**<br/> + usage, interrupts, softirqs, frequency, total and per core -- **Disks** (per disk: I/O, operations, backlog, utilization, space, etc) +- **Memory**<br/> + RAM, swap and kernel memory usage, KSM (Kernel Samepage Merging), NUMA + +- **Disks**<br/> + per disk: I/O, operations, backlog, utilization, space  -- **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc) +- **Network interfaces**<br/> + 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**<br/> + bandwidth, packets, errors, fragments, + tcp: connections, packets, errors, handshake, + udp: packets, errors, + broadcast: bandwidth, packets, + multicast: bandwidth, packets + +- **IPv6 networking**<br/> + 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**<br/> + such as semaphores and semaphores arrays -- **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**<br/> + connections, connection tracker events, errors -- **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc) +- **Linux DDoS protection**<br/> + SYNPROXY metrics -- **Linux DDoS protection** (SYNPROXY metrics) +- **fping** latencies</br> + for any number of hosts, showing latency, packets and packet loss -- **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) +- **Processes**<br/> + running, blocked, forks, active -- **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime) +- **Entropy**<br/> + random numbers pool, using in cryptography + +- **NFS file servers and clients**<br/> + NFS v2, v3, v4: I/O, cache, read ahead, RPC calls + +- **Network QoS**<br/> + the only tool that visualizes network `tc` classes in realtime  -- **Linux Control Groups** (containers), systemd, lxc, docker, etc +- **Linux Control Groups**<br/> + containers: systemd, lxc, docker -- **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc) +- **Applications**<br/> + 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**<br/> + 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**<br/> + `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers -- **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too) +- **Nginx web servers**<br/> + `stub-status`, for multiple servers -- **Nginx web servers** stub-status (multiple servers) +- **Tomcat**<br/> + accesses, threads, free memory, volume -- **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc) +- **mySQL databases**<br/> + multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, + tmp operations, connections, binlog metrics, threads, innodb metrics, and more -- **Redis databases** (multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves) +- **Postgres databases**<br/> + multiple servers, each showing: per database statistics (connections, tuples + read - written - returned, transactions, locks), backend processes, indexes, + tables, write ahead, background writer and more -- **memcached databases** (multiple servers, each showing: bandwidth, connections, items, etc) +- **Redis databases**<br/> + multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves -- **ISC Bind name servers** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics) +- **memcached databases**<br/> + multiple servers, each showing: bandwidth, connections, items -- **Postfix email servers** message queue (entries, size) +- **ISC Bind name servers**<br/> + multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics -- **exim email servers** message queue (emails queued) +- **Postfix email servers**<br/> + message queue (entries, size) -- **IPFS** (Bandwidth, Peers) +- **exim email servers**<br/> + message queue (emails queued) -- **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests) +- **Dovecot** POP3/IMAP servers<br/> -- **Hardware sensors** (temperature, voltage, fans, power, humidity, etc) +- **IPFS**<br/> + bandwidth, peers -- **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics) +- **Squid proxy servers**<br/> + multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests -- **Tomcat** (accesses, threads, free memory, volume) +- **Hardware sensors**<br/> + temperature, voltage, fans, power, humidity -- **PHP-FPM** (multiple instances, each reporting connections, requests, performance) +- **NUT and APC UPSes**<br/> + load, charge, battery voltage, temperature, utility metrics, output metrics -- **hddtemp** (disk temperatures) +- **PHP-FPM**<br/> + multiple instances, each reporting connections, requests, performance -- **SNMP devices** can be monitored too (although you will need to configure these) +- **hddtemp**<br/> + disk temperatures + +- **SNMP devices**<br/> + 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. @@ -150,22 +242,30 @@ And you can extend it, by writing plugins that collect data from any source, usi ## 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 +- Alpine - Arch Linux -- Ubuntu / Debian - 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). |