open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
221 stars 141 forks source link

Proposal: version control system (VCS) information: revision #1144

Open jschaf opened 3 weeks ago

jschaf commented 3 weeks ago

Proposal: add vcs.revision as a semantic convention key.

It's often useful to add the version control revision, like a Git commit hash, to logs and traces that indicate the commit that the binary was built from. The vcs.revision is helpful to debug production issues.

As a counterpoint, service.version might already include the information or be detailed enough to identify the commit.

Complicating matters: should there also be vcs.repo to denote which repo the commit originated from?

trask commented 3 weeks ago

related to https://github.com/open-telemetry/semantic-conventions/issues/915