netdata/DOCUMENTATION.md

6.7 KiB

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. Plus, long-term storage comes ready out-of-the-box, so can collect, monitor, and maintain your metrics in one insightful place.

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.

Installation guide

Use our automated one-line installation script to install Netdata on Linux systems or find detailed instructions for binary packages, Kubernetes, Docker, macOS, and more.

Step-by-step tutorial

Take a guided tour through each of Netdata's core features—perfect for beginners. Follow detailed instructions to monitor your systems and apps, and start your journey into performance troubleshooting.

Getting started guide

Have some monitoring and system administration experience? Dive right into configuring Netdata, accessing the dashboard, working with the daemon, and changing how Netdata stores metrics.

Configuration guide

Take your configuration options from the getting started guide to the next level. Increase metrics retention, modify how charts are displayed, disable collectors, and modify alarms.

Netdata Cloud: Use Netdata Cloud and the Nodes View to view real-time, distributed health monitoring and performance troubleshooting data for all your systems in one place. Add as many nodes as you'd like!

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.

  • Tutorial: Change how long Netdata stores metrics: Extend Netdata's long-term metrics storage database by allowing Netdata to use more of your system's RAM and disk.
  • Netdata Behind Nginx: Use an Nginx web server instead of Netdata's built-in server to enable TLS, HTTPS, and basic authentication.
  • Collect more metrics from other services and applications: Enable new internal or external plugins and understand when auto-detection works.
  • Performance: Tips on running Netdata on devices with limited CPU and RAM resources, such as embedded devices, IoT, and edge devices.
  • Streaming: Information for those who want to centralize Netdata metrics from any number of distributed agents.
  • Backends: Learn how to archive Netdata's real-time metrics to a time series database (like Prometheus) for long-term archiving.

Visit the contributing guide, contributing to documentation guide, and documentation style guide to learn more about our community and how you can get started contributing to Netdata.

Want to get news, how-tos, and heaps of monitoring savvy straight from Netdata? Subscribe to our newsletter to monitor our team of monitoring pros.