amplitudeinc/ampli-all

ampli 镜像文档

镜像概述

本镜像用于运行 ampli 工具，帮助开发者验证项目中分析工具的集成状态，确保分析事件的定义、配置及发送机制正确无误。通过该镜像，用户可便捷地在各类环境中执行分析工具的状态检查，提升分析数据的准确性和可靠性。

核心功能与特性

主要功能

• 验证项目中分析工具的集成状态，包括事件定义、配置参数及发送逻辑的正确性。
• 支持对分析事件的格式、触发条件及数据完整性进行检查。

核心特性

• 跨运行时支持：兼容所有主流运行时环境（如 Node.js、Python、Java、Ruby、.NET 等），无需针对特定环境单独配置。
• 轻量级设计：镜像体积小巧，启动快速，可无缝集成到 CI/CD 流程或本地开发环境。

使用场景与适用范围

适用场景

• 开发阶段：开发者在集成分析工具后，快速验证配置是否符合预期。
• 测试阶段：在自动化测试流程中加入分析工具状态检查，确保迭代过程中分析功能未被意外修改。
• 部署前验证：在项目部署至生产环境前，确认分析工具已正确配置，避免数据采集遗漏。

适用项目类型

• Web 应用（前端/后端）
• 移动应用（iOS/Android）
• 桌面应用
• 各类后端服务（微服务、API 服务等）

使用方法与配置说明

基本使用（Docker Run）

通过以下命令启动容器并执行分析工具状态验证：

bash
docker run --rm -v /path/to/your/project:/app docker.xuanyuan.run/ampli-image ampli status

参数说明：

• --rm：容器退出后自动删除，避免残留临时文件。
• -v /path/to/your/project:/app：将本地项目目录挂载至容器内 /app 目录，确保 ampli 可访问项目中的分析工具配置文件。
• ampli-image：镜像名称（实际使用时需替换为具体镜像标签，如 amplitude/ampli:latest）。
• ampli status：执行 ampli 的状态验证命令，输出分析工具的当前配置状态。

进阶配置

自定义工作目录

若项目配置文件位于非根目录，可通过 -w 参数指定容器内工作目录：

bash
docker run --rm -v /path/to/your/project:/app -w /app/src docker.xuanyuan.run/ampli-image ampli status

输出详细日志

添加 -v 参数可获取更详细的验证过程日志：

bash
docker run --rm -v /path/to/your/project:/app docker.xuanyuan.run/ampli-image ampli status -v

集成 CI/CD 流程

在 CI/CD 配置文件（如 GitHub Actions、GitLab CI）中添加以下步骤，实现自动化验证：

yaml
# 示例：GitHub Actions 配置
jobs:
  verify-analytics:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Run ampli verification
        run: docker run --rm -v $PWD:/app ampli-image ampli status

注意事项

• 确保本地项目目录已包含 ampli 配置文件（通常为 ampli.json 或 .ampli 目录），否则工具可能无法正常识别项目分析配置。
• 不同版本的 ampli 工具可能存在功能差异，建议使用指定版本标签（如 amplitude/ampli:v1.0.0）以确保兼容性。