kyanos项目本地编译指南：从环境搭建到二进制生成

kyanos项目本地编译指南：从环境搭建到二进制生成

kyanos Kyanos is a networking analysis tool using eBPF. It can visualize the time packets spend in the kernel, capture requests/responses, makes troubleshooting more efficient. 项目地址: https://gitcode.com/gh_mirrors/ky/kyanos

项目概述

kyanos是一个基于eBPF技术的系统监控工具，它利用Linux内核的BPF虚拟机来实现高性能的系统观测功能。本文将详细介绍如何在本地环境中编译kyanos项目，包括环境准备、依赖安装以及不同架构下的编译方法。

环境准备

硬件要求

• x86_64或ARM64架构的处理器
• 至少4GB内存（建议8GB以上）
• 10GB可用磁盘空间

软件要求

核心工具链版本

• Golang 1.23或更高版本
• Clang 10.0或更高版本
• LLVM 10.0或更高版本

其他依赖项

• linux-tools-common
• linux-tools-generic
• pkgconf
• libelf-dev

环境搭建

Ubuntu系统快速配置

对于Ubuntu 20.04及以上版本用户，可以使用以下命令一键初始化编译环境：

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/hengyoush/kyanos/refs/heads/main/init_env.sh)"

其他Linux发行版配置

1. 首先获取项目源代码
2. 初始化并更新所有子模块
3. 手动安装上述列出的所有依赖项

编译流程详解

基础编译方法

对于本地开发和测试，执行以下简单命令即可：

make build-bpf && make

编译完成后，会在项目根目录下生成kyanos可执行文件。

高级编译选项

嵌入BTF文件编译

BTF（BPF Type Format）是Linux内核中用于描述数据结构的元数据格式。为了确保kyanos在不同内核版本上的兼容性，建议编译时嵌入BTF文件。

x86_64架构编译命令：

make build-bpf && make btfgen BUILD_ARCH=x86_64 ARCH_BPF_NAME=x86 && make

ARM64架构编译命令：

make build-bpf && make btfgen BUILD_ARCH=arm64 ARCH_BPF_NAME=arm64 && make

注意：make btfgen过程可能需要15分钟以上，具体时间取决于系统性能。

内核BTF支持检查

在运行kyanos之前，需要确认内核是否启用了BTF支持：

(zgrep CONFIG_DEBUG_INFO_BTF /proc/config.gz; grep CONFIG_DEBUG_INFO_BTF "/boot/config-$(uname -r)") | uniq

如果输出结果为CONFIG_DEBUG_INFO_BTF=y，则表示BTF已启用。否则，需要采取额外措施：

1. 从官方镜像站点下载对应内核版本的BTF文件
2. 启动kyanos时使用--btf选项指定BTF文件路径

常见问题解决

编译失败排查

1. 工具链版本不符：确认Golang、Clang和LLVM版本符合要求
2. 依赖缺失：检查所有列出的依赖项是否已正确安装
3. 权限问题：确保有足够的权限执行编译命令

运行时报错处理

1. BTF相关错误：按照上述方法检查并配置BTF支持
2. 内核版本不兼容：确认kyanos支持当前内核版本
3. 权限不足：某些功能可能需要root权限

最佳实践建议

1. 开发环境：建议使用Ubuntu 22.04 LTS作为开发环境
2. 生产环境：推荐编译时嵌入BTF文件以提高兼容性
3. 性能优化：在资源充足的机器上进行编译，可显著减少编译时间

通过本文的详细指导，您应该能够顺利完成kyanos项目的本地编译工作。如果在过程中遇到任何问题，建议查阅项目文档或相关技术社区获取更多帮助。

kyanos Kyanos is a networking analysis tool using eBPF. It can visualize the time packets spend in the kernel, capture requests/responses, makes troubleshooting more efficient. 项目地址: https://gitcode.com/gh_mirrors/ky/kyanos