View Source OpenTelemetry.SemConv.Incubating.VcsAttributes (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for Vcs attributes.
Summary
Functions
The ID of the change (pull request/merge request) if applicable. This is usually a unique (within repository) identifier generated by the VCS system.
The human readable title of the change (pull request/merge request). This title is often a brief summary of the change and may get merged in to a ref as the commit summary.
The name of the reference such as branch or tag in the repository.
The revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN.
The type of the reference in the repository.
The URL of the repository providing the complete address in order to locate and identify the repository.
Types
@type vcs_repository_ref_type_values() :: %{branch: :branch, tag: :tag}
The type of the reference in the repository.
Enum Values
Functions
@spec vcs_repository_change_id() :: :"vcs.repository.change.id"
The ID of the change (pull request/merge request) if applicable. This is usually a unique (within repository) identifier generated by the VCS system.
Value type
Value must be of type atom() | String.t()
.
Examples
["123"]
iex> OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_change_id()
:"vcs.repository.change.id"
?VCS_REPOSITORY_CHANGE_ID.
'vcs.repository.change.id'
@spec vcs_repository_change_title() :: :"vcs.repository.change.title"
The human readable title of the change (pull request/merge request). This title is often a brief summary of the change and may get merged in to a ref as the commit summary.
Value type
Value must be of type atom() | String.t()
.
Examples
["Fixes broken thing", "feat: add my new feature", "[chore] update dependency"]
iex> OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_change_title()
:"vcs.repository.change.title"
?VCS_REPOSITORY_CHANGE_TITLE.
'vcs.repository.change.title'
@spec vcs_repository_ref_name() :: :"vcs.repository.ref.name"
The name of the reference such as branch or tag in the repository.
Value type
Value must be of type atom() | String.t()
.
Examples
["my-feature-branch", "tag-1-test"]
iex> OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_ref_name()
:"vcs.repository.ref.name"
?VCS_REPOSITORY_REF_NAME.
'vcs.repository.ref.name'
@spec vcs_repository_ref_revision() :: :"vcs.repository.ref.revision"
The revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN.
Value type
Value must be of type atom() | String.t()
.
Notes
The revision can be a full hash value (see glossary),
of the recorded change to a ref within a repository pointing to a
commit commit object. It does
not necessarily have to be a hash; it can simply define a
revision number
which is an integer that is monotonically increasing. In cases where
it is identical to the ref.name
, it SHOULD still be included. It is
up to the implementer to decide which value to set as the revision
based on the VCS system and situational context.
Examples
["9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc", "main", "123", "HEAD"]
iex> OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_ref_revision()
:"vcs.repository.ref.revision"
?VCS_REPOSITORY_REF_REVISION.
'vcs.repository.ref.revision'
@spec vcs_repository_ref_type() :: :"vcs.repository.ref.type"
The type of the reference in the repository.
Examples
["branch", "tag"]
iex> OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_ref_type()
:"vcs.repository.ref.type"
iex> OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_ref_type_values().branch
:branch
iex> %{OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_ref_type() => OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_ref_type_values().branch}
%{:"vcs.repository.ref.type" => :branch}
?VCS_REPOSITORY_REF_TYPE.
'vcs.repository.ref.type'
?VCS_REPOSITORY_REF_TYPE_VALUES_BRANCH.
'branch'
#{?VCS_REPOSITORY_REF_TYPE => ?VCS_REPOSITORY_REF_TYPE_VALUES_BRANCH}.
#{'vcs.repository.ref.type' => 'branch'}
@spec vcs_repository_ref_type_values() :: vcs_repository_ref_type_values()
@spec vcs_repository_url_full() :: :"vcs.repository.url.full"
The URL of the repository providing the complete address in order to locate and identify the repository.
Value type
Value must be of type atom() | String.t()
.
Examples
["https://github.com/opentelemetry/open-telemetry-collector-contrib", "https://gitlab.com/my-org/my-project/my-projects-project/repo"]
iex> OpenTelemetry.SemConv.Incubating.VcsAttributes.vcs_repository_url_full()
:"vcs.repository.url.full"
?VCS_REPOSITORY_URL_FULL.
'vcs.repository.url.full'