Update functions documents (#14331)
Reviewed the docs functions to: * fix broken links * add current available functions * callout for when user gets an error on Cloud Co-authored-by: Tasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com> Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud>
Hugo Valente committed
Jan 30, 2023 at 15:14 UTC
3473e7fee86411e483f6bf2cb394abd8b5bd054e
2 files changed
+21
-10
docs/cloud/netdata-functions.md
+15
-6
@@ -23,9 +23,18 @@ A function is a `key` - `value` pair. The `key` uniquely identifies the fu
23
function (i.e. code) to be run by a data collector when
24
the function is invoked.
25
26
-For more details please check out documentation on our first collector that exposes
27
-functions - [plugins.d](/docs/nightly/references/collectors-references/plugins.d/#function)
26
+For more details please check out documentation on how we use our internal collector to get this from the first collector that exposes
27
+functions - [plugins.d](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#function).
28
29
+#### What functions are currently available?
30
+
31
+| Function | Description | plugin - module |
32
+| :-- | :-- | :-- |
33
+| processes | Detailed information on the currently running processes on the node. | [apps.plugin](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) |
34
+
35
+If you have ideas or requests for other functions:
36
+* open a [Feature request](https://github.com/netdata/netdata-cloud/issues/new?assignees=&labels=feature+request%2Cneeds+triage&template=FEAT_REQUEST.yml&title=%5BFeat%5D%3A+) on Netdata Cloud repo
37
+* engage with out community on [Netdata discord server](https://discord.com/invite/mPZ6WZKKG2).
38
#### How do functions work with streaming?
39
40
Via streaming, the definitions of functions are transmitted to a parent node so it knows all the functions available on
@@ -41,16 +50,16 @@ concern is to ensure no sensitive
50
information or disruptive actions are exposed through the Agent's API.
51
52
With the communication between the Netdata Agent and Netdata Cloud being
44
-through [ACLK](https://github.com/netdata/netdata/blob/master/docs/concepts/netdata-agent/aclk.md#ACLK) this
53
+through [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md) this
54
concern is addressed.
55
56
## Related Topics
57
58
### **Related Concepts**
59
51
-- [ACLK](https://github.com/netdata/netdata/blob/master/docs/concepts/netdata-agent/aclk.md)
52
-- [plugins.d](https://github.com/netdata/netdata/tree/master/collectors/plugins.d)
60
+- [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md)
61
+- [plugins.d](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md)
62
63
### Related Tasks
64
56
-- [Run-time troubleshooting with Functions](docs/nightly/tasks/operations/runtime-troubleshootting-with-function)
65
+- [Run-time troubleshooting with Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/runtime-troubleshooting-with-functions.md)
docs/cloud/runtime-troubleshooting-with-functions.md
+6
-4
@@ -16,8 +16,8 @@ These routines can be used to retrieve additional information to help you troubl
16
### Prerequisites
17
18
The following is required to be able to run Functions from Netdata Cloud.
19
-* Have at least one capable node claimed to one of your Spaces (node on a version higher than `v1.37`)
20
-* Ensure that node has the collector that exposes the function enabled
19
+* At least one of the nodes claimed to your Space should be on a Netdata agent version higher than `v1.37.1`
20
+* 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))
21
22
### Execute a function (from functions view)
23
@@ -32,10 +32,12 @@ The following is required to be able to run Functions from Netdata Cloud.
32
2. You are directed to the **Functions** tab
33
3. Follow the above instructions from step 3.
34
35
+> ⚠️ If you get an error saying that your node can't execute Functions please check the [prerequisites](#prerequisites).
36
+
37
## Related Topics
38
39
### **Related Concepts**
38
-- [Netdata Functions](https://github.com/netdata/netdata/blob/master/docs/concepts/guided-troubleshooting/netdata-functions.md)
40
+- [Netdata Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md)
41
42
#### Related References documentation
41
-- [External plugins overview](https://github.com/netdata/netdata/tree/master/collectors/plugins.d#function)
43
+- [External plugins overview](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#function)