docs: fix unresolved file references (#12872)
Ilya Mashchenko committed
May 11, 2022 at 13:06 UTC
dd313048f6907e052cc8da2a5d001ad35635ee25
6 files changed
+13
-15
collectors/COLLECTORS.md
+1
-3
@@ -252,10 +252,8 @@ configure any of these collectors according to your setup and infrastructure.
252
- [Access point](/collectors/charts.d.plugin/ap/README.md): Monitor client, traffic and signal metrics using the `aw`
253
tool.
254
- [APC UPS](/collectors/charts.d.plugin/apcupsd/README.md): Capture status information using the `apcaccess` tool.
255
-- [Energi Core (Go)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/energid): Monitor
255
+- [Energi Core](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/energid): Monitor
256
blockchain indexes, memory usage, network usage, and transactions of wallet instances.
257
-- [Energi Core (Python)](/collectors/python.d.plugin/energid/README.md): Monitor blockchain, memory, network, and
258
- unspent transactions statistics.
257
- [UPS/PDU](/collectors/charts.d.plugin/nut/README.md): Read the status of UPS/PDU devices using the `upsc` tool.
258
- [SNMP devices](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/snmp): Gather data using the SNMP protocol.
259
- [1-Wire sensors](/collectors/python.d.plugin/w1sensor/README.md): Monitor sensor temperature.
collectors/apps.plugin/README.md
+1
-1
@@ -160,7 +160,7 @@ There are a few command line options you can pass to `apps.plugin`. The list of
160
### Integration with eBPF
161
162
If you don't see charts under the **eBPF syscall** or **eBPF net** sections, you should edit your
163
-[`ebpf.d.conf`](/collectors/ebpf.plugin/README.md#ebpf-programs) file to ensure the eBPF program is enabled.
163
+[`ebpf.d.conf`](/collectors/ebpf.plugin/README.md#configure-the-ebpf-collector) file to ensure the eBPF program is enabled.
164
165
Also see our [guide on troubleshooting apps with eBPF
166
metrics](/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md) for ideas on how to interpret these charts in a
collectors/ebpf.plugin/README.md
+4
-4
@@ -29,7 +29,7 @@ Netdata uses the following features from the Linux kernel to run eBPF programs:
29
- Tracepoints are hooks to call specific functions. Tracepoints are more stable than `kprobes` and are preferred when
30
both options are available.
31
- Trampolines are bridges between kernel functions, and BPF programs. Netdata uses them by default whenever available.
32
-- Kprobes and return probes (`kretprobe`): Probes can insert virtually into any kernel instruction. When eBPF runs in `entry` mode, it attaches only `kprobes` for internal functions monitoring calls and some arguments every time a function is called. The user can also change configuration to use [`return`](#global) mode, and this will allow users to monitor return from these functions and detect possible failures.
32
+- Kprobes and return probes (`kretprobe`): Probes can insert virtually into any kernel instruction. When eBPF runs in `entry` mode, it attaches only `kprobes` for internal functions monitoring calls and some arguments every time a function is called. The user can also change configuration to use [`return`](#global-configuration-options) mode, and this will allow users to monitor return from these functions and detect possible failures.
33
34
In each case, wherever a normal kprobe, kretprobe, or tracepoint would have run its hook function, an eBPF program is run instead, performing various collection logic before letting the kernel continue its normal control flow.
35
@@ -137,7 +137,7 @@ _enable_ the integration with `cgroups.plugin`, change the `cgroups` setting to
137
138
If you do not need to monitor specific metrics for your `cgroups`, you can enable `cgroups` inside
139
`ebpf.d.conf`, and then disable the plugin for a specific `thread` by following the steps in the
140
-[Configuration](#configuration) section.
140
+[Configuration](#configuring-ebpfplugin) section.
141
142
#### Integration Dashboard Elements
143
@@ -419,7 +419,7 @@ collected in the previous and current seconds.
419
### System overview
420
421
Not all charts within the System Overview menu are enabled by default. Charts that rely on `kprobes` are disabled by default because they add around 100ns overhead for each function call. This is a small number from a human's perspective, but the functions are called many times and create an impact
422
-on host. See the [configuration](#configuration) section for details about how to enable them.
422
+on host. See the [configuration](#configuring-ebpfplugin) section for details about how to enable them.
423
424
#### Processes
425
@@ -863,7 +863,7 @@ eBPF monitoring is complex and produces a large volume of metrics. We've discove
863
significantly increases kernel memory usage by several hundred MB.
864
865
If your node is experiencing high memory usage and there is no obvious culprit to be found in the `apps.mem` chart,
866
-consider testing for high kernel memory usage by [disabling eBPF monitoring](#configuration). Next,
866
+consider testing for high kernel memory usage by [disabling eBPF monitoring](#configuring-ebpfplugin). Next,
867
[restart Netdata](/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see if system memory
868
usage (see the `system.ram` chart) has dropped significantly.
869
docs/dashboard/customize.mdx
+1
-1
@@ -32,7 +32,7 @@ Click this toggle to move the legend to the _right_ of charts.
32
33
Find this setting under the **Visual** tab. Choose between Dark (the default) and White.
34
35
-## Customize the standard dashboard
35
+## Customize the standard dashboard info
36
37
Netdata stores information about individual charts in the `dashboard_info.js` file. This file includes section and
38
subsection headings, descriptions, colors, titles, tooltips, and other information for Netdata to render on the
docs/dashboard/import-export-print-snapshot.mdx
+1
-1
@@ -12,7 +12,7 @@ node running Netdata. Or, you can create a print-ready version of your dashboard
12
paper.
13
14
Snapshots can be incredibly useful for diagnosing anomalies after they've already happened. Let's say Netdata triggered a warning alarm while you were asleep. In the morning, you can [select the
15
-timeframe](/docs/dashboard/select-timeframes.mdx) when the alarm triggered, export a snapshot, and send it to a
15
+timeframe](/docs/dashboard/visualization-date-and-time-controls.mdx) when the alarm triggered, export a snapshot, and send it to a
16
17
colleague for further analysis.
18
docs/dashboard/reference-web-server.mdx
+5
-5
@@ -28,9 +28,9 @@ Scroll down to the `[web]` section to find the following settings.
28
## Settings
29
30
| Setting | Default | Description |
31
-| :----------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
32
-| `ssl key` | `/etc/netdata/ssl/key.pem` | Declare the location of an SSL key to [enable HTTPS](#enable-HTTPSTLS-support). |
33
-| `ssl certificate` | `/etc/netdata/ssl/cert.pem` | Declare the location of an SSL certificate to [enable HTTPS](#enable-HTTPSTLS-support). |
31
+|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
32
+| `ssl key` | `/etc/netdata/ssl/key.pem` | Declare the location of an SSL key to [enable HTTPS](#enable-httpstls-support). |
33
+| `ssl certificate` | `/etc/netdata/ssl/cert.pem` | Declare the location of an SSL certificate to [enable HTTPS](#enable-httpstls-support). |
34
| `tls version` | `1.3` | Choose which TLS version to use. While all versions are allowed (`1` or `1.0`, `1.1`, `1.2` and `1.3`), we recommend `1.3` for the most secure encryption. If left blank, Netdata uses the highest available protocol version on your system. |
35
| `tls ciphers` | `none` | Choose which TLS cipher to use. Options include `TLS_AES_256_GCM_SHA384`, `TLS_CHACHA20_POLY1305_SHA256`, and `TLS_AES_128_GCM_SHA256`. If left blank, Netdata uses the default cipher list for that protocol provided by your TLS implementation. |
36
| `ses max window` | `15` | See [single exponential smoothing](/web/api/queries/ses/README.md). |
@@ -45,7 +45,7 @@ Scroll down to the `[web]` section to find the following settings.
45
| `accept a streaming request every seconds` | `0` | Can be used to set a limit on how often a parent node will accept streaming requests from child nodes in a [streaming and replication setup](/streaming/README.md). |
46
| `respect do not track policy` | `no` | If set to `yes`, Netdata will respect the user's browser preferences for [Do Not Track](https://www.eff.org/issues/do-not-track) (DNT) and storing cookies. If DNT is _enabled_ in the browser, and this option is set to `yes`, users will not be able to sign in to Netdata Cloud via their local Agent dashboard, and their node will not connect to any [registry](/registry/README.md). For certain browsers, users must disable DNT and change this option to `yes` for full functionality. |
47
| `x-frame-options response header` | ` ` | Avoid [clickjacking attacks](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options), by ensuring that the content is not embedded into other sites. |
48
-| `allow connections from` | `localhost *` | Declare which IP addresses or full-qualified domain names (FQDNs) are allowed to connect to the web server, including the [dashboard](/docs/dashboard/dashboards-charts.mdx) or [HTTP API](/web/api/README.md). This is a global setting with higher priority to any of the ones below. |
48
+| `allow connections from` | `localhost *` | Declare which IP addresses or full-qualified domain names (FQDNs) are allowed to connect to the web server, including the [dashboard](/docs/dashboard/interact-charts.mdx) or [HTTP API](/web/api/README.md). This is a global setting with higher priority to any of the ones below. |
49
| `allow connections by dns` | `heuristic` | See the [access list examples](#access-lists) for details on using `allow` settings. |
50
| `allow dashboard from` | `localhost *` | |
51
| `allow dashboard by dns` | `heuristic` | |
@@ -62,7 +62,7 @@ Scroll down to the `[web]` section to find the following settings.
62
| `gzip compression level` | `3` | Valid settings are 1 (fastest) to 9 (best ratio). |
63
| `web server threads` | ` ` | How many processor threads the web server is allowed. The default is system-specific, the minimum of `6` or the number of CPU cores. |
64
| `web server max sockets` | ` ` | Available sockets. The default is system-specific, automatically adjusted to 50% of the max number of open files Netdata is allowed to use (via `/etc/security/limits.conf` or systemd), to allow enough file descriptors to be available for data collection. |
65
-| `custom dashboard_info.js` | ` ` | Specifies the location of a custom `dashboard.js` file. See [customizing the standard dashboard](/docs/dashboard/customize.mdx#customize-the-standard-dashboard) for details. |
65
+| `custom dashboard_info.js` | ` ` | Specifies the location of a custom `dashboard.js` file. See [customizing the standard dashboard](/docs/dashboard/customize.mdx#customize-the-standard-dashboard) for details. |
66
67
## Examples
68