@cryptotaxi247 / netdata-1 / commits / 109a635d0

Liquify start-stop-restart doc (#17037)

liquify start-stop-restart doc

Fotis Voutsas committed Feb 21, 2024 at 09:39 UTC 109a635d0426832397c311ade22045f3dac950ab

38 files changed +209 -352

docs/category-overview-pages/secure-nodes.md

+1 -1

@@ -60,7 +60,7 @@ static-threaded` setting, and change it to `none`.

60 mode = none

61 ```

63 -Save and close the editor, then [restart your Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md)

63 +Save and close the editor, then [restart your Agent](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation)

64 using `sudo systemctl

65 restart netdata`. If you try to visit the local dashboard to `http://NODE:19999` again, the connection will fail because

66 that node no longer serves its local dashboard.

docs/cloud/insights/anomaly-advisor.md

+1 -1

@@ -34,7 +34,7 @@ To enable ML on your Netdata Agent, you need to edit the `[ml]` section in your

35 At a minimum you just need to set `enabled = yes` to enable ML with default params. More details about configuration can be found in the [Netdata Agent ML docs](https://github.com/netdata/netdata/blob/master/src/ml/README.md#configuration).

37 -When you have finished your configuration, restart Netdata with a command like `sudo systemctl restart netdata` for the config changes to take effect. You can find more info on restarting Netdata [here](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).

37 +When you have finished your configuration, restart Netdata with a command like `sudo systemctl restart netdata` for the config changes to take effect. You can find more info on restarting Netdata [here](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation).

39 After a brief delay, you should see the number of `trained` dimensions start to increase on the "dimensions" chart of the "Anomaly Detection" menu on the Overview page. By default the `minimum num samples to train = 3600` parameter means at least 1 hour of data is required to train initial models, but you could set this to `900` if you want to train initial models quicker but on less data. Over time, they will retrain on up to `maximum num samples to train = 14400` (4 hours by default), but you could increase this is you wanted to train on more data.

docs/collect/system-metrics.md

+1 -1

@@ -45,7 +45,7 @@ details see [the requirements](https://github.com/netdata/go.d.plugin/blob/maste

46 Next, [configure](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md#configuration) the Windows

47 collector to point to the URL and port of your exposed endpoint. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

48 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. You'll start seeing Windows system metrics, such as CPU

48 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system. You'll start seeing Windows system metrics, such as CPU

49 utilization, memory, bandwidth per NIC, number of processes, and much more.

51 For information about collecting metrics from applications _running on Windows systems_, see the [application metrics

docs/configure/nodes.md

+1 -1

@@ -98,7 +98,7 @@ method for `edit-config` to write into the config directory. Use your `$EDITOR`,

98 > defaulted to `vim` or `nano`. Use `export EDITOR=` to change this temporarily, or edit your shell configuration file

99 > to change to permanently.

100

101 -After you make your changes, you need to [restart the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl

101 +After you make your changes, you need to [restart the Agent](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) with `sudo systemctl

102 restart netdata` or the appropriate method for your system.

103

104 Here's an example of editing the node's hostname, which appears in both the local dashboard and in Netdata Cloud.

docs/configure/start-stop-restart.md deleted

-154

@@ -1,154 +0,0 @@

1 -# Start, stop, or restart the Netdata Agent

2 -

3 -When you install the Netdata Agent, the [daemon](https://github.com/netdata/netdata/blob/master/src/daemon/README.md) is

4 -configured to start at boot and stop and restart/shutdown.

5 -

6 -You will most often need to _restart_ the Agent to load new or editing configuration files.

7 -[Health configuration](#reload-health-configuration) files are the only exception, as they can be reloaded without restarting

8 -the entire Agent.

9 -

10 -Stopping or restarting the Netdata Agent will cause gaps in stored metrics until the `netdata` process initiates

11 -collectors and the database engine.

12 -

13 -## Using `systemctl`, `service`, or `init.d`

14 -

15 -This is the recommended way to start, stop, or restart the Netdata daemon.

16 -

17 -- To **start** Netdata, run `sudo systemctl start netdata`.

18 -- To **stop** Netdata, run `sudo systemctl stop netdata`.

19 -- To **restart** Netdata, run `sudo systemctl restart netdata`.

20 -

21 -If the above commands fail, or you know that you're using a non-systemd system, try using the `service` command:

22 -

23 -- **service**: `sudo service netdata start`, `sudo service netdata stop`, `sudo service netdata restart`

24 -

25 -## Using `netdata`

26 -

27 -Use the `netdata` command, typically located at `/usr/sbin/netdata`, to start the Netdata daemon.

28 -

29 -```bash

30 -sudo netdata

31 -```

32 -

33 -If you start the daemon this way, close it with `sudo killall netdata`.

34 -

35 -## Using `netdatacli`

36 -

37 -The Netdata Agent also comes with a [CLI tool](https://github.com/netdata/netdata/blob/master/src/cli/README.md) capable of performing shutdowns. Start the Agent back up

38 -using your preferred method listed above.

39 -

40 -```bash

41 -sudo netdatacli shutdown-agent

42 -```

43 -

44 -## Netdata MSI installations

45 -

46 -Netdata provides an installer for Windows using WSL, on those installations by using a Windows terminal (e.g. the Command prompt or Windows Powershell) you can:

47 -

48 -- Start Netdata, by running `start-netdata`

49 -- Stop Netdata, by running `stop-netdata`

50 -- Restart Netdata, by running `restart-netdata`

51 -

52 -## Reload health configuration

53 -

54 -You do not need to restart the Netdata Agent between changes to health configuration files, such as specific health

55 -entities. Instead, use [`netdatacli`](#using-netdatacli) and the `reload-health` option to prevent gaps in metrics

56 -collection.

57 -

58 -```bash

59 -sudo netdatacli reload-health

60 -```

61 -

62 -If `netdatacli` doesn't work on your system, send a `SIGUSR2` signal to the daemon, which reloads health configuration

63 -without restarting the entire process.

64 -

65 -```bash

66 -killall -USR2 netdata

67 -```

68 -

69 -## Force stop stalled or unresponsive `netdata` processes

70 -

71 -In rare cases, the Netdata Agent may stall or not properly close sockets, preventing a new process from starting. In

72 -these cases, try the following three commands:

73 -

74 -```bash

75 -sudo systemctl stop netdata

76 -sudo killall netdata

77 -ps aux| grep netdata

78 -```

79 -

80 -The output of `ps aux` should show no `netdata` or associated processes running. You can now start the Netdata Agent

81 -again with `service netdata start`, or the appropriate method for your system.

82 -

83 -## Starting Netdata at boot

84 -

85 -In the `system` directory you can find scripts and configurations for the

86 -various distros.

87 -

88 -### systemd

89 -

90 -The installer already installs `netdata.service` if it detects a systemd system.

91 -

92 -To install `netdata.service` by hand, run:

93 -

94 -```sh

95 -# stop Netdata

96 -killall netdata

97 -

98 -# copy netdata.service to systemd

99 -cp system/netdata.service /etc/systemd/system/

100 -

101 -# let systemd know there is a new service

102 -systemctl daemon-reload

103 -

104 -# enable Netdata at boot

105 -systemctl enable netdata

106 -

107 -# start Netdata

108 -systemctl start netdata

109 -```

110 -

111 -### init.d

112 -

113 -In the system directory you can find `netdata-lsb`. Copy it to the proper place according to your distribution

114 -documentation. For Ubuntu, this can be done via running the following commands as root.

115 -

116 -```sh

117 -# copy the Netdata startup file to /etc/init.d

118 -cp system/netdata-lsb /etc/init.d/netdata

119 -

120 -# make sure it is executable

121 -chmod +x /etc/init.d/netdata

122 -

123 -# enable it

124 -update-rc.d netdata defaults

125 -```

126 -

127 -### openrc (gentoo)

128 -

129 -In the `system` directory you can find `netdata-openrc`. Copy it to the proper

130 -place according to your distribution documentation.

131 -

132 -### CentOS / Red Hat Enterprise Linux

133 -

134 -For older versions of RHEL/CentOS that don't have systemd, an init script is included in the system directory. This can

135 -be installed by running the following commands as root.

136 -

137 -```sh

138 -# copy the Netdata startup file to /etc/init.d

139 -cp system/netdata-init-d /etc/init.d/netdata

140 -

141 -# make sure it is executable

142 -chmod +x /etc/init.d/netdata

143 -

144 -# enable it

145 -chkconfig --add netdata

146 -```

147 -

148 -_There have been some recent work on the init script, see PR

149 -<https://github.com/netdata/netdata/pull/403>_

150 -

151 -### other systems

152 -

153 -You can start Netdata by running it from `/etc/rc.local` or equivalent.

154 -

docs/export/enable-connector.md

+2 -2

@@ -54,7 +54,7 @@ Replace `my_opentsdb_http_instance` with an instance name of your choice, and ch

54 address or hostname of your OpenTSDB database.

56 Restart your Agent with `sudo systemctl restart netdata`, or

57 -the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin exporting to your OpenTSDB

57 +the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to begin exporting to your OpenTSDB

58 database. The

59 Netdata Agent exports metrics _beginning from the time the process starts_, and because it exports as metrics are

60 collected, you should start seeing data in your external database after only a few seconds.

@@ -78,7 +78,7 @@ Replace `my_graphite_instance` with an instance name of your choice, and change

78 address or hostname of your Graphite-supported database.

80 Restart your Agent with `sudo systemctl restart netdata`, or

81 -the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin exporting to your

81 +the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to begin exporting to your

82 Graphite-supported database.

83 Because the Agent exports metrics as they're collected, you should start seeing data in your external database after

84 only a few seconds.

docs/guides/collect-apache-nginx-web-logs.md

+1 -1

@@ -82,7 +82,7 @@ jobs:

82 ```

84 Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

85 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. Netdata should pick up your web server's access log and

85 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system. Netdata should pick up your web server's access log and

86 begin showing real-time charts!

88 ### Custom log formats and fields

docs/guides/collect-unbound-metrics.md

+2 -2

@@ -59,7 +59,7 @@ You may not need to do any more configuration to have Netdata collect your Unbou

60 If you followed the steps above to enable `remote-control` and make your Unbound files readable by Netdata, that should

61 be enough. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

62 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. You should see Unbound metrics in your Netdata

62 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system. You should see Unbound metrics in your Netdata

63 dashboard!

65 ![Some charts showing Unbound metrics in real-time](https://user-images.githubusercontent.com/1153921/69659974-93160f00-103c-11ea-88e6-27e9efcf8c0d.png)

@@ -104,7 +104,7 @@ Netdata will attempt to read `unbound.conf` to get the appropriate `address`, `c

104 `tls_key` parameters.

105

106 Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

107 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

107 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

108

109 ### Manual setup for a remote Unbound server

110

docs/guides/monitor-cockroachdb.md

+1 -1

@@ -38,7 +38,7 @@ display them on the dashboard.

39 If your CockroachDB instance is accessible through `http://localhost:8080/` or `http://127.0.0.1:8080`, your setup is

40 complete. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

41 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, and refresh your browser. You should see CockroachDB

41 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, and refresh your browser. You should see CockroachDB

42 metrics in your Netdata dashboard!

44 <figure>

docs/guides/monitor-hadoop-cluster.md

+1 -1

@@ -164,7 +164,7 @@ jobs:

164 address : 203.0.113.10:2182

165 ```

166

167 -Finally, [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).

167 +Finally, [restart Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation).

168

169 ```sh

170 sudo systemctl restart netdata

docs/guides/monitor/anomaly-detection.md

+1 -1

@@ -53,7 +53,7 @@ Pressing the anomalies icon (next to the information icon in the chart header) w

54 ## Anomaly Rate Based Alerts

56 -It is possible to use the `anomaly-bit` when defining traditional Alerts within netdata. The `anomaly-bit` is just another `options` parameter that can be passed as part of an [alert line lookup](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#alert-line-lookup).

56 +It is possible to use the `anomaly-bit` when defining traditional Alerts within netdata. The `anomaly-bit` is just another `options` parameter that can be passed as part of an alert line lookup.

58 You can see some example ML based alert configurations below:

docs/guides/monitor/lamp-stack.md

+1 -1

@@ -105,7 +105,7 @@ FLUSH PRIVILEGES;

105 ```

106

107 Run `sudo systemctl restart netdata`, or the [appropriate alternative for your

108 -system](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md), to collect dozens of metrics every second for robust MySQL monitoring.

108 +system](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation), to collect dozens of metrics every second for robust MySQL monitoring.

109

110 ## Enable PHP monitoring

111

docs/guides/monitor/process.md

+2 -2

@@ -180,7 +180,7 @@ sql: mariad* postmaster* oracle_* ora_* sqlservr

180 ```

181

182 Restart Netdata with `sudo systemctl restart netdata`, or

183 -the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to start collecting utilization metrics

183 +the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to start collecting utilization metrics

184 from your application. Time to [visualize your process metrics](#visualize-process-metrics).

185

186 ### Custom applications

@@ -207,7 +207,7 @@ custom-app: custom-app

207 ```

208

209 Restart Netdata with `sudo systemctl restart netdata`, or

210 -the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to start collecting utilization metrics

210 +the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to start collecting utilization metrics

211 from your application.

212

213 ## Visualize process metrics

docs/guides/monitor/raspberry-pi-anomaly-detection.md

+1 -1

@@ -53,7 +53,7 @@ LLVM_CONFIG=llvm-config-9 pip3 install --user llvmlite numpy==1.20.1 netdata-pan

54 ## Enable the anomalies collector

56 -Now you're ready to enable the collector and [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).

56 +Now you're ready to enable the collector and [restart Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation).

58 ```bash

59 sudo ./edit-config python.d.conf

docs/guides/python-collector.md

+2 -2

@@ -410,7 +410,7 @@ ORDER = [

410 ]

411 ```

412

413 -[Restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see the new humidity

413 +[Restart Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) with `sudo systemctl restart netdata` to see the new humidity

414 chart:

415

416 ![A snapshot of the modified chart](https://i.imgur.com/XOeCBmg.png)

@@ -467,7 +467,7 @@ ORDER = [

467 ]

468 ```

469

470 -[Restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with `sudo systemctl restart netdata` to see the new

470 +[Restart Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) with `sudo systemctl restart netdata` to see the new

471 min/max/average temperature chart with multiple dimensions:

472

473 ![A snapshot of the modified chart](https://i.imgur.com/g7E8lnG.png)

docs/guides/troubleshoot/monitor-debug-applications-ebpf.md

+2 -2

@@ -61,7 +61,7 @@ dev: custom-app

61 ```

63 Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

64 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin seeing metrics for this particular

64 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to begin seeing metrics for this particular

65 group+process. You can also add additional processes to the same group.

67 You can set up `apps_groups.conf` to more show more precise eBPF metrics for any application or service running on your

@@ -110,7 +110,7 @@ Replace `entry` with `return`:

110 ```

111

112 Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

113 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

113 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

114

115 ## Get familiar with per-application eBPF metrics and charts

116

docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md

+1 -1

@@ -91,7 +91,7 @@ the Netdata service cannot be enabled by default and you must do it manually, us

91 > ### Note

92 >

93 > In some cases a simple restart of the Agent can fix the issue.

94 -> Read more about [Starting, Stopping and Restarting the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).

94 +> Read more about [Starting, Stopping and Restarting the Agent](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation).

96 #### Troubleshoot connection establishment with Docker

docs/metrics-storage-management/enable-streaming.md

+3 -3

@@ -138,7 +138,7 @@ simplified version of the configuration, minus the commented lines, looks like t

138 ```

139

140 Save the file and close it, then restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

141 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

141 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

142

143 ### Enable streaming on the child node

144

@@ -159,7 +159,7 @@ looks like the following:

159 ```

160

161 Save the file and close it, then restart Netdata with `sudo systemctl restart netdata`, or the [appropriate

162 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

162 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

163

164 ### Enable TLS/SSL on streaming (optional)

165

@@ -199,7 +199,7 @@ self-signed certificates.

199 ```

200

201 Restart both the parent and child nodes with `sudo systemctl restart netdata`, or the [appropriate

202 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to stream encrypted metrics using TLS/SSL.

202 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to stream encrypted metrics using TLS/SSL.

203

204 ### View streamed metrics in Netdata Cloud

205

docs/running-through-cf-tunnels.md

+1 -1

@@ -102,7 +102,7 @@ You can edit the configuration file using the `edit-config` script from the Netd

102 destination = tcp:127.0.0.1:19999

103 ```

104

105 -[Restart the Agents](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md), and you are done!

105 +[Restart the Agents](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation), and you are done!

106

107 You should now be able to have a Local Dashboard that gets its metrics from Child instances, running through Cloudflare tunnels.

108

docs/store/change-metrics-storage.md

+1 -1

@@ -160,7 +160,7 @@ Once you have decided how to size each tier, open `netdata.conf` with

160 and make your changes in the `[db]` subsection.

161

162 Save the file and restart the Agent with `sudo systemctl restart netdata`, or

163 -the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md)

163 +the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation)

164 for your system, to change the database engine's size.

165

166 ## Scaling dedicated parent nodes

packaging/installer/README.md

+26 -119

@@ -3,23 +3,16 @@ import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/Inst

3 import Tabs from '@theme/Tabs';

4 import TabItem from '@theme/TabItem';

6 -# Install Netdata

6 +# Netdata Agent Installation

8 -This document will guide you through installing the open-source Netdata monitoring Agent on Linux, Docker, Kubernetes, and many others, often with one command.

8 +Netdata is very flexible and can be used to monitor all kinds of infrastructure. Read more about possible [Deployment guides](https://github.com/netdata/netdata/blob/master/docs/deployment-guides/README.md) to understand what better suites your needs.

10 -Netdata is very flexible and can be used to monitor all kinds of infrastructure. Read more about possible [Deployment strategies](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/deployment-strategies.md) to understand what better suites your needs.

10 +## Install through Netdata Cloud

12 -## Get started

12 +Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.

14 -Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from

15 -any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.

16 -

17 -Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you can monitor your entire infrastructure in

18 -real time and troubleshoot problems that threaten the health of your nodes.

19 -

20 -Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. It

21 -runs on Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters,

22 -Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` required.

14 +Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices.

15 +It runs on Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` required.

17 To install Netdata in minutes on your platform:

@@ -27,113 +20,27 @@ To install Netdata in minutes on your platform:

20 2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform

21 3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it

30 -Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts

31 -in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md).

32 -

33 -Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting,

34 -but we have some hints on what you might want to do next.

23 +Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Take a look at our Dashboards and Charts](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/accessing-netdata-dashboards.md) section to read more about Netdata's features.

24 +

25 +## Maintaining a Netdata Agent installation

26 +

27 +For actions like starting, stopping, restarting, updating and uninstalling the Netdata Agent take a look at your specific installation platform in the current section of our Documentation.

28 +

29 +## Configuration

30 +

31 +If you are looking to configure your Netdata Agent installation, refer to the [respective section in our Documentation](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md).

32 +

33 +## Data collection

34 +

35 +If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/src/collectors/README.md). If there's a [supported collector](https://github.com/netdata/netdata/blob/master/src/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/src/collectors/REFERENCE.md) or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.

36 +

37 +## Alerts & notifications

38 +

39 +Netdata comes with hundreds of pre-configured alerts, designed by our monitoring gurus in parallel with our open-source community, but you may want to [edit alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) or [enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.

40 +

41 +## Make your deployment production ready

36 -### What's next?

37 -

38 -Explore our [general advanced installation options and troubleshooting](#advanced-installation-options-and-troubleshooting), specific options

39 -for the [single line installer](#install-on-linux-with-one-line-installer), or [other installation methods](#other-installation-methods).

40 -

41 -#### Configuration

42 -

43 -Discover the recommended way to [configure Netdata's settings or behavior](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) using our built-in

44 -`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores

45 -metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).

46 -

47 -#### Data collection

48 -

49 -If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should

50 -learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/src/collectors/README.md). If there's a [supported

51 -collector](https://github.com/netdata/netdata/blob/master/src/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/src/collectors/REFERENCE.md)

52 -or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.

53 -

54 -#### Alerts & notifications

55 -

56 -Netdata comes with hundreds of preconfigured alerts, designed by our monitoring gurus in parallel with our open-source

57 -community, but you may want to [edit alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) or

58 -[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.

59 -

60 -#### Make your deployment production ready

61 -

62 -Go through our [deployment strategies](https://github.com/netdata/netdata/edit/master/docs/category-overview-pages/deployment-strategies.md),

63 -for suggested configuration changes for production deployments.

64 -

65 -## Install on Linux with one-line installer

66 -

67 -The **recommended** way to install Netdata on a Linux node (physical, virtual, container, IoT) is our one-line

68 -[kickstart script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).

69 -This script automatically installs dependencies and builds Netdata from its source code.

70 -

71 -To install, copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process.

72 -

73 - <Tabs>

74 - <TabItem value="wget" label=<code>wget</code>>

75 -

76 - <OneLineInstallWget/>

77 -

78 - </TabItem>

79 - <TabItem value="curl" label=<code>curl</code>>

80 -

81 - <OneLineInstallCurl/>

82 -

83 - </TabItem>

84 -</Tabs>

85 -

86 -> ### Note

87 ->

88 -> If you plan to also claim the node to Netdata Cloud, make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space, and `YOUR_ROOM_ID` with the ID of the room you are claiming to.

89 -> You can leave the room id blank to have your node claimed to the default "All nodes" room.

90 -

91 -Jump up to [what's next](#whats-next) to learn how to view your new dashboard and take your next steps in monitoring and

92 -troubleshooting with Netdata.

93 -

94 -## Other installation methods

95 -

96 -<InstallRegexLink>

97 - <InstallBoxRegexLink

98 - to="[](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)"

99 - os="Run with Docker"

100 - svg="docker" />

101 - <InstallBoxRegexLink

102 - to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)"

103 - os="Deploy on Kubernetes"

104 - svg="kubernetes" />

105 - <InstallBoxRegexLink

106 - to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)"

107 - os="Install on macOS"

108 - svg="macos" />

109 - <InstallBoxRegexLink

110 - to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/packages.md)"

111 - os="Native DEB/RPM packages"

112 - svg="linux" />

113 - <InstallBoxRegexLink

114 - to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)"

115 - os="Linux from Git"

116 - svg="linux" />

117 - <InstallBoxRegexLink

118 - to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)"

119 - os="Linux from source"

120 - svg="linux" />

121 - <InstallBoxRegexLink

122 - to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)"

123 - os="Linux for offline nodes"

124 - svg="linux" />

125 -</InstallRegexLink>

126 -

127 -- [Native DEB/RPM packages](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/packages.md)

128 -- [Run with Docker](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)

129 -- [Deploy on Kubernetes](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)

130 -- [Install on macOS](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)

131 -- [Linux from Git](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)

132 -- [Linux from source](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)

133 -- [Linux for offline nodes](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)

134 -

135 -The full list of all installation methods for various systems is available in [Netdata Learn](https://learn.netdata.cloud),

136 -under [Installation](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/installation-overview.md).

43 +Go through our [deployment guides](https://github.com/netdata/netdata/blob/master/docs/deployment-guides/README.md), for suggested configuration changes for production deployments.

45 ## Advanced installation options and troubleshooting

packaging/installer/methods/kickstart.md

+126 -31

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Install Netdata with kickstart.sh"

3 -description: "The kickstart.sh script installs Netdata from source, including all dependencies required to connect to Netdata Cloud, with a single command."

4 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md"

5 -sidebar_label: "One line installer (kickstart.sh)"

6 -learn_status: "Published"

7 -learn_rel_path: "Installation/Installation methods"

8 -sidebar_position: 10

9 --->

10 -

1 import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'

2 import { Install, InstallBox } from '@site/src/components/Install/'

3 import Tabs from '@theme/Tabs';

@@ -19,28 +9,13 @@ import TabItem from '@theme/TabItem';

10 `kickstart.sh` is the recommended way of installing Netdata.

22 -This script works on all Linux distributions and macOS environments, by detecting the optimal method of installing Netdata directly to the operating system (it will never install a docker image of Netdata - to run Netdata in a container [check Installing with Docker](https://learn.netdata.cloud/docs/installing/docker)).

23 -

24 -If you are installing on macOS, make sure to check the [install documentation for macOS](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md) before continuing.

25 -

26 -

27 -## Verify script integrity

28 -

29 -To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,

30 -run the following:

31 -

32 -```bash

33 -[ "@KICKSTART_CHECKSUM@" = "$(curl -Ss https://get.netdata.cloud/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"

34 -```

35 -

36 -If the script is valid, this command will return `OK, VALID`.

37 -

12 +This script works on all Linux distributions and macOS environments, by detecting the optimal method of installing Netdata directly to the operating system.

14 ## Installation

16 > :bulb: Tip

17 >

43 -> If you are unsure whether you want nightly or stable releases, read the [installation guide](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#nightly-vs-stable-releases).

18 +> If you are unsure whether you want nightly or stable releases, read the [related section](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#nightly-vs-stable-releases) of our Documentation, detailing the pros and cons of each release type.

20 To install Netdata, run the following as your normal user:

@@ -58,10 +33,20 @@ To install Netdata, run the following as your normal user:

33 </Tabs>

35 > :bookmark_tabs: Note

61 ->

36 +>

37 > If you plan to also connect the node to Netdata Cloud, make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,

38 > and `YOUR_ROOM_ID` with the ID of the room you are willing to connect the node to.

40 +## Verify script integrity

41 +

42 +To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,

43 +run the following:

44 +

45 +```bash

46 +[ "@KICKSTART_CHECKSUM@" = "$(curl -Ss https://get.netdata.cloud/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"

47 +```

48 +

49 +If the script is valid, this command will return `OK, VALID`.

51 ## What does `kickstart.sh` do?

@@ -78,6 +63,116 @@ The `kickstart.sh` script does the following after being downloaded and run usin

63 versions, unless you override that with an [optional parameter](#optional-parameters-to-alter-your-installation).

64 - Prints a message whether installation succeeded or failed for QA purposes.

66 +## Start stop or restart the Netdata Agent

67 +

68 +You will most often need to _restart_ the Agent to load new or edited configuration files.

69 +

70 +> **Note**

71 +> Stopping or restarting the Netdata Agent will cause gaps in stored metrics until the `netdata` process initiates collectors and the database engine.

72 +>

73 +> You do not need to restart the Netdata Agent between changes to health configuration files, see the relevant section on [reloading health configuration](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#reload-health-configuration).

74 +

75 +### Using `systemctl` or `service`

76 +

77 +This is the recommended way to start, stop, or restart the Netdata daemon.

78 +

79 +- To **start** Netdata, run `sudo systemctl start netdata`.

80 +- To **stop** Netdata, run `sudo systemctl stop netdata`.

81 +- To **restart** Netdata, run `sudo systemctl restart netdata`.

82 +

83 +If the above commands fail, or you know that you're using a non-systemd system, try using the `service` command:

84 +

85 +- Starting: `sudo service netdata start`.

86 +- Stopping: `sudo service netdata stop`.

87 +- Restarting: `sudo service netdata restart`.

88 +

89 +### Using the `netdata` command

90 +

91 +Use the `netdata` command, typically located at `/usr/sbin/netdata`, to start the Netdata daemon:

92 +

93 +```bash

94 +sudo netdata

95 +```

96 +

97 +If you start the daemon this way, close it with `sudo killall netdata`.

98 +

99 +### Shutdown using `netdatacli`

100 +

101 +The Netdata Agent also comes with a [CLI tool](https://github.com/netdata/netdata/blob/master/src/cli/README.md) capable of performing shutdowns. Start the Agent back up using your preferred method listed above.

102 +

103 +```bash

104 +sudo netdatacli shutdown-agent

105 +```

106 +

107 +## Starting Netdata at boot

108 +

109 +In the `system` directory you can find scripts and configurations for the

110 +various distros.

111 +

112 +### systemd

113 +

114 +The installer already installs `netdata.service` if it detects a systemd system.

115 +

116 +To install `netdata.service` by hand, run:

117 +

118 +```sh

119 +# stop Netdata

120 +killall netdata

121 +

122 +# copy netdata.service to systemd

123 +cp system/netdata.service /etc/systemd/system/

124 +

125 +# let systemd know there is a new service

126 +systemctl daemon-reload

127 +

128 +# enable Netdata at boot

129 +systemctl enable netdata

130 +

131 +# start Netdata

132 +systemctl start netdata

133 +```

134 +

135 +### init.d

136 +

137 +In the system directory you can find `netdata-lsb`. Copy it to the proper place according to your distribution's documentation. For Ubuntu, this can be done via running the following commands as root.

138 +

139 +```sh

140 +# copy the Netdata startup file to /etc/init.d

141 +cp system/netdata-lsb /etc/init.d/netdata

142 +

143 +# make sure it is executable

144 +chmod +x /etc/init.d/netdata

145 +

146 +# enable it

147 +update-rc.d netdata defaults

148 +```

149 +

150 +### openrc / Gentoo Linux

151 +

152 +In the `system` directory you can find `netdata-openrc`. Copy it to the proper

153 +place according to your distribution documentation.

154 +

155 +### CentOS / Red Hat Enterprise Linux

156 +

157 +For older versions of RHEL/CentOS that don't have systemd, an init script is included in the system directory. This can be installed by running the following commands as root.

158 +

159 +```sh

160 +# copy the Netdata startup file to /etc/init.d

161 +cp system/netdata-init-d /etc/init.d/netdata

162 +

163 +# make sure it is executable

164 +chmod +x /etc/init.d/netdata

165 +

166 +# enable it

167 +chkconfig --add netdata

168 +```

169 +

170 +_There have been some recent work on the init script, see the following PR <https://github.com/netdata/netdata/pull/403>_

171 +

172 +### Other operating systems

173 +

174 +You can start Netdata by running it from `/etc/rc.local` or your system's equivalent.

175 +

176 ## Optional parameters to alter your installation

177

178 The `kickstart.sh` script accepts a number of optional parameters to control how the installation process works:

@@ -177,6 +272,7 @@ By default, the agent is sending anonymous telemetry data to help us take identi

272 Uninstall an existing installation of Netdata. Fails if there is no existing install.

273

274 ### other options

275 +

276 - `--dry-run`

277 Show what the installer would do, but don’t actually do any of it.

278 - `--dont-start-it`

@@ -204,10 +300,9 @@ should not need to use special values for any of these):

300 those to work, or have a different tool to do the same thing on your system, you can specify it here.

301 - `DISABLE_TELEMETRY`: If set to a value other than 0, behave as if `--disable-telemetry` was specified.

302

207 -

303 ## Native packages

304

210 -We publish official DEB/RPM packages for a number of common Linux distributions as part of our releases and nightly

305 +We publish [official DEB/RPM packages](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/packages.md) for a number of common Linux distributions as part of our releases and nightly

306 builds. These packages are available for 64-bit x86 systems. Depending on the distribution and release they may

307 also be available for 32-bit x86, ARMv7, and AArch64 systems. If a native package is available, it will be used as the

308 default installation method. This allows you to handle Netdata updates as part of your usual system update procedure.

@@ -217,7 +312,7 @@ you can do so by adding `--native-only` to the options you pass to the installer

312

313 ## Static builds

314

220 -We publish pre-built static builds of Netdata for Linux systems. Currently, these are published for 64-bit x86, ARMv7,

315 +We publish pre-built [static builds](https://github.com/netdata/netdata/blob/master/packaging/makeself/README.md) of Netdata for Linux systems. Currently, these are published for 64-bit x86, ARMv7,

316 AArch64, and POWER8+ hardware. These static builds are able to operate in a mostly self-contained manner and only

317 require a POSIX compliant shell and a supported init system. These static builds install under `/opt/netdata`. If

318 you are on a platform which we provide static builds for but do not provide native packages for, a static build

src/collectors/REFERENCE.md

+2 -2

@@ -80,7 +80,7 @@ enable/disable it with `yes` and `no` settings. Uncomment any line you change to

80 start.

82 After you make your changes, restart the Agent with `sudo systemctl restart netdata`, or the [appropriate

83 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

83 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

85 ## Configure a collector

@@ -118,7 +118,7 @@ configure that collector. Uncomment any line you change to ensure the collector'

118 read it on start.

119

120 After you make your changes, restart the Agent with `sudo systemctl restart netdata`, or the [appropriate

121 -method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

121 +method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

122

123 ## Troubleshoot a collector

124

src/collectors/charts.d.plugin/sensors/metadata.yaml

+1 -1

@@ -57,7 +57,7 @@ modules:

57 sudo ./edit-config charts.d.conf

58 ```

60 - Change the value of the `sensors` setting to `force` and uncomment the line. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

60 + Change the value of the `sensors` setting to `force` and uncomment the line. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

61 configuration:

62 file:

63 name: charts.d/sensors.conf

src/collectors/ebpf.plugin/README.md

+1 -1

@@ -899,7 +899,7 @@ node is experiencing high memory usage and there is no obvious culprit to be fou

899

900 If with these changes you still suspect eBPF using too much memory, and there is no obvious culprit to be found

901 in the `apps.mem` chart, consider testing for high kernel memory usage by [disabling eBPF monitoring](#configuring-ebpfplugin).

902 -Next, [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) with

902 +Next, [restart Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) with

903 `sudo systemctl restart netdata` to see if system memory usage (see the `system.ram` chart) has dropped significantly.

904

905 Beginning with `v1.31`, kernel memory usage is configurable via the [`pid table size` setting](#pid-table-size)

src/collectors/perf.plugin/metadata.yaml

+1 -1

@@ -55,7 +55,7 @@ modules:

55 sudo ./edit-config netdata.conf

56 ```

58 - Change the value of the `perf` setting to `yes` in the `[plugins]` section. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

58 + Change the value of the `perf` setting to `yes` in the `[plugins]` section. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

59 configuration:

60 file:

61 name: "netdata.conf"

src/collectors/python.d.plugin/go_expvar/metadata.yaml

+1 -1

@@ -48,7 +48,7 @@ modules:

48 sudo ./edit-config python.d.conf

49 ```

51 - Change the value of the `go_expvar` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

51 + Change the value of the `go_expvar` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

52 - title: "Sample `expvar` usage in a Go application"

53 description: |

54 The `expvar` package exposes metrics over HTTP and is very easy to use.

src/collectors/python.d.plugin/hpssa/metadata.yaml

+1 -1

@@ -49,7 +49,7 @@ modules:

49 sudo ./edit-config python.d.conf

50 ```

52 - Change the value of the `hpssa` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

52 + Change the value of the `hpssa` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

53 - title: 'Allow user netdata to execute `ssacli` as root.'

54 description: |

55 This module uses `ssacli`, which can only be executed by root. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `ssacli` as root without a password.

src/collectors/python.d.plugin/samba/metadata.yaml

+1 -1

@@ -52,7 +52,7 @@ modules:

52 cd /etc/netdata # Replace this path with your Netdata config directory, if different

53 sudo ./edit-config python.d.conf

54 ```

55 - Change the value of the `samba` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.

55 + Change the value of the `samba` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.

56 - title: Permissions and programs

57 description: |

58 To run the collector you need:

src/collectors/statsd.plugin/README.md

+1 -1

@@ -973,7 +973,7 @@ Note that Netdata will report the rate for metrics and counters, even if k6 or a

973 sends an _absolute_ number. For example, k6 sends absolute HTTP requests with `http_reqs`,

974 but Netdata visualizes that in `requests/second`.

975

976 -To enable this StatsD configuration, [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).

976 +To enable this StatsD configuration, [restart Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation).

977

978 ### Final touches

979

src/daemon/README.md

+2 -2

@@ -2,7 +2,7 @@

3 The Netdata daemon is practically a synonym for the Netdata Agent, as it controls its

4 entire operation. We support various methods to

5 -[start, stop, or restart the daemon](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).

5 +[start, stop, or restart the daemon](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation).

7 This document provides some basic information on the command line options, log files, and how to debug and troubleshoot

@@ -282,7 +282,7 @@ all programs), edit `netdata.conf` and set:

282 process nice level = -1

283 ```

284

285 -then execute this to [restart Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md):

285 +then execute this to [restart Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation):

286

287 ```sh

288 sudo systemctl restart netdata

src/daemon/config/README.md

+1 -1

@@ -53,7 +53,7 @@ comment on settings it does not currently use.

54 ## Applying changes

56 -After `netdata.conf` has been modified, Netdata needs to be [restarted](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for

56 +After `netdata.conf` has been modified, Netdata needs to be [restarted](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for

57 changes to apply:

59 ```bash

src/go/collectors/go.d.plugin/README.md

+1 -1

@@ -164,7 +164,7 @@ modules:

164 example: yes

165 ```

166

167 -Then [restart netdata](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for the

167 +Then [restart netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for the

168 change to take effect.

169

170 ## Contributing

src/go/collectors/go.d.plugin/docs/how-to-write-a-module.md

+1 -1

@@ -46,7 +46,7 @@ The steps are:

46 our [documentation](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md#external-plugins-api).

47 - If you want to test the collector with the actual Netdata Agent, you need to replace the `go.d.plugin` binary that

48 exists in the Netdata Agent installation directory with the one you just compiled. Once

49 - you [restart](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) the Netdata Agent, it will detect and run

49 + you [restart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) the Netdata Agent, it will detect and run

50 it, creating all the charts. It is advised not to remove the default `go.d.plugin` binary, but simply rename it

51 to `go.d.plugin.old` so that the Agent doesn't run it, but you can easily rename it back once you are done.

52 - Run `make clean` when you are done with testing.

src/go/collectors/go.d.plugin/modules/postgres/integrations/postgresql.md

+1 -1

@@ -267,7 +267,7 @@ GRANT pg_monitor TO netdata;

267 ```

268

269 After creating the new user, restart the Netdata agent with `sudo systemctl restart netdata`, or

270 -the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your

270 +the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your

271 system.

272

273

src/go/collectors/go.d.plugin/modules/postgres/metadata.yaml

+1 -1

@@ -69,7 +69,7 @@ modules:

69 ```

71 After creating the new user, restart the Netdata agent with `sudo systemctl restart netdata`, or

72 - the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your

72 + the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your

73 system.

74 configuration:

75 file:

src/health/REFERENCE.md

+14 -5

@@ -13,6 +13,20 @@ node_ via individual Netdata Agents. If you want to deploy a new alert across yo

13 [infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you must configure each node with the same health configuration

14 files.

16 +## Reload health configuration

17 +

18 +You do not need to restart the Netdata Agent between changes to health configuration files, such as specific health entities. Instead, you can use `netdatacli` and the `reload-health` option to prevent gaps in metrics collection.

19 +

20 +```bash

21 +sudo netdatacli reload-health

22 +```

23 +

24 +If `netdatacli` doesn't work on your system, send a `SIGUSR2` signal to the daemon, which reloads health configuration without restarting the entire process.

25 +

26 +```bash

27 +killall -USR2 netdata

28 +```

29 +

30 ## Edit health configuration files

32 You can configure the Agent's health watchdog service by editing files in two locations:

@@ -184,11 +198,6 @@ In human-readable format:

198 When you finish writing this new health entity, [reload Netdata's health configuration](#reload-health-configuration) to

199 see it live on the local dashboard or Netdata Cloud.

200

187 -## Reload health configuration

188 -

189 -To make any changes to your health configuration live, you must reload Netdata's health monitoring system. To do that

190 -without restarting all of Netdata, run `netdatacli reload-health` or `killall -USR2 netdata`.

191 -

201 ## Health entity reference

202

203 The following reference contains information about the syntax and options of _health entities_, which Netdata attaches

src/health/notifications/README.md

+1 -1

@@ -13,7 +13,7 @@ The default script is `alarm-notify.sh`.

13 > - 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.

14 > Note that to run the script you need to be inside your Netdata config directory.

15 >

16 -> - 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.

16 +> - Please also note that after most configuration changes you will need to [restart the Agent](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for the changes to take effect.

17 >

18 > It is recommended to use this way for configuring Netdata.