Install Netdata on Linux from a Git checkout
To install the latest git version of Netdata, please follow these 2 steps:
Install the required packages on your system.
Download and install Netdata. You can also update it the same way.
#
Prepare your systemUse our automatic requirements installer (no need to be root
), which attempts to find the packages that
should be installed on your system to build and run Netdata. It supports a large variety of major Linux distributions
and other operating systems and is regularly tested. You can find this tool here or run it directly with bash <(curl -sSL https://raw.githubusercontent.com/netdata/netdata/master/packaging/installer/install-required-packages.sh)
. Otherwise read on for how to get requires packages manually:
Alpine Linux and its derivatives
- You have to install
bash
yourself, before using the installer.
- You have to install
Arch Linux and its derivatives
- You need arch/aur for package Judy.
Gentoo Linux and its derivatives
Debian Linux and its derivatives (including Ubuntu, Mint)
Red Hat Enterprise Linux and its derivatives (including Fedora, CentOS, Amazon Machine Image)
SUSE Linux and its derivatives (including openSUSE)
SLE12 Must have your system registered with SUSE Customer Center or have the DVD. See #1162
Install the packages for having a basic Netdata installation (system monitoring and many applications, without mysql
/ mariadb
, postgres
, named
, hardware sensors and SNMP
):
Install all the required packages for monitoring everything Netdata can monitor:
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).
This is how to do it by hand:
Once Netdata is compiled, to run it the following packages are required (already installed using the above commands):
package | description |
---|---|
libuuid | part of util-linux for GUIDs management |
zlib | gzip compression for the internal Netdata web server |
libuv | Multi-platform support library with a focus on asynchronous I/O, version 1 or greater |
Netdata will fail to start without the above.
Netdata plugins and various aspects of Netdata can be enabled or benefit when these are installed (they are optional):
package | description |
---|---|
bash | for shell plugins and alarm notifications |
curl | for shell plugins and alarm notifications |
iproute or iproute2 | for monitoring Linux traffic QoS use iproute2 if iproute reports as not available or obsolete |
python | for most of the external plugins |
python-yaml | used for monitoring beanstalkd |
python-beanstalkc | used for monitoring beanstalkd |
python-dnspython | used for monitoring DNS query time |
python-ipaddress | used for monitoring DHCPd this package is required only if the system has python v2. python v3 has this functionality embedded |
python-mysqldb or python-pymysql | used for monitoring mysql or mariadb databasespython-mysqldb is a lot faster and thus preferred |
python-psycopg2 | used for monitoring postgresql databases |
python-pymongo | used for monitoring mongodb databases |
nodejs | used for node.js plugins for monitoring named and SNMP devices |
lm-sensors | for monitoring hardware sensors |
libelf | for monitoring kernel-level metrics using eBPF |
libmnl | for collecting netfilter metrics |
netcat | for shell plugins to collect metrics from remote systems |
Netdata will greatly benefit if you have the above packages installed, but it will still work without them.
Netdata DB engine can be enabled when these are installed (they are optional):
package | description |
---|---|
liblz4 | Extremely fast compression algorithm, version r129 or greater |
Judy | General purpose dynamic array |
openssl | Cryptography and SSL/TLS toolkit |
Netdata will greatly benefit if you have the above packages installed, but it will still work without them.
Netdata Cloud support may require the following packages to be installed:
package | description |
---|---|
cmake | Needed at build time if you aren't using your distribution's version of libwebsockets or are building on a platform other than Linux |
openssl | Needed to secure communications with the Netdata Cloud |
Netdata will greatly benefit if you have the above packages installed, but it will still work without them.
#
CentOS / RHEL 6.xOn CentOS / RHEL 6.x, many of the dependencies for Netdata are only available with versions older than what we need, so special setup is required if manually installing packages.
CentOS 6.x:
- Enable the EPEL repo
- Enable the additional repo from okay.network
And install the minimum required dependencies.
#
CentOS / RHEL 8.xFor CentOS / RHEL 8.x a lot of development packages have moved out into their own separate repositories. Some other dependencies are either missing completely or have to be sourced by 3rd-parties.
CentOS 8.x:
- Enable the PowerTools repo
- Enable the EPEL repo
- Enable the Extra repo from OKAY
And install the minimum required dependencies:
#
Install NetdataDo this to install and run Netdata:
If you don't want to run it straight-away, add
--dont-start-it
option.You can also append
--stable-channel
to fetch and install only the official releases from GitHub, instead of the nightly builds.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 installgo.d.plugin
.
#
Optional parameters to alter your installationnetdata-installer.sh
accepts a few parameters to customize your installation:
--dont-wait
: Enable automated installs by not prompting for permission to install any required packages.--dont-start-it
: Prevent the installer from starting Netdata automatically.--stable-channel
: Automatically update only on the release of new major versions.--nightly-channel
: Automatically update on every new nightly build.--disable-telemetry
: Opt-out of anonymous statistics we use to make Netdata better.--no-updates
: Prevent automatic updates of any kind.--reinstall
: If an existing install is detected, reinstall instead of trying to update it. Note that this cannot be used to change installation types.--local-files
: Used for offline installations. Pass four file paths: the Netdata tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the process using those files. This option conflicts with the--stable-channel
option. If you set this and--stable-channel
, Netdata will use the local files.
#
Connect node to Netdata Cloud during installationUnlike the kickstart.sh
or
kickstart-static64.sh
methods, the netdata-installer.sh
script does
not allow you to automatically connect your node to Netdata Cloud immediately after installation.
See the connect to cloud doc for details on connecting a node with a manual installation of Netdata.
#
'nonrepresentable section on output' errorsOur current build process unfortunately has some issues when using certain configurations of the clang
C compiler on Linux.
If the installation fails with errors like /bin/ld: externaldeps/libwebsockets/libwebsockets.a(context.c.o): relocation R_X86_64_32 against '.rodata.str1.1' can not be used when making a PIE object; recompile with -fPIC
, and you are trying to build with clang
on Linux, you will need to build Netdata using GCC to get a fully functional install.
In most cases, you can do this by running CC=gcc ./netdata-installer.sh
.
#
What's next?When you're finished with installation, check out our single-node or infrastructure monitoring quickstart guides based on your use case.
Or, skip straight to configuring the Netdata Agent.
Read through Netdata's documentation, which is structured based on actions and solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to external databases, and more.