summaryrefslogtreecommitdiffstats
path: root/collectors
diff options
context:
space:
mode:
authorFotis Voutsas <fotis@netdata.cloud>2023-03-27 16:52:33 +0300
committerGitHub <noreply@github.com>2023-03-27 06:52:33 -0700
commit00fd201803e2e368e98f5903dbe037c2c55bd8af (patch)
treea23baab0a2f76c3c1c1f1517e24228d6bdbaa352 /collectors
parent2a9c0b54b1759c31c99669498cabc5606ecea193 (diff)
Address Learn feedback from users (#14802)
* Update collectors/charts.d.plugin/sensors/README.md * lint the file, and correct some mistypes * add suggestions and fix wording * cover feedback by users * fix broken link * Update invite-your-team.md
Diffstat (limited to 'collectors')
-rw-r--r--collectors/apps.plugin/README.md3
-rw-r--r--collectors/charts.d.plugin/sensors/README.md32
-rw-r--r--collectors/diskspace.plugin/README.md40
3 files changed, 39 insertions, 36 deletions
diff --git a/collectors/apps.plugin/README.md b/collectors/apps.plugin/README.md
index 8ffbb73795..ad4e0882fd 100644
--- a/collectors/apps.plugin/README.md
+++ b/collectors/apps.plugin/README.md
@@ -9,7 +9,8 @@ learn_rel_path: "Integrations/Monitor/System metrics"
# Application monitoring (apps.plugin)
-`apps.plugin` breaks down system resource usage to **processes**, **users** and **user groups**.
+`apps.plugin` breaks down system resource usage to **processes**, **users** and **user groups**.
+It is enabled by default on every Netdata installation.
To achieve this task, it iterates through the whole process tree, collecting resource usage information
for every process found running.
diff --git a/collectors/charts.d.plugin/sensors/README.md b/collectors/charts.d.plugin/sensors/README.md
index 5e46f45fd5..2601a2b65f 100644
--- a/collectors/charts.d.plugin/sensors/README.md
+++ b/collectors/charts.d.plugin/sensors/README.md
@@ -1,16 +1,7 @@
-<!--
-title: "Linux machine sensors monitoring with Netdata"
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/sensors/README.md"
-sidebar_label: "lm-sensors"
-learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "Integrations/Monitor/Devices"
--->
-
# Linux machine sensors collector
-Use this collector when `lm-sensors` doesn't work on your device (e.g. for RPi temperatures).
-For all other cases use the [Python collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/sensors), which supports multiple
+Use this collector when `lm-sensors` doesn't work on your device (e.g. for RPi temperatures).
+For all other cases use the [Python collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/sensors), which supports multiple
jobs, is more efficient and performs calculations on top of the kernel provided values.
This plugin will provide charts for all configured system sensors, by reading sensors directly from the kernel.
@@ -30,15 +21,23 @@ One chart for every sensor chip found and each of the above will be created.
## Enable the collector
-The `sensors` collector is disabled by default. To enable it, edit the `charts.d.conf` file using `edit-config` from the
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+The `sensors` collector is disabled by default.
+
+To enable the collector, you need to edit the configuration file of `charts.d/sensors.conf`. You can do so by using the `edit config` script.
+
+> ### Info
+>
+> To edit configuration files in a safe way, we provide the [`edit config` script](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) located in your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically.
+> It is recommended to use this way for configuring Netdata.
+>
+> Please also note that after most configuration changes you will need to [restart the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for the changes to take effect.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config charts.d.conf
```
-It also needs to be set to "force" to be enabled:
+You need to uncomment the regarding `sensors`, and set the value to `force`.
```shell
# example=force
@@ -47,8 +46,7 @@ sensors=force
## Configuration
-Edit the `charts.d/sensors.conf` configuration file using `edit-config` from the
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+Edit the `charts.d/sensors.conf` configuration file using `edit-config`:
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -79,5 +77,3 @@ sensors_excluded=()
```
---
-
-
diff --git a/collectors/diskspace.plugin/README.md b/collectors/diskspace.plugin/README.md
index cf1273ac54..b70bbf0085 100644
--- a/collectors/diskspace.plugin/README.md
+++ b/collectors/diskspace.plugin/README.md
@@ -1,29 +1,37 @@
-<!--
-title: "Monitor disk (diskspace.plugin)"
-description: "Monitor the disk usage space of mounted disks in real-time with the Netdata Agent, plus preconfigured alarms for disks at risk of filling up."
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md"
-sidebar_label: "Disks"
-learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "Integrations/Monitor/System metrics"
--->
-
# Monitor disk (diskspace.plugin)
This plugin monitors the disk space usage of mounted disks, under Linux. The plugin requires Netdata to have execute/search permissions on the mount point itself, as well as each component of the absolute path to the mount point.
Two charts are available for every mount:
-- Disk Space Usage
-- Disk Files (inodes) Usage
+- Disk Space Usage
+- Disk Files (inodes) Usage
## configuration
Simple patterns can be used to exclude mounts from showed statistics based on path or filesystem. By default read-only mounts are not displayed. To display them `yes` should be set for a chart instead of `auto`.
-By default, Netdata will enable monitoring metrics only when they are not zero. If they are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear though). Set `yes` for a chart instead of `auto` to enable it permanently. You can also set the `enable zero metrics` option to `yes` in the `[global]` section which enables charts with zero metrics for all internal Netdata plugins.
+By default, Netdata will enable monitoring metrics only when they are not zero. If they are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear though).
+
+To configure this plugin, you need to edit the configuration file `netdata.conf`. You can do so by using the `edit config` script.
+
+> ### Info
+>
+> To edit configuration files in a safe way, we provide the [`edit config` script](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) located in your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically.
+> It is recommended to use this way for configuring Netdata.
+>
+> Please also note that after most configuration changes you will need to [restart the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for the changes to take effect.
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config netdata.conf
```
+
+You can enable the effect of each line by uncommenting it.
+
+You can set `yes` for a chart instead of `auto` to enable it permanently. You can also set the `enable zero metrics` option to `yes` in the `[global]` section which enables charts with zero metrics for all internal Netdata plugins.
+
+```conf
[plugin:proc:diskspace]
# remove charts of unmounted disks = yes
# update every = 1
@@ -34,14 +42,12 @@ By default, Netdata will enable monitoring metrics only when they are not zero.
# inodes usage for all disks = auto
```
-Charts can be enabled/disabled for every mount separately:
+Charts can be enabled/disabled for every mount separately, just look for the name of the mount after `[plugin:proc:diskspace:`.
-```
+```conf
[plugin:proc:diskspace:/]
# space usage = auto
# inodes usage = auto
```
> for disks performance monitoring, see the `proc` plugin, [here](https://github.com/netdata/netdata/blob/master/collectors/proc.plugin/README.md#monitoring-disks)
-
-