Merge pull request #706 from typelevel/update/opentelemetry-semconv-1…

….26.0-alpha

Update opentelemetry-semconv to 1.26.0-alpha

build.sbt

@@ -53,7 +53,7 @@ val MUnitScalaCheckEffectVersion = "2.0.0-M2"
 val OpenTelemetryVersion = "1.40.0"
 val OpenTelemetryInstrumentationVersion = "2.6.0"
 val OpenTelemetryInstrumentationAlphaVersion = "2.5.0-alpha"
-val OpenTelemetrySemConvVersion = "1.25.0-alpha"
+val OpenTelemetrySemConvVersion = "1.26.0-alpha"
 val OpenTelemetryProtoVersion = "1.1.0-alpha"
 val PekkoStreamVersion = "1.0.3"
 val PekkoHttpVersion = "1.0.1"
@@ -576,6 +576,7 @@ lazy val `semconv-experimental` =
       startYear := Some(2023),
       // We use opentelemetry-semconv dependency to track releases of the OpenTelemetry semantic convention spec
       libraryDependencies += "io.opentelemetry.semconv" % "opentelemetry-semconv-incubating" % OpenTelemetrySemConvVersion % "compile-internal" intransitive (),
+      mimaPreviousArtifacts := Set.empty
     )
     .settings(munitDependencies)
     .settings(scalafixSettings)

buildscripts/semantic-convention/templates/SemanticAttributes.scala.j2

@@ -38,10 +38,11 @@
 {{stablePkg}}.{{ root_namespace | to_camelcase(True) }}Attributes{{separator}}{{const_name}}
 {%- endmacro %}
 
+{%- set excluded_attributes_list = excluded_attributes.replace("\"", "").split(' ') %}
 {%- if filter != 'any' %}
-{%- set filtered_attributes = attributes_and_templates | select(filter) | list %}
+{%- set filtered_attributes = attributes_and_templates | rejectattr("fqn", "in", excluded_attributes) | select(filter) | list %}
 {%- else %}
-{%- set filtered_attributes = attributes_and_templates | list %}
+{%- set filtered_attributes = attributes_and_templates | rejectattr("fqn", "in", excluded_attributes) | list %}
 {%- endif %}
 
 {%- set filtered_enums = filtered_attributes | selectattr('is_enum', 'equalto', true) | list %}

project/SemanticConventionsGenerator.scala

