数据狗CI

数据狗CI

从持续集成 (CI) 和持续交付 (CD) 管道执行命令以与现有 Datadog 产品集成。

有关可用命令的列表，请参阅“用法”部分。

如何安装 CLI

该软件包位于 @datadog/datadog-ci 下，可以通过 NPM 或 Yarn 安装：

 # NPMnpm install --save-dev @datadog/datadog-ci# Yarnarn add --dev @datadog/datadog-ci

如果您需要datadog-ci作为 CLI 工具而不是软件包，您可以使用npx运行它或全局安装它：

 # npxnpx @datadog/datadog-ci [命令]# NPM 全局安装 npm install -g @datadog/datadog-ci# Yarn v1 全局添加yarn 全局添加 @datadog/datadog-ci

有关安装 CLI 的更多方法，请参阅本节。

用法

用法：datadog-ci <命令> [<子命令>] [选项]

以下值可用于每个和（可选） 。

有关更多详细信息，请参阅每个命令的链接自述文件，或单击？查看相关文档页面。

cloud-run

• flare ：排查 Cloud Run 服务配置问题。 ？

dsyms

• upload ：上传 iOS dSYM 文件以进行错误跟踪（仅限 macOS）。 ？

flutter-symbols

• upload ：上传 Flutter 符号以进行错误跟踪。 ？

unity-symbols

• upload ：上传 Unity 符号以进行错误跟踪。

git-metadata

• upload ：上传源代码集成的 Git 元数据。 ？

junit

• upload ：上传 JUnit 测试报告以实现测试可见性。 ？

lambda

• flare ：解决 AWS Lambda 函数上的 Datadog 检测问题。

• instrument ：将 Datadog 检测应用到给定的 AWS Lambda 函数。

• uninstrument ：从给定的 AWS Lambda 函数恢复 Datadog 检测。

measure

• 将测量添加到 Datadog 中的 CI 可见性管道跟踪或作业跨度。 ？

react-native

• codepush ：上传 React Native CodePush 源映射以进行错误跟踪。 ？

• upload ：上传 React Native 源映射以进行错误跟踪。 ？

• xcode ：从 XCode 包构建阶段上传 React Native 源映射以进行错误跟踪。 ？

sarif

• upload ：将静态分析结果交换格式 (SARIF) 报告上传到 Datadog。 ？

sbom

• upload ：将软件物料清单 (SBOM) 文件上传到 Datadog。 ？

sourcemaps

• upload ：上传 JavaScript 源映射以进行错误跟踪。 ？

stepfunctions

• instrument ：使用 Datadog 检测 AWS Step Function 以获取日志和跟踪。 ？

• uninstrument ：Uninstrument AWS Step Function。 ？

synthetics

• run-tests ：从 CI 运行持续测试。 ？

• upload-application ：将新版本上传到 Datadog 中现有的移动应用程序。 ？

tag

• 将自定义标签添加到 Datadog 中的 CI 可见性管道跟踪或作业跨度。 ？

trace

• 将自定义命令添加到 Datadog 中的 CI 可见性管道。 ？

测试版命令

以下是测试版命令，您可以使用DD_BETA_COMMANDS_ENABLED=1启用它们：

deployment

• mark ：将 CI 作业标记为部署。 ？

• correlate ：将 GitOps CD 部署与应用程序存储库 CI 管道关联起来。 ？

dora

• deployment ：将 DORA Metrics 的新部署事件发送到 Datadog。 ？

elf-symbols

• upload ：上传 Elf 调试信息文件以进行性能分析（需要 binutils）。 ？

gate

• evaluate ：评估 Datadog 中的质量门规则。 ？

安装 CLI 的更多方法

独立二进制文件

如果在 CI 中安装 NodeJS 是一个问题，则随版本一起提供独立的二进制文件。支持linux-x64 、 linux-arm64 、 darwin-x64 、 darwin-arm64 (MacOS) 和win-x64 (Windows)。

安装：

Linux

 curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_linux-x64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci

苹果系统

卷曲-L --fail“https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_darwin-x64”--输出“/usr/local/bin/datadog-ci”&& chmod +x /usr/local/bin/datadog-ci

视窗

Invoke-WebRequest -Uri“https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_win-x64”-OutFile“datadog-ci.exe”

然后，您可以正常运行datadog-ci命令：

 datadog-ci 版本

容器镜像

要从容器运行datadog-ci ，您可以使用 Docker Hub 以及公共 Amazon ECR 和 Google GC 注册表中提供的datadog/ci映像。

 docker拉数据狗/ci

此示例演示如何使用容器运行命令并传入 API 和应用程序密钥：

导出 DD_API_KEY=$(cat /secret/dd_api_key)export DD_APP_KEY=$(cat /secret/dd_app_key)docker run --rm -it -v $(pwd):/w -e DD_API_KEY -e DD_APP_KEY datadog/ci 合成运行-测试-p pub-lic-id1

构建您自己的容器镜像

您可以使用提供的 Dockerfile 构建映像：

 CD容器
docker build --tag datadog-ci 。

或者，您可以使用VERSION构建参数来构建特定版本的映像：

 docker build --build-arg "VERSION=v1.14" --t datadog-ci 。

发展

在为这个开源项目做出贡献之前，请阅读我们的 CONTRIBUTING.md。

执照

Apache 许可证，v2.0