sumologic/sumologic-otel-collector-dev

Sumo Logic Distribution for OpenTelemetry Collector 开发镜像

概述

Sumo Logic Distribution for OpenTelemetry Collector 开发镜像是专为开发和构建 Sumo Logic 分发版 OpenTelemetry Collector 而设计的专用Docker镜像。该镜像集成了开发过程中所需的全部环境依赖、构建工具和调试组件，旨在简化开发者的工作流程，确保开发环境的一致性和可重复性。

核心功能与特性

• 完整开发环境：预配置构建、测试 Sumo Logic OTel Collector 所需的全部依赖项，包括编译器、打包工具和依赖库
• 工具集成：包含代码检查、单元测试、集成测试等开发工具，支持自动化构建流程
• 环境一致性：确保所有开发者使用相同的开发环境，消除"在我机器上能运行"的环境差异问题
• 调试支持：提供调试工具和配置，便于诊断和解决开发过程中的问题

使用场景与适用范围

• 本地开发：开发者在本地机器上构建和测试 Sumo Logic OTel Collector 代码
• 代码贡献：为贡献者提供标准化环境，简化代码提交和审核流程
• 自定义组件开发：用于开发基于 Sumo Logic OTel Collector 的自定义接收器、处理器或导出器
• CI/CD 集成：可集成到本地或云端 CI/CD 管道，支持自动化构建和测试流程

使用方法与配置说明

前提条件

• Docker Engine 20.10 或更高版本
• Git 版本控制工具（用于拉取源代码）

获取镜像

通过以下命令拉取最新开发镜像：

bash
docker pull sumologic/sumologic-otel-collector-dev:latest

基本开发流程

1. 拉取源代码（如需本地开发）：

bash
git clone https://github.com/SumoLogic/sumologic-otel-collector.git
cd sumologic-otel-collector

2. 启动开发容器，挂载本地代码目录：

bash
docker run -it --rm \
  -v $(pwd):/workspace \
  -w /workspace \
  sumologic/sumologic-otel-collector-dev:latest

3. 执行开发任务：

• 构建项目：

  bash
  make build
  

• 运行单元测试：

  bash
  make test
  

• 生成文档：

  bash
  make docs
  

高级配置选项

• 环境变量：通过 -e 参数传递构建参数，如 GOOS=linux 指定目标操作系统
• 配置文件挂载：自定义构建配置可挂载至容器内 /workspace/build-config 目录

官方文档参考

完整开发指南、API 文档和贡献指南，请查阅 GitHub 仓库：
https://github.com/SumoLogic/sumologic-otel-collector/