netdata

(β˜… 80,252)

The fastest path to AI-powered full stack observability, even for lean teams.

Showing a partial file list β€” download the zip above to see everything.

  • .clang-format
  • .codacy.yml
  • .dockerignore
  • .env.template
  • .flake8
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .shellcheckrc
  • .yamllint.yml
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • CMakeLists.txt
  • Dockerfile
  • GEMINI.md
  • LICENSE
  • netdata-installer.sh
  • netdata.spec.in
  • README.md
  • REDISTRIBUTED.md
  • server.json

# Installation Guide

1. Get the code
git clone https://github.com/netdata/netdata

Downloads the entire project code from GitHub to your computer.

cd netdata

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t netdata .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 netdata

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r packaging/dag/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/collectors/cgroups.plugin/cgroup-name

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

6. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/crates

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation