-netdata
-=======
+# netdata
-### Linux real time system monitoring, over the web!
+#### 180.000+ views, 50.000+ visitors, 15.000+ downloads, 8.000+ github stars, 400+ forks, 7 days!
-**Netdata** is a daemon that collects system information from a linux system and presents a web site to view the data.
-The presentation is full of charts that precisely render all system values, in realtime, for a short time (1 hour by default).
+And it still runs with 1.000+ git downloads... per day!
-You can use it to monitor all your servers, linux PCs or linux embedded devices, without the need to ssh to them.
-Also, you can view a short history of all collected values, so if something happens you can use **netdata** to find out what and when.
+**[check what our users say about netdata](https://github.com/firehol/netdata/issues/148)**.
-Check it live at:
+Thank you!
- - [My Home Gentoo Box](http://195.97.5.206:19999/)
- - [My Home Raspberry Pi B+](http://195.97.5.204:19999/) with data collection every 5s (raspbian playing movies 24x7)
- - [My Home Raspberry Pi 2](http://195.97.5.205:19999/) (osmc as an access point)
+---
-Here is a screenshot:
+**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!
-# Features
+Live demo: [http://netdata.firehol.org](http://netdata.firehol.org)
-- **highly optimized C code**
+
- It only needs a few milliseconds per second to collect all the data.
- It will nicelly run even on a raspberry pi with just one cpu core, or any other embedded system.
+---
-- **extremely lightweight**
+## Features
- It only needs a few megabytes of memory to store all its round robin database.
-
- Although `netdata` does all its calculation using `long double` (128 bit) arithmetics, it stores all values using a **custom-made 32-bit number**. This custom-made number can store in 29 bits values from -167772150000000.0 to 167772150000000.0 with a precision of 0.00001 (yes, it is a floating point number, meaning that higher integer values have less decimal precision) and 3 bits for flags (2 are currently used and 1 is reserved for future use). This provides an extremely optimized memory footprint with just 0.0001% max accuracy loss (run: `./netdata --unittest` to see it in action).
+**netdata** is a highly optimized Linux daemon providing **real-time performance monitoring for Linux systems, Applications, SNMP devices, over the web**!
-- **per second data collection**
+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.
- Every chart, every value, is updated every second. Of course, you can control collection period per module.
+This is what you get:
- **netdata** can perform several calculations on each value (dimension) collected:
+- **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
- - **absolute**, stores the collected value, as collected (this is used, for example for the number of processes running, the number of connections open, the amount of RAM used, etc)
+---
- - **incremental**, stores the difference of the collected value to the last collected value (this is used, for example, for the bandwidth of interfaces, disk I/O, i.e. for counters that always get incremented) - **netdata** automatically interpolates these values to second boundary, using nanosecond calculations so that small delays at the data collection layer will not affect the quality of the result - also, **netdata** detects arithmetic overflows and presents them properly at the charts.
+## What does it monitor?
- - **percentage of absolute row**, stores the percentage of the collected value, over the sum of all dimensions of the chart.
+This is what it currently monitors (most with zero configuration):
- - **percentage of incremental row**, stores the percentage of this collected value, over the sum of the the **incremental** differences of all dimensions of the chart (this is used, for example, for system CPU utilization).
+- **CPU usage, interrupts, softirqs and frequency** (total and per core)
-- **visualizes QoS classes automatically**
+- **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
- If you also use FireQOS for QoS, it collects class names automatically.
+- **Disks** (per disk: I/O, operations, backlog, utilization, etc)
-- **appealing web site**
+ 
- The web site uses bootstrap and google charts for a very appealing result.
- It works even on mobile devices and adapts to screen size changes and rotation (responsive design).
+- **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
-- **web charts do respect your browser resources**
+ 
- The charts adapt to show only as many points are required to have a clear view.
- Also, the javascript code respects your browser resources (stops refreshing when the window looses focus, when scrolling, etc).
+- **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
-- **highly configurable**
+- **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)
- All charts and all features can be enabled or disabled.
- The program generates its configuration file based on the resources available on the system it runs, for you to edit.
+- **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
-- It reads and renders charts for all these:
- - `/proc/net/dev` (all netwrok interfaces for all their values)
- - `/proc/diskstats` (all disks for all their values)
- - `/proc/net/snmp` (total IPv4, TCP and UDP usage)
- - `/proc/net/netstat` (more IPv4 usage)
- - `/proc/net/stat/nf_conntrack` (connection tracking performance)
- - `/proc/net/ip_vs/stats` (IPVS connection statistics)
- - `/proc/stat` (CPU utilization)
- - `/proc/meminfo` (memory information)
- - `/proc/vmstat` (system performance)
- - `/proc/net/rpc/nfsd` (NFS server statistics for both v3 and v4 NFS)
- - `tc` classes (QoS classes)
+- **Linux anti-DDoS protection** (SYNPROXY metrics)
-- It supports **plugins** for collecting information from other sources!
+- **Processes** (running, blocked, forks, active, etc)
- Plugins can be written in any computer language (pipe / stdout communication for data collection).
+- **Entropy** (random numbers pool, using in cryptography)
- It ships with 2 plugins: `apps.plugin` and `charts.d.plugin`:
+- **NFS file servers**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
- - `apps.plugin` is a plugin that attempts to collect statistics per process. It groups the entire process tree based on your settings (for example, mplayer, kodi, vlc are all considered `media`) and for each group it attempts to find CPU usage, memory usages, physical and logical disk read and writes, number of processes, number of threads, number of open files, number of open sockets, number of open pipes, minor and major page faults (major = swapping), etc. 15 stackable (per group) charts in total.
+- **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
- - `charts.d.plugin` provides a simple way to script data collection in BASH. It includes example plugins that collect values from:
+ 
- - `nut` (UPS load, frequency, voltage, etc)
- - `sensors` (temperature, voltage, current, power, humidity, fans rotation sensors)
- - `cpufreq` (current CPU clock frequency)
- - `postfix` (e-mail queue size)
- - `squid` (web proxy statistics)
- - `mysql` (mysql global statistics)
+- **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
- Of course, you can write your own using BASH scripting.
+ 
-- netdata is a web server, supporting gzip compression
+- **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)
- It serves its own static files and dynamic files for rendering the site.
- It does not support authentication or SSL - limit its access using your firewall.
- It does not allow ` .. ` or ` / ` in the files requested (so it can only serve files stored in the `web/` directory).
+- **Apache web server** mod-status (v2.2, v2.4)
+- **Nginx web server** stub-status
-# How it works
+- **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
-1. You run a daemon on your linux: netdata.
- This deamon is written in C and is extremely lightweight.
-
- netdata:
+- **ISC Bind name server** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
- - Spawns threads to collect all the data for all sources
- - Keeps track of the collected values in memory (no disk I/O at all)
- - Generates JSON and JSONP HTTP responses containing all the data needed for the web graphs
- - Is a standalone web server.
+- **Postfix email server** message queue (entries, size)
- For example, you can access JSON data by using:
-
- ```
- http://127.0.0.1:19999/data/net.eth0
- ```
-
- This will give you the JSON file for traffic on eth0.
- The above is equivalent to:
-
- ```
- http://127.0.0.1:19999/data/net.eth0/3600/1/average/0/0
- ```
-
- where:
+- **Squid proxy server** (clients bandwidth and requests, servers bandwidth and requests)
- - 3600 is the number of entries to generate.
- - 1 is grouping count, 1 = every single entry, 2 = half the entries, 3 = one every 3 entries, etc
- - `average` is the grouping method. It can also be `max`.
- - 0/0 they are `before` and `after` timestamps, allowing panning on the data
+- **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
+- **NUT UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
-2. If you need to embed a **netdata** chart on your web page, you can add a few javascript lines and a `div` for every graph you need. Check [this example](http://195.97.5.206:19999/datasource.html) (open it in a new tab and view its source to get the idea).
+- **SNMP devices** can be monitored too (although you will need to configure these)
-3. Graphs are generated using Google Charts API (so, your client needs to have internet access).
+And you can extend it, by writing plugins that collect data from any source, using any computer language.
+---
-# Installation
+## Still not convinced?
-## Automatic installation
+Read **[Why netdata?](https://github.com/firehol/netdata/wiki/Why-netdata%3F)**
-Before you start, make sure you have `zlib` development files installed.
-To install it in Ubuntu, you need to run:
+---
-```sh
-apt-get install zlib1g-dev
-```
+## Installation
-You also need to have a basic build environment in place. You will need packages like
-`pgk-config`, `autoconf`, `gcc`, etc.
+Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system
-Then do this to install and run netdata:
+It should run on **any Linux** system. It has been tested on:
-```sh
+- Gentoo
+- ArchLinux
+- Ubuntu / Debian
+- CentOS
+- Fedora
+- RedHat Enterprise Linux
+- SUSE
+- Alpine Linux
+- PLD Linux
-# download it
-git clone https://github.com/ktsaou/netdata.git netdata.git
-cd netdata.git
+---
-# build it
-./netdata-installer.sh
+## Documentation
-```
-
-The script `netdata-installer.sh` will build netdata and install it to your system.
-
-Once the installer completes, the file `/etc/netdata/netdata.conf` will be created.
-You can edit this file to set options.
-To apply the changes you made, you have to run netdata.start again.
-
-- You can start netdata by executing it with `netdata` (the installer will also start it).
-
-- You can stop netdata by killing it with `killall netdata`.
- You can stop and start netdata at any point. Netdata saves on exit its round robbin
- database to `/var/cache/netdata` so that it will continue from where it stopped the last time.
-
-To access the web site for all graphs, go to:
-
- ```
- http://127.0.0.1:19999/
- ```
-
-You can get the running config file at any time, by accessing `http://127.0.0.1:19999/netdata.conf`.
-
-To start it at boot, just run `netdata` from your `/etc/rc.local` or equivalent.
+Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
projects / netdata.git / blobdiff