mirror of
https://github.com/netdata/netdata.git
synced 2025-04-24 05:13:08 +00:00

* make the title metadta the H1 * Update collectors/python.d.plugin/zscores/README.md * Update libnetdata/ebpf/README.md * Update ml/README.md * Update libnetdata/string/README.md --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
45 lines
2.1 KiB
Markdown
45 lines
2.1 KiB
Markdown
<!--
|
|
title: "Run-time troubleshooting with Functions"
|
|
sidebar_label: "Run-time troubleshooting with Functions"
|
|
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/runtime-troubleshooting-with-functions.md"
|
|
learn_status: "Published"
|
|
sidebar_position: "4"
|
|
learn_topic_type: "Tasks"
|
|
learn_rel_path: "Operations"
|
|
learn_docs_purpose: "Instructions on how to use Functions"
|
|
-->
|
|
|
|
# Run-time troubleshooting with Functions
|
|
|
|
Netdata Functions feature allows you to execute on-demand a pre-defined routine on a node where a Netdata Agent is running. These routines are exposed by a given collector.
|
|
These routines can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself.
|
|
|
|
|
|
### Prerequisites
|
|
|
|
The following is required to be able to run Functions from Netdata Cloud.
|
|
* At least one of the nodes claimed to your Space should be on a Netdata agent version higher than `v1.37.1`
|
|
* Ensure that the node has the collector that exposes the function you want enabled ([see current available functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md#what-functions-are-currently-available))
|
|
|
|
### Execute a function (from functions view)
|
|
|
|
1. From the right-hand bar select the **Function** you want to run
|
|
2. Still on the right-hand bar select the **Node** where you want to run it
|
|
3. Results will be displayed in the central area for you to interact with
|
|
4. Additional filtering capabilities, depending on the function, should be available on right-hand bar
|
|
|
|
### Execute a function (from Nodes view)
|
|
|
|
1. Click on the functions icon for a node that has this active
|
|
2. You are directed to the **Functions** tab
|
|
3. Follow the above instructions from step 3.
|
|
|
|
> ⚠️ If you get an error saying that your node can't execute Functions please check the [prerequisites](#prerequisites).
|
|
|
|
## Related Topics
|
|
|
|
### **Related Concepts**
|
|
- [Netdata Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md)
|
|
|
|
#### Related References documentation
|
|
- [External plugins overview](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#function)
|