View Source OpenTelemetry.SemConv.Incubating.CicdAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for Cicd attributes.

Summary

Types

cicd_pipeline_task_type_values()

The type of the task within a pipeline.

Functions

cicd_pipeline_name()

The human readable name of the pipeline within a CI/CD system.

cicd_pipeline_run_id()

The unique identifier of a pipeline run within a CI/CD system.

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.

cicd_pipeline_task_run_id()

The unique identifier of a task run within a pipeline.

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.

cicd_pipeline_task_type()

The type of the task within a pipeline.

cicd_pipeline_task_type_values()

Types

Link to this type

cicd_pipeline_task_type_values()

View Source 
@type cicd_pipeline_task_type_values() :: %{
  build: :build,
  test: :test,
  deploy: :deploy
}

The type of the task within a pipeline.

Enum Values

  • :build e - build
  • :test e - test
  • :deploy e - deploy

Functions

Link to this function

cicd_pipeline_name()

View Source 
@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"]
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_name()
:"cicd.pipeline.name"
Link to this function

cicd_pipeline_run_id()

View Source 
@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"]
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_run_id()
:"cicd.pipeline.run.id"
Link to this function

cicd_pipeline_task_name()

View Source 
@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"]
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_name()
:"cicd.pipeline.task.name"
Link to this function

cicd_pipeline_task_run_id()

View Source 
@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"]
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_run_id()
:"cicd.pipeline.task.run.id"
Link to this function

cicd_pipeline_task_run_url_full()

View Source 
@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"]
iex> OpenTelemetry.SemConv.Incubating.CicdAttributes.cicd_pipeline_task_run_url_full()
:"cicd.pipeline.task.run.url.full"
Link to this function

cicd_pipeline_task_type()

View Source 
@spec cicd_pipeline_task_type() :: :"cicd.pipeline.task.type"

The type of the task within a pipeline.

Examples 

["build", "test", "deploy"]
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}
Link to this function

cicd_pipeline_task_type_values()

View Source 
@spec cicd_pipeline_task_type_values() :: cicd_pipeline_task_type_values()