Code Contributions

Mon, 01 Jan 0001 00:00:00 +0000

Contributing to HUATUO

Thank you for your interest in contributing to HUATUO! This guide will help you get started.

Ways to Contribute

There are many ways to contribute to HUATUO:

Code — Fix bugs, add features, improve performance
Documentation — Improve docs, translate content, write tutorials
Testing — Write unit tests, integration tests, report bugs
eBPF — Add new kernel probes, improve kernel compatibility
Review — Review pull requests from other contributors

Development Environment

Prerequisites

Tool	Requirement	Note
Go	1.24+	The project is written in Go
Linux	Kernel 4.18+	eBPF programs require a Linux kernel
Clang/LLVM	Any recent version	Required for compiling eBPF C programs
Kernel headers	linux-headers	Required for BPF compilation
Docker	(optional)	For containerized development
Git	Any recent version	For version control

Clone the Repository

# Fork the repository on GitHub, then:
git clone https://github.com/YOUR_USERNAME/huatuo.git
cd huatuo
git remote add upstream https://github.com/ccfos/huatuo.git

Build and Test

Build

make all          # Build everything (BPF + Go)
make bpf-build    # Build only BPF programs
make build        # Build only Go binaries
make docker-build # Build Docker image

Full Container Integration

Build the development image from the current source and start the collector, API Server, Elasticsearch, Prometheus, and Grafana:

Contribute on HUATUO Documentation