Costa Tsaousis d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
..
apps.plugin d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
cgroups.plugin d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
charts.d.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
checks.plugin 0541c97e53 Introduce the new Structure of the documentation (#13915) 2 years ago
cups.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
diskspace.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
ebpf.plugin d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
freebsd.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
freeipmi.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
idlejitter.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
ioping.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
macos.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
nfacct.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
perf.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
plugins.d d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
proc.plugin d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
python.d.plugin 736cc65834 Reorganize learn documents under Integrations part 2 (#14538) 2 years ago
slabinfo.plugin d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
statsd.plugin aebab7080d Learn integrations category changes (#14510) 2 years ago
tc.plugin d2daa19bf5 JSON internal API, IEEE754 base64/hex streaming, weights endpoint optimization (#14493) 2 years ago
timex.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
xenstat.plugin d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
COLLECTORS.md 32baa46cb1 Fix broken links in markdown files (#14513) 2 years ago
Makefile.am 4322b1973d remove deprecated fping.plugin in accordance with v1.37.0 deprecation notice (#14073) 2 years ago
README.md d2a44e118e Move collectors under Integrations/Monitoring (#14509) 2 years ago
REFERENCE.md aebab7080d Learn integrations category changes (#14510) 2 years ago
all.h b7a2125da3 `ml - machine learning` to just `machine learning` (#14242) 2 years ago

README.md

Collecting metrics

When Netdata starts, and with zero configuration, it auto-detects thousands of data sources and immediately collects per-second metrics.

Netdata can immediately collect metrics from these endpoints thanks to 300+ collectors, which all come pre-installed when you install Netdata.

All collectors are installed by default with every installation of Netdata. You do not need to install collectors manually to collect metrics from new sources. See our list of supported collectors.

Upon startup, Netdata will auto-detect any application or service that has a collector, as long as both the collector and the app/service are configured correctly. If you don't see charts for your application, see our collectors' configuration reference.

How Netdata's metrics collectors work

Every collector has two primary jobs:

  • Look for exposed metrics at a pre- or user-defined endpoint.
  • Gather exposed metrics and use additional logic to build meaningful, interactive visualizations.

If the collector finds compatible metrics exposed on the configured endpoint, it begins a per-second collection job. The Netdata Agent gathers these metrics, sends them to the database engine for storage , and immediately visualizes them meaningfully on dashboards.

Each collector comes with a pre-defined configuration that matches the default setup for that application. This endpoint can be a URL and port, a socket, a file, a web page, and more. The endpoint is user-configurable, as are many other specifics of what a given collector does.

Collector architecture and terminology

  • Collectors are the processes/programs that actually gather metrics from various sources.

  • Plugins help manage all the independent data collection processes in a variety of programming languages, based on their purpose and performance requirements. There are three types of plugins:

    • Internal plugins organize collectors that gather metrics from /proc, /sys and other Linux kernel sources. They are written in C, and run as threads within the Netdata daemon.

    • External plugins organize collectors that gather metrics from external processes, such as a MySQL database or Nginx web server. They can be written in any language, and the netdata daemon spawns them as long-running independent processes. They communicate with the daemon via pipes. All external plugins are managed by plugins.d, which provides additional management options.

  • Orchestrators are external plugins that run and manage one or more modules. They run as independent processes. The Go orchestrator is in active development.

    • go.d.plugin: An orchestrator for data collection modules written in go.

    • python.d.plugin: An orchestrator for data collection modules written in python v2/v3.

    • charts.d.plugin: An orchestrator for data collection modules written inbash v4+.

  • Modules are the individual programs controlled by an orchestrator to collect data from a specific application, or type of endpoint.