VCS

VCS Ref

Status:

type: vcs.ref

Description: A reference to a specific version in the Version Control System.

Other Attributes:

:warning: This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute	Type	Description	Examples	Requirement Level	Stability
vcs.ref.head.name	string	The name of the reference such as branch or tag in the repository. [1]	my-feature-branch; tag-1-test	Recommended
vcs.ref.head.revision	string	The revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN. [2]	9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc; main; 123; HEAD	Recommended
vcs.ref.type	string	The type of the reference in the repository.	branch; tag	Recommended

[1] vcs.ref.head.name: head refers to where you are right now; the current reference at a given time.

[2] vcs.ref.head.revision: head refers to where you are right now; the current reference at a given time.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.head.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.

vcs.ref.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
branch	branch
tag	tag

VCS Repo

Status:

type: vcs.repo

Description: A repository in the Version Control System.

Other Attributes:

:warning: This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute	Type	Description	Examples	Requirement Level	Stability
vcs.repository.name	string	The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [3]	semantic-conventions; my-cool-repo	Recommended
vcs.repository.url.full	string	The canonical URL of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [4]	https://github.com/opentelemetry/open-telemetry-collector-contrib; https://gitlab.com/my-org/my-project/my-projects-project/repo	Recommended

[3] vcs.repository.name: Due to it only being the name, it can clash with forks of the same repository if collecting telemetry across multiple orgs or groups in the same backends.

[4] vcs.repository.url.full: In Git Version Control Systems, the canonical URL SHOULD NOT include the .git extension.