Tag CI Visibility pipeline and job spans.
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 shapekey:value
. This will be the tags added to the pipeline or job span. The resulting dictionary will be merged with whatever is in theDD_TAGS
environment variable. If akey
appears both in--tags
andDD_TAGS
, whatever value is inDD_TAGS
will take precedence.--silent
(default:false
) will prevent the tag command from writing to stdout and stderr.
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 bekey1:value1,key2:value2
.DD_SITE
: choose your Datadog site, e.g. datadoghq.com or datadoghq.eu.
The tag command only works for the following CI providers: Buildkite, CircleCI, GitHub, GitLab, Azure Pipelines and Jenkins. If used in any other provider it will fail.
To verify this command works as expected, you can tag a mock pipeline and validate the command returns 0:
export DD_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
Additional helpful documentation, links, and articles: