@cryptotaxi247 / netdata-1 / commits / 82e77690a

docs: fix unresolved file references (#12528)

Ilya Mashchenko committed Mar 28, 2022 at 17:43 UTC 82e77690af5abfd75e9ebf76236a49d018fb4b82
2 files changed +39 -39
daemon/config/README.md
+38 -38
@@ -46,45 +46,45 @@ Please note that your data history will be lost if you have modified `history` p
46
47 ### [global] section options
48
49 -| setting|default|info|||
50 -|:-----:|:-----:|:---|---|---|
51 -| process scheduling policy|`keep`|See [Netdata process scheduling policy](/daemon/README.md#netdata-process-scheduling-policy)|||
52 -| OOM score|`1000`|See [OOM score](/daemon/README.md#oom-score)|||
53 -| glibc malloc arena max for plugins|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).|||
54 -| glibc malloc arena max for Netdata|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).|||
55 -| hostname|auto-detected|The hostname of the computer running Netdata.|||
56 -| history|`3996`| Used with `memory mode = save/map/ram/alloc`, not the default `memory mode = dbengine`. This number reflects the number of entries the `netdata` daemon will by default keep in memory for each chart dimension. This setting can also be configured per chart. Check [Memory Requirements](/database/README.md) for more information. |||
57 -| update every|`1`|The frequency in seconds, for data collection. For more information see the [performance guide](/docs/guides/configure/performance.md).|||
58 -| config directory|`/etc/netdata`|The directory configuration files are kept.|||
59 -| stock config directory|`/usr/lib/netdata/conf.d`||||
60 -| log directory|`/var/log/netdata`|The directory in which the [log files](/daemon/README.md#log-files) are kept.|||
61 -| web files directory|`/usr/share/netdata/web`|The directory the web static files are kept.|||
62 -| cache directory|`/var/cache/netdata`|The directory the memory database will be stored if and when Netdata exits. Netdata will re-read the database when it will start again, to continue from the same point.|||
63 -| lib directory|`/var/lib/netdata`|Contains the alarm log and the Netdata instance guid.|||
64 -| home directory|`/var/cache/netdata`|Contains the db files for the collected metrics|||
65 -| plugins directory|`"/usr/libexec/netdata/plugins.d" "/etc/netdata/custom-plugins.d"`|The directory plugin programs are kept. This setting supports multiple directories, space separated. If any directory path contains spaces, enclose it in single or double quotes.|||
49 +| setting|default|info|
50 +|:-----:|:-----:|:---|
51 +| process scheduling policy|`keep`|See [Netdata process scheduling policy](/daemon/README.md#netdata-process-scheduling-policy)|
52 +| OOM score|`0`||
53 +| glibc malloc arena max for plugins|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).|
54 +| glibc malloc arena max for Netdata|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).|
55 +| hostname|auto-detected|The hostname of the computer running Netdata.|
56 +| history|`3996`| Used with `memory mode = save/map/ram/alloc`, not the default `memory mode = dbengine`. This number reflects the number of entries the `netdata` daemon will by default keep in memory for each chart dimension. This setting can also be configured per chart. Check [Memory Requirements](/database/README.md) for more information. |
57 +| update every|`1`|The frequency in seconds, for data collection. For more information see the [performance guide](/docs/guides/configure/performance.md).|
58 +| config directory|`/etc/netdata`|The directory configuration files are kept.|
59 +| stock config directory|`/usr/lib/netdata/conf.d`||
60 +| log directory|`/var/log/netdata`|The directory in which the [log files](/daemon/README.md#log-files) are kept.|
61 +| web files directory|`/usr/share/netdata/web`|The directory the web static files are kept.|
62 +| cache directory|`/var/cache/netdata`|The directory the memory database will be stored if and when Netdata exits. Netdata will re-read the database when it will start again, to continue from the same point.|
63 +| lib directory|`/var/lib/netdata`|Contains the alarm log and the Netdata instance guid.|
64 +| home directory|`/var/cache/netdata`|Contains the db files for the collected metrics|
65 +| plugins directory|`"/usr/libexec/netdata/plugins.d" "/etc/netdata/custom-plugins.d"`|The directory plugin programs are kept. This setting supports multiple directories, space separated. If any directory path contains spaces, enclose it in single or double quotes.|
66 | memory mode | `dbengine` | `dbengine`: The default for long-term metrics storage with efficient RAM and disk usage. Can be extended with `page cache size` and `dbengine disk space`. <br />`save`: Netdata will save its round robin database on exit and load it on startup. <br />`map`: Cache files will be updated in real-time. Not ideal for systems with high load or slow disks (check `man mmap`). <br />`ram`: The round-robin database will be temporary and it will be lost when Netdata exits. <br />`none`: Disables the database at this host, and disables health monitoring entirely, as that requires a database of metrics. |
67 -| page cache size | 32 | Determines the amount of RAM in MiB that is dedicated to caching Netdata metric values. |||
68 -| dbengine disk space | 256 | Determines the amount of disk space in MiB that is dedicated to storing Netdata metric values and all related metadata describing them. |||
69 -| dbengine multihost disk space | 256 | Same functionality as `dbengine disk space`, but includes support for storing metrics streamed to a parent node by its children. Can be used in single-node environments as well. |||
70 -| host access prefix||This is used in docker environments where /proc, /sys, etc have to be accessed via another path. You may also have to set SYS_PTRACE capability on the docker for this work. Check [issue 43](https://github.com/netdata/netdata/issues/43).|
71 -| memory deduplication (ksm)|`yes`|When set to `yes`, Netdata will offer its in-memory round robin database to kernel same page merging (KSM) for deduplication. For more information check [Memory Deduplication - Kernel Same Page Merging - KSM](/database/README.md#ksm)|||
72 -| TZ environment variable|`:/etc/localtime`|Where to find the timezone|||
73 -| timezone|auto-detected|The timezone retrieved from the environment variable|||
74 -| debug flags|`0x0000000000000000`|Bitmap of debug options to enable. For more information check [Tracing Options](/daemon/README.md#debugging).|||
75 -| debug log|`/var/log/netdata/debug.log`|The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to `syslog` to send the debug messages to syslog, or `none` to disable this log. For more information check [Tracing Options](/daemon/README.md#debugging).|||
76 -| error log|`/var/log/netdata/error.log`|The filename to save error messages for Netdata daemon and all plugins (`stderr` is sent here for all Netdata programs, including the plugins). You can also set it to `syslog` to send the errors to syslog, or `none` to disable this log.|||
77 -| access log|`/var/log/netdata/access.log`|The filename to save the log of web clients accessing Netdata charts. You can also set it to `syslog` to send the access log to syslog, or `none` to disable this log.|||
78 -| errors flood protection period|`1200`|Length of period (in sec) during which the number of errors should not exceed the `errors to trigger flood protection`.|||
79 -| errors to trigger flood protection|`200`|Number of errors written to the log in `errors flood protection period` sec before flood protection is activated.|||
80 -| run as user|`netdata`|The user Netdata will run as.|||
81 -| pthread stack size|auto-detected||||
82 -| cleanup obsolete charts after seconds|`3600`|See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also sets the timeout for cleaning up obsolete dimensions|||
83 -| gap when lost iterations above|`1`||||
84 -| cleanup orphan hosts after seconds|`3600`|How long to wait until automatically removing from the DB a remote Netdata host (child) that is no longer sending data.|||
85 -| delete obsolete charts files|`yes`|See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also affects the deletion of files for obsolete dimensions|||
86 -| delete orphan hosts files|`yes`|Set to `no` to disable non-responsive host removal.|||
87 -| enable zero metrics|`no`|Set to `yes` to show charts when all their metrics are zero.|||
67 +| page cache size | 32 | Determines the amount of RAM in MiB that is dedicated to caching Netdata metric values. |
68 +| dbengine disk space | 256 | Determines the amount of disk space in MiB that is dedicated to storing Netdata metric values and all related metadata describing them. |
69 +| dbengine multihost disk space | 256 | Same functionality as `dbengine disk space`, but includes support for storing metrics streamed to a parent node by its children. Can be used in single-node environments as well. |
70 +| host access prefix| |This is used in docker environments where /proc, /sys, etc have to be accessed via another path. You may also have to set SYS_PTRACE capability on the docker for this work. Check [issue 43](https://github.com/netdata/netdata/issues/43).|
71 +| memory deduplication (ksm)|`yes`|When set to `yes`, Netdata will offer its in-memory round robin database to kernel same page merging (KSM) for deduplication. For more information check [Memory Deduplication - Kernel Same Page Merging - KSM](/database/README.md#ksm)|
72 +| TZ environment variable|`:/etc/localtime`|Where to find the timezone|
73 +| timezone|auto-detected|The timezone retrieved from the environment variable|
74 +| debug flags|`0x0000000000000000`|Bitmap of debug options to enable. For more information check [Tracing Options](/daemon/README.md#debugging).|
75 +| debug log|`/var/log/netdata/debug.log`|The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to `syslog` to send the debug messages to syslog, or `none` to disable this log. For more information check [Tracing Options](/daemon/README.md#debugging).|
76 +| error log|`/var/log/netdata/error.log`|The filename to save error messages for Netdata daemon and all plugins (`stderr` is sent here for all Netdata programs, including the plugins). You can also set it to `syslog` to send the errors to syslog, or `none` to disable this log.|
77 +| access log|`/var/log/netdata/access.log`|The filename to save the log of web clients accessing Netdata charts. You can also set it to `syslog` to send the access log to syslog, or `none` to disable this log.|
78 +| errors flood protection period|`1200`|Length of period (in sec) during which the number of errors should not exceed the `errors to trigger flood protection`.|
79 +| errors to trigger flood protection|`200`|Number of errors written to the log in `errors flood protection period` sec before flood protection is activated.|
80 +| run as user|`netdata`|The user Netdata will run as.|
81 +| pthread stack size|auto-detected||
82 +| cleanup obsolete charts after seconds|`3600`|See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also sets the timeout for cleaning up obsolete dimensions|
83 +| gap when lost iterations above|`1`||
84 +| cleanup orphan hosts after seconds|`3600`|How long to wait until automatically removing from the DB a remote Netdata host (child) that is no longer sending data.|
85 +| delete obsolete charts files|`yes`|See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also affects the deletion of files for obsolete dimensions|
86 +| delete orphan hosts files|`yes`|Set to `no` to disable non-responsive host removal.|
87 +| enable zero metrics|`no`|Set to `yes` to show charts when all their metrics are zero.|
88
89 ### [web] section options
90
streaming/README.md
+1 -1
@@ -107,7 +107,7 @@ This also disables the registry (there cannot be a registry without an API).
107 requests from its child nodes. 0 sets no limit, 1 means maximum once every second. If this is set, you may see error log
108 entries "... too busy to accept new streaming request. Will be allowed in X secs".
109
110 -You can [use](docs/agent/exporting/README.md#configuration) the exporting engine to configure data archiving to an external database (it archives all databases maintained on
110 +You can [use](/exporting/README.md#configuration) the exporting engine to configure data archiving to an external database (it archives all databases maintained on
111 this host).
112
113 ### Streaming configuration