Skip to content

Commit 1c799b4

Browse files
committed
[vcs] add organization and vendor name VCS attributes
Signed-off-by: Afonso Fernandes <21228942+afonsonf@users.noreply.github.com>
1 parent 6533b8a commit 1c799b4

File tree

5 files changed

+98
-0
lines changed

5 files changed

+98
-0
lines changed

.chloggen/1452-vcs-metrics.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: enhancement
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: vcs
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Add organization and vendor name to VCS attribute list
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: [1452]
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext:

docs/attributes-registry/vcs.md

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ This group defines the attributes for [Version Control Systems (VCS)](https://wi
2626
| <a id="vcs-repository-name" href="#vcs-repository-name">`vcs.repository.name`</a> | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [7] | `semantic-conventions`; `my-cool-repo` | ![Development](https://img.shields.io/badge/-development-blue) |
2727
| <a id="vcs-repository-url-full" href="#vcs-repository-url-full">`vcs.repository.url.full`</a> | string | The [canonical URL](https://support.google.com/webmasters/answer/10347851?hl=en#:~:text=A%20canonical%20URL%20is%20the,Google%20chooses%20one%20as%20canonical.) of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [8] | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | ![Development](https://img.shields.io/badge/-development-blue) |
2828
| <a id="vcs-revision-delta-direction" href="#vcs-revision-delta-direction">`vcs.revision_delta.direction`</a> | string | The type of revision comparison. | `ahead`; `behind` | ![Development](https://img.shields.io/badge/-development-blue) |
29+
| <a id="vcs-owner-name" href="#vcs-owner-name">`vcs.owner.name`</a> | string | The group owner within the version control system. | `my-org`; `myteam` | ![Development](https://img.shields.io/badge/-development-blue) |
30+
| <a id="vcs-vendor-name" href="#vcs-vendor-name">`vcs.vendor.name`</a> | string | The vendor name of the version control system. | `github`; `gitlab` | ![Development](https://img.shields.io/badge/-development-blue) |
2931

3032
**[1] `vcs.ref.base.name`:** `base` refers to the starting point of a change. For example, `main`
3133
would be the base reference of type branch if you've created a new

docs/cicd/cicd-metrics.md

+18
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,8 @@ This metric is [recommended][MetricRecommended].
324324
| [`vcs.change.state`](/docs/attributes-registry/vcs.md) | string | The state of the change (pull request/merge request/changelist). | `open`; `closed`; `merged` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
325325
| [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [canonical URL](https://support.google.com/webmasters/answer/10347851?hl=en#:~:text=A%20canonical%20URL%20is%20the,Google%20chooses%20one%20as%20canonical.) of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [1] | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
326326
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [2] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
327+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
328+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
327329

328330
**[1] `vcs.repository.url.full`:** In Git Version Control Systems, the canonical URL SHOULD NOT include
329331
the `.git` extension.
@@ -369,6 +371,8 @@ This metric is [recommended][MetricRecommended].
369371
| [`vcs.ref.head.name`](/docs/attributes-registry/vcs.md) | string | The name of the [reference](https://git-scm.com/docs/gitglossary#def_ref) such as **branch** or **tag** in the repository. [1] | `my-feature-branch`; `tag-1-test` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
370372
| [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [canonical URL](https://support.google.com/webmasters/answer/10347851?hl=en#:~:text=A%20canonical%20URL%20is%20the,Google%20chooses%20one%20as%20canonical.) of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [2] | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
371373
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | 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` | ![Development](https://img.shields.io/badge/-development-blue) |
374+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
375+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
372376

373377
**[1] `vcs.ref.head.name`:** `head` refers to where you are right now; the current reference at a
374378
given time.
@@ -419,6 +423,8 @@ This metric is [recommended][MetricRecommended].
419423
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [4] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
420424
| [`vcs.ref.base.revision`](/docs/attributes-registry/vcs.md) | string | The revision, literally [revised version](https://www.merriam-webster.com/dictionary/revision), The revision most often refers to a commit object in Git, or a revision number in SVN. [5] | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
421425
| [`vcs.ref.head.revision`](/docs/attributes-registry/vcs.md) | string | The revision, literally [revised version](https://www.merriam-webster.com/dictionary/revision), The revision most often refers to a commit object in Git, or a revision number in SVN. [6] | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
426+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
427+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
422428

423429
**[1] `vcs.ref.head.name`:** `head` refers to where you are right now; the current reference at a
424430
given time.
@@ -488,6 +494,8 @@ This metric is [recommended][MetricRecommended].
488494
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [4] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
489495
| [`vcs.ref.base.revision`](/docs/attributes-registry/vcs.md) | string | The revision, literally [revised version](https://www.merriam-webster.com/dictionary/revision), The revision most often refers to a commit object in Git, or a revision number in SVN. [5] | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
490496
| [`vcs.ref.head.revision`](/docs/attributes-registry/vcs.md) | string | The revision, literally [revised version](https://www.merriam-webster.com/dictionary/revision), The revision most often refers to a commit object in Git, or a revision number in SVN. [6] | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
497+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
498+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
491499

492500
**[1] `vcs.ref.head.name`:** `head` refers to where you are right now; the current reference at a
493501
given time.
@@ -574,6 +582,8 @@ This metric is [recommended][MetricRecommended].
574582
| [`vcs.ref.type`](/docs/attributes-registry/vcs.md) | string | The type of the [reference](https://git-scm.com/docs/gitglossary#def_ref) in the repository. | `branch`; `tag` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
575583
| [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [canonical URL](https://support.google.com/webmasters/answer/10347851?hl=en#:~:text=A%20canonical%20URL%20is%20the,Google%20chooses%20one%20as%20canonical.) of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [1] | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
576584
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [2] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
585+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
586+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
577587

578588
**[1] `vcs.repository.url.full`:** In Git Version Control Systems, the canonical URL SHOULD NOT include
579589
the `.git` extension.
@@ -625,6 +635,8 @@ If number of lines added/removed should be calculated from the start of time, th
625635
| [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [canonical URL](https://support.google.com/webmasters/answer/10347851?hl=en#:~:text=A%20canonical%20URL%20is%20the,Google%20chooses%20one%20as%20canonical.) of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [5] | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
626636
| [`vcs.change.id`](/docs/attributes-registry/vcs.md) | string | The ID of the change (pull request/merge request/changelist) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. | `123` | `Conditionally Required` if a change is associate with the ref. | ![Development](https://img.shields.io/badge/-development-blue) |
627637
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [6] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
638+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
639+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
628640

629641
**[1] `vcs.ref.base.name`:** `base` refers to the starting point of a change. For example, `main`
630642
would be the base reference of type branch if you've created a new
@@ -707,6 +719,8 @@ instrumentation SHOULD report two measurements: 3 and 2 (both positive numbers)
707719
| [`vcs.revision_delta.direction`](/docs/attributes-registry/vcs.md) | string | The type of revision comparison. | `ahead`; `behind` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
708720
| [`vcs.change.id`](/docs/attributes-registry/vcs.md) | string | The ID of the change (pull request/merge request/changelist) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. | `123` | `Conditionally Required` if a change is associate with the ref. | ![Development](https://img.shields.io/badge/-development-blue) |
709721
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [6] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
722+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
723+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
710724

711725
**[1] `vcs.ref.base.name`:** `base` refers to the starting point of a change. For example, `main`
712726
would be the base reference of type branch if you've created a new
@@ -782,6 +796,8 @@ This metric is [recommended][MetricRecommended].
782796
| [`vcs.ref.head.type`](/docs/attributes-registry/vcs.md) | string | The type of the [reference](https://git-scm.com/docs/gitglossary#def_ref) in the repository. [2] | `branch`; `tag` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
783797
| [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [canonical URL](https://support.google.com/webmasters/answer/10347851?hl=en#:~:text=A%20canonical%20URL%20is%20the,Google%20chooses%20one%20as%20canonical.) of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [3] | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
784798
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [4] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
799+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
800+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
785801

786802
**[1] `vcs.ref.head.name`:** `head` refers to where you are right now; the current reference at a
787803
given time.
@@ -829,6 +845,8 @@ This metric is [opt-in][MetricOptIn].
829845
|---|---|---|---|---|---|
830846
| [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [canonical URL](https://support.google.com/webmasters/answer/10347851?hl=en#:~:text=A%20canonical%20URL%20is%20the,Google%20chooses%20one%20as%20canonical.) of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser. [1] | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
831847
| [`vcs.repository.name`](/docs/attributes-registry/vcs.md) | string | The human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub. [2] | `semantic-conventions`; `my-cool-repo` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
848+
| [`vcs.owner.name`](/docs/attributes-registry/vcs.md) | string | The group owner within the version control system. | `my-org`; `myteam` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
849+
| [`vcs.vendor.name`](/docs/attributes-registry/vcs.md) | string | The vendor name of the version control system. | `github`; `gitlab` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
832850

833851
**[1] `vcs.repository.url.full`:** In Git Version Control Systems, the canonical URL SHOULD NOT include
834852
the `.git` extension.

0 commit comments

Comments
 (0)