1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-08-10 22:31:50 +02:00

Generate v1.31.0 semconv (#6479)

- Generate `semconv/v1.31.0`
- Stop generating deprecated metric semconv similar to all other
generation
- Fix acronyms:
  - `ReplicationController`
  - `ResourceQuota`

## [`v1.31.0` semantic convention release
notes](https://github.com/open-telemetry/semantic-conventions/releases/tag/v1.31.0):

<h3>🛑 Breaking changes 🛑</h3>
<ul>
<li>
<p><code>code</code>: <code>code.function.name</code> value should
contain the fully qualified function name, <code>code.namespace</code>
is now deprecated (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1677"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1677/hovercard">#1677</a>)</p>
</li>
<li>
<p><code>gen-ai</code>: Introduce <code>gen_ai.output.type</code>and
deprecate <code>gen_ai.openai.request.response_format</code> (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1757"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/semantic-conventions/pull/1757/hovercard">#1757</a>)</p>
</li>
<li>
<p><code>mobile</code>: Rework <code>device.app.lifecycle</code> mobile
event. (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1880"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/semantic-conventions/pull/1880/hovercard">#1880</a>)<br>
The <code>device.app.lifecycle</code> event has been reworked to use
attributes instead<br>
of event body fields. The <code>ios.app.state</code> and
<code>android.app.state</code> attributes<br>
have been reintroduced to the attribute registry.</p>
</li>
<li>
<p><code>system</code>: Move CPU-related system.cpu.* metrics to CPU
namespace (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1873"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1873/hovercard">#1873</a>)</p>
</li>
<li>
<p><code>k8s</code>: Change k8s.replication_controller metrics to
k8s.replicationcontroller (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1848"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/semantic-conventions/pull/1848/hovercard">#1848</a>)</p>
</li>
<li>
<p><code>db</code>: Rename <code>db.system</code> to
<code>db.system.name</code> in database metrics, and update the values
to be consistent with database spans. (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1581"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1581/hovercard">#1581</a>)</p>
</li>
<li>
<p><code>session</code>: Move <code>session.id</code> and
<code>session.previous_id</code> from body fields to event attributes,
and yamlize <code>session.start</code> and <code>session.end</code>
events. (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1845"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/semantic-conventions/pull/1845/hovercard">#1845</a>)<br>
As part of the ongoing migration of event fields from LogRecord body to
extended/complex attributes, the <code>session.start</code> and
<code>session.end</code> events have been redefined.</p>
</li>
</ul>
<h3>💡 Enhancements 💡</h3>
<ul>
<li>
<p><code>code</code>: Mark <code>code.*</code> semantic conventions as
release candidate (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1377"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1377/hovercard">#1377</a>)</p>
</li>
<li>
<p><code>gen-ai</code>: Added AI Agent Semantic Convention (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1732"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1732/hovercard">#1732</a>,
<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1739"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/semantic-conventions/pull/1739/hovercard">#1739</a>)</p>
</li>
<li>
<p><code>db</code>: Add database-specific notes on db.operation.name and
db.collection.name for Cassandra, Cosmos DB, HBase, MongoDB, and Redis,
covering their batch/bulk terms and lack of cross-table queries. (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1863"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/semantic-conventions/pull/1863/hovercard">#1863</a>,
<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1573"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1573/hovercard">#1573</a>)</p>
</li>
<li>
<p><code>gen-ai</code>: Adds <code>gen_ai.request.choice.count</code>
span attribute (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1888"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1888/hovercard">#1888</a>)<br>
Enables recording target number of completions to generate</p>
</li>
<li>
<p><code>enduser</code>: Undeprecate 'enduser.id' and introduce new
attribute <code>enduser.pseudo.id</code> (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1104"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1104/hovercard">#1104</a>)<br>
The new attribute <code>enduser.pseudo.id</code> is intended to provide
a unique identifier of a pseudonymous enduser.</p>
</li>
<li>
<p><code>k8s</code>: Add <code>k8s.hpa</code>,
<code>k8s.resourcequota</code> and
<code>k8s.replicationcontroller</code> attributes and resources (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1656"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1656/hovercard">#1656</a>)</p>
</li>
<li>
<p><code>k8s</code>: How to populate resource attributes based on
attributes, labels and transformation (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/236"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/236/hovercard">#236</a>)</p>
</li>
<li>
<p><code>process</code>: Adjust the semantic expectations for
<code>process.executable.name</code> (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1736"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1736/hovercard">#1736</a>)</p>
</li>
<li>
<p><code>otel</code>: Adds SDK self-monitoring metrics for span
processing (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1631"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/semantic-conventions/pull/1631/hovercard">#1631</a>)</p>
</li>
<li>
<p><code>cicd</code>: Adds a new attribute
<code>cicd.pipeline.run.url.full</code> and corrects the attribute
description of <code>cicd.pipeline.task.run.url.full</code> (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1796"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1796/hovercard">#1796</a>)</p>
</li>
<li>
<p><code>user-agent</code>: Add <code>user_agent.os.name</code> and
<code>user_agent.os.version</code> attributes (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1433"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1433/hovercard">#1433</a>)</p>
</li>
</ul>
<h3>🧰 Bug fixes 🧰</h3>
<ul>
<li><code>process</code>: Fix units of
process.open_file_descriptor.count and process.context_switches (<a
href="https://github.com/open-telemetry/semantic-conventions/issues/1662"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/semantic-conventions/issues/1662/hovercard">#1662</a>)</li>
</ul>

---------

Co-authored-by: Robert Pająk <pellared@hotmail.com>
This commit is contained in:
Tyler Yahn
2025-03-26 00:05:18 -07:00
committed by GitHub
parent ff6be9eeee
commit 95e5bbab98
10 changed files with 14697 additions and 1 deletions

View File

@@ -8,6 +8,12 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
## [Unreleased]
### Added
- The `go.opentelemetry.io/otel/semconv/v1.31.0` package.
The package contains semantic conventions from the `v1.31.0` version of the OpenTelemetry Semantic Conventions.
See the [migration documentation](./semconv/v1.31.0/MIGRATION.md) for information on how to upgrade from `go.opentelemetry.io/otel/semconv/v1.30.0`(#6479)
### Removed
- Drop support for [Go 1.22]. (#6381, #6418)

View File

@@ -7,7 +7,7 @@
package semconv // import "go.opentelemetry.io/otel/semconv/{{params.tag}}"
const (
{%- for metric in ctx %}
{%- for metric in ctx if not metric.deprecated %}
{{ h.metric_keydoc(metric) | comment(indent=2) }}
// Instrument: {{ metric.instrument }}
// Unit: {{ metric.unit }}

View File

@@ -0,0 +1,77 @@
# Semantic Convention Changes
The `go.opentelemetry.io/otel/semconv/v1.31.0` package should be a drop-in replacement for `go.opentelemetry.io/otel/semconv/v1.30.0` with the following exceptions.
## Dropped deprecations
The following declarations have been deprecated in the [OpenTelemetry Semantic Conventions].
Refer to the respective documentation in that repository for deprecation instructions for each type.
- `CodeNamespace`
- `CodeNamespaceKey`
- `DBClientConnectionsCreateTimeDescription`
- `DBClientConnectionsCreateTimeName`
- `DBClientConnectionsCreateTimeUnit`
- `DBClientConnectionsIdleMaxDescription`
- `DBClientConnectionsIdleMaxName`
- `DBClientConnectionsIdleMaxUnit`
- `DBClientConnectionsIdleMinDescription`
- `DBClientConnectionsIdleMinName`
- `DBClientConnectionsIdleMinUnit`
- `DBClientConnectionsMaxDescription`
- `DBClientConnectionsMaxName`
- `DBClientConnectionsMaxUnit`
- `DBClientConnectionsPendingRequestsDescription`
- `DBClientConnectionsPendingRequestsName`
- `DBClientConnectionsPendingRequestsUnit`
- `DBClientConnectionsTimeoutsDescription`
- `DBClientConnectionsTimeoutsName`
- `DBClientConnectionsTimeoutsUnit`
- `DBClientConnectionsUsageDescription`
- `DBClientConnectionsUsageName`
- `DBClientConnectionsUsageUnit`
- `DBClientConnectionsUseTimeDescription`
- `DBClientConnectionsUseTimeName`
- `DBClientConnectionsUseTimeUnit`
- `DBClientConnectionsWaitTimeDescription`
- `DBClientConnectionsWaitTimeName`
- `DBClientConnectionsWaitTimeUnit`
- `DBClientCosmosDBActiveInstanceCountDescription`
- `DBClientCosmosDBActiveInstanceCountName`
- `DBClientCosmosDBActiveInstanceCountUnit`
- `DBClientCosmosDBOperationRequestChargeDescription`
- `DBClientCosmosDBOperationRequestChargeName`
- `DBClientCosmosDBOperationRequestChargeUnit`
- `GenAIOpenaiRequestResponseFormatJSONObject`
- `GenAIOpenaiRequestResponseFormatJSONSchema`
- `GenAIOpenaiRequestResponseFormatKey`
- `GenAIOpenaiRequestResponseFormatText`
- `MessagingClientPublishedMessagesDescription`
- `MessagingClientPublishedMessagesName`
- `MessagingClientPublishedMessagesUnit`
- `MessagingProcessMessagesDescription`
- `MessagingProcessMessagesName`
- `MessagingProcessMessagesUnit`
- `MessagingPublishDurationDescription`
- `MessagingPublishDurationName`
- `MessagingPublishDurationUnit`
- `MessagingPublishMessagesDescription`
- `MessagingPublishMessagesName`
- `MessagingPublishMessagesUnit`
- `MessagingReceiveDurationDescription`
- `MessagingReceiveDurationName`
- `MessagingReceiveDurationUnit`
- `MessagingReceiveMessagesDescription`
- `MessagingReceiveMessagesName`
- `MessagingReceiveMessagesUnit`
- `SystemCPUFrequencyDescription`
- `SystemCPUFrequencyName`
- `SystemCPUFrequencyUnit`
- `SystemCPUTimeDescription`
- `SystemCPUTimeName`
- `SystemCPUTimeUnit`
- `SystemCPUUtilizationDescription`
- `SystemCPUUtilizationName`
- `SystemCPUUtilizationUnit`
[OpenTelemetry Semantic Conventions]: https://github.com/open-telemetry/semantic-conventions

View File

@@ -0,0 +1,3 @@
# Semconv v1.31.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.31.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.31.0)

File diff suppressed because it is too large Load Diff

9
semconv/v1.31.0/doc.go Normal file
View File

@@ -0,0 +1,9 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
// Package semconv implements OpenTelemetry semantic conventions.
//
// OpenTelemetry semantic conventions are agreed standardized naming
// patterns for OpenTelemetry things. This package represents the v1.31.0
// version of the OpenTelemetry semantic conventions.
package semconv // import "go.opentelemetry.io/otel/semconv/v1.31.0"

View File

@@ -0,0 +1,9 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package semconv // import "go.opentelemetry.io/otel/semconv/v1.31.0"
const (
// ExceptionEventName is the name of the Span event representing an exception.
ExceptionEventName = "exception"
)

1678
semconv/v1.31.0/metric.go Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,9 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package semconv // import "go.opentelemetry.io/otel/semconv/v1.31.0"
// SchemaURL is the schema URL that matches the version of the semantic conventions
// that this package defines. Semconv packages starting from v1.4.0 must declare
// non-empty schema URL in the form https://opentelemetry.io/schemas/<version>
const SchemaURL = "https://opentelemetry.io/schemas/1.31.0"

View File

@@ -135,6 +135,8 @@ acronyms:
- RHS
- RPC
- ReplicaSet
- ReplicationController
- ResourceQuota
- SDK
- SLA
- SMTP