summaryrefslogtreecommitdiffstats
path: root/docs/configure
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 12:08:03 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 12:08:18 +0000
commit5da14042f70711ea5cf66e034699730335462f66 (patch)
tree0f6354ccac934ed87a2d555f45be4c831cf92f4a /docs/configure
parentReleasing debian version 1.44.3-2. (diff)
downloadnetdata-5da14042f70711ea5cf66e034699730335462f66.tar.xz
netdata-5da14042f70711ea5cf66e034699730335462f66.zip
Merging upstream version 1.45.3+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/configure')
-rw-r--r--docs/configure/common-changes.md18
-rw-r--r--docs/configure/nodes.md18
-rw-r--r--docs/configure/start-stop-restart.md154
3 files changed, 18 insertions, 172 deletions
diff --git a/docs/configure/common-changes.md b/docs/configure/common-changes.md
index 1c6f6f5a7..2d1757fe9 100644
--- a/docs/configure/common-changes.md
+++ b/docs/configure/common-changes.md
@@ -22,8 +22,8 @@ directory.
The Netdata Agent's [local dashboard](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/accessing-netdata-dashboards.md), accessible
at `http://NODE:19999` is highly configurable. If
-you use Netdata Cloud
-for [infrastructure monitoring](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you
+you use [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/README.md)
+for infrastructure monitoring, you
will see many of these
changes reflected in those visualizations due to the way Netdata Cloud proxies metric data and metadata to your browser.
@@ -38,7 +38,7 @@ to help you determine the exact settings for your desired retention period.
### Reduce the data collection frequency
Change `update every` in
-the [`[global]` section](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#global-section-options)
+the [`[global]` section](https://github.com/netdata/netdata/blob/master/src/daemon/config/README.md#global-section-options)
of `netdata.conf` so
that it is greater than `1`. An `update every` of `5` means the Netdata Agent enforces a _minimum_ collection frequency
of 5 seconds.
@@ -51,13 +51,13 @@ of 5 seconds.
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
`python.d.conf` or `charts.d.conf` files, or in individual collector configuration files. If the `update
every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See
-the [enable or configure a collector](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
+the [enable or configure a collector](https://github.com/netdata/netdata/blob/master/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
doc for details.
### Disable a collector or plugin
Turn off entire plugins in
-the [`[plugins]` section](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#plugins-section-options)
+the [`[plugins]` section](https://github.com/netdata/netdata/blob/master/src/daemon/config/README.md#plugins-section-options)
of
`netdata.conf`.
@@ -83,9 +83,9 @@ sudo ./edit-config health.d/example-alert.conf
Or, append your new alert to an existing file by editing a relevant existing file in the `health.d/` directory.
-Read more about [configuring alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to
+Read more about [configuring alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) to
get started, and see
-the [health monitoring reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) for a full listing
+the [health monitoring reference](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) for a full listing
of options available in health entities.
### Configure a specific alert
@@ -116,7 +116,7 @@ template: disk_fill_rate
### Turn of all alerts and notifications
Set `enabled` to `no` in
-the [`[health]`](https://github.com/netdata/netdata/blob/master/daemon/config/README.md#health-section-options)
+the [`[health]`](https://github.com/netdata/netdata/blob/master/src/daemon/config/README.md#health-section-options)
section of `netdata.conf`.
### Enable alert notifications
@@ -131,7 +131,7 @@ click on the link to your preferred notification method to find documentation fo
While the Netdata Agent is both [open and secure by design](https://www.netdata.cloud/blog/netdata-agent-dashboard/), we
recommend every user take some action to administer and secure their nodes.
-Learn more about the available options in the [security design documentation](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md).
+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).
## Reduce resource usage
diff --git a/docs/configure/nodes.md b/docs/configure/nodes.md
index 8fdd1070c..99e00223c 100644
--- a/docs/configure/nodes.md
+++ b/docs/configure/nodes.md
@@ -31,20 +31,20 @@ these files in your own Netdata config directory, as the next section describes
exist.
- `netdata.conf` is the main configuration file. This is where you'll find most configuration options. Read descriptions
- for each in the [daemon config](https://github.com/netdata/netdata/blob/master/daemon/config/README.md) doc.
+ for each in the [daemon config](https://github.com/netdata/netdata/blob/master/src/daemon/config/README.md) doc.
- `edit-config` is a shell script used for [editing configuration files](#use-edit-config-to-edit-configuration-files).
- Various configuration files ending in `.conf` for [configuring plugins or
- collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) behave. Examples: `go.d.conf`,
+ collectors](https://github.com/netdata/netdata/blob/master/src/collectors/REFERENCE.md) behave. Examples: `go.d.conf`,
`python.d.conf`, and `ebpf.d.conf`.
- Various directories ending in `.d`, which contain other configuration files, each ending in `.conf`, for [configuring
- specific collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md).
+ specific collectors](https://github.com/netdata/netdata/blob/master/src/collectors/REFERENCE.md).
- `apps_groups.conf` is a configuration file for changing how applications/processes are grouped when viewing the
- **Application** charts from [`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) or
- [`ebpf.plugin`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
-- `health.d/` is a directory that contains [health configuration files](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
+ **Application** charts from [`apps.plugin`](https://github.com/netdata/netdata/blob/master/src/collectors/apps.plugin/README.md) or
+ [`ebpf.plugin`](https://github.com/netdata/netdata/blob/master/src/collectors/ebpf.plugin/README.md).
+- `health.d/` is a directory that contains [health configuration files](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md).
- `health_alarm_notify.conf` enables and configures [alert notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
-- `statsd.d/` is a directory for configuring Netdata's [statsd collector](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md).
-- `stream.conf` configures [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) between separate nodes running the Agent.
+- `statsd.d/` is a directory for configuring Netdata's [statsd collector](https://github.com/netdata/netdata/blob/master/src/collectors/statsd.plugin/README.md).
+- `stream.conf` configures [parent-child streaming](https://github.com/netdata/netdata/blob/master/src/streaming/README.md) between separate nodes running the Agent.
- `.environment` is a hidden file that describes the environment in which the Netdata Agent is installed, including the
`PATH` and any installation options. Useful for [reinstalling](https://github.com/netdata/netdata/blob/master/packaging/installer/REINSTALL.md) or
[uninstalling](https://github.com/netdata/netdata/blob/master/packaging/installer/UNINSTALL.md) the Agent.
@@ -98,7 +98,7 @@ method for `edit-config` to write into the config directory. Use your `$EDITOR`,
> defaulted to `vim` or `nano`. Use `export EDITOR=` to change this temporarily, or edit your shell configuration file
> to change to permanently.
-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
+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
restart netdata` or the appropriate method for your system.
Here's an example of editing the node's hostname, which appears in both the local dashboard and in Netdata Cloud.
diff --git a/docs/configure/start-stop-restart.md b/docs/configure/start-stop-restart.md
deleted file mode 100644
index 45691bc94..000000000
--- a/docs/configure/start-stop-restart.md
+++ /dev/null
@@ -1,154 +0,0 @@
-# Start, stop, or restart the Netdata Agent
-
-When you install the Netdata Agent, the [daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md) is
-configured to start at boot and stop and restart/shutdown.
-
-You will most often need to _restart_ the Agent to load new or editing configuration files.
-[Health configuration](#reload-health-configuration) files are the only exception, as they can be reloaded without restarting
-the entire Agent.
-
-Stopping or restarting the Netdata Agent will cause gaps in stored metrics until the `netdata` process initiates
-collectors and the database engine.
-
-## Using `systemctl`, `service`, or `init.d`
-
-This is the recommended way to start, stop, or restart the Netdata daemon.
-
-- To **start** Netdata, run `sudo systemctl start netdata`.
-- To **stop** Netdata, run `sudo systemctl stop netdata`.
-- To **restart** Netdata, run `sudo systemctl restart netdata`.
-
-If the above commands fail, or you know that you're using a non-systemd system, try using the `service` command:
-
-- **service**: `sudo service netdata start`, `sudo service netdata stop`, `sudo service netdata restart`
-
-## Using `netdata`
-
-Use the `netdata` command, typically located at `/usr/sbin/netdata`, to start the Netdata daemon.
-
-```bash
-sudo netdata
-```
-
-If you start the daemon this way, close it with `sudo killall netdata`.
-
-## Using `netdatacli`
-
-The Netdata Agent also comes with a [CLI tool](https://github.com/netdata/netdata/blob/master/cli/README.md) capable of performing shutdowns. Start the Agent back up
-using your preferred method listed above.
-
-```bash
-sudo netdatacli shutdown-agent
-```
-
-## Netdata MSI installations
-
-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:
-
-- Start Netdata, by running `start-netdata`
-- Stop Netdata, by running `stop-netdata`
-- Restart Netdata, by running `restart-netdata`
-
-## Reload health configuration
-
-You do not need to restart the Netdata Agent between changes to health configuration files, such as specific health
-entities. Instead, use [`netdatacli`](#using-netdatacli) and the `reload-health` option to prevent gaps in metrics
-collection.
-
-```bash
-sudo netdatacli reload-health
-```
-
-If `netdatacli` doesn't work on your system, send a `SIGUSR2` signal to the daemon, which reloads health configuration
-without restarting the entire process.
-
-```bash
-killall -USR2 netdata
-```
-
-## Force stop stalled or unresponsive `netdata` processes
-
-In rare cases, the Netdata Agent may stall or not properly close sockets, preventing a new process from starting. In
-these cases, try the following three commands:
-
-```bash
-sudo systemctl stop netdata
-sudo killall netdata
-ps aux| grep netdata
-```
-
-The output of `ps aux` should show no `netdata` or associated processes running. You can now start the Netdata Agent
-again with `service netdata start`, or the appropriate method for your system.
-
-## Starting Netdata at boot
-
-In the `system` directory you can find scripts and configurations for the
-various distros.
-
-### systemd
-
-The installer already installs `netdata.service` if it detects a systemd system.
-
-To install `netdata.service` by hand, run:
-
-```sh
-# stop Netdata
-killall netdata
-
-# copy netdata.service to systemd
-cp system/netdata.service /etc/systemd/system/
-
-# let systemd know there is a new service
-systemctl daemon-reload
-
-# enable Netdata at boot
-systemctl enable netdata
-
-# start Netdata
-systemctl start netdata
-```
-
-### init.d
-
-In the system directory you can find `netdata-lsb`. Copy it to the proper place according to your distribution
-documentation. For Ubuntu, this can be done via running the following commands as root.
-
-```sh
-# copy the Netdata startup file to /etc/init.d
-cp system/netdata-lsb /etc/init.d/netdata
-
-# make sure it is executable
-chmod +x /etc/init.d/netdata
-
-# enable it
-update-rc.d netdata defaults
-```
-
-### openrc (gentoo)
-
-In the `system` directory you can find `netdata-openrc`. Copy it to the proper
-place according to your distribution documentation.
-
-### CentOS / Red Hat Enterprise Linux
-
-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.
-
-```sh
-# copy the Netdata startup file to /etc/init.d
-cp system/netdata-init-d /etc/init.d/netdata
-
-# make sure it is executable
-chmod +x /etc/init.d/netdata
-
-# enable it
-chkconfig --add netdata
-```
-
-_There have been some recent work on the init script, see PR
-<https://github.com/netdata/netdata/pull/403>_
-
-### other systems
-
-You can start Netdata by running it from `/etc/rc.local` or equivalent.
-