Skip to content

Commit 95e5bba

Browse files
MrAliaspellared
andauthored
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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#1732" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1732/hovercard">#1732</a>, <a href="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#1863" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1863/hovercard">#1863</a>, <a href="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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="open-telemetry/semantic-conventions#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>
1 parent ff6be9e commit 95e5bba

10 files changed

+14697
-1
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
88

99
## [Unreleased]
1010

11+
### Added
12+
13+
- The `go.opentelemetry.io/otel/semconv/v1.31.0` package.
14+
The package contains semantic conventions from the `v1.31.0` version of the OpenTelemetry Semantic Conventions.
15+
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)
16+
1117
### Removed
1218

1319
- Drop support for [Go 1.22]. (#6381, #6418)

semconv/metric.go.j2

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
package semconv // import "go.opentelemetry.io/otel/semconv/{{params.tag}}"
88

99
const (
10-
{%- for metric in ctx %}
10+
{%- for metric in ctx if not metric.deprecated %}
1111
{{ h.metric_keydoc(metric) | comment(indent=2) }}
1212
// Instrument: {{ metric.instrument }}
1313
// Unit: {{ metric.unit }}

semconv/v1.31.0/MIGRATION.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Semantic Convention Changes
2+
3+
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.
4+
5+
## Dropped deprecations
6+
7+
The following declarations have been deprecated in the [OpenTelemetry Semantic Conventions].
8+
Refer to the respective documentation in that repository for deprecation instructions for each type.
9+
10+
- `CodeNamespace`
11+
- `CodeNamespaceKey`
12+
- `DBClientConnectionsCreateTimeDescription`
13+
- `DBClientConnectionsCreateTimeName`
14+
- `DBClientConnectionsCreateTimeUnit`
15+
- `DBClientConnectionsIdleMaxDescription`
16+
- `DBClientConnectionsIdleMaxName`
17+
- `DBClientConnectionsIdleMaxUnit`
18+
- `DBClientConnectionsIdleMinDescription`
19+
- `DBClientConnectionsIdleMinName`
20+
- `DBClientConnectionsIdleMinUnit`
21+
- `DBClientConnectionsMaxDescription`
22+
- `DBClientConnectionsMaxName`
23+
- `DBClientConnectionsMaxUnit`
24+
- `DBClientConnectionsPendingRequestsDescription`
25+
- `DBClientConnectionsPendingRequestsName`
26+
- `DBClientConnectionsPendingRequestsUnit`
27+
- `DBClientConnectionsTimeoutsDescription`
28+
- `DBClientConnectionsTimeoutsName`
29+
- `DBClientConnectionsTimeoutsUnit`
30+
- `DBClientConnectionsUsageDescription`
31+
- `DBClientConnectionsUsageName`
32+
- `DBClientConnectionsUsageUnit`
33+
- `DBClientConnectionsUseTimeDescription`
34+
- `DBClientConnectionsUseTimeName`
35+
- `DBClientConnectionsUseTimeUnit`
36+
- `DBClientConnectionsWaitTimeDescription`
37+
- `DBClientConnectionsWaitTimeName`
38+
- `DBClientConnectionsWaitTimeUnit`
39+
- `DBClientCosmosDBActiveInstanceCountDescription`
40+
- `DBClientCosmosDBActiveInstanceCountName`
41+
- `DBClientCosmosDBActiveInstanceCountUnit`
42+
- `DBClientCosmosDBOperationRequestChargeDescription`
43+
- `DBClientCosmosDBOperationRequestChargeName`
44+
- `DBClientCosmosDBOperationRequestChargeUnit`
45+
- `GenAIOpenaiRequestResponseFormatJSONObject`
46+
- `GenAIOpenaiRequestResponseFormatJSONSchema`
47+
- `GenAIOpenaiRequestResponseFormatKey`
48+
- `GenAIOpenaiRequestResponseFormatText`
49+
- `MessagingClientPublishedMessagesDescription`
50+
- `MessagingClientPublishedMessagesName`
51+
- `MessagingClientPublishedMessagesUnit`
52+
- `MessagingProcessMessagesDescription`
53+
- `MessagingProcessMessagesName`
54+
- `MessagingProcessMessagesUnit`
55+
- `MessagingPublishDurationDescription`
56+
- `MessagingPublishDurationName`
57+
- `MessagingPublishDurationUnit`
58+
- `MessagingPublishMessagesDescription`
59+
- `MessagingPublishMessagesName`
60+
- `MessagingPublishMessagesUnit`
61+
- `MessagingReceiveDurationDescription`
62+
- `MessagingReceiveDurationName`
63+
- `MessagingReceiveDurationUnit`
64+
- `MessagingReceiveMessagesDescription`
65+
- `MessagingReceiveMessagesName`
66+
- `MessagingReceiveMessagesUnit`
67+
- `SystemCPUFrequencyDescription`
68+
- `SystemCPUFrequencyName`
69+
- `SystemCPUFrequencyUnit`
70+
- `SystemCPUTimeDescription`
71+
- `SystemCPUTimeName`
72+
- `SystemCPUTimeUnit`
73+
- `SystemCPUUtilizationDescription`
74+
- `SystemCPUUtilizationName`
75+
- `SystemCPUUtilizationUnit`
76+
77+
[OpenTelemetry Semantic Conventions]: https://github.com/open-telemetry/semantic-conventions

semconv/v1.31.0/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Semconv v1.31.0
2+
3+
[![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)

0 commit comments

Comments
 (0)