otel/build-protobuf

OpenTelemetry Protocol 构建工具容器

镜像概述

该镜像基于 https://github.com/open-telemetry/opentelemetry-proto 仓库构建，提供OpenTelemetry协议（OTLP）相关的构建工具集。主要用途是处理OpenTelemetry协议定义文件（如Protobuf文件），执行代码生成、构建产物生成等操作，支持OpenTelemetry可观测性数据（追踪、指标、日志）的协议实现开发与集成。

核心功能与特性

• Protobuf文件处理：支持解析和处理OpenTelemetry协议定义的.proto文件
• 代码生成：可基于协议定义生成多语言客户端/服务端代码（具体语言支持依赖工具配置）
• 协议标准遵循：严格遵循OpenTelemetry协议规范，确保生成产物与OTLP标准兼容
• 构建流程集成：可无缝集成到CI/CD流水线或本地开发环境的构建流程中

使用场景

• OpenTelemetry协议实现开发：开发人员基于协议定义文件生成特定语言的协议实现代码
• 多语言客户端/服务端开发：为不同编程语言生成OpenTelemetry协议的编解码代码
• 自动化构建流程：在CI/CD系统中集成，实现协议文件变更后的自动代码生成与构建
• 协议验证与测试：验证自定义协议扩展或修改是否符合OpenTelemetry标准

使用方法

基本使用步骤

1. 拉取镜像
   从容器仓库拉取最新版本镜像（具体仓库地址请参考官方发布信息）：

   bash
   docker pull docker.xuanyuan.run/<镜像仓库地址>/open-telemetry/opentelemetry-proto:latest
   

2. 运行容器执行构建
   挂载本地协议文件目录，执行构建命令（以下为示例，具体命令需根据实际工具链调整）：

   bash
   docker run -v /本地协议文件目录:/workspace \
     docker.xuanyuan.run/<镜像仓库地址>/open-telemetry/opentelemetry-proto:latest \
     <构建命令>  # 如生成代码命令、构建产物命令等
   

示例：生成代码

假设需基于本地/proto目录下的.proto文件生成代码，挂载该目录并执行生成命令：

bash
docker run -v $(pwd)/proto:/workspace/proto \
  -v $(pwd)/generated:/workspace/generated \
  docker.xuanyuan.run/<镜像仓库地址>/open-telemetry/opentelemetry-proto:latest \
  generate-code --input /workspace/proto --output /workspace/generated

配置说明

具体配置参数、支持的命令及环境变量请参考官方仓库文档：

• https://github.com/open-telemetry/opentelemetry-proto
• https://github.com/open-telemetry/opentelemetry-proto/blob/main/CONTRIBUTING.md

相关资源

• 了解更多OpenTelemetry协议详情：https://opentelemetry.io
• 协议定义文件及规范：https://github.com/open-telemetry/opentelemetry-proto