Netdata

https://learn.netdata.cloud/docs
Admin
Netdata is a real-time, distributed performance monitoring platform that provides instant visibility...
Tokens:2,463,901
Snippets:20,344
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Complete Installation on Ubuntu 22.04 (Jammy)

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/linux/native-linux-distribution-packages

Complete example of installing Netdata on Ubuntu 22.04 using native packages. Steps include downloading the repository configuration package, installing it, updating package lists, installing Netdata, starting and enabling the service, and verifying the installation with curl.

```bash
# Step 1: Download the repository configuration package  

wget https://repository.netdata.cloud/repos/repoconfig/ubuntu/jammy/netdata-repo_latest.jammy_all.deb  

  

# Step 2: Install the repository configuration  

sudo apt install ./netdata-repo_latest.jammy_all.deb  

  

# Step 3: Update package lists  

sudo apt update  

  

# Step 4: Install Netdata  

sudo apt install netdata  

  

# Step 5: Start and enable Netdata service  

sudo systemctl enable --now netdata  

  

# Step 6: Verify installation  

curl localhost:19999/api/v1/info  
```

--------------------------------

### Example preparation command with stable channel

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/linux/offline-systems

Example command to prepare an offline installation source for the stable release channel.

```bash
sh /tmp/netdata-kickstart.sh --release-channel stable --prepare-offline-install-source ./netdata-offline  

```

--------------------------------

### Quick Decision Guide: Installation Type to Method Mapping

Source: https://learn.netdata.cloud/docs/netdata-agent/anonymous-telemetry-events

A text-based decision guide mapping installation types to the recommended opt-out method. Linux, FreeBSD, manual/offline use Method 1; Windows uses Method 2; Docker uses Method 3.

```text
🐧 Linux (standard)    → Use Method 1 (File-based)  

🖥️  Windows             → Use Method 2 (Windows-specific)  

🐳 Docker              → Use Method 3 (Environment variable)  

📦 Manual/Offline      → Use Method 1 (File-based)  

🔷 FreeBSD             → Use Method 1 (File-based)  

```

--------------------------------

### Helm install with values file

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/kubernetes-helm-chart-reference

Example of installing the Netdata Helm chart by providing a YAML file with parameter values.

```bash
$ helm install ./netdata --name my-release -f values.yaml  

```

--------------------------------

### Example ls output of artifacts directory

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/linux/static-binary-linux-packages

Example output from listing the artifacts directory, showing the generated installer files with sizes and permissions.

```bash
$ ls -l artifacts/  

drwxrwxr-x   - user group     cache  

.rwxrwxr-x 94M user group     netdata-latest.gz.run  

.rwxrwxr-x 94M user group     netdata-v2.3.0-193-nightly.gz.run  

.rwxrwxr-x 94M user group     netdata-x86_64-latest.gz.run  

.rwxrwxr-x 94M user group     netdata-x86_64-v2.3.0-193-nightly.gz.run  
```

--------------------------------

### Install Netdata Agent with --dont-start-it

Source: https://learn.netdata.cloud/docs/netdata-agent/maintenance/backup-and-restore-an-agent

Use the kickstart script with the --dont-start-it option to install the Agent without starting it, which is helpful when you plan to restore a backup on top of the installation.

```bash
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --dont-start-it
```

--------------------------------

### Start Netdata and check version

Source: https://learn.netdata.cloud/docs/edge-device-monitoring/minimize-disk-footprint

Start the Netdata Agent and verify the installed version using netdatacli. The expected version output is shown in the next block.

```bash
sudo systemctl start netdata  

sudo /opt/netdata/bin/netdatacli version  

```

--------------------------------

### Basic configuration example

Source: https://learn.netdata.cloud/docs/collecting-metrics/collectors/synthetic-testing/ioping

Minimum configuration to run the plugin, setting the destination to /dev/sda.

```bash
destination="/dev/sda"
```

--------------------------------

### PowerShell: Get installed Netdata version

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/windows/switching-install-types-and-release-channels

Use this PowerShell command to retrieve the installed Netdata version from the Windows registry. The output includes DisplayName, DisplayVersion, and Publisher, as shown in the example output.

```powershell
# Get installed Netdata version  

Get-ItemProperty "HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall\*" |  

        Where-Object {  

            $_.DisplayName -like "*Netdata*"  

        } |  

        Select-Object DisplayName, DisplayVersion, Publisher  
```

```text
DisplayName    : Netdata  

DisplayVersion : 2.1.0  

Publisher      : Netdata Inc.  
```

--------------------------------

### Install extra Debian packages at container start

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/docker

Uses NETDATA_EXTRA_DEB_PACKAGES to install lm-sensors and netcat-openbsd with apt-get at container start. Installation runs every time the container starts, increasing startup time.

```bash
docker run -e NETDATA_EXTRA_DEB_PACKAGES="lm-sensors netcat-openbsd" netdata/netdata
```

