Skip to main content

Netdata Functions

Netdata Agent collectors are able to expose functions that can be executed in run-time and on-demand. These will be executed on the node - host where the function is made available.

What is a function?

Collectors besides the metric collection, storing, and/or streaming work are capable of executing specific routines on request. These routines will bring additional information to help you troubleshoot or even trigger some action to happen on the node itself.

A function is a key - value pair. The key uniquely identifies the function within a node. The value is a function (i.e. code) to be run by a data collector when the function is invoked.

For more details please check out documentation on how we use our internal collector to get this from the first collector that exposes functions - plugins.d.

What functions are currently available?

FunctionDescriptionplugin - module
processesDetailed information on the currently running processes on the node.apps.plugin
ebpf_socketDetailed socket information.ebpf.plugin
ebpf_threadController for eBPF threads.ebpf.plugin

If you have ideas or requests for other functions:

How do functions work with streaming?

Via streaming, the definitions of functions are transmitted to a parent node so it knows all the functions available on any children connected to it.

If the parent node is the one connected to Netdata Cloud it is capable of triggering the call to the respective children node to run the function.

Why are they available only on Netdata Cloud?

Since these functions are able to execute routines on the node and due the potential use cases that they can cover, our concern is to ensure no sensitive information or disruptive actions are exposed through the Agent's API.

With the communication between the Netdata Agent and Netdata Cloud being through ACLK this concern is addressed.

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.