Change links to relative links in one doc (#17719)
Fotis Voutsas committed
May 21, 2024 at 10:22 UTC
97004af2a63c97f821ab91b2d4be4a3e0c7ccd27
1 file changed
+16
-27
docs/netdata-agent/configuration/common-configuration-changes.md
+16
-27
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Common configuration changes"
3
-description: "See the most popular configuration changes to make to the Netdata Agent, including longer metrics retention, reduce sampling, and more."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/netdata-agent/configuration/common-configuration-changes.md"
5
-sidebar_label: "Common configuration changes"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Configuration"
9
--->
10
-
1
# Common configuration changes
2
3
The Netdata Agent requires no configuration upon installation to collect thousands of per-second metrics from most
@@ -15,14 +5,14 @@ systems, containers, and applications, but there are hundreds of settings to twe
5
over your monitoring platform.
6
7
This document assumes familiarity with
18
-using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md) from the Netdata config
8
+using [`edit-config`](/docs/netdata-agent/configuration/README.md) from the Netdata config
9
directory.
10
11
## Change dashboards and visualizations
12
23
-The Netdata Agent's [local dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboards-and-charts/README.md), accessible
13
+The Netdata Agent's [local dashboard](/docs/dashboards-and-charts/README.md), accessible
14
at `http://NODE:19999` is highly configurable. If
25
-you use [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/README.md)
15
+you use [Netdata Cloud](/docs/netdata-cloud/README.md)
16
for infrastructure monitoring, you
17
will see many of these
18
changes reflected in those visualizations due to the way Netdata Cloud proxies metric data and metadata to your browser.
@@ -30,15 +20,15 @@ changes reflected in those visualizations due to the way Netdata Cloud proxies m
20
### Increase the long-term metrics retention period
21
22
Read our doc
33
-on [increasing long-term metrics storage](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md)
23
+on [increasing long-term metrics storage](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md)
24
for details, including a
35
-[calculator](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
25
+[calculator](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
26
to help you determine the exact settings for your desired retention period.
27
28
### Reduce the data collection frequency
29
30
Change `update every` in
41
-the [`[global]` section](https://github.com/netdata/netdata/blob/master/src/daemon/config/README.md#global-section-options)
31
+the [`[global]` section](/src/daemon/config/README.md#global-section-options)
32
of `netdata.conf` so
33
that it is greater than `1`. An `update every` of `5` means the Netdata Agent enforces a _minimum_ collection frequency
34
of 5 seconds.
@@ -51,13 +41,13 @@ of 5 seconds.
41
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
42
`python.d.conf` or `charts.d.conf` files, or in individual collector configuration files. If the `update
43
every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See
54
-the [enable or configure a collector](https://github.com/netdata/netdata/blob/master/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
44
+the [enable or configure a collector](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
45
doc for details.
46
47
### Disable a collector or plugin
48
49
Turn off entire plugins in
60
-the [`[plugins]` section](https://github.com/netdata/netdata/blob/master/src/daemon/config/README.md#plugins-section-options)
50
+the [`[plugins]` section](/src/daemon/config/README.md#plugins-section-options)
51
of
52
`netdata.conf`.
53
@@ -83,9 +73,9 @@ sudo ./edit-config health.d/example-alert.conf
73
74
Or, append your new alert to an existing file by editing a relevant existing file in the `health.d/` directory.
75
86
-Read more about [configuring alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) to
76
+Read more about [configuring alerts](/src/health/REFERENCE.md) to
77
get started, and see
88
-the [health monitoring reference](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) for a full listing
78
+the [health monitoring reference](/src/health/REFERENCE.md) for a full listing
79
of options available in health entities.
80
81
### Configure a specific alert
@@ -94,7 +84,7 @@ Tweak existing alerts by editing files in the `health.d/` directory. For example
84
the Agent responds to anomalies related to CPU utilization.
85
86
To see which configuration file you need to edit to configure a specific
97
-alert, [view your active alerts](https://github.com/netdata/netdata/blob/master/docs/dashboards-and-charts/alerts-tab.md) in
87
+alert, [view your active alerts](/docs/dashboards-and-charts/alerts-tab.md) in
88
Netdata Cloud or the local Agent dashboard and look for the **source** line. For example, it might
89
read `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`.
90
@@ -116,13 +106,12 @@ template: disk_fill_rate
106
### Turn of all alerts and notifications
107
108
Set `enabled` to `no` in
119
-the [`[health]`](https://github.com/netdata/netdata/blob/master/src/daemon/config/README.md#health-section-options)
109
+the [`[health]`](/src/daemon/config/README.md#health-section-options)
110
section of `netdata.conf`.
111
112
### Enable alert notifications
113
124
-Open `health_alarm_notify.conf` for editing. First, read the [enabling
125
-notifications](https://github.com/netdata/netdata/blob/master/docs/alerts-and-notifications/notifications/README.md#netdata-agent) doc
114
+Open `health_alarm_notify.conf` for editing. First, read the [enabling notifications](/docs/alerts-and-notifications/notifications/README.md#netdata-agent) doc
115
for an example of the process using Slack, then
116
click on the link to your preferred notification method to find documentation for that specific endpoint.
117
@@ -131,12 +120,12 @@ click on the link to your preferred notification method to find documentation fo
120
While the Netdata Agent is both [open and secure by design](https://www.netdata.cloud/blog/netdata-agent-dashboard/), we
121
recommend every user take some action to administer and secure their nodes.
122
134
-Learn more about the available options in the [security design documentation](https://github.com/netdata/netdata/blob/master/docs/security-and-privacy-design/README.md).
123
+Learn more about the available options in the [security design documentation](/docs/security-and-privacy-design/README.md).
124
125
## Reduce resource usage
126
127
Read
139
-our [performance optimization guide](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/optimize-the-netdata-agents-performance.md)
128
+our [performance optimization guide](/docs/netdata-agent/configuration/optimize-the-netdata-agents-performance.md)
129
for a long list of specific changes
130
that can reduce the Netdata Agent's CPU/memory footprint and IO requirements.
131
@@ -147,7 +136,7 @@ and as metadata to Netdata Cloud, and help you organize the metrics coming from
136
defined in the section `[host labels]`.
137
138
For a quick introduction, read
150
-the [host label guide](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md).
139
+the [host label guide](/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md).
140
141
The following restrictions apply to host label names:
142