@@ -67,6 +67,7 @@ object SemanticConventionsGenerator {
       "--file-per-group", "root_namespace",
       // Space delimited list of root namespaces to excluded (i.e. "foo bar")
       "-Dexcluded_namespaces=\"ios aspnetcore signalr\"",
+      "-Dexcluded_attributes=messaging.client_id",
       s"-Dfilter=$filter",
       s"-DclassPrefix=$classPrefix",
       s"-Dpkg=$packageNameArg",

semconv/experimental/src/main/scala/org/typelevel/otel4s/semconv/experimental/AndroidExperimentalAttributes.scala

@@ -29,8 +29,8 @@ object AndroidExperimentalAttributes {
     */
   val AndroidOsApiLevel: AttributeKey[String] = string("android.os.api_level")
 
-  /** This attribute represents the state the application has transitioned into
-    * at the occurrence of the event.
+  /** Deprecated use the `device.app.lifecycle` event definition including
+    * `android.state` as a payload field instead.
     *
     * @note
     *   - The Android lifecycle states are defined in <a

semconv/experimental/src/main/scala/org/typelevel/otel4s/semconv/experimental/ContainerExperimentalAttributes.scala

@@ -64,7 +64,7 @@ object ContainerExperimentalAttributes {
     *     endpoint. K8s defines a link to the container registry repository with
     *     digest `"imageID": "registry.azurecr.io
     *     /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`.
-    *     The ID is assinged by the container runtime and can vary in different
+    *     The ID is assigned by the container runtime and can vary in different
     *     environments. Consider using `oci.manifest.digest` if it is important
     *     to identify the same image in different environments/runtimes.
     */

semconv/experimental/src/main/scala/org/typelevel/otel4s/semconv/experimental/DbExperimentalAttributes.scala

@@ -59,18 +59,35 @@ object DbExperimentalAttributes {
     "db.cassandra.speculative_execution_count"
   )
 
-  /** The name of the primary Cassandra table that the operation is acting upon,
-    * including the keyspace name (if applicable).
+  /** Deprecated, use `db.collection.name` instead.
+    */
+  @deprecated("Use `db.collection.name` instead", "0.5.0")
+  val DbCassandraTable: AttributeKey[String] = string("db.cassandra.table")
+
+  /** The name of the connection pool; unique within the instrumented
+    * application. In case the connection pool implementation doesn't provide a
+    * name, instrumentation should use a combination of `server.address` and
+    * `server.port` attributes formatted as `server.address:server.port`.
+    */
+  val DbClientConnectionsPoolName: AttributeKey[String] = string(
+    "db.client.connections.pool.name"
+  )
+
+  /** The state of a connection in the pool
+    */
+  val DbClientConnectionsState: AttributeKey[String] = string(
+    "db.client.connections.state"
+  )
+
+  /** The name of a collection (table, container) within the database.
     *
     * @note
-    *   - This mirrors the db.sql.table attribute but references cassandra
-    *     rather than sql. It is not recommended to attempt any client-side
-    *     parsing of `db.statement` just to get this property, but it should be
-    *     set if it is provided by the library being instrumented. If the
-    *     operation is acting upon an anonymous table, or more than one table,
-    *     this value MUST NOT be set.
+    *   - If the collection name is parsed from the query, it SHOULD match the
+    *     value provided in the query and may be qualified with the schema and
+    *     database name. It is RECOMMENDED to capture the value as provided by
+    *     the application without attempting to do any case normalization.
     */
-  val DbCassandraTable: AttributeKey[String] = string("db.cassandra.table")
+  val DbCollectionName: AttributeKey[String] = string("db.collection.name")
 
   /** Deprecated, use `server.address`, `server.port` attributes instead.
     */
@@ -87,8 +104,9 @@ object DbExperimentalAttributes {
     "db.cosmosdb.connection_mode"
   )
 
-  /** Cosmos DB container name.
+  /** Deprecated, use `db.collection.name` instead.
     */
+  @deprecated("Use `db.collection.name` instead", "0.5.0")
   val DbCosmosdbContainer: AttributeKey[String] = string(
     "db.cosmosdb.container"
   )
@@ -127,9 +145,9 @@ object DbExperimentalAttributes {
     "db.elasticsearch.cluster.name"
   )
 
-  /** Deprecated, use `db.instance.id` instead.
+  /** Represents the human-readable identifier of the node/instance to which a
+    * request was routed.
     */
-  @deprecated("Use `db.instance.id` instead", "0.5.0")
   val DbElasticsearchNodeName: AttributeKey[String] = string(
     "db.elasticsearch.node.name"
   )
@@ -148,13 +166,13 @@ object DbExperimentalAttributes {
     "db.elasticsearch.path_parts"
   )
 
-  /** An identifier (address, unique name, or any other identifier) of the
-    * database instance that is executing queries or mutations on the current
-    * connection. This is useful in cases where the database is running in a
-    * clustered environment and the instrumentation is able to record the node
-    * executing the query. The client may obtain this value in databases like
-    * MySQL using queries like `select @@hostname`.
+  /** Deprecated, no general replacement at this time. For Elasticsearch, use
+    * `db.elasticsearch.node.name` instead.
     */
+  @deprecated(
+    "No general replacement at this time. for elasticsearch, use `db.elasticsearch.node.name` instead",
+    "0.5.0"
+  )
   val DbInstanceId: AttributeKey[String] = string("db.instance.id")
 
   /** Removed, no replacement at this time.
@@ -164,81 +182,103 @@ object DbExperimentalAttributes {
     "db.jdbc.driver_classname"
   )
 
-  /** The MongoDB collection being accessed within the database stated in
-    * `db.name`.
+  /** Deprecated, use `db.collection.name` instead.
     */
+  @deprecated("Use `db.collection.name` instead", "0.5.0")
   val DbMongodbCollection: AttributeKey[String] = string(
     "db.mongodb.collection"
   )
 
-  /** The Microsoft SQL Server <a
-    * href="https://docs.microsoft.com/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15">instance
-    * name</a> connecting to. This name is used to determine the port of a named
-    * instance.
-    *
-    * @note
-    *   - If setting a `db.mssql.instance_name`, `server.port` is no longer
-    *     required (but still recommended if non-standard).
+  /** Deprecated, SQL Server instance is now populated as a part of
+    * `db.namespace` attribute.
     */
+  @deprecated(
+    "Sql server instance is now populated as a part of `db.namespace` attribute",
+    "0.5.0"
+  )
   val DbMssqlInstanceName: AttributeKey[String] = string(
     "db.mssql.instance_name"
   )
 
-  /** This attribute is used to report the name of the database being accessed.
-    * For commands that switch the database, this should be set to the target
-    * database (even if the command fails).
-    *
-    * @note
-    *   - In some SQL databases, the database name to be used is called
-    *     &quot;schema name&quot;. In case there are multiple layers that could
-    *     be considered for database name (e.g. Oracle instance name and schema
-    *     name), the database name to be used is the more specific layer (e.g.
-    *     Oracle schema name).
+  /** Deprecated, use `db.namespace` instead.
     */
+  @deprecated("Use `db.namespace` instead", "0.5.0")
   val DbName: AttributeKey[String] = string("db.name")
 
-  /** The name of the operation being executed, e.g. the <a
-    * href="https://docs.mongodb.com/manual/reference/command/#database-operations">MongoDB
-    * command name</a> such as `findAndModify`, or the SQL keyword.
+  /** The name of the database, fully qualified within the server address and
+    * port.
     *
     * @note
-    *   - When setting this to an SQL keyword, it is not recommended to attempt
-    *     any client-side parsing of `db.statement` just to get this property,
-    *     but it should be set if the operation name is provided by the library
-    *     being instrumented. If the SQL statement has an ambiguous operation,
-    *     or performs more than one operation, this value may be omitted.
-    */
+    *   - If a database system has multiple namespace components, they SHOULD be
+    *     concatenated (potentially using database system specific conventions)
+    *     from most general to most specific namespace component, and more
+    *     specific namespaces SHOULD NOT be captured without the more general
+    *     namespaces, to ensure that &quot;startswith&quot; queries for the more
+    *     general namespaces will be valid. Semantic conventions for individual
+    *     database systems SHOULD document what `db.namespace` means in the
+    *     context of that system. It is RECOMMENDED to capture the value as
+    *     provided by the application without attempting to do any case
+    *     normalization.
+    */
+  val DbNamespace: AttributeKey[String] = string("db.namespace")
+
+  /** Deprecated, use `db.operation.name` instead.
+    */
+  @deprecated("Use `db.operation.name` instead", "0.5.0")
   val DbOperation: AttributeKey[String] = string("db.operation")
 
-  /** The index of the database being accessed as used in the <a
-    * href="https://redis.io/commands/select">`SELECT` command</a>, provided as
-    * an integer. To be used instead of the generic `db.name` attribute.
+  /** The name of the operation or command being executed.
+    *
+    * @note
+    *   - It is RECOMMENDED to capture the value as provided by the application
+    *     without attempting to do any case normalization.
     */
-  val DbRedisDatabaseIndex: AttributeKey[Long] = long("db.redis.database_index")
+  val DbOperationName: AttributeKey[String] = string("db.operation.name")
 
-  /** The name of the primary table that the operation is acting upon, including
-    * the database name (if applicable).
+  /** The query parameters used in `db.query.text`, with `<key>` being the
+    * parameter name, and the attribute value being the parameter value.
     *
     * @note
-    *   - It is not recommended to attempt any client-side parsing of
-    *     `db.statement` just to get this property, but it should be set if it
-    *     is provided by the library being instrumented. If the operation is
-    *     acting upon an anonymous table, or more than one table, this value
-    *     MUST NOT be set.
+    *   - Query parameters should only be captured when `db.query.text` is
+    *     parameterized with placeholders. If a parameter has no name and
+    *     instead is referenced only by index, then `<key>` SHOULD be the
+    *     0-based index.
+    */
+  val DbQueryParameter: AttributeKey[String] = string("db.query.parameter")
+
+  /** The database query being executed.
     */
+  val DbQueryText: AttributeKey[String] = string("db.query.text")
+
+  /** Deprecated, use `db.namespace` instead.
+    */
+  @deprecated("Use `db.namespace` instead", "0.5.0")
+  val DbRedisDatabaseIndex: AttributeKey[Long] = long("db.redis.database_index")
+
+  /** Deprecated, use `db.collection.name` instead.
+    */
+  @deprecated("Use `db.collection.name` instead", "0.5.0")
   val DbSqlTable: AttributeKey[String] = string("db.sql.table")
 
   /** The database statement being executed.
     */
+  @deprecated("The database statement being executed", "0.5.0")
   val DbStatement: AttributeKey[String] = string("db.statement")
 
-  /** An identifier for the database management system (DBMS) product being
-    * used. See below for a list of well-known identifiers.
+  /** The database management system (DBMS) product as identified by the client
+    * instrumentation.
+    *
+    * @note
+    *   - The actual DBMS may differ from the one identified by the client. For
+    *     example, when using PostgreSQL client libraries to connect to a
+    *     CockroachDB, the `db.system` is set to `postgresql` based on the
+    *     instrumentation's best knowledge.
     */
   val DbSystem: AttributeKey[String] = string("db.system")
 
-  /** Username for accessing the database.
+  /** Deprecated, no replacement at this time.
     */
+  @deprecated("No replacement at this time", "0.5.0")
   val DbUser: AttributeKey[String] = string("db.user")
   // Enum definitions
 
@@ -284,6 +324,18 @@ object DbExperimentalAttributes {
         extends DbCassandraConsistencyLevelValue("local_serial")
   }
 
+  /** Values for [[DbClientConnectionsState]].
+    */
+  abstract class DbClientConnectionsStateValue(val value: String)
+  object DbClientConnectionsStateValue {
+
+    /** idle. */
+    case object Idle extends DbClientConnectionsStateValue("idle")
+
+    /** used. */
+    case object Used extends DbClientConnectionsStateValue("used")
+  }
+
   /** Values for [[DbCosmosdbConnectionMode]].
     */
   abstract class DbCosmosdbConnectionModeValue(val value: String)

semconv/experimental/src/main/scala/org/typelevel/otel4s/semconv/experimental/ErrorExperimentalAttributes.scala

@@ -25,9 +25,12 @@ object ErrorExperimentalAttributes {
   /** Describes a class of error the operation ended with.
     *
     * @note
-    *   - The `error.type` SHOULD be predictable and SHOULD have low
-    *     cardinality. Instrumentations SHOULD document the list of errors they
-    *     report.
+    *   - The `error.type` SHOULD be predictable, and SHOULD have low
+    *     cardinality.
+    *   - When `error.type` is set to a type (e.g., an exception type), its
+    *     canonical class name identifying the type within the artifact SHOULD
+    *     be used.
+    *   - Instrumentations SHOULD document the list of errors they report.
     *   - The cardinality of `error.type` within one instrumentation library
     *     SHOULD be low. Telemetry consumers that aggregate data from multiple
     *     instrumentation libraries and applications should be prepared for

semconv/experimental/src/main/scala/org/typelevel/otel4s/semconv/experimental/EventExperimentalAttributes.scala

@@ -26,7 +26,7 @@ object EventExperimentalAttributes {
     *
     * @note
     *   - Event names are subject to the same rules as <a
-    *     href="https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/common/attribute-naming.md">attribute
+    *     href="https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/common/attribute-naming.md">attribute
     *     names</a>. Notably, event names are namespaced to avoid collisions and
     *     provide a clean separation of semantics for events in separate domains
     *     like browser, mobile, and kubernetes.

semconv/experimental/src/main/scala/org/typelevel/otel4s/semconv/experimental/ExceptionExperimentalAttributes.scala

@@ -36,8 +36,9 @@ object ExceptionExperimentalAttributes {
     *     exception is thrown whether it will escape the scope of a span.
     *     However, it is trivial to know that an exception will escape, if one
     *     checks for an active exception just before ending the span, as done in
-    *     the <a href="#recording-an-exception">example for recording span
-    *     exceptions</a>.
+    *     the <a
+    *     href="https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception">example
+    *     for recording span exceptions</a>.
     *   - It follows that an exception may still escape the scope of the span
     *     even if the `exception.escaped` attribute was not set or set to false,
     *     since the event might have been recorded at a time where it was not