From c8b61636277c9577a8e1948f1df70b4da8716d2d Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Fri, 8 Mar 2024 08:41:04 -0800 Subject: [PATCH] Deprecate `db.jdbc.driver_classname` attribute since it's not used (#796) --- .chloggen/796.yaml | 4 ++++ docs/attributes-registry/db.md | 10 +--------- docs/database/mssql.md | 1 - docs/database/sql.md | 1 - model/registry/db.yaml | 7 ------- model/registry/deprecated/db.yaml | 7 ++++++- model/trace/database.yaml | 2 -- 7 files changed, 11 insertions(+), 21 deletions(-) create mode 100644 .chloggen/796.yaml diff --git a/.chloggen/796.yaml b/.chloggen/796.yaml new file mode 100644 index 0000000000..725dc48513 --- /dev/null +++ b/.chloggen/796.yaml @@ -0,0 +1,4 @@ +change_type: deprecation +component: db +note: Deprecate `db.jdbc.driver_classname` attribute +issues: [796] diff --git a/docs/attributes-registry/db.md b/docs/attributes-registry/db.md index 5441b91de9..be7f5753d0 100644 --- a/docs/attributes-registry/db.md +++ b/docs/attributes-registry/db.md @@ -9,7 +9,6 @@ - [Cassandra Attributes](#cassandra-attributes) - [CosmosDB Attributes](#cosmosdb-attributes) - [Elasticsearch Attributes](#elasticsearch-attributes) -- [JDBC Attributes](#jdbc-attributes) - [MongoDB Attributes](#mongodb-attributes) - [MSSQL Attributes](#mssql-attributes) - [Redis Attributes](#redis-attributes) @@ -178,14 +177,6 @@ **[1]:** Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.`, where `` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names. -## JDBC Attributes - - -| Attribute | Type | Description | Examples | -|---|---|---|---| -| `db.jdbc.driver_classname` | string | The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | - - ## MongoDB Attributes @@ -228,4 +219,5 @@ | Attribute | Type | Description | Examples | |---|---|---|---| | `db.connection_string` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | +| `db.jdbc.driver_classname` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | \ No newline at end of file diff --git a/docs/database/mssql.md b/docs/database/mssql.md index 6eeaf08030..e0ad3c6727 100644 --- a/docs/database/mssql.md +++ b/docs/database/mssql.md @@ -17,7 +17,6 @@ described on this page. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`db.jdbc.driver_classname`](../attributes-registry/db.md) | string | The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | Recommended | | [`db.mssql.instance_name`](../attributes-registry/db.md) | string | The Microsoft SQL Server [instance name](https://docs.microsoft.com/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15) connecting to. This name is used to determine the port of a named instance. [1] | `MSSQLSERVER` | Recommended | | [`db.sql.table`](../attributes-registry/db.md) | string | The name of the primary table that the operation is acting upon, including the database name (if applicable). [2] | `public.users`; `customers` | Recommended | diff --git a/docs/database/sql.md b/docs/database/sql.md index d60e3e158e..17b8dcc892 100644 --- a/docs/database/sql.md +++ b/docs/database/sql.md @@ -15,7 +15,6 @@ described on this page. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`db.jdbc.driver_classname`](../attributes-registry/db.md) | string | The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | Recommended | | [`db.sql.table`](../attributes-registry/db.md) | string | The name of the primary table that the operation is acting upon, including the database name (if applicable). [1] | `public.users`; `customers` | Recommended | **[1]:** 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. diff --git a/model/registry/db.yaml b/model/registry/db.yaml index a94eef9471..4185c279ab 100644 --- a/model/registry/db.yaml +++ b/model/registry/db.yaml @@ -192,13 +192,6 @@ groups: in order to map the path part values to their names. examples: ['db.elasticsearch.path_parts.index=test-index', 'db.elasticsearch.path_parts.doc_id=123'] tag: tech-specific-elasticsearch - - id: jdbc.driver_classname - type: string - stability: experimental - brief: > - The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect. - examples: ['org.postgresql.Driver', 'com.microsoft.sqlserver.jdbc.SQLServerDriver'] - tag: tech-specific-jdbc - id: mongodb.collection type: string stability: experimental diff --git a/model/registry/deprecated/db.yaml b/model/registry/deprecated/db.yaml index a3718cf6bc..1dd6996704 100644 --- a/model/registry/deprecated/db.yaml +++ b/model/registry/deprecated/db.yaml @@ -9,5 +9,10 @@ groups: type: string brief: 'Deprecated, use `server.address`, `server.port` attributes instead.' deprecated: > - "Removed in favor of `server.address` and `server.port`." + "Replaced by `server.address` and `server.port`." examples: Server=(localdb)\v11.0;Integrated Security=true; + - id: jdbc.driver_classname + type: string + brief: 'Removed, no replacement at this time.' + deprecated: 'Removed as not used.' + examples: ['org.postgresql.Driver', 'com.microsoft.sqlserver.jdbc.SQLServerDriver'] diff --git a/model/trace/database.yaml b/model/trace/database.yaml index 74ea98ceb2..5d7d4fc269 100644 --- a/model/trace/database.yaml +++ b/model/trace/database.yaml @@ -183,8 +183,6 @@ groups: attributes: - ref: db.sql.table tag: tech-specific - - ref: db.jdbc.driver_classname - tag: tech-specific - id: db.cosmosdb type: span