Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.68 KB

File metadata and controls

57 lines (36 loc) · 1.68 KB

trace command

Trace a command with a custom span and report it to Datadog.

Usage

datadog-ci trace [--no-fail] [--name <name>] -- <command>

For example:

datadog-ci trace --name "Say Hello" -- echo "Hello World"
  • The positional arguments are the command which will be launched and traced.
  • --name (default: same as ) is a human-friendly name for the reported span.
  • --no-fail (default: false) will prevent the trace command from failing even when not run in a supported CI Provider. In this case, the command will be launched and nothing will be reported to Datadog.

Environment variables

Additionally you might configure the trace command with environment variables:

  • DD_API_KEY (required): API key used to authenticate the requests.
  • DD_ENV: you may choose the environment you want your test results to appear in.
  • DD_TAGS: set global tags applied to all spans. The format must be key1:value1,key2:value2.
  • DD_SITE: choose your Datadog site, e.g. datadoghq.com or datadoghq.eu.

Optional dependencies

  • git is used for extracting repository metadata.

End-to-end testing process

To verify this command works as expected, you can trace a mock command and validate the command returns 0:

export DD_API_KEY='<API key>'
export CIRCLECI=true

yarn launch trace --name "Say Hello" echo "Hello World"

Successful output should look like this:

Hello World

Further reading

Additional helpful documentation, links, and articles: