summaryrefslogtreecommitdiffstats
path: root/docs/cloud/runtime-troubleshooting-with-functions.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-02-06 16:11:34 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-02-06 16:11:34 +0000
commitd079b656b4719739b2247dcd9d46e9bec793095a (patch)
treed2c950c70a776bcf697c963151c5bd959f8a9f03 /docs/cloud/runtime-troubleshooting-with-functions.md
parentReleasing debian version 1.37.1-2. (diff)
downloadnetdata-d079b656b4719739b2247dcd9d46e9bec793095a.tar.xz
netdata-d079b656b4719739b2247dcd9d46e9bec793095a.zip
Merging upstream version 1.38.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/cloud/runtime-troubleshooting-with-functions.md')
-rw-r--r--docs/cloud/runtime-troubleshooting-with-functions.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/cloud/runtime-troubleshooting-with-functions.md b/docs/cloud/runtime-troubleshooting-with-functions.md
new file mode 100644
index 000000000..3800ea20d
--- /dev/null
+++ b/docs/cloud/runtime-troubleshooting-with-functions.md
@@ -0,0 +1,43 @@
+<!--
+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"
+-->
+
+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)