Netdata is a monitoring agent. It is designed to be installed and run on all your systems: physical and virtual servers, containers, even IoT.

The best way to install Netdata is directly from source. Our automatic installer will install any required system packages and compile Netdata directly on your systems.

Warning

You can find Netdata packages distributed by third parties. In many cases, these packages are either too old or broken. So, the suggested ways to install Netdata are the ones in this page.We are currently working to provide our binary packages for all Linux distros. Stay tuned…

This method is fully automatic on all Linux distributions. FreeBSD and MacOS systems need some preparations before installing Netdata for the first time. Check the FreeBSD and the MacOS sections for more information.

To install Netdata from source and keep it up to date automatically, run the following:

You can install a pre-compiled static binary of Netdata on any Intel/AMD 64bit Linux system
(even those that don’t have a package manager, like CoreOS, CirrOS, busybox systems, etc).
You can also use these packages on systems with broken or unsupported package managers.

To install Netdata with a binary package on any Linux distro, any kernel version - for Intel/AMD 64bit hosts, run the following:

bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh)

(do not sudo this command, it will do it by itself as needed; if the target system does not have bash installed, see below for instructions to run it without bash)

Try our experimental automatic requirements installer (no need to be root). This will try to find the packages that should be installed on your system to build and run Netdata. It supports most major Linux distributions released after 2010:

Alpine Linux and its derivatives (you have to install bash yourself, before using the installer)

If the above do not work for you, please open a github issue with a copy of the message you get on screen. We are trying to make it work everywhere (this is also why the script reports back success or failure for all its runs).

If you don’t want to run it straight-away, add --dont-start-it option.

If you don’t want to install it on the default directories, you can run the installer like this: ./netdata-installer.sh --install /opt. This one will install Netdata in /opt/netdata.

If your server does not have access to the internet and you have manually put the installation directory on your server, you will need to pass the option --disable-go to the installer. The option will prevent the installer from attempting to download and install go.d.plugin.

Once the installer completes, the file /etc/netdata/netdata.conf will be created (if you changed the installation directory, the configuration will appear in that directory too).

You can edit this file to set options. One common option to tweak is history, which controls the size of the memory database Netdata will use. By default is 3600 seconds (an hour of data at the charts) which makes Netdata use about 10-15MB of RAM (depending on the number of charts detected on your system). Check Memory Requirements.

To install Netdata on pfSense run the following commands (within a shell or under Diagnostics/Command Prompt within the pfSense web interface).

Change platform (i386/amd64, etc) and FreeBSD versions (10/11, etc) according to your environment and change Netdata version (1.10.0 in example) according to latest version present within the FreeSBD repository:-

Note first three packages are downloaded from the pfSense repository for maintaining compatibility with pfSense, Netdata is downloaded from the FreeBSD repository.

To start Netdata automatically at each boot add service netdata start as a Shellcmd within the pfSense web interface (under Services/Shellcmd, which you need to install beforehand under System/Package Manager/Available Packages).
Shellcmd Type should be set to Shellcmd.
Alternatively more information can be found in https://doc.pfsense.org/index.php/Installing_FreeBSD_Packages, for achieving the same via the command line and scripts.

The documentation previously recommended installing the Debian Chroot package from the Synology community package sources and then running Netdata from within the chroot. This does not work, as the chroot environment does not have access to /proc, and therefore exposes very few metrics to Netdata. Additionally, this issue, still open as of 2018/06/24, indicates that the Debian Chroot package is not suitable for DSM versions greater than version 5 and may corrupt system libraries and render the NAS unable to boot.

The good news is that the 64-bit static installer works fine if your NAS is one that uses the amd64 architecture. It will install the content into /opt/netdata, making future removal safe and simple.

When Netdata is first installed, it will run as root. This may or may not be acceptable for you, and since other installations run it as the netdata user, you might wish to do the same. This requires some extra work:

Creat a group netdata via the Synology group interface. Give it no access to anything.

Create a user netdata via the Synology user interface. Give it no access to anything and a random password. Assign the user to the netdata group. Netdata will chuid to this user when running.