diff options
Diffstat (limited to 'docs/what-is-netdata.md')
| -rw-r--r-- | docs/what-is-netdata.md | 374 |
1 files changed, 285 insertions, 89 deletions
diff --git a/docs/what-is-netdata.md b/docs/what-is-netdata.md index 2a30124ef6..d87161849c 100644 --- a/docs/what-is-netdata.md +++ b/docs/what-is-netdata.md @@ -1,61 +1,177 @@ <!-- --- title: "What is Netdata?" -date: 2020-03-31 +date: 2020-04-07 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/what-is-netdata.md --- --> -# What is Netdata? +# Netdata [](https://travis-ci.com/netdata/netdata) [](https://bestpractices.coreinfrastructure.org/projects/2231) [](https://www.gnu.org/licenses/gpl-3.0) [](<>) -[](https://travis-ci.com/netdata/netdata) [](https://bestpractices.coreinfrastructure.org/projects/2231) [](https://www.gnu.org/licenses/gpl-3.0) [](<>) - -[](https://codeclimate.com/github/netdata/netdata) [](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade) [](https://lgtm.com/projects/g/netdata/netdata/context:cpp) [](https://lgtm.com/projects/g/netdata/netdata/context:javascript) [](https://lgtm.com/projects/g/netdata/netdata/context:python) +[](https://codeclimate.com/github/netdata/netdata) +[](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade) +[](https://lgtm.com/projects/g/netdata/netdata/context:cpp) +[](https://lgtm.com/projects/g/netdata/netdata/context:javascript) +[](https://lgtm.com/projects/g/netdata/netdata/context:python) --- -**Netdata** is **distributed, real-time, performance and health monitoring for systems and applications**. It is a highly optimized monitoring agent you install on all your systems and containers. +Netdata is **distributed, real-time performance and health monitoring** for systems and applications. It is a +highly-optimized monitoring agent you install on all your systems and containers. + +Netdata provides **unparalleled insights**, in **real-time**, of everything happening on the systems it's running on +(including web servers, databases, applications), using **highly interactive web dashboards**. + +A highly-efficient database **stores long-term historical metrics for days, weeks, or months**, all at 1-second +granularity. Run this long-term storage autonomously, or integrate Netdata with your existing monitoring toolchains +(Prometheus, Graphite, OpenTSDB, Kafka, Grafana, and more). -Netdata provides **unparalleled insights**, **in real-time**, of everything happening on the systems it runs (including web servers, databases, applications), using **highly interactive web dashboards**. It can run autonomously, without any third party components, or it can be integrated to existing monitoring tool chains (Prometheus, Graphite, OpenTSDB, Kafka, Grafana, etc). +Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** and **virtual** servers, +**containers**, **IoT** devices), without disrupting their core function. -_Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** & **virtual** servers, **containers**, **IoT** devices), without disrupting their core function._ +Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **macOS**, along with +other systems derived from them, such as **Kubernetes** and **Docker**. -Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **macOS**. +Netdata is not hosted by the CNCF but is the 3rd most starred open-source project in the [Cloud Native Computing +Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars). --- -## How it looks +People get **addicted to Netdata**. Once you use it on your systems, **there is no going back**! _You've been warned..._ + + + +[](https://twitter.com/intent/tweet?text=Netdata,%20real-time%20performance%20and%20health%20monitoring,%20done%20right!&url=https://my-netdata.io/&via=linuxnetdata&hashtags=netdata,monitoring) -The following animated image, shows the top part of a typical Netdata dashboard. +## Contents - +1. [What does it look like?](#what-does-it-look-like) - Take a quick tour through the dashboard +2. [Our userbase](#user-base) - Enterprises we help monitor and our userbase +3. [Quickstart](#quickstart) - How to try it now on your systems +4. [Why Netdata](#why-netdata) - Why people love Netdata and how it compares with other solutions +5. [How Netdata works](#how-it-works) - A high-level diagram of how Netdata works +6. [Infographic](#infographic) - Everything about Netdata in a single graphic +7. [Features](#features) - How you'll use Netdata on your systems +8. [Visualization](#visualization) - Learn about visual anomaly detection +9. [What Netdata monitors](#what-netdata-monitors) - See which apps/services Netdata auto-detects +10. [Documentation](#documentation) - Read the documentation +11. [Community](#community) - Discuss Netdata with others and get support +12. [License](#license) - Check Netdata's licencing +13. [Is it any good?](#is-it-any-good) - Yes. +14. [Is it awesome?](#is-it-awesome) - Yes. -_A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive and **real-time**, optimized to get the work done!_ +## What does it look like? -> _We have a few online demos to experience it live: [https://www.netdata.cloud](https://www.netdata.cloud/#live-demo)_ +The following animated GIF shows the top part of a typical Netdata dashboard. + + + +> A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse +> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive, +> **real-time**, and optimized to get the work done! + +Want to see Netdata live? Check out any of our [live demos](https://www.netdata.cloud/#live-demo). ## User base -Netdata is used by hundreds of thousands of users all over the world. -Check our [GitHub watchers list](https://github.com/netdata/netdata/watchers). -You will find people working for **Amazon**, **Atos**, **Baidu**, **Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**, -**Elastic**, **EPAM Systems**, **Ericsson**, **Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**, -**IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red Hat**, **SAP**, **Selectel**, **TicketMaster**, -**Vimeo**, and many more! +Netdata is used by hundreds of thousands of users all over the world. Check our [GitHub watchers +list](https://github.com/netdata/netdata/watchers). You will find people working for **Amazon**, **Atos**, **Baidu**, +**Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**, **Elastic**, **EPAM Systems**, **Ericsson**, +**Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**, **IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red +Hat**, **SAP**, **Selectel**, **TicketMaster**, **Vimeo**, and many more! ### Docker pulls -We provide docker images for the most common architectures. These are statistics reported by docker hub: +We provide Docker images for the most common architectures. These are statistics reported by Docker Hub: -[](https://hub.docker.com/r/netdata/netdata/) [](https://hub.docker.com/r/firehol/netdata/) [](https://hub.docker.com/r/titpetric/netdata/) +[](https://hub.docker.com/r/netdata/netdata/) +[](https://hub.docker.com/r/firehol/netdata/) +[](https://hub.docker.com/r/titpetric/netdata/) ### Registry -When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run: +When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata +registry](/registry/README.md). This is a web browser feature and it allows us to count the number of unique users and +unique Netdata servers installed. The following information comes from the global public Netdata registry we run: + +[](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:_<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) + +## Quickstart + + + + +To install Netdata from source on any Linux system (physical, virtual, container, IoT, edge) and keep it up to date with +our **nightly releases** automatically, run the following: + +```bash +# make sure you run `bash` for your shell +bash + +# install Netdata directly from GitHub source +bash <(curl -Ss https://my-netdata.io/kickstart.sh) +``` + +Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read +about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md) page. + +The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for +_actively_ contributing to Netdata's future. + +To learn more about the pros and cons of using _nightly_ vs. _stable_ releases, see our [notice about the two options](/packaging/installer/README.md#nightly-vs-stable-releases). + +The above command will: -[](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) +- Install any required packages on your system (it will ask you to confirm before doing so) +- Compile it, install it, and start it. -_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) +More installation methods and additional options can be found at the [installation +page](/packaging/installer/README.md). + +To try Netdata in a Docker container, run this: + +```sh +docker run -d --name=netdata \ + -p 19999:19999 \ + -v /etc/passwd:/host/etc/passwd:ro \ + -v /etc/group:/host/etc/group:ro \ + -v /proc:/host/proc:ro \ + -v /sys:/host/sys:ro \ + -v /var/run/docker.sock:/var/run/docker.sock:ro \ + --cap-add SYS_PTRACE \ + --security-opt apparmor=unconfined \ + netdata/netdata +``` + +For more information about running Netdata in Docker, check the [docker installation page](/packaging/docker/README.md). + + + +From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read +more about the information collected and how to opt-out, check the [anonymous statistics +page](/docs/anonymous-statistics.md). ## Why Netdata @@ -63,55 +179,59 @@ Netdata has a quite different approach to monitoring. Netdata is a monitoring agent you install on all your systems. It is: -- a **metrics collector** - for system and application metrics (including web servers, databases, containers, etc) -- a **time-series database** - all stored in memory (does not touch the disks while it runs) -- a **metrics visualizer** - super fast, interactive, modern, optimized for anomaly detection -- an **alarms notification engine** - an advanced watchdog for detecting performance and availability issues +- A **metrics collector** for system and application metrics (including web servers, databases, containers, and much + more), +- A **long-term metrics database** that stores recent metrics in memory and "spills" historical metrics to disk for + efficient long-term storage, +- A super fast, interactive, and modern **metrics visualizer** optimized for anomaly detection, +- And an **alarms notification engine** for detecting performance and availability issues. All the above, are packaged together in a very flexible, extremely modular, distributed application. This is how Netdata compares to other monitoring solutions: -| Netdata | others (open-source and commercial)| -|:-----:|:---------------------------------:| -| **High resolution metrics** (1s granularity)|Low resolution metrics (10s granularity at best)| -| Monitors everything, **thousands of metrics per node**|Monitor just a few metrics| -| UI is super fast, optimized for **anomaly detection**|UI is good for just an abstract view| -| **Meaningful presentation**, to help you understand the metrics|You have to know the metrics before you start| -| Install and get results **immediately**|Long preparation is required to get any useful results| -| Use it for **troubleshooting** performance problems|Use them to get *statistics of past performance*| -| **Kills the console** for tracing performance issues|The console is always required for troubleshooting| -| Requires **zero dedicated resources**|Require large dedicated resources| +| Netdata | others (open-source and commercial) | +| :-------------------------------------------------------------- | :--------------------------------------------------------------- | +| **High resolution metrics** (1s granularity) | Low resolution metrics (10s granularity at best) | +| Monitors everything, **thousands of metrics per node** | Monitor just a few metrics | +| UI is super fast, optimized for **anomaly detection** | UI is good for just an abstract view | +| **Long-term, autonomous storage** at one-second granularity | Centralized metrics in an expensive data lake at 10s granularity | +| **Meaningful presentation**, to help you understand the metrics | You have to know the metrics before you start | +| Install and get results **immediately** | Long preparation is required to get any useful results | +| Use it for **troubleshooting** performance problems | Use them to get _statistics of past performance_ | +| **Kills the console** for tracing performance issues | The console is always required for troubleshooting | +| Requires **zero dedicated resources** | Require large dedicated resources | Netdata is **open-source**, **free**, super **fast**, very **easy**, completely **open**, extremely **efficient**, **flexible** and integrate-able. -It has been designed by **SysAdmins**, **DevOps** and **Developers** for troubleshooting performance problems, -not just visualize metrics. +It has been designed by **system administrators**, **DevOps engineers**, and **developers** for to not just visualize +metrics, but also troubleshoot complex performance problems. ## How it works -Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for concurrent operations on the metrics. +Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for +concurrent operations on the metrics.  This is how it works: -|Function|Description|Documentation| -|:------:|:----------|:-----------:| -|**Collect**|Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects.|[`collectors`](../collectors/)| -|**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](../database/)| -|**Check**|A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications.|[`health`](../health/)| -|**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected.|[`streaming`](../streaming/)| -|**Archive**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](../backends/)| -|**Query**|Multiple independent workers are attached to the [internal web server](../web/server/), servicing API requests, including [data queries](../web/api/queries/README.md).|[`web/api`](../web/api/)| +| Function | Description | Documentation | +| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | +| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) | +| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) | +| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) | +| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) | +| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`backends`](/backends/README.md) | +| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) | -The result is a highly efficient, low latency system, supporting multiple readers and one writer on each metric. +The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric. ## Infographic -This is a high level overview of Netdata feature set and architecture. -Click it to interact with it (it has direct links to documentation). +This is a high level overview of Netdata feature set and architecture. Click it to to interact with it (it has direct +links to our documentation). [](https://my-netdata.io/infographic.html) @@ -123,41 +243,70 @@ This is what you should expect from Netdata: ### General -- **1s granularity** - the highest possible resolution for all metrics. -- **Unlimited metrics** - collects all the available metrics, the more the better. -- **1% CPU utilization of a single core** - it is super fast, unbelievably optimized. -- **A few MB of RAM** - by default it uses 25MB RAM. [You size it](../database). -- **Zero disk I/O** - while it runs, it does not load or save anything (except `error` and `access` logs). -- **Zero configuration** - auto-detects everything, it can collect up to 10000 metrics per server out of the box. -- **Zero maintenance** - You just run it, it does the rest. -- **Zero dependencies** - it is even its own web server, for its static web files and its web API (though its plugins may require additional libraries, depending on the applications monitored). -- **Scales to infinity** - you can install it on all your servers, containers, VMs and IoTs. Metrics are not centralized by default, so there is no limit. -- **Several operating modes** - Autonomous host monitoring (the default), headless data collector, forwarding proxy, store and forward proxy, central multi-host monitoring, in all possible configurations. Each node may have different metrics retention policy and run with or without health monitoring. +- **1s granularity** - The highest possible resolution for all metrics. +- **Unlimited metrics** - Netdata collects all the available metrics—the more, the better. +- **1% CPU utilization of a single core** - It's unbelievably optimized. +- **A few MB of RAM** - The highly-efficient database engine stores per-second metrics in RAM and then "spills" + historical metrics to disk long-term storage. +- **Minimal disk I/O** - While running, Netdata only writes historical metrics and reads `error` and `access` logs. +- **Zero configuration** - Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the + box. +- **Zero maintenance** - You just run it. Netdata does the rest. +- **Zero dependencies** - Netdata runs a custom web server for its static web files and its web API (though its + plugins may require additional libraries, depending on the applications monitored). +- **Scales to infinity** - You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not + centralized by default, so there is no limit. +- **Several operating modes** - Autonomous host monitoring (the default), headless data collector, forwarding proxy, + store and forward proxy, central multi-host monitoring, in all possible configurations. Each node may have different + metrics retention policies and run with or without health monitoring. ### Health Monitoring & Alarms -- **Sophisticated alerting** - comes with hundreds of alarms, **out of the box**! Supports dynamic thresholds, hysteresis, alarm templates, multiple role-based notification methods. -- **Notifications**: [alerta.io](../health/notifications/alerta/), [amazon sns](../health/notifications/awssns/), [discordapp.com](../health/notifications/discord/), [email](../health/notifications/email/), [flock.com](../health/notifications/flock/), [irc](../health/notifications/irc/), [kavenegar.com](../health/notifications/kavenegar/), [messagebird.com](../health/notifications/messagebird/), [pagerduty.com](../health/notifications/pagerduty/), [prowl](../health/notifications/prowl/), [pushbullet.com](../health/notifications/pushbullet/), [pushover.net](../health/notifications/pushover/), [rocket.chat](../health/notifications/rocketchat/), [slack.com](../health/notifications/slack/), [smstools3](../health/notifications/smstools3/), [syslog](../health/notifications/syslog/), [telegram.org](../health/notifications/telegram/), [twilio.com](../health/notifications/twilio/), [web](../health/notifications/web/) and [custom notifications](../health/notifications/custom/). +- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic + thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more. +- **Notifications**: [alerta.io](/health/notifications/alerta/README.md), [amazon + sns](/health/notifications/awssns/README.md), [discordapp.com](/health/notifications/discord/README.md), + [email](/health/notifications/email/README.md), [flock.com](/health/notifications/flock/README.md), + [hangouts](/health/notifications/hangouts/README.md), [irc](/health/notifications/irc/README.md), + [kavenegar.com](/health/notifications/kavenegar/README.md), [messagebird.com](/health/notifications/messagebird/), + [pagerduty.com](/health/notifications/pagerduty/README.md), [prowl](/health/notifications/prowl/README.md), + [pushbullet.com](/health/notifications/pushbullet/README.md), + [pushover.net](/health/notifications/pushover/README.md), [rocket.chat](/health/notifications/rocketchat/README.md), + [slack.com](/health/notifications/slack/README.md), [smstools3](/health/notifications/smstools3/README.md), + [syslog](/health/notifications/syslog/README.md), [telegram.org](/health/notifications/telegram/README.md), + [twilio.com](/health/notifications/twilio/README.md), [web](/health/notifications/web/README.md) and [custom + notifications](/health/notifications/custom/README.md). ### Integrations -- **time-series dbs** - can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS Kinesis**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API** which allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**, **Splunk**, **VictoriaMetrics** and a lot of other [storage providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage). +- **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS + Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting + these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which + allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**, + **Splunk**, **VictoriaMetrics** and a lot of other [storage + providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage). ## Visualization -- **Stunning interactive dashboards** - mouse, touchpad and touch-screen friendly in 2 themes: `slate` (dark) and `white`. -- **Amazingly fast visualization** - responds to all queries in less than 1 ms per metric, even on low-end hardware. -- **Visual anomaly detection** - the dashboards are optimized for detecting anomalies visually. -- **Embeddable** - its charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence as a monitoring dashboard](../web/gui/confluence/). -- **Customizable** - custom dashboards can be built using simple HTML (no javascript necessary). +- **Stunning interactive dashboards** - Our dashboard is mouse-, touchpad-, and touch-screen friendly in 2 themes: + `slate` (dark) and `white`. +- **Amazingly fast visualization** - Even on low-end hardware, the dashboard responds to all queries in less than 1 ms + per metric. +- **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect + anomalies visually. +- **Embeddable** - Charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence + as a monitoring dashboard](/web/gui/confluence/README.md). +- **Customizable** - You can build custom dashboards using simple HTML. No JavaScript needed! ### Positive and negative values -To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`, `inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`. +To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`, +`inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.  -*Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is negative.* +_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is +negative._ ### Autoscaled y-axis @@ -165,58 +314,105 @@ Netdata charts automatically zoom vertically, to visualize the variation of each  -*A zero based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is selected.* +_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is +selected._ ### Charts are synchronized -Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed at any time, and all other charts will follow. +Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed +at any time, and all other charts will follow.  -_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the mouse pointer is over a chart._ +_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the +mouse pointer is over a chart._ -> The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server, when navigating via the [node menu](../registry#registry). +> The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server when navigating via the +> [My nodes menu](/registry/README.md). ### Highlighted time-frame -To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `ALT` + `mouse selection`) on all charts. +To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse +selection`) on all charts.  -_A highlighted time-frame can be given by pressing `ALT` + `mouse selection` on any chart. Netdata will highlight the same range on all charts._ +_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the +same range on all charts._ -> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [node menu](../registry#registry). +> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [My nodes +> menu](/registry/README.md). ## What Netdata monitors Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics jocs, such as CPU, memory, disks, filesystems, networking, and more. We call these **collectors**, and they're managed -by [**plugins**](../collectors/plugins.d/), which support a variety of programming languages, including Go and Python. +by [**plugins**](/collectors/plugins.d/README.md), which support a variety of programming languages, including Go and +Python. Popular collectors include **Nginx**, **Apache**, **MySQL**, **statsd**, **cgroups** (containers, Docker, Kubernetes, LXC, and more), **Traefik**, **web server `access.log` files**, and much more. -See the **full list of [supported collectors](../collectors/COLLECTORS.md)**. +See the **full list of [supported collectors](/collectors/COLLECTORS.md)**. Netdata's data collection is **extensible**, which means you can monitor anything you can get a metric for. You can even -write a collector for your custom application using our [plugin API](../collectors/plugins.d/README.md). +write a collector for your custom application using our [plugin API](/collectors/plugins.d/README.md). + +## Documentation + +The Netdata documentation is at <https://docs.netdata.cloud>, but you can also find each page inside of Netdata's +repository itself in Markdown (`.md`) files. You can find all our documentation by navigating the repository. + +Here is a quick list of notable documents: + +| Directory | Description | +| :---------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- | +| [`installer`](/packaging/installer/README.md) | Instructions to install Netdata on your systems. | +| [`docker`](/packaging/docker/README.md) | Instructions to install Netdata using docker. | +| [`daemon`](/daemon/README.md) | Information about the Netdata daemon and its configuration. | +| [`collectors`](/collectors/README.md) | Information about data collection plugins. | +| [`health`](/health/README.md) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. | +| [`streaming`](/streaming/README.md) | How to build hierarchies of Netdata servers, by streaming metrics between them. | +| [`backends`](/backends/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. | +| [`web/api`](/web/api/README.md) | Learn how to query the Netdata API and the queries it supports. | +| [`web/api/badges`](/web/api/badges/README.md) | Learn how to generate badges (SVG images) from live data. | +| [`web/gui/custom`](/web/gui/custom/README.md) | Learn how to create custom Netdata dashboards. | +| [`web/gui/confluence`](/web/gui/confluence/README.md) | Learn how to create Netdata dashboards on Atlassian's Confluence. | + +You can also check all the other directories. Most of them have plenty of documentation. ## Community -We welcome [contributions](../CONTRIBUTING.md). So, feel free to join the team. +We welcome [contributions](/CONTRIBUTING.md). Feel free to join the team! -To report bugs, or get help, use [GitHub Issues](https://github.com/netdata/netdata/issues). +To report bugs or get help, use [GitHub's issues](https://github.com/netdata/netdata/issues). You can also find Netdata on: - [Facebook](https://www.facebook.com/linuxnetdata/) - [Twitter](https://twitter.com/linuxnetdata) -- [OpenHub](https://www.openhub.net/p/netdata) -- [Repology](https://repology.org/metapackage/netdata/versions) - [StackShare](https://stackshare.io/netdata) +- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/) +- [Repology](https://repology.org/metapackage/netdata/versions) ## License -Netdata is [GPLv3+](../LICENSE). +Netdata is GPLv3+. + +Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](/REDISTRIBUTED.md). + +## Is it any good? + +Yes. + +_When people first hear about a new product, they frequently ask if it is any good. A Hacker News user +[remarked](https://news.ycombinator.com/item?id=3067434):_ + +> Note to self: Starting immediately, all raganwald projects will have a “Is it any good?” section in the readme, and +> the answer shall be “yes.". + +So, we follow the tradition... + +## Is it awesome? -Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](../REDISTRIBUTED.md). +[These people](https://github.com/netdata/netdata/stargazers) seem to like it. |