Update DB migration guide (#2215)
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
This commit is contained in:
Liudmila Molkova
GitHub
parent
ef60e23256
commit
8d6d60a7de
|
|
@ -43,7 +43,7 @@ This section summarizes the changes made to the HTTP semantic conventions
|
|||
from
|
||||
[v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/README.md).
|
||||
to
|
||||
[v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/README.md).
|
||||
[v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/README.md).
|
||||
|
||||
### Database client span attributes
|
||||
|
||||
|
|
@ -58,6 +58,7 @@ to
|
|||
| `db.redis.database_index` | Removed, integrated into the new `db.namespace` |
|
||||
| `db.mssql.instance_name` | Removed, integrated into the new `db.namespace` |
|
||||
| `db.instance.id` | Removed, replaced by `server.address` or integrated into `db.namespace` as appropriate |
|
||||
| `db.system` → `db.system.name` | |
|
||||
| `db.statement` → `db.query.text` | Clarified, SHOULD be collected by default only if there is sanitization that excludes sensitive information |
|
||||
| `db.operation` → `db.operation.name` | |
|
||||
| `db.sql.table` → `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
|
|||
| New: `db.query.summary` | |
|
||||
| New: `db.operation.batch.size` | |
|
||||
| New: `db.response.status_code` | |
|
||||
| New: `db.operation.parameter.<key>` | Opt-In |
|
||||
| New: `db.stored_procedure.name` | |
|
||||
| New: `error.type` | |
|
||||
| New: `db.operation.parameter.<key>` | _Not marked stable yet_ |
|
||||
| New: `db.query.parameter.<key>` | _Not marked stable yet_ |
|
||||
| New: `db.response.returned_rows` | _Not marked stable yet_ |
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
References:
|
||||
|
||||
- [Database client span attributes v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
|
||||
- [Database client span attributes v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-spans.md)
|
||||
- [Database client span attributes v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-spans.md)
|
||||
|
||||
### Database client span names
|
||||
|
||||
The recommended span name has changed.
|
||||
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)
|
||||
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)
|
||||
for details on the new span name recommendation.
|
||||
|
||||
References:
|
||||
|
||||
- [Database client span names v1.24.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
|
||||
- [Database client span names v1.31.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.31.0/docs/database/database-spans.md#name)
|
||||
- [Database client span names v1.33.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.33.0/docs/database/database-spans.md#name)
|
||||
|
||||
### Database client operation duration metric
|
||||
|
||||
This is a required metric. There was no similar metric previously.
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Experimental connection metrics
|
||||
|
||||
|
|
@ -115,7 +118,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection idle max
|
||||
|
||||
|
|
@ -133,7 +136,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection idle min
|
||||
|
||||
|
|
@ -151,7 +154,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection max
|
||||
|
||||
|
|
@ -169,7 +172,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection pending requests
|
||||
|
||||
|
|
@ -187,7 +190,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection timeouts
|
||||
|
||||
|
|
@ -205,7 +208,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection create time
|
||||
|
||||
|
|
@ -224,7 +227,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection wait time
|
||||
|
||||
|
|
@ -243,7 +246,7 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
||||
#### Database client connection use time
|
||||
|
||||
|
|
@ -262,4 +265,4 @@ Metric changes:
|
|||
References:
|
||||
|
||||
- [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)
|
||||
- [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)
|
||||
- [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)
|
||||
|
|
|
|||
Loading…
Reference in New Issue