Skip to content

Commit 8d6d60a

Browse files
Liudmila Molkovatrask
andauthored
Update DB migration guide (#2215)
Co-authored-by: Trask Stalnaker <[email protected]>
1 parent ef60e23 commit 8d6d60a

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

docs/non-normative/db-migration.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This section summarizes the changes made to the HTTP semantic conventions
4343
from
4444
[v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/README.md).
4545
to
46-
[v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/README.md).
46+
[v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/README.md).
4747

4848
### Database client span attributes
4949

@@ -58,6 +58,7 @@ to
5858
| `db.redis.database_index` | Removed, integrated into the new `db.namespace` |
5959
| `db.mssql.instance_name` | Removed, integrated into the new `db.namespace` |
6060
| `db.instance.id` | Removed, replaced by `server.address` or integrated into `db.namespace` as appropriate |
61+
| `db.system` &rarr; `db.system.name` | |
6162
| `db.statement` &rarr; `db.query.text` | Clarified, SHOULD be collected by default only if there is sanitization that excludes sensitive information |
6263
| `db.operation` &rarr; `db.operation.name` | |
6364
| `db.sql.table` &rarr; `db.collection.name` | Should not be captured if extracting the value from `db.query.text` since there could be multiple |
@@ -67,32 +68,34 @@ to
6768
| New: `db.query.summary` | |
6869
| New: `db.operation.batch.size` | |
6970
| New: `db.response.status_code` | |
70-
| New: `db.operation.parameter.<key>` | Opt-In |
7171
| New: `db.stored_procedure.name` | |
7272
| New: `error.type` | |
73+
| New: `db.operation.parameter.<key>` | _Not marked stable yet_ |
74+
| New: `db.query.parameter.<key>` | _Not marked stable yet_ |
75+
| New: `db.response.returned_rows` | _Not marked stable yet_ |
7376
<!-- prettier-ignore-end -->
7477

7578
References:
7679

7780
- [Database client span attributes v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
78-
- [Database client span attributes v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-spans.md)
81+
- [Database client span attributes v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-spans.md)
7982

8083
### Database client span names
8184

8285
The recommended span name has changed.
83-
See [Database client span names v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-spans.md#name)
86+
See [Database client span names v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-spans.md#name)
8487
for details on the new span name recommendation.
8588

8689
References:
8790

8891
- [Database client span names v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
89-
- [Database client span names v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-spans.md#name)
92+
- [Database client span names v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-spans.md#name)
9093

9194
### Database client operation duration metric
9295

9396
This is a required metric. There was no similar metric previously.
9497

95-
See [Metric `db.client.operation.duration` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientoperationduration).
98+
See [Metric `db.client.operation.duration` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientoperationduration).
9699

97100
### Experimental connection metrics
98101

@@ -115,7 +118,7 @@ Metric changes:
115118
References:
116119

117120
- [Metric `db.client.connections.usage` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionsusage)
118-
- [Metric `db.client.connection.count` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectioncount)
121+
- [Metric `db.client.connection.count` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectioncount)
119122

120123
#### Database client connection idle max
121124

@@ -133,7 +136,7 @@ Metric changes:
133136
References:
134137

135138
- [Metric `db.client.connections.idle.max` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionsidlemax)
136-
- [Metric `db.client.connection.idle.max` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectionidlemax)
139+
- [Metric `db.client.connection.idle.max` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectionidlemax)
137140

138141
#### Database client connection idle min
139142

@@ -151,7 +154,7 @@ Metric changes:
151154
References:
152155

153156
- [Metric `db.client.connections.idle.min` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionsidlemin)
154-
- [Metric `db.client.connection.idle.min` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectionidlemin)
157+
- [Metric `db.client.connection.idle.min` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectionidlemin)
155158

156159
#### Database client connection max
157160

@@ -169,7 +172,7 @@ Metric changes:
169172
References:
170173

171174
- [Metric `db.client.connections.max` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionsmax)
172-
- [Metric `db.client.connection.max` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectionmax)
175+
- [Metric `db.client.connection.max` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectionmax)
173176

174177
#### Database client connection pending requests
175178

@@ -187,7 +190,7 @@ Metric changes:
187190
References:
188191

189192
- [Metric `db.client.connections.pending_requests` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionspending_requests)
190-
- [Metric `db.client.connection.pending_requests` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectionpending_requests)
193+
- [Metric `db.client.connection.pending_requests` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectionpending_requests)
191194

192195
#### Database client connection timeouts
193196

@@ -205,7 +208,7 @@ Metric changes:
205208
References:
206209

207210
- [Metric `db.client.connections.timeouts` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionstimeouts)
208-
- [Metric `db.client.connection.timeouts` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectiontimeouts)
211+
- [Metric `db.client.connection.timeouts` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectiontimeouts)
209212

210213
#### Database client connection create time
211214

@@ -224,7 +227,7 @@ Metric changes:
224227
References:
225228

226229
- [Metric `db.client.connections.create_time` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionscreate_time)
227-
- [Metric `db.client.connection.create_time` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectioncreate_time)
230+
- [Metric `db.client.connection.create_time` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectioncreate_time)
228231

229232
#### Database client connection wait time
230233

@@ -243,7 +246,7 @@ Metric changes:
243246
References:
244247

245248
- [Metric `db.client.connections.wait_time` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionswait_time)
246-
- [Metric `db.client.connection.wait_time` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectionwait_time)
249+
- [Metric `db.client.connection.wait_time` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectionwait_time)
247250

248251
#### Database client connection use time
249252

@@ -262,4 +265,4 @@ Metric changes:
262265
References:
263266

264267
- [Metric `db.client.connections.use_time` v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md#metric-dbclientconnectionsuse_time)
265-
- [Metric `db.client.connection.use_time` v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-metrics.md#metric-dbclientconnectionuse_time)
268+
- [Metric `db.client.connection.use_time` v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-metrics.md#metric-dbclientconnectionuse_time)

0 commit comments

Comments
 (0)