VCS

VCS 存储库属性

此组定义了版本控制系统 (VCS) 的属性。

Attributes

StabilityValue Type描述Example Values
vcs.change.idDevelopment字符串如果适用,则为更改(拉取请求/合并请求/更改列表)的 ID。这通常是 VCS 系统生成的(在存储库内唯一)标识符。123
vcs.change.stateDevelopment字符串更改(拉取请求/合并请求/更改列表)的状态。open; closed; merged
vcs.change.titleDevelopment字符串更改(拉取请求/合并请求/更改列表)的可读标题。此标题通常是更改的简要摘要,并且可能会与提交摘要一起合并到 ref 中。Fixes broken thing; feat: add my new feature; [chore] update dependency
vcs.line_change.typeDevelopment字符串在分支或更改上测量的行更改的类型。added; removed
vcs.owner.nameDevelopment字符串版本控制系统内的组所有者。my-org; myteam; business-unit
vcs.provider.nameDevelopment字符串版本控制系统提供商的名称。github; gitlab; gitea; bitbucket
vcs.ref.base.nameDevelopment字符串存储库中的引用的名称,例如**分支**或**标签**。[1]my-feature-branch; tag-1-test
vcs.ref.base.revisionDevelopment字符串修订版本,字面意思是修订后的版本。修订版本通常指的是 Git 中的提交对象,或 SVN 中的修订版本号。[2]9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc; main; 123; HEAD
vcs.ref.base.typeDevelopment字符串存储库中引用的类型。[3]branch; tag
vcs.ref.head.nameDevelopment字符串存储库中的引用的名称,例如**分支**或**标签**。[4]my-feature-branch; tag-1-test
vcs.ref.head.revisionDevelopment字符串修订版本,字面意思是修订后的版本。修订版本通常指的是 Git 中的提交对象,或 SVN 中的修订版本号。[5]9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc; main; 123; HEAD
vcs.ref.head.typeDevelopment字符串存储库中引用的类型。[6]branch; tag
vcs.ref.typeDevelopment字符串存储库中引用的类型。branch; tag
vcs.repository.nameDevelopment字符串存储库的可读名称。它不应包含任何额外的标识符,例如 GitLab 中的 Group/SubGroup 或 GitHub 中的 organization。[7]semantic-conventions; my-cool-repo
vcs.repository.url.fullDevelopment字符串规范 URL,提供完整的 HTTP(S) 地址,以便通过浏览器定位和识别存储库。[8]https://github.com/opentelemetry/open-telemetry-collector-contrib; https://gitlab.com/my-org/my-project/my-projects-project/repo
vcs.revision_delta.directionDevelopment字符串修订版本比较的类型。ahead; behind

[1] vcs.ref.base.name: base 指的是更改的起始点。例如,如果您基于类型为 branch 的新引用创建了一个新引用,并创建了新的提交,那么 main 将是类型为 branch 的基本引用。

[2] vcs.ref.base.revision: base 指的是更改的起始点。例如,如果您基于类型为 branch 的新引用创建了一个新引用,并创建了新的提交,那么 main 将是类型为 branch 的基本引用。修订版本可以是完整的哈希值(参见词汇表),表示存储库中引用的已记录更改,指向一个提交提交对象。它不一定必须是哈希值;它可以简单地定义一个修订版本号,这是一个单调递增的整数。在与 ref.base.name 相同的情况下,仍应包含它。由实现者决定根据 VCS 系统和情况设置修订版本值。

[3] vcs.ref.base.type: base 指的是更改的起始点。例如,如果您基于类型为 branch 的新引用创建了一个新引用,并创建了新的提交,那么 main 将是类型为 branch 的基本引用。

[4] vcs.ref.head.name: head 指的是您当前所在的位置;给定时间点的当前引用。

[5] vcs.ref.head.revision: head 指的是您当前所在的位置;给定时间点的当前引用。修订版本可以是完整的哈希值(参见词汇表),表示存储库中引用的已记录更改,指向一个提交提交对象。它不一定必须是哈希值;它可以简单地定义一个修订版本号,这是一个单调递增的整数。在与 ref.head.name 相同的情况下,仍应包含它。由实现者决定根据 VCS 系统和情况设置修订版本值。

[6] vcs.ref.head.type: head 指的是您当前所在的位置;给定时间点的当前引用。

[7] vcs.repository.name: 由于它仅是名称,因此在同一后端收集跨多个组织或组的遥测数据时,可能会与同一存储库的分叉发生冲突。

[8] vcs.repository.url.full: 在 Git 版本控制系统中,规范 URL 不应包含 .git 扩展名。


vcs.change.state 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
closedClosed 表示合并请求已关闭且未合并。这可能出于多种原因,例如更改被认为不必要,问题已以其他方式解决,或作者决定撤回请求。Development
mergedMerged 表示更改已成功集成到目标代码库中。Development
openOpen 表示更改当前处于活动状态并正在审查中。它尚未合并到目标分支,仍可以进行更改或添加注释。Development
wipWIP(work-in-progress,草稿)表示更改仍在进行中,尚未准备好进行全面审查。它可能仍会发生重大变化。Development

vcs.line_change.type 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
added添加的行数。Development
removed删除的行数。Development

vcs.provider.name 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
bitbucketBitbucketDevelopment
giteaGiteaDevelopment
githubGitHubDevelopment
gitlabGitLabDevelopment

vcs.ref.base.type 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
branchbranchDevelopment
tagtagDevelopment

vcs.ref.head.type 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
branchbranchDevelopment
tagtagDevelopment

vcs.ref.type 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
branchbranchDevelopment
tagtagDevelopment

vcs.revision_delta.direction 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
ahead更改相对于目标 ref 超前的修订版本数。Development
behind更改落后于目标 ref 的修订版本数。Development

VCS 已弃用属性

描述已弃用的 vcs 属性。

Attributes

StabilityValue Type描述Example Values
vcs.repository.change.idDeprecated
vcs.change.id 替换。
字符串已弃用,请改用 vcs.change.id123
vcs.repository.change.titleDeprecated
vcs.change.title 替换。
字符串已弃用,请改用 vcs.change.titleFixes broken thing; feat: add my new feature; [chore] update dependency
vcs.repository.ref.nameDeprecated
vcs.ref.head.name 替换。
字符串已弃用,请改用 vcs.ref.head.namemy-feature-branch; tag-1-test
vcs.repository.ref.revisionDeprecated
vcs.ref.head.revision 替换。
字符串已弃用,请改用 vcs.ref.head.revision9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc; main; 123; HEAD
vcs.repository.ref.typeDeprecated
vcs.ref.head.type 替换。
字符串已弃用,请改用 vcs.ref.head.typebranch; tag

vcs.repository.ref.type 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
branchbranchDevelopment
tagtagDevelopment