Use Datadog from your CI.
@datadog/datadog-ci"">
Execute commands from your Continuous Integration (CI) and Continuous Delivery (CD) pipelines to integrate with existing Datadog products.
See the Usage section for a list of available commands.
The package is under @datadog/datadog-ci"">@datadog/datadog-ci and can be installed through NPM or Yarn:
# NPM
npm install --save-dev @datadog/datadog-ci
# Yarn
yarn add --dev @datadog/datadog-ci
If you need datadog-ci
as a CLI tool instead of a package, you can run it with npx
or install it globally:
# npx
npx @datadog/datadog-ci [command]
# NPM install globally
npm install -g @datadog/datadog-ci
# Yarn v1 add globally
yarn global add @datadog/datadog-ci
For more ways to install the CLI, see this section.
Usage: datadog-ci <command> [<subcommand>] [options]
The following values are available for each <command>
and (optionally) <subcommand>
.
See each command’s linked README for more details, or click on 📚 to see the related documentation page.
cloud-run
flare
: Troubleshoot your issues with Cloud Run service configuration. 📚dsyms
upload
: Upload iOS dSYM files for Error Tracking (macOS only). 📚flutter-symbols
upload
: Upload Flutter symbols for Error Tracking. 📚unity-symbols
upload
: Upload Unity symbols for Error Tracking.git-metadata
upload
: Upload Git metadata for the Source Code Integration. 📚junit
upload
: Upload JUnit test reports for Test Visibility. 📚lambda
flare
: Troubleshoot your issues with Datadog instrumentation on your AWS Lambda functions.instrument
: Apply Datadog instrumentation to the given AWS Lambda functions.uninstrument
: Revert Datadog instrumentation from the given AWS Lambda functions.measure
react-native
codepush
: Upload React Native CodePush sourcemaps for Error Tracking. 📚upload
: Upload React Native sourcemaps for Error Tracking. 📚xcode
: Upload React Native sourcemaps for Error Tracking from the XCode bundle build phase. 📚sarif
upload
: Upload Static Analysis Results Interchange Format (SARIF) reports to Datadog. 📚sbom
upload
: Upload Software Bill of Materials (SBOM) files to Datadog. 📚sourcemaps
upload
: Upload JavaScript sourcemaps for Error Tracking. 📚stepfunctions
instrument
: Instrument AWS Step Function with Datadog to get logs and traces. 📚uninstrument
: Uninstrument AWS Step Function. 📚synthetics
run-tests
: Run Continuous Testing tests from the CI. 📚upload-application
: Upload a new version to an existing mobile application in Datadog. 📚tag
trace
The following are beta commands, you can enable them with with DD_BETA_COMMANDS_ENABLED=1
:
coverage
upload
: Upload code coverage report files to Datadog. (📚: no public documentation page yet)deployment
mark
: Mark a CI job as a deployment. 📚correlate
: Correlate GitOps CD deployments with application repositories CI pipelines. 📚dora
deployment
: Send a new deployment event for DORA Metrics to Datadog. 📚elf-symbols
upload
: Upload Elf debug info files for Profiling (requires binutils). 📚pe-symbols
upload
: Upload Windows PE debug info files for Profiling. 📚gate
evaluate
: Evaluate Quality Gates rules in Datadog. 📚The fips
option allows datadog-ci
to use a FIPS cryptographic module provider if the OpenSSL library installed on the host system provides it.
Note: datadog-ci
cannot assert if such a provider is available, and doesn’t throw any error if the provider is not FIPS validated.
Node.js versions below 17 are incompatible with OpenSSL 3, which provides FIPS support.
If you are using a Node.js version below 17, enabling the fips
option causes the command to throw an error.
The option fips-ignore-error
ignores this error.
The released datadog-ci
binary now uses Node.js version 18 to be compatible with OpenSSL 3.
fips
Enable datadog-ci
FIPS support if a FIPS validated provider is installed on the host system.
If you do not have a FIPS provider installed, datadog-ci
does not raise an error.
ENV variable: DATADOG_FIPS=true
CLI param: --fips
fips-ignore-error
Ignore Node.js errors if FIPS cannot be enabled on the host system.
Note: the absence of an error doesn’t indicate that FIPS is enabled successfully.
ENV variable: DATADOG_FIPS_IGNORE_ERROR=true
CLI param: --fips-ignore-error
If installing NodeJS in the CI is an issue, standalone binaries are provided with releases. linux-x64, linux-arm64, darwin-x64, darwin-arm64 (MacOS) and win-x64 (Windows) are supported.
To install:
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
curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_darwin-x64" --output "/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"
Then, you can run datadog-ci
commands normally:
datadog-ci version
To run datadog-ci
from a container, you can use the datadog/ci
image available in Docker Hub as well as the public Amazon ECR and Google GC registries.
docker pull datadog/ci
This example demonstrates how to run a command using the container and passing in the API and app keys:
export 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 synthetics run-tests -p pub-lic-id1
You can build an image using the provided Dockerfile:
cd container
docker build --tag datadog-ci .
Optionally, you can use the VERSION
build argument to build an image for a specific version:
docker build --build-arg "VERSION=v1.14" --t datadog-ci .
If you are upgrading from a previous major version, read our MIGRATING.md document to understand the changes and how to adapt your scripts.
Before contributing to this open source project, read our CONTRIBUTING.md document.