tag

tag command

Tag CI Visibility pipeline and job spans.

Usage

datadog-ci tag [--no-fail] [--level <pipeline|job>] [--tags]

For example:

datadog-ci tag --level job --tags "go.version:`go version`"

• --level Has to be one of [pipeline, job]. It will determine in what span the tags will be added. If pipeline is selected then the tags will be added to the pipeline trace span. If job is selected it will be added to the span for the currently running job.
• --no-fail (default: false) will prevent the tag command from failing if there are issues submitting the data.
• --tags is an array of key value pairs of the shape key:value. This will be the tags added to the pipeline or job span. The resulting dictionary will be merged with whatever is in the DD_TAGS environment variable. If a key appears both in --tags and DD_TAGS, whatever value is in DD_TAGS will take precedence.

Environment variables

• DATADOG_API_KEY or DD_API_KEY (required): API key used to authenticate the requests.
• DD_TAGS: set tags applied to the pipeline or job span. The format must be key1:value1,key2:value2.
• DATADOG_SITE: choose your Datadog site, e.g. datadoghq.com or datadoghq.eu.

Supported providers

The tag command only works for the following CI providers: [Buildkite, CircleCI, GitHub, GitLab]. If used in any other provider it will fail. Note that for GitHub actions only the level pipeline is supported. If the command is invoked in GitHub actions with level job it will exit with status code 1 and return an error.

End-to-end testing process

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

export DATADOG_API_KEY='<API key>'
export BUILDKITE=true
export BUILDKITE_BUILD_ID=uuid

yarn launch tag --level pipeline --tags foo:bar

Successful output should look like this:

Tags sent