View Source OpenTelemetry.SemConv.Incubating.CicdAttributes (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for Cicd attributes.
Summary
Types
The type of the task within a pipeline.
Functions
The human readable name of the pipeline within a CI/CD system.
The unique identifier of a pipeline run within a CI/CD system.
The human readable name of a task within a pipeline. Task here most closely aligns with a computing process in a pipeline. Other terms for tasks include commands, steps, and procedures.
The unique identifier of a task run within a pipeline.
The URL of the pipeline run providing the complete address in order to locate and identify the pipeline run.
The type of the task within a pipeline.
Types
Functions
@spec cicd_pipeline_name() :: :"cicd.pipeline.name"
The human readable name of the pipeline within a CI/CD system.
Value type
Value must be of type atom() | String.t().
Examples
["Build and Test", "Lint", "Deploy Go Project", "deploy_to_environment"]Elixir
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_name()
:"cicd.pipeline.name"Erlang
?CICD_PIPELINE_NAME.
'cicd.pipeline.name'@spec cicd_pipeline_run_id() :: :"cicd.pipeline.run.id"
The unique identifier of a pipeline run within a CI/CD system.
Value type
Value must be of type atom() | String.t().
Examples
["120912"]Elixir
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_run_id()
:"cicd.pipeline.run.id"Erlang
?CICD_PIPELINE_RUN_ID.
'cicd.pipeline.run.id'@spec cicd_pipeline_task_name() :: :"cicd.pipeline.task.name"
The human readable name of a task within a pipeline. Task here most closely aligns with a computing process in a pipeline. Other terms for tasks include commands, steps, and procedures.
Value type
Value must be of type atom() | String.t().
Examples
["Run GoLang Linter", "Go Build", "go-test", "deploy_binary"]Elixir
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_name()
:"cicd.pipeline.task.name"Erlang
?CICD_PIPELINE_TASK_NAME.
'cicd.pipeline.task.name'@spec cicd_pipeline_task_run_id() :: :"cicd.pipeline.task.run.id"
The unique identifier of a task run within a pipeline.
Value type
Value must be of type atom() | String.t().
Examples
["12097"]Elixir
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_run_id()
:"cicd.pipeline.task.run.id"Erlang
?CICD_PIPELINE_TASK_RUN_ID.
'cicd.pipeline.task.run.id'@spec cicd_pipeline_task_run_url_full() :: :"cicd.pipeline.task.run.url.full"
The URL of the pipeline run providing the complete address in order to locate and identify the pipeline run.
Value type
Value must be of type atom() | String.t().
Examples
["https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075"]Elixir
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_run_url_full()
:"cicd.pipeline.task.run.url.full"Erlang
?CICD_PIPELINE_TASK_RUN_URL_FULL.
'cicd.pipeline.task.run.url.full'@spec cicd_pipeline_task_type() :: :"cicd.pipeline.task.type"
The type of the task within a pipeline.
Examples
["build", "test", "deploy"]Elixir
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_type()
:"cicd.pipeline.task.type"
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_type_values().build
:build
iex> %{OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_type() => OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_type_values().build}
%{:"cicd.pipeline.task.type" => :build}Erlang
?CICD_PIPELINE_TASK_TYPE.
'cicd.pipeline.task.type'
?CICD_PIPELINE_TASK_TYPE_VALUES_BUILD.
'build'
#{?CICD_PIPELINE_TASK_TYPE => ?CICD_PIPELINE_TASK_TYPE_VALUES_BUILD}.
#{'cicd.pipeline.task.type' => 'build'}@spec cicd_pipeline_task_type_values() :: cicd_pipeline_task_type_values()