New 'homepage' for documentation site (#6428)
* Created new docs homepage with attempt to "fix" build script * Created new docs homepage with attempt to "fix" build script * Trying more links * Trying more links * Move documentation homepage and got script mostly working * Move documentation homepage and got script mostly working * Final changes based on C&C feedback * Final changes based on C&C feedback * A few new custom styles * A few new custom styles * Removing unnecessary sed * Removing unnecessary sed * Final fixes to docs homepage * Final fixes to docs homepage * Cleanup on DOCUMENTATION page * Remove localization folder * Fixed typo * Created buttons for new documentation homepage. * Remove whitespace * Cleanup in the CSS file * Working on replacing html content * Finalized new build process * Updated the new what is Netdata page * Fixed all the broken links
This commit is contained in:
Joel Hans
GitHub
parent
36c442933a
commit
986e468df6
|
|
@ -0,0 +1,53 @@
|
|||
# Netdata Documentation
|
||||
|
||||
**Netdata is real-time health monitoring and performance troubleshooting for systems and applications.** It helps you instantly diagnose slowdowns and anomalies in your infrastructure with thousands of metrics, interactive visualizations, and insightful health alarms.
|
||||
|
||||
|
||||
## Navigating the Netdata documentation
|
||||
|
||||
Welcome! You've arrived at the documentation for Netdata. Use the links below to find answers to the most common questions about Netdata, such as how to install it, getting started guides, basic configuration, and adding more charts. Or, explore all of Netdata's documentation using the table of contents to your left.
|
||||
|
||||
<div class="homepage-nav">
|
||||
|
||||
<div class="nav-install">
|
||||
<a class="nav-button" href="packaging/installer/#one-line-installation">One-line installation</a>
|
||||
<p>Use our completely automated one-line installation process to get Netdata on all Linux distributions. Or, find detailed instructions for binary packages, Kubernetes, macOS, and more.</p>
|
||||
|
||||
</div>
|
||||
<div class="nav-getting-started">
|
||||
<a class="nav-button" href="docs/GettingStarted/">Getting started guide</a>
|
||||
<p>The perfect place for Netdata beginners to start. Learn how to access Netdata's dashboard, start and stop the service, basic configuration, and more.</p>
|
||||
|
||||
</div>
|
||||
<div class="nav-configuration">
|
||||
<a class="nav-button" href="docs/configuration-guide/">Configuration guide</a>
|
||||
<p>Take your configuration options from the <em>getting started guide</em> to the next level. Increase metrics retention, modify how charts are displayed, disable collectors, and modify alarms.</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
**Advanced users**: For those who already understand how to access a Netdata dashboard and perform basic configuration, feel free to see what's behind any of these other doors.
|
||||
|
||||
- [Netdata Behind Nginx](docs/Running-behind-nginx.md): Use an Nginx web server instead of Netdata's built-in server to enable TLS, HTTPS, and basic authentication.
|
||||
- [Add More Charts](docs/Add-more-charts-to-netdata.md): Enable new internal or external plugins and understand when auto-detection works.
|
||||
- [Performance](docs/Performance.md): Tips on running Netdata on devices with limited CPU and RAM resources, such as embedded devices, IoT, and edge devices.
|
||||
- [Streaming](streaming/): Information for those who want to centralize Netdata metrics from any number of distributed agents.
|
||||
- [Backends](backends/): Learn how to archive Netdata's real-time metrics to a time series database (like Prometheus) for long-term archiving.
|
||||
|
||||
|
||||
Visit the [contributing](CONTRIBUTING.md) page to find guides about the Netdata code of conduct, our community, and how you can get started contributing to Netdata.
|
||||
|
||||
|
||||
## Subscribe for news and tips from monitoring pros
|
||||
|
||||
<script charset="utf-8" type="text/javascript" src="//js.hsforms.net/forms/shell.js"></script>
|
||||
<script>
|
||||
hbspt.forms.create({
|
||||
portalId: "4567453",
|
||||
formId: "6a20deb5-a1e6-4312-9c4d-f6862f947fe0"
|
||||
});
|
||||
</script>
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -24,13 +24,17 @@ echo "Copying files"
|
|||
rm -rf ${SRC_DIR}
|
||||
find . -type d \( -path ./${GENERATOR_DIR} -o -path ./node_modules \) -prune -o -name "*.md" -print | cpio -pd ${SRC_DIR}
|
||||
|
||||
# Move main README.md file to what-is-netdata.md
|
||||
# echo "Replacing docs homepage"
|
||||
# mv ./${SRC_DIR}/README.md ./${SRC_DIR}/what-is-netdata.md
|
||||
# mv ./${SRC_DIR}/DOCUMENTATION.md ./${SRC_DIR}/README.md
|
||||
|
||||
# Copy Netdata html resources
|
||||
cp -a ./${GENERATOR_DIR}/custom ./${SRC_DIR}/
|
||||
|
||||
|
||||
# Modify the first line of the main README.md, to enable proper static html generation
|
||||
echo "Modifying README header"
|
||||
sed -i -e '0,/# Netdata /s//# Introduction\n\n/' ${SRC_DIR}/README.md
|
||||
sed -i -e '0,/# Netdata /s//# Netdata Documentation\n\n/' ${SRC_DIR}/README.md
|
||||
|
||||
# Remove all GA tracking code
|
||||
find ${SRC_DIR} -name "*.md" -print0 | xargs -0 sed -i -e 's/\[!\[analytics.*UA-64295674-3)\]()//g'
|
||||
|
|
@ -84,6 +88,10 @@ prep_html() {
|
|||
if [ "${lang}" != "en" ] ; then
|
||||
find "${GENERATOR_DIR}/${SITE_DIR}" -name "*.html" -print0 | xargs -0 sed -i -e 's/https:\/\/github.com\/netdata\/netdata\/blob\/master\/\S*md/https:\/\/github.com\/netdata\/localization\//g'
|
||||
fi
|
||||
|
||||
# Replace index.html with DOCUMENTATION/index.html
|
||||
echo "Replacing index.html with DOCUMENTATION/index.html"
|
||||
cat ${GENERATOR_DIR}/${SITE_DIR}/DOCUMENTATION/index.html > ${GENERATOR_DIR}/${SITE_DIR}/index.html
|
||||
}
|
||||
|
||||
for d in "en" $(find ${LOC_DIR} -mindepth 1 -maxdepth 1 -name .git -prune -o -type d -printf '%f ') ; do
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ repo_url: https://github.com/netdata/netdata
|
|||
repo_name: GitHub
|
||||
edit_uri: blob/master
|
||||
site_description: Netdata Documentation
|
||||
copyright: Netdata, 2018
|
||||
copyright: Netdata, 2019
|
||||
docs_dir: '${docs_dir}'
|
||||
site_dir: '${site_dir}'
|
||||
#use_directory_urls: false
|
||||
|
|
@ -123,9 +123,12 @@ markdown_extensions:
|
|||
- pymdownx.extrarawhtml
|
||||
nav:'
|
||||
|
||||
navpart 1 . README "About"
|
||||
navpart 1 . "README" ""
|
||||
|
||||
echo -ne " - 'docs/Demo-Sites.md'
|
||||
navpart 1 . . "About Netdata"
|
||||
|
||||
echo -ne " - 'docs/what-is-netdata.md'
|
||||
- 'docs/Demo-Sites.md'
|
||||
- 'docs/netdata-security.md'
|
||||
- 'docs/anonymous-statistics.md'
|
||||
- 'docs/Donations-netdata-has-received.md'
|
||||
|
|
|
|||
|
|
@ -6,6 +6,36 @@
|
|||
font-size: .75rem
|
||||
}
|
||||
|
||||
/* Custom styling for the new documentation homepage.
|
||||
In particular, the three buttons for install/getting started/configuration. */
|
||||
|
||||
.homepage-nav {
|
||||
display: flex;
|
||||
margin-top: 1.4rem;
|
||||
}
|
||||
|
||||
.homepage-nav div {
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
.homepage-nav .nav-install {
|
||||
margin-right: 1rem;
|
||||
}
|
||||
|
||||
.homepage-nav .nav-configuration {
|
||||
margin-left: 1rem;
|
||||
}
|
||||
|
||||
.nav-button {
|
||||
border: 2px solid black;
|
||||
border-radius: 4px;
|
||||
display: block;
|
||||
font-weight: 700;
|
||||
margin: 0 auto;
|
||||
padding: 0.6rem 0;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
/* Hide the label at the top of the navigation menu. Does nothing. */
|
||||
.md-nav__title {
|
||||
display: none;
|
||||
|
|
|
|||
|
|
@ -0,0 +1,385 @@
|
|||
# What is Netdata?
|
||||
|
||||
[](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)
|
||||
|
||||
---
|
||||
|
||||
**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 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** & **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**.
|
||||
|
||||
---
|
||||
|
||||
## How it looks
|
||||
|
||||
The following animated image, 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 and **real-time**, optimized to get the work done!*
|
||||
|
||||
> *We have a few online demos to experience it live: [https://www.netdata.cloud](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!
|
||||
|
||||
### Docker pulls
|
||||
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/)
|
||||
|
||||
### Registry
|
||||
When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../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:
|
||||
|
||||
[](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)
|
||||
|
||||
## Why Netdata
|
||||
|
||||
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
|
||||
|
||||
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 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.
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
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/#data-collection-plugins)
|
||||
**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/#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/#health-monitoring)
|
||||
**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/#streaming-and-replication)
|
||||
**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/#web-server), servicing API requests, including [data queries](../web/api/queries/#database-queries).|[`web/api`](../web/api/#api)
|
||||
|
||||
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 to interact with it (it has direct links to documentation).
|
||||
|
||||
[](https://my-netdata.io/infographic.html)
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
### 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/).
|
||||
|
||||
### 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).
|
||||
|
||||
## 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).
|
||||
|
||||
### 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`.
|
||||
|
||||
|
||||
|
||||
*Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is negative.*
|
||||
|
||||
### Autoscaled y-axis
|
||||
|
||||
Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame.
|
||||
|
||||
|
||||
|
||||
*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 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).
|
||||
|
||||
### 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.
|
||||
|
||||
|
||||
|
||||
*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).
|
||||
|
||||
|
||||
## What does it monitor
|
||||
|
||||
Netdata data collection is **extensible** - you can monitor anything you can get a metric for.
|
||||
Its [Plugin API](../collectors/plugins.d/) supports all programing languages (anything can be a Netdata plugin, BASH, python, perl, node.js, java, Go, ruby, etc).
|
||||
|
||||
- For better performance, most system related plugins (cpu, memory, disks, filesystems, networking, etc) have been written in `C`.
|
||||
- For faster development and easier contributions, most application related plugins (databases, web servers, etc) have been written in `python`.
|
||||
|
||||
#### APM (Application Performance Monitoring)
|
||||
- **[statsd](../collectors/statsd.plugin/)** - Netdata is a fully featured statsd server.
|
||||
- **[Go expvar](../collectors/python.d.plugin/go_expvar/)** - collects metrics exposed by applications written in the Go programming language using the expvar package.
|
||||
- **[Spring Boot](../collectors/python.d.plugin/springboot/)** - monitors running Java Spring Boot applications that expose their metrics with the use of the Spring Boot Actuator included in Spring Boot library.
|
||||
- **[uWSGI](../collectors/python.d.plugin/uwsgi/)** - collects performance metrics from uWSGI applications.
|
||||
|
||||
#### System Resources
|
||||
- **[CPU Utilization](../collectors/proc.plugin/)** - total and per core CPU usage.
|
||||
- **[Interrupts](../collectors/proc.plugin/)** - total and per core CPU interrupts.
|
||||
- **[SoftIRQs](../collectors/proc.plugin/)** - total and per core SoftIRQs.
|
||||
- **[SoftNet](../collectors/proc.plugin/)** - total and per core SoftIRQs related to network activity.
|
||||
- **[CPU Throttling](../collectors/proc.plugin/)** - collects per core CPU throttling.
|
||||
- **[CPU Frequency](../collectors/proc.plugin/)** - collects the current CPU frequency.
|
||||
- **[CPU Idle](../collectors/proc.plugin/)** - collects the time spent per processor state.
|
||||
- **[IdleJitter](../collectors/idlejitter.plugin/)** - measures CPU latency.
|
||||
- **[Entropy](../collectors/proc.plugin/)** - random numbers pool, using in cryptography.
|
||||
- **[Interprocess Communication - IPC](../collectors/proc.plugin/)** - such as semaphores and semaphores arrays.
|
||||
|
||||
#### Memory
|
||||
- **[ram](../collectors/proc.plugin/)** - collects info about RAM usage.
|
||||
- **[swap](../collectors/proc.plugin/)** - collects info about swap memory usage.
|
||||
- **[available memory](../collectors/proc.plugin/)** - collects the amount of RAM available for userspace processes.
|
||||
- **[committed memory](../collectors/proc.plugin/)** - collects the amount of RAM committed to userspace processes.
|
||||
- **[Page Faults](../collectors/proc.plugin/)** - collects the system page faults (major and minor).
|
||||
- **[writeback memory](../collectors/proc.plugin/)** - collects the system dirty memory and writeback activity.
|
||||
- **[huge pages](../collectors/proc.plugin/)** - collects the amount of RAM used for huge pages.
|
||||
- **[KSM](../collectors/proc.plugin/)** - collects info about Kernel Same Merging (memory dedupper).
|
||||
- **[Numa](../collectors/proc.plugin/)** - collects Numa info on systems that support it.
|
||||
- **[slab](../collectors/proc.plugin/)** - collects info about the Linux kernel memory usage.
|
||||
|
||||
#### Disks
|
||||
- **[block devices](../collectors/proc.plugin/)** - per disk: I/O, operations, backlog, utilization, space, etc.
|
||||
- **[BCACHE](../collectors/proc.plugin/)** - detailed performance of SSD caching devices.
|
||||
- **[DiskSpace](../collectors/proc.plugin/)** - monitors disk space usage.
|
||||
- **[mdstat](../collectors/proc.plugin/)** - software RAID.
|
||||
- **[hddtemp](../collectors/python.d.plugin/hddtemp/)** - disk temperatures.
|
||||
- **[smartd](../collectors/python.d.plugin/smartd_log/)** - disk S.M.A.R.T. values.
|
||||
- **[device mapper](../collectors/proc.plugin/)** - naming disks.
|
||||
- **[Veritas Volume Manager](../collectors/proc.plugin/)** - naming disks.
|
||||
- **[megacli](../collectors/python.d.plugin/megacli/)** - adapter, physical drives and battery stats.
|
||||
- **[adaptec_raid](../collectors/python.d.plugin/adaptec_raid/)** - logical and physical devices health metrics.
|
||||
- **[ioping](../collectors/ioping.plugin/)** - to measure disk read/write latency.
|
||||
|
||||
#### Filesystems
|
||||
- **[BTRFS](../collectors/proc.plugin/)** - detailed disk space allocation and usage.
|
||||
- **[Ceph](../collectors/python.d.plugin/ceph/)** - OSD usage, Pool usage, number of objects, etc.
|
||||
- **[NFS file servers and clients](../collectors/proc.plugin/)** - NFS v2, v3, v4: I/O, cache, read ahead, RPC calls
|
||||
- **[Samba](../collectors/python.d.plugin/samba/)** - performance metrics of Samba SMB2 file sharing.
|
||||
- **[ZFS](../collectors/proc.plugin/)** - detailed performance and resource usage.
|
||||
|
||||
#### Networking
|
||||
- **[Network Stack](../collectors/proc.plugin/)** - everything about the networking stack (both IPv4 and IPv6 for all protocols: TCP, UDP, SCTP, UDPLite, ICMP, Multicast, Broadcast, etc), and all network interfaces (per interface: bandwidth, packets, errors, drops).
|
||||
- **[Netfilter](../collectors/proc.plugin/)** - everything about the netfilter connection tracker.
|
||||
- **[SynProxy](../collectors/proc.plugin/)** - collects performance data about the linux SYNPROXY (DDoS).
|
||||
- **[NFacct](../collectors/nfacct.plugin/)** - collects accounting data from iptables.
|
||||
- **[Network QoS](../collectors/tc.plugin/)** - the only tool that visualizes network `tc` classes in real-time
|
||||
- **[FPing](../collectors/fping.plugin/)** - to measure latency and packet loss between any number of hosts.
|
||||
- **[ISC dhcpd](../collectors/python.d.plugin/isc_dhcpd/)** - pools utilization, leases, etc.
|
||||
- **[AP](../collectors/charts.d.plugin/ap/)** - collects Linux access point performance data (`hostapd`).
|
||||
- **[SNMP](../collectors/node.d.plugin/snmp/)** - SNMP devices can be monitored too (although you will need to configure these).
|
||||
- **[port_check](../collectors/python.d.plugin/portcheck/)** - checks TCP ports for availability and response time.
|
||||
|
||||
#### Virtual Private Networks
|
||||
- **[OpenVPN](../collectors/python.d.plugin/ovpn_status_log/)** - collects status per tunnel.
|
||||
- **[LibreSwan](../collectors/charts.d.plugin/libreswan/)** - collects metrics per IPSEC tunnel.
|
||||
- **[Tor](../collectors/python.d.plugin/tor/)** - collects Tor traffic statistics.
|
||||
|
||||
#### Processes
|
||||
- **[System Processes](../collectors/proc.plugin/)** - running, blocked, forks, active.
|
||||
- **[Applications](../collectors/apps.plugin/)** - by grouping the process tree and reporting CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets - per process group.
|
||||
- **[systemd](../collectors/cgroups.plugin/)** - monitors systemd services using CGROUPS.
|
||||
|
||||
#### Users
|
||||
- **[Users and User Groups resource usage](../collectors/apps.plugin/)** - by summarizing the process tree per user and group, reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets
|
||||
- **[logind](../collectors/python.d.plugin/logind/)** - collects sessions, users and seats connected.
|
||||
|
||||
#### Containers and VMs
|
||||
- **[Containers](../collectors/cgroups.plugin/)** - collects resource usage for all kinds of containers, using CGROUPS (systemd-nspawn, lxc, lxd, docker, kubernetes, etc).
|
||||
- **[libvirt VMs](../collectors/cgroups.plugin/)** - collects resource usage for all kinds of VMs, using CGROUPS.
|
||||
- **[dockerd](../collectors/python.d.plugin/dockerd/)** - collects docker health metrics.
|
||||
|
||||
#### Web Servers
|
||||
- **[Apache and lighttpd](../collectors/python.d.plugin/apache/)** - `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers.
|
||||
- **[IPFS](../collectors/python.d.plugin/ipfs/)** - bandwidth, peers.
|
||||
- **[LiteSpeed](../collectors/python.d.plugin/litespeed/)** - reads the litespeed rtreport files to collect metrics.
|
||||
- **[Nginx](../collectors/python.d.plugin/nginx/)** - `stub-status`, for multiple servers.
|
||||
- **[Nginx+](../collectors/python.d.plugin/nginx_plus/)** - connects to multiple nginx_plus servers (local or remote) to collect real-time performance metrics.
|
||||
- **[PHP-FPM](../collectors/python.d.plugin/phpfpm/)** - multiple instances, each reporting connections, requests, performance, etc.
|
||||
- **[Tomcat](../collectors/python.d.plugin/tomcat/)** - accesses, threads, free memory, volume, etc.
|
||||
- **[web server `access.log` files](../collectors/python.d.plugin/web_log/)** - extracting in real-time, web server and proxy performance metrics and applying several health checks, etc.
|
||||
- **[HTTP check](../collectors/python.d.plugin/httpcheck/)** - checks one or more web servers for HTTP status code and returned content.
|
||||
|
||||
#### Proxies, Balancers, Accelerators
|
||||
- **[HAproxy](../collectors/python.d.plugin/haproxy/)** - bandwidth, sessions, backends, etc.
|
||||
- **[Squid](../collectors/python.d.plugin/squid/)** - multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests.
|
||||
- **[Traefik](../collectors/python.d.plugin/traefik/)** - connects to multiple traefik instances (local or remote) to collect API metrics (response status code, response time, average response time and server uptime).
|
||||
- **[Varnish](../collectors/python.d.plugin/varnish/)** - threads, sessions, hits, objects, backends, etc.
|
||||
- **[IPVS](../collectors/proc.plugin/)** - collects metrics from the Linux IPVS load balancer.
|
||||
|
||||
#### Database Servers
|
||||
- **[CouchDB](../collectors/python.d.plugin/couchdb/)** - reads/writes, request methods, status codes, tasks, replication, per-db, etc.
|
||||
- **[MemCached](../collectors/python.d.plugin/memcached/)** - multiple servers, each showing: bandwidth, connections, items, etc.
|
||||
- **[MongoDB](../collectors/python.d.plugin/mongodb/)** - operations, clients, transactions, cursors, connections, asserts, locks, etc.
|
||||
- **[MySQL and mariadb](../collectors/python.d.plugin/mysql/)** - multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, and more.
|
||||
- **[PostgreSQL](../collectors/python.d.plugin/postgres/)** - multiple servers, each showing: per database statistics (connections, tuples read - written - returned, transactions, locks), backend processes, indexes, tables, write ahead, background writer and more.
|
||||
- **[Proxy SQL](../collectors/python.d.plugin/proxysql/)** - collects Proxy SQL backend and frontend performance metrics.
|
||||
- **[Redis](../collectors/python.d.plugin/redis/)** - multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves.
|
||||
- **[RethinkDB](../collectors/python.d.plugin/rethinkdbs/)** - connects to multiple rethinkdb servers (local or remote) to collect real-time metrics.
|
||||
|
||||
#### Message Brokers
|
||||
- **[beanstalkd](../collectors/python.d.plugin/beanstalk/)** - global and per tube monitoring.
|
||||
- **[RabbitMQ](../collectors/python.d.plugin/rabbitmq/)** - performance and health metrics.
|
||||
|
||||
#### Search and Indexing
|
||||
- **[ElasticSearch](../collectors/python.d.plugin/elasticsearch/)** - search and index performance, latency, timings, cluster statistics, threads statistics, etc.
|
||||
|
||||
#### DNS Servers
|
||||
- **[bind_rndc](../collectors/python.d.plugin/bind_rndc/)** - parses `named.stats` dump file to collect real-time performance metrics. All versions of bind after 9.6 are supported.
|
||||
- **[dnsdist](../collectors/python.d.plugin/dnsdist/)** - performance and health metrics.
|
||||
- **[ISC Bind (named)](../collectors/node.d.plugin/named/)** - multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics. All versions of bind after 9.9.10 are supported.
|
||||
- **[NSD](../collectors/python.d.plugin/nsd/)** - queries, zones, protocols, query types, transfers, etc.
|
||||
- **[PowerDNS](../collectors/python.d.plugin/powerdns/)** - queries, answers, cache, latency, etc.
|
||||
- **[unbound](../collectors/python.d.plugin/unbound/)** - performance and resource usage metrics.
|
||||
- **[dns_query_time](../collectors/python.d.plugin/dns_query_time/)** - DNS query time statistics.
|
||||
|
||||
#### Time Servers
|
||||
- **[chrony](../collectors/python.d.plugin/chrony/)** - uses the `chronyc` command to collect chrony statistics (Frequency, Last offset, RMS offset, Residual freq, Root delay, Root dispersion, Skew, System time).
|
||||
- **[ntpd](../collectors/python.d.plugin/ntpd/)** - connects to multiple ntpd servers (local or remote) to provide statistics of system variables and optional also peer variables.
|
||||
|
||||
#### Mail Servers
|
||||
- **[Dovecot](../collectors/python.d.plugin/dovecot/)** - POP3/IMAP servers.
|
||||
- **[Exim](../collectors/python.d.plugin/exim/)** - message queue (emails queued).
|
||||
- **[Postfix](../collectors/python.d.plugin/postfix/)** - message queue (entries, size).
|
||||
|
||||
#### Hardware Sensors
|
||||
- **[IPMI](../collectors/freeipmi.plugin/)** - enterprise hardware sensors and events.
|
||||
- **[lm-sensors](../collectors/python.d.plugin/sensors/)** - temperature, voltage, fans, power, humidity, etc.
|
||||
- **[Nvidia](../collectors/python.d.plugin/nvidia_smi/)** - collects information for Nvidia GPUs.
|
||||
- **[RPi](../collectors/charts.d.plugin/sensors/)** - Raspberry Pi temperature sensors.
|
||||
- **[w1sensor](../collectors/python.d.plugin/w1sensor/)** - collects data from connected 1-Wire sensors.
|
||||
|
||||
#### UPSes
|
||||
- **[apcupsd](../collectors/charts.d.plugin/apcupsd/)** - load, charge, battery voltage, temperature, utility metrics, output metrics
|
||||
- **[NUT](../collectors/charts.d.plugin/nut/)** - load, charge, battery voltage, temperature, utility metrics, output metrics
|
||||
- **[Linux Power Supply](../collectors/proc.plugin/)** - collects metrics reported by power supply drivers on Linux.
|
||||
|
||||
#### Social Sharing Servers
|
||||
- **[RetroShare](../collectors/python.d.plugin/retroshare/)** - connects to multiple retroshare servers (local or remote) to collect real-time performance metrics.
|
||||
|
||||
#### Security
|
||||
- **[Fail2Ban](../collectors/python.d.plugin/fail2ban/)** - monitors the fail2ban log file to check all bans for all active jails.
|
||||
|
||||
#### Authentication, Authorization, Accounting (AAA, RADIUS, LDAP) Servers
|
||||
- **[FreeRadius](../collectors/python.d.plugin/freeradius/)** - uses the `radclient` command to provide freeradius statistics (authentication, accounting, proxy-authentication, proxy-accounting).
|
||||
|
||||
#### Telephony Servers
|
||||
- **[opensips](../collectors/charts.d.plugin/opensips/)** - connects to an opensips server (localhost only) to collect real-time performance metrics.
|
||||
|
||||
#### Household Appliances
|
||||
- **[SMA webbox](../collectors/node.d.plugin/sma_webbox/)** - connects to multiple remote SMA webboxes to collect real-time performance metrics of the photovoltaic (solar) power generation.
|
||||
- **[Fronius](../collectors/node.d.plugin/fronius/)** - connects to multiple remote Fronius Symo servers to collect real-time performance metrics of the photovoltaic (solar) power generation.
|
||||
- **[StiebelEltron](../collectors/node.d.plugin/stiebeleltron/)** - collects the temperatures and other metrics from your Stiebel Eltron heating system using their Internet Service Gateway (ISG web).
|
||||
|
||||
#### Game Servers
|
||||
- **[SpigotMC](../collectors/python.d.plugin/spigotmc/)** - monitors Spigot Minecraft server ticks per second and number of online players using the Minecraft remote console.
|
||||
|
||||
#### Distributed Computing
|
||||
- **[BOINC](../collectors/python.d.plugin/boinc/)** - monitors task states for local and remote BOINC client software using the remote GUI RPC interface. Also provides alarms for a handful of error conditions.
|
||||
|
||||
#### Media Streaming Servers
|
||||
- **[IceCast](../collectors/python.d.plugin/icecast/)** - collects the number of listeners for active sources.
|
||||
|
||||
### Monitoring Systems
|
||||
- **[Monit](../collectors/python.d.plugin/monit/)** - collects metrics about monit targets (filesystems, applications, networks).
|
||||
|
||||
#### Provisioning Systems
|
||||
- **[Puppet](../collectors/python.d.plugin/puppet/)** - connects to multiple Puppet Server and Puppet DB instances (local or remote) to collect real-time status metrics.
|
||||
|
||||
You can easily extend Netdata, by writing plugins that collect data from any source, using any computer language.
|
||||
|
||||
## Community
|
||||
|
||||
We welcome [contributions](../CONTRIBUTING.md). So, feel free to join the team.
|
||||
|
||||
To report bugs, or get help, use [GitHub 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)
|
||||
|
||||
## License
|
||||
|
||||
Netdata is [GPLv3+](../LICENSE).
|
||||
|
||||
Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](../REDISTRIBUTED.md).
|
||||
Loading…
Reference in New Issue