Update the documentation on charts with zero metrics (#6314)
Vladimir Kobal committed
Jun 20, 2019 at 21:32 UTC
caaf0f2d2f67c5bd7a21bae5897507fd1991e771
6 files changed
+20
-1
collectors/cgroups.plugin/README.md
+9
@@ -101,6 +101,15 @@ The whole point for the additional pattern list, is to limit the number of times
101
102
The above pattern list is matched against the path of the cgroup. For matched cgroups, netdata calls the script [cgroup-name.sh](cgroup-name.sh.in) to get its name. This script queries `docker`, or applies heuristics to find give a name for the cgroup.
103
104
+### charts with zero metrics
105
+
106
+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. For example:
107
+
108
+```
109
+[plugin:cgroups]
110
+ enable memory (used mem including cache) = yes
111
+```
112
+
113
### alarms
114
115
CPU and memory limits are watched and used to rise alarms. Memory usage for every cgroup is checked against `ram` and `ram+swap` limits. CPU usage for every cgroup is checked against `cpuset.cpus` and `cpu.cfs_period_us` + `cpu.cfs_quota_us` pair assigned for the cgroup. Configuration for the alarms is available in `health.d/cgroups.conf` file.
collectors/diskspace.plugin/README.md
+3
@@ -10,6 +10,9 @@ Two charts are available for every mount:
10
11
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`.
12
13
+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.
14
+
15
+
16
```
17
[plugin:proc:diskspace]
18
# remove charts of unmounted disks = yes
collectors/proc.plugin/README.md
+1
-1
@@ -75,7 +75,7 @@ netdata will automatically set the name of disks on the dashboard, from the moun
75
76
### performance metrics
77
78
-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).
78
+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.
79
80
netdata categorizes all block devices in 3 categories:
81
collectors/tc.plugin/README.md
+1
@@ -191,6 +191,7 @@ Add the following configuration option in `/etc/netdata.conf`:
191
Finally, create `/etc/netdata/tc-qos-helper.conf` with this content:
192
```tc_show="class"```
193
194
+Please note, that 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.
195
196
197
[]()
daemon/config/README.md
+2
@@ -128,6 +128,8 @@ The configuration options for plugins appear in sections following the pattern `
128
129
Most internal plugins will provide additional options. Check [Internal Plugins](../../collectors/) for more information.
130
131
+Please note, that by default Netdata will enable monitoring metrics for disks, memory, and network 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). Use `yes` instead of `auto` in plugin configuration sections to enable these charts permanently.
132
+
133
#### External plugins
134
135
External plugins will have only 2 options at `netdata.conf`:
docs/configuration-guide.md
+4
@@ -57,6 +57,10 @@ Entire plugins can be turned off from the [netdata.conf [plugins]](../daemon/con
57
- `node.d.conf` for [nodejs](../collectors/node.d.plugin/#nodedplugin)
58
- `charts.d.conf` for [bash](../collectors/charts.d.plugin/#chartsdplugin)
59
60
+##### Show charts with zero metrics
61
+
62
+By default, Netdata will enable monitoring metrics for disks, memory, and network 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). Use `yes` instead of `auto` in plugin configuration sections to enable these charts permanently.
63
+
64
### Modify alarms and notifications
65
66
##### Add a new alarm