ebpf-exporter-deploy

用于在Kubernetes上运行ebpf_exporter的Helm图表和Dockerfile。

项目状态

本项目：

• 由Teachers Pay Teachers维护
• 已在Teachers Pay Teachers的生产环境中使用

版本控制

• Docker镜像标签与ebpf_exporter版本匹配
• Helm图表的apiVersion与ebpf_exporter版本匹配
• Helm version遵循语义化版本控制，当values.yaml发生变更时递增

发布制品

• GitHub发布以ebpf-exporter-helm-或ebpf-exporter-docker-为前缀，具体取决于变更内容
• Docker镜像发布至Dockerhub
• Helm图表发布至teacherspayteachers.github.io/helm-charts/

环境要求

• 构建Docker镜像需安装Docker
• 校验和模板化Helm图表需安装Helm
• Helm部署要求主机具备Linux内核源码或头文件
• Helm部署要求提升的安全权限

项目背景

Cloudflare的ebpf_exporter便于从eBPF程序提取Prometheus指标，但未提供生产就绪的Docker镜像。

ebpf_exporter_helm是社区提供的ebpf_exporter Helm图表，但作者已通过邮件告知不再维护。

本仓库包含基于ebpf_exporter_dockerfile构建的生产就绪Docker镜像，以及基于ebpf_exporter_helm维护的Helm图表。

使用方法

配置eBPF程序

首先，定义eBPF程序配置集。配置格式参见ebpf_exporter文档。可选择覆盖values.yaml中的默认值，例如：

yaml
config:
- programs:
  - name: cachestat
    metrics:
      counters:
        - name: page_cache_ops_total
          help: 按类型统计的页缓存操作计数器
          table: counts
          labels:
            - name: op
              size: 8
              decoders:
                - name: ksym
            - name: command
              size: 128
              decoders:
                - name: string
                - name: regexp
                  regexps:
                    - ^systemd-journal$
                    - ^syslog-ng$
    kprobes:
      add_to_page_cache_lru: do_count
      mark_page_accessed: do_count
      account_page_dirtied: do_count
      mark_buffer_dirty: do_count
    code: |
      #include <uapi/linux/ptrace.h>
  
      struct key_t {
          u64 ip;
          char command[128];
      };
  
      BPF_HASH(counts, struct key_t);
  
      int do_count(struct pt_regs *ctx) {
          struct key_t key = { .ip = PT_REGS_IP(ctx) - 1 };
          bpf_get_current_comm(&key.command, sizeof(key.command));
  
          counts.increment(key);
  
          return 0;
      }

通过Helm安装

将程序配置提供给Helm安装命令：

shell
$ helm repo add tpt [***]
$ helm install ebpf-exporter tpt/ebpf-exporter -f values.yaml

指标说明

关于导出的Prometheus指标工作原理，参见ebpf_exporter文档。

替代方案

• Cloudflare直接在主机上部署ebpf_exporter，以避免将内核源码和头文件绑定挂载到Docker容器中
• 本仓库Helm图表基于的社区Helm图表
• 替代Dockerfile

贡献指南

非常欢迎贡献！详情参见CONTRIBUTING.md。

许可证

MIT