VCS
VCS Ref
状态:
类型: vcs.ref
描述: 版本控制系统中的特定版本引用。
其他属性
⚠️ 此实体定义包含没有角色的属性。稳定的实体不得包含没有定义角色的属性。
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
vcs.ref.head.name | 推荐 | 字符串 | 存储库中的引用的名称,例如**分支**或**标签**。[1] | my-feature-branch; tag-1-test | |
vcs.ref.head.revision | 推荐 | 字符串 | 修订版本,字面意思是修订后的版本。修订版本通常指的是 Git 中的提交对象,或 SVN 中的修订版本号。[2] | 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc; main; 123; HEAD | |
vcs.ref.type | 推荐 | 字符串 | 存储库中引用的类型。 | branch; tag |
[1] vcs.ref.head.name: head 指的是你当前的位置;在给定时间点的当前引用。
[2] vcs.ref.head.revision: head 指的是你当前的位置;在给定时间点的当前引用。此修订版本可以是仓库中 ref 的完整 哈希值(参见术语表),指向 commit commit 对象。它不一定是哈希值;它可以简单地定义一个 修订版本号,这是一个单调递增的整数。在与 ref.head.name 相同的情况下,也应该包含它。实现者可以根据 VCS 系统和情境决定设置哪个值作为修订版本。
vcs.ref.type 具有以下一系列已知值。如果适用其中一项,则必须使用相应的值;否则,可以改用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
branch | branch | |
tag | tag |
VCS Repo
状态:
类型: vcs.repo
描述: 版本控制系统中的一个仓库。
其他属性
⚠️ 此实体定义包含没有角色的属性。稳定的实体不得包含没有定义角色的属性。
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
vcs.repository.name | 推荐 | 字符串 | 仓库的可读名称。它不应包含 GitLab 中的 Group/SubGroup 或 GitHub 中的 organization 等任何附加标识符。[3] | semantic-conventions; my-cool-repo | |
vcs.repository.url.full | 推荐 | 字符串 | 仓库的 规范 URL,提供完整的 HTTP(S) 地址,以便通过浏览器定位和标识仓库。[4] | https://github.com/opentelemetry/open-telemetry-collector-contrib; https://gitlab.com/my-org/my-project/my-projects-project/repo |
[3] vcs.repository.name: 由于它仅仅是名称,在后端收集跨多个组织或组的遥测数据时,它可能会与同一仓库的分支发生冲突。
[4] vcs.repository.url.full: 在 Git 版本控制系统中,规范 URL 不应包含 .git 扩展名。