--------------------------------

### Kickstart installer command for standalone installation

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/freebsd

Downloads and runs the kickstart script with a claim token and URL. Replace <YOUR_TOKEN> with your actual claim token.

```bash
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token <YOUR_TOKEN> --claim-url https://app.netdata.cloud  
```

--------------------------------

### macOS Homebrew service commands for Netdata

Source: https://learn.netdata.cloud/docs/netdata-agent/maintenance/service-control

These commands manage the Netdata Agent service installed via Homebrew. Note that the Agent does not start automatically after installation; you must use `brew services start` to start it and register it to launch at login.

```bash
brew services start netdata
```

```bash
brew services stop netdata
```

```bash
brew services restart netdata
```

```bash
brew services info netdata
```

--------------------------------

### Install and claim Netdata Agent with kickstart.sh

Source: https://learn.netdata.cloud/docs/getting-started

Use this command for new installations to install the Netdata Agent and connect it to your Cloud Space. It automatically detects your operating system, installs the latest Agent, connects to your Space, and starts monitoring immediately. Replace YOUR_TOKEN, YOUR_ROOMS, and YOUR_URL with your actual values.

```bash
bash <(curl -Ss https://get.netdata.cloud/kickstart.sh) --claim-token YOUR_TOKEN --claim-rooms YOUR_ROOMS --claim-url https://app.netdata.cloud
```

--------------------------------

### Determine installation type with netdata -W buildinfo

Source: https://learn.netdata.cloud/docs/netdata-agent/maintenance/update

Run this command to identify your Netdata installation type. The output will show a line starting with 'Installation Type' or 'Install type:'.

```bash
netdata -W buildinfo | grep -E 'Installation Type|Install type:'
```

--------------------------------

### Install Netdata with wget

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/linux

Downloads and runs the kickstart.sh script using wget. The script detects the OS, checks for existing installations, and installs using native packages, static build, or source. Defaults: automatic updates enabled, nightly releases, anonymous statistics enabled, Cloud connection disabled.

```bash
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh
```

--------------------------------

### Clone and install Netdata from Git

Source: https://learn.netdata.cloud/docs/developer-and-contributor-corner/install-the-netdata-agent-from-a-git-checkout

Clones the Netdata repository with a depth of 100 and recursive submodules, then runs the installer script with root privileges to build, install, and start Netdata. Add --dont-start-it to prevent automatic start, --stable-channel for official releases, --install-prefix /opt to change the install directory, or --disable-go if the server has no internet access.

```bash
# download it - the directory 'netdata' will be created  

git clone https://github.com/netdata/netdata.git --depth=100 --recursive  

cd netdata  

  

# run script with root privileges to build, install, start Netdata  

./netdata-installer.sh  
```

--------------------------------

### Run Netdata installer with prefix

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/macos

Enters the cloned directory and runs the installer with a custom prefix. The configuration directory will be /usr/local/netdata/ and the stock configuration directory /usr/local/lib/netdata/conf.d/. The installer also installs a startup plist to launch Netdata at boot.

```bash
cd netdata/  
sudo ./netdata-installer.sh --install-prefix /usr/local  
```

--------------------------------

### Install Netdata with curl

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/linux

Downloads and runs the kickstart.sh script using curl. The script detects the OS, checks for existing installations, and installs using native packages, static build, or source. Defaults: automatic updates enabled, nightly releases, anonymous statistics enabled, Cloud connection disabled.

```bash
curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
```

--------------------------------

### Run setup-demo-environment.sh to start container

Source: https://learn.netdata.cloud/docs/dashboards-and-charts/grafana-plugin

Starts a Grafana container with the Netdata datasource plugin already installed using the provided script.

```bash
setup-demo-environment.sh run  
```

--------------------------------

### Install Netdata with --no-updates to skip auto-updates

Source: https://learn.netdata.cloud/docs/netdata-agent/maintenance/update

Pass --no-updates to the kickstart script to skip setting up auto-updates entirely during installation.

```bash
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --no-updates
```

--------------------------------

### Switch to Nightly Channel (Static/Local Builds)

Source: https://learn.netdata.cloud/docs/netdata-agent/installation/linux/switch-install-types-and-release-channels

Use the kickstart script with the --reinstall and --nightly-channel flags to switch a static or local build to the nightly release channel.

```bash
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh
sh /tmp/netdata-kickstart.sh --reinstall --nightly-channel
```

--------------------------------

### Configured Zookeeper jobs

Source: https://learn.netdata.cloud/docs/developer-and-contributor-corner/monitor-a-hadoop-cluster-with-netdata

Example configuration for Zookeeper jobs. Uncomment the example jobs and adjust the address values according to your setup.

```yaml
jobs:  
  - name    : local  
    address : 127.0.0.1:2181  
  
  - name    : remote  
    address : 203.0.113.10:2182  

```
Tokens:
Raw