11 KiB

Raw Blame History

Semantic conventions for CICD spans

CICD Spans
- Pipeline run
- Pipeline task run

CICD Spans

The conventions described in this section are specific to Continuous Integration / Continuous Deployment (CICD) systems.

Any resources of the CICD and VCS resource conventions that apply SHOULD be used.

Pipeline run

Status:

This span describes a CICD pipeline run.

For all pipeline runs, a span with kind SERVER SHOULD be created corresponding to the execution of the pipeline run.

Span name MUST follow the overall guidelines for span names.

The span name SHOULD be {action} {pipeline} if there is a (low-cardinality) pipeline name available. If the pipeline name is not available or is likely to have high cardinality, then the span name SHOULD be {action}.

The {action} SHOULD be the cicd.pipeline.action.name.

The {pipeline} SHOULD be the cicd.pipeline.name.

Span kind SHOULD be SERVER.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level
`cicd.pipeline.result`	string	The result of a pipeline run.	`success`; `failure`; `timeout`; `skipped`	`Required`
`error.type`	string	Describes a class of error the operation ended with. [1]	`timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500`	`Conditionally Required` if the pipeline result is `failure` or `error`
`cicd.pipeline.action.name`	string	The kind of action a pipeline run is performing.	`BUILD`; `RUN`; `SYNC`	`Opt-In`

[1] error.type: The error.type SHOULD be predictable, and SHOULD have low cardinality.

When error.type is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used.

Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time when no additional filters are applied.

If the operation has completed successfully, instrumentations SHOULD NOT set error.type.

If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), it's RECOMMENDED to:

Use a domain-specific attribute
Set error.type to capture all errors, regardless of whether they are defined within the domain-specific set or not.

cicd.pipeline.action.name has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
`BUILD`	The pipeline run is executing a build.
`RUN`	The pipeline run is executing.
`SYNC`	The pipeline run is executing a sync.

cicd.pipeline.result has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
`cancellation`	The pipeline run was cancelled, eg. by a user manually cancelling the pipeline run.
`error`	The pipeline run failed due to an error in the CICD system, eg. due to the worker being killed.
`failure`	The pipeline run did not finish successfully, eg. due to a compile error or a failing test. Such failures are usually detected by non-zero exit codes of the tools executed in the pipeline run.
`skip`	The pipeline run was skipped, eg. due to a precondition not being met.
`success`	The pipeline run finished successfully.
`timeout`	A timeout caused the pipeline run to be interrupted.

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
`_OTHER`	A fallback error value to be used when the instrumentation doesn't define a custom value.

Pipeline task run