Function docs edits (#17390)
Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com> Co-authored-by: ilyam8 <ilya@netdata.cloud>
Fotis Voutsas committed
Apr 16, 2024 at 09:46 UTC
9d9fbfbdbbbd293c6b0ce2574928bdaffa084a7b
5 files changed
+48
-82
README.md
+3
-3
@@ -21,7 +21,7 @@
21
<a href="https://scan.coverity.com/projects/netdata-netdata?tab=overview"><img alt="Coverity Scan" src="https://img.shields.io/coverity/scan/netdata"></a>
22
<a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPL%20v3%2B-blue.svg" alt="License: GPL v3+"></a>
23
<br />
24
- <a href="https://discord.com/invite/mPZ6WZKKG2"><img alt="Discord" src="https://img.shields.io/discord/847502280503590932?logo=discord&logoColor=white&label=chat%20on%20discord"></a>
24
+ <a href="https://discord.com/invite/2mEmfW735j"><img alt="Discord" src="https://img.shields.io/discord/847502280503590932?logo=discord&logoColor=white&label=chat%20on%20discord"></a>
25
<a href="https://community.netdata.cloud"><img alt="Discourse topics" src="https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.netdata.cloud%2F&logo=discourse&label=discourse%20forum"></a>
26
<a href="https://github.com/netdata/netdata/discussions"><img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/netdata/netdata?logo=github&label=github%20discussions"></a>
27
</p>
@@ -798,7 +798,7 @@ to collect metrics, troubleshoot via charts, export to external databases, and m
798
## :tada: Community
799
800
<p align="center">
801
- <a href="https://discord.com/invite/mPZ6WZKKG2"><img alt="Discord" src="https://img.shields.io/discord/847502280503590932?logo=discord&logoColor=white&label=chat%20on%20discord"></a>
801
+ <a href="https://discord.com/invite/2mEmfW735j"><img alt="Discord" src="https://img.shields.io/discord/847502280503590932?logo=discord&logoColor=white&label=chat%20on%20discord"></a>
802
<a href="https://community.netdata.cloud"><img alt="Discourse topics" src="https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.netdata.cloud%2F&logo=discourse&label=discourse%20forum"></a>
803
<a href="https://github.com/netdata/netdata/discussions"><img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/netdata/netdata?logo=github&label=github%20discussions"></a>
804
</p>
@@ -807,7 +807,7 @@ Netdata is an inclusive open-source project and community. Please read our [Code
807
808
Join the Netdata community:
809
810
-- Chat with us and other community members on [Discord](https://discord.com/invite/mPZ6WZKKG2).
810
+- Chat with us and other community members on [Discord](https://discord.com/invite/2mEmfW735j).
811
- Start a discussion on [GitHub discussions](https://github.com/netdata/netdata/discussions).
812
- Open a topic to our [community forums](https://community.netdata.cloud).
813
docs/cloud/netdata-functions.md
+26
-53
@@ -1,37 +1,25 @@
1
-<!--
2
-title: "Netdata Functions"
3
-sidebar_label: "Netdata Functions"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md"
5
-sidebar_position: "2800"
6
-learn_status: "Published"
7
-learn_topic_type: "Concepts"
8
-learn_rel_path: "Concepts"
9
-learn_docs_purpose: "Present the Netdata Functions what these are and why they should be used."
10
--->
11
-
12
-# Netdata Functions
1
+# Top Monitoring (Netdata Functions)
2
3
Netdata Agent collectors are able to expose functions that can be executed in run-time and on-demand. These will be
15
-executed on the node - host where the function is made
16
-available.
4
+executed on the node/host where the function is made available.
5
18
-#### What is a function?
6
+## What is a function?
7
20
-Collectors besides the metric collection, storing, and/or streaming work are capable of executing specific routines on
21
-request. These routines will bring additional information
22
-to help you troubleshoot or even trigger some action to happen on the node itself.
8
+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.
9
24
-A function is a `key` - `value` pair. The `key` uniquely identifies the function within a node. The `value` is a
25
-function (i.e. code) to be run by a data collector when
26
-the function is invoked.
10
+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](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md#function).
11
28
-For more details please check out documentation on how we use our internal collector to get this from the first collector that exposes
29
-functions - [plugins.d](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md#function).
12
+## Prerequisites
13
31
-#### What functions are currently available?
14
+The following is required to be able to run Functions from Netdata Cloud.
15
33
-| Function | Description | Alternative to CLI tools | Require Cloud | plugin - module |
34
-|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|:--------------|:-----------------------------------------------------------------------------------------------------------|
16
+- At least one of the nodes claimed to your Space should be on a Netdata agent version higher than `v1.37.1`
17
+- Ensure that the node has the collector that exposes the function you want enabled
18
+
19
+## What functions are currently available?
20
+
21
+| Function | Description | Alternative to CLI tools | Require Cloud | plugin - module |
22
+|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|:--------------|:---------------------------------------------------------------------------------------------------------------|
23
| Block-devices | Disk I/O activity for all block devices, offering insights into both data transfer volume and operation performance. | `iostat` | no | [proc](https://github.com/netdata/netdata/tree/master/src/collectors/proc.plugin#readme) |
24
| Containers-vms | Insights into the resource utilization of containers and QEMU virtual machines: CPU usage, memory consumption, disk I/O, and network traffic. | `docker stats`, `systemd-cgtop` | no | [cgroups](https://github.com/netdata/netdata/tree/master/src/collectors/cgroups.plugin#readme) |
25
| Ipmi-sensors | Readings and status of IPMI sensors. | `ipmi-sensors` | no | [freeipmi](https://github.com/netdata/netdata/tree/master/src/collectors/freeipmi.plugin#readme) |
@@ -41,38 +29,23 @@ functions - [plugins.d](https://github.com/netdata/netdata/blob/master/src/colle
29
| Systemd-journal | Viewing, exploring and analyzing systemd journal logs. | `journalctl` | yes | [systemd-journal](https://github.com/netdata/netdata/tree/master/src/collectors/systemd-journal.plugin#readme) |
30
| Systemd-list-units | Information about all systemd units, including their active state, description, whether or not they are enabled, and more. | `systemctl list-units` | yes | [systemd-journal](https://github.com/netdata/netdata/tree/master/src/collectors/systemd-journal.plugin#readme) |
31
| Systemd-services | System resource utilization for all running systemd services: CPU, memory, and disk IO. | `systemd-cgtop` | no | [cgroups](https://github.com/netdata/netdata/tree/master/src/collectors/cgroups.plugin#readme) |
44
-| Streaming | Comprehensive overview of all Netdata children instances, offering detailed information about their status, replication completion time, and many more. | | yes | |
45
-
46
-
47
-If you have ideas or requests for other functions:
48
-* Participate in the relevant [GitHub discussion](https://github.com/netdata/netdata/discussions/14412)
49
-* 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
50
-* Join the Netdata community on [Discord](https://discord.com/invite/mPZ6WZKKG2) and let us know.
32
+| Streaming | Comprehensive overview of all Netdata children instances, offering detailed information about their status, replication completion time, and many more. | | yes | |
33
+| Netdata-api-calls | Real-time tracing of API calls made to the Netdata Agent. It provides information on query, source, status, elapsed time, and more. | | yes | |
34
52
-#### How do functions work with streaming?
35
+## How do functions work with streaming?
36
54
-Via streaming, the definitions of functions are transmitted to a parent node, so it knows all the functions available on
55
-any children connected to it.
37
+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.
38
57
-If the parent node is the one connected to Netdata Cloud it is capable of triggering the call to the respective children
58
-node to run the function.
39
+## Why are some functions only available on Netdata Cloud?
40
60
-#### Why are some functions only available on Netdata Cloud?
41
+Since these functions are able to execute routines on the node and due to 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.
42
62
-Since these functions are able to execute routines on the node and due to the potential use cases that they can cover, our
63
-concern is to ensure no sensitive information or disruptive actions are exposed through the Agent's API.
43
+With the communication between the Netdata Agent and Netdata Cloud being through [ACLK](https://github.com/netdata/netdata/blob/master/src/aclk/README.md) this concern is addressed.
44
65
-With the communication between the Netdata Agent and Netdata Cloud being
66
-through [ACLK](https://github.com/netdata/netdata/blob/master/src/aclk/README.md) this
67
-concern is addressed.
45
+## Feedback
46
69
-## Related Topics
70
-
71
-### **Related Concepts**
72
-
73
-- [ACLK](https://github.com/netdata/netdata/blob/master/src/aclk/README.md)
74
-- [plugins.d](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md)
75
-
76
-### Related Tasks
47
+If you have ideas or requests for other functions:
48
78
-- [Run-time troubleshooting with Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/runtime-troubleshooting-with-functions.md)
49
+- Participate in the relevant [GitHub discussion](https://github.com/netdata/netdata/discussions/14412)
50
+- 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
51
+- Join the Netdata community on [Discord](https://discord.com/invite/2mEmfW735j) and let us know.
docs/cloud/runtime-troubleshooting-with-functions.md
+17
-24
@@ -1,34 +1,27 @@
1
-# Run-time troubleshooting with Functions
1
+# Top tab
2
3
-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.
4
-These routines can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself.
3
+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.
4
+They can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself.
5
6
+> **Tip**
7
+>
8
+> 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.
9
7
-### Prerequisites
10
+> **Note**
11
+>
12
+> 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).
13
9
-The following is required to be able to run Functions from Netdata Cloud.
10
-* At least one of the nodes claimed to your Space should be on a Netdata agent version higher than `v1.37.1`
11
-* 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))
14
+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.
15
13
-### Execute a function (from the Functions tab)
16
+Visualizations vary depending on the Function and most allow for user customization.
17
15
-1. From the right-hand bar select the **Function** you want to run
16
-2. Still on the right-hand bar select the **Node** where you want to run it
17
-3. Results will be displayed in the central area for you to interact with
18
-4. Additional filtering capabilities, depending on the function, should be available on right-hand bar
18
+On the top right-hand corner you can:
19
20
-### Execute a function (from the Nodes tab)
20
+- Refresh the results (Given that the dashboard is on `Paused` mode)
21
+- Set the update interval of the results.
22
22
-1. Click on the functions icon for a node that has this active
23
-2. You are directed to the **Functions** tab
24
-3. Follow the above instructions from step 3.
23
+## Functions bar
24
26
-> ⚠️ If you get an error saying that your node can't execute Functions please check the [prerequisites](#prerequisites).
25
+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.
26
28
-## Related Topics
29
-
30
-### **Related Concepts**
31
-- [Netdata Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md)
32
-
33
-#### Related References documentation
34
-- [External plugins overview](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md#function)
27
+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.
docs/getting-started/introduction.md
+1
-1
@@ -151,7 +151,7 @@ charts, or use Netdata's health watchdog to send notifications whenever an anoma
151
Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
152
153
Find most of the Netdata team in our [community forums](https://community.netdata.cloud). It's the best place to
154
-ask questions, find resources, and engage with passionate professionals. The team is also available and active in our [Discord](https://discord.com/invite/mPZ6WZKKG2) too.
154
+ask questions, find resources, and engage with passionate professionals. The team is also available and active in our [Discord](https://discord.com/invite/2mEmfW735j) too.
155
156
You can also find Netdata on:
157
src/collectors/REFERENCE.md
+1
-1
@@ -145,5 +145,5 @@ The next step is based on the collector's orchestrator.
145
```
146
147
The output from the relevant command will provide valuable troubleshooting information. If you can't figure out how to
148
-enable the collector using the details from this output, feel free to [join our Discord server](https://discord.com/invite/mPZ6WZKKG2),
148
+enable the collector using the details from this output, feel free to [join our Discord server](https://discord.com/invite/2mEmfW735j),
149
to get help from our experts.