Skip to main content

Step 6. Collect metrics from more services and apps

When Netdata starts, it auto-detects dozens of data sources, such as database servers, web servers, and more.

To auto-detect and collect metrics from a source you just installed, you need to restart Netdata using sudo systemctl restart netdata, or the appropriate method for your system.

However, auto-detection only works if you installed the source using its standard installation procedure. If Netdata isn't collecting metrics after a restart, your source probably isn't configured correctly.

Check out the collectors that come pre-installed with Netdata to find the module for the source you want to monitor.

What you'll learn in this step

We'll begin with an overview on Netdata's collector architecture, and then dive into the following:

Netdata's collector architecture

Many Netdata users never have to configure collector or worry about which plugin orchestrator they want to use.

But, if you want to configure collector or write a collector for your custom source, it's important to understand the underlying architecture.

By default, Netdata collects a lot of metrics every second using any number of discrete collector. Collectors, in turn, are organized and manged by plugins. Internal plugins collect system metrics, external plugins collect non-system metrics, and orchestrator plugins group individual collectors together based on the programming language they were built in.

These modules are primarily written in Go (go.d) and Python, although some use Bash (charts.d).

Enable and disable plugins

You don't need to explicitly enable plugins to auto-detect properly configured sources, but it's useful to know how to enable or disable them.

One reason you might want to disable plugins is to improve Netdata's performance on low-resource systems, like ephemeral nodes or edge devices. Disabling orchestrator plugins like python.d can save significant resources if you're not using any of its data collector modules.

You can enable or disable plugins in the [plugin] section of netdata.conf. This section features a list of all the plugins with a boolean setting (yes or no) to enable or disable them. Be sure to uncomment the line by removing the hash (#)!

Enabled:

[plugins]
# python.d = yes

Disabled:

[plugins]
python.d = no

When you explicitly disable a plugin this way, it won't auto-collect metrics using its collectors.

Example: Enable the Nginx collector

To help explain how the auto-detection process works, let's use an Nginx web server as an example.

Even if you don't have Nginx installed on your system, we recommend you read through the following section so you can apply the process to other data sources, such as Apache, Redis, Memcached, and more.

The Nginx collector, which helps Netdata collect metrics from a running Nginx web server, is part of the python.d.plugin external plugin orchestrator.

In order for Netdata to auto-detect an Nginx web server, you need to enable ngx_http_stub_status_module and pass the stub_status directive in the location block of your Nginx configuration file.

You can confirm if the stub_status Nginx module is already enabled or not by using following command:

nginx -V 2>&1 | grep -o with-http_stub_status_module

If this command returns nothing, you'll need to enable this module.

Next, edit your /etc/nginx/sites-enabled/default file to include a location block with the following:

    location /stub_status {
stub_status;
}

Restart Netdata using sudo systemctl restart netdata, or the appropriate method for your system, and Netdata will auto-detect metrics from your Nginx web server!

While not necessary for most auto-detection and collection purposes, you can also configure the Nginx collector itself by editing its configuration file:

./edit-config python.d/nginx.conf

After configuring any source, or changing the configuration files for their respective modules, always restart Netdata.

What's next?

Now that you've learned the fundamentals behind configuring data sources for auto-detection, it's time to move back to the dashboard to learn more about some of its more advanced features.

Next: Netdata's dashboard in depth

Was this page helpful?

Need further help?

Search for an answer in our community forum.

Contribute