diff options
Diffstat (limited to 'docs/cloud/runtime-troubleshooting-with-functions.md')
| -rw-r--r-- | docs/cloud/runtime-troubleshooting-with-functions.md | 41 |
1 files changed, 17 insertions, 24 deletions
diff --git a/docs/cloud/runtime-troubleshooting-with-functions.md b/docs/cloud/runtime-troubleshooting-with-functions.md index 193ba33ca1..5db863ba62 100644 --- a/docs/cloud/runtime-troubleshooting-with-functions.md +++ b/docs/cloud/runtime-troubleshooting-with-functions.md @@ -1,34 +1,27 @@ -# Run-time troubleshooting with Functions +# Top tab -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. +The Top tab allows you to run [Netdata Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md) on a node where a Netdata Agent is running. These routines are exposed by a given collector. +They can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself. +> **Tip** +> +> You can also execute a Function from the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md), by pressing the `f(x)` button. -### Prerequisites +> **Note** +> +> If you get an error saying that your node can't execute Functions please check the [prerequisites](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md#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)) +The main view of this tab provides you with (depending on the Function) two elements: a visualization on the top and a table on the bottom. -### Execute a function (from the Functions tab) +Visualizations vary depending on the Function and most allow for user customization. -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 +On the top right-hand corner you can: -### Execute a function (from the Nodes tab) +- Refresh the results (Given that the dashboard is on `Paused` mode) +- Set the update interval of the results. -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. +## Functions bar -> ⚠️ If you get an error saying that your node can't execute Functions please check the [prerequisites](#prerequisites). +The bar on the right-hand side allows you to select which Function to run, on which node, and then depending on the Function, there might be more fine-grained filtering available. -## 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/src/collectors/plugins.d/README.md#function) +For example the `Block-devices` Function allows you to filter per Device, Type, ID, Model and Serial number or the Block devices on your node. |