Skip to content

Commit

Permalink
Deprecate db.jdbc.driver_classname attribute since it's not used (#796
Browse files Browse the repository at this point in the history
)
  • Loading branch information
lmolkova authored Mar 8, 2024
1 parent a3252cb commit c8b6163
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 21 deletions.
4 changes: 4 additions & 0 deletions .chloggen/796.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: deprecation
component: db
note: Deprecate `db.jdbc.driver_classname` attribute
issues: [796]
10 changes: 1 addition & 9 deletions docs/attributes-registry/db.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.<key>`, where `<key>` 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.
<!-- endsemconv -->

## JDBC Attributes

<!-- semconv registry.db(omit_requirement_level,tag=tech-specific-jdbc) -->
| 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` |
<!-- endsemconv -->

## MongoDB Attributes

<!-- semconv registry.db(omit_requirement_level,tag=tech-specific-mongodb) -->
Expand Down Expand Up @@ -228,4 +219,5 @@
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `db.connection_string` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>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)<br>Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` |
<!-- endsemconv -->
1 change: 0 additions & 1 deletion docs/database/mssql.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ described on this page.
<!-- semconv db.mssql(full,tag=tech-specific) -->
| 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 |

Expand Down
1 change: 0 additions & 1 deletion docs/database/sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ described on this page.
<!-- semconv db.sql(full,tag=tech-specific) -->
| 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.
Expand Down
7 changes: 0 additions & 7 deletions model/registry/db.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 6 additions & 1 deletion model/registry/deprecated/db.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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']
2 changes: 0 additions & 2 deletions model/trace/database.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c8b6163

Please sign in to comment.