Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename db.client.connections.* metric namespace to db.client.connection.* #259

Closed
wants to merge 1 commit into from
+76 −63
Closed

Rename db.client.connections.* metric namespace to db.client.connection.* #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ release.
- Clarify that `http/dup` has higher precedence than `http` in case both values are present
in `OTEL_SEMCONV_STABILITY_OPT_IN`
([#249](https://github.com/open-telemetry/semantic-conventions/pull/249))
- BREAKING: Rename `db.client.connections.*` metric namespace to `db.client.connection.*`.
([#259](https://github.com/open-telemetry/semantic-conventions/pull/259))

## v1.21.0 (2023-07-13)

Expand Down
90 changes: 45 additions & 45 deletions docs/database/database-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,33 @@ and attributes but more may be added in the future.
<!-- toc -->

- [Connection pools](#connection-pools)
* [Metric: `db.client.connections.usage`](#metric-dbclientconnectionsusage)
* [Metric: `db.client.connections.idle.max`](#metric-dbclientconnectionsidlemax)
* [Metric: `db.client.connections.idle.min`](#metric-dbclientconnectionsidlemin)
* [Metric: `db.client.connections.max`](#metric-dbclientconnectionsmax)
* [Metric: `db.client.connections.pending_requests`](#metric-dbclientconnectionspending_requests)
* [Metric: `db.client.connections.timeouts`](#metric-dbclientconnectionstimeouts)
* [Metric: `db.client.connections.create_time`](#metric-dbclientconnectionscreate_time)
* [Metric: `db.client.connections.wait_time`](#metric-dbclientconnectionswait_time)
* [Metric: `db.client.connections.use_time`](#metric-dbclientconnectionsuse_time)
* [Metric: `db.client.connection.usage`](#metric-dbclientconnectionusage)
* [Metric: `db.client.connection.idle.max`](#metric-dbclientconnectionidlemax)
* [Metric: `db.client.connection.idle.min`](#metric-dbclientconnectionidlemin)
* [Metric: `db.client.connection.max`](#metric-dbclientconnectionmax)
* [Metric: `db.client.connection.pending_requests`](#metric-dbclientconnectionpending_requests)
* [Metric: `db.client.connection.timeouts`](#metric-dbclientconnectiontimeouts)
* [Metric: `db.client.connection.create_time`](#metric-dbclientconnectioncreate_time)
* [Metric: `db.client.connection.wait_time`](#metric-dbclientconnectionwait_time)
* [Metric: `db.client.connection.use_time`](#metric-dbclientconnectionuse_time)

<!-- tocstop -->

## Connection pools

The following metric instruments describe database client connection pool operations.

### Metric: `db.client.connections.usage`
### Metric: `db.client.connection.usage`

This metric is [required][MetricRequired].

<!-- semconv metric.db.client.connections.usage(metric_table) -->
<!-- semconv metric.db.client.connection.usage(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.usage` | UpDownCounter | `{connection}` | The number of connections that are currently in state described by the `state` attribute |
| `db.client.connection.usage` | UpDownCounter | `{connection}` | The number of connections that are currently in state described by the `state` attribute |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.usage(full) -->
<!-- semconv metric.db.client.connection.usage(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
Expand All @@ -55,129 +55,129 @@ This metric is [required][MetricRequired].
| `idle` | idle |
| `used` | used |
<!-- endsemconv -->
### Metric: `db.client.connections.idle.max`
### Metric: `db.client.connection.idle.max`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.idle.max(metric_table) -->
<!-- semconv metric.db.client.connection.idle.max(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.idle.max` | UpDownCounter | `{connection}` | The maximum number of idle open connections allowed |
| `db.client.connection.idle.max` | UpDownCounter | `{connection}` | The maximum number of idle open connections allowed |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.idle.max(full) -->
<!-- semconv metric.db.client.connection.idle.max(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
<!-- endsemconv -->

### Metric: `db.client.connections.idle.min`
### Metric: `db.client.connection.idle.min`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.idle.min(metric_table) -->
<!-- semconv metric.db.client.connection.idle.min(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.idle.min` | UpDownCounter | `{connection}` | The minimum number of idle open connections allowed |
| `db.client.connection.idle.min` | UpDownCounter | `{connection}` | The minimum number of idle open connections allowed |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.idle.min(full) -->
<!-- semconv metric.db.client.connection.idle.min(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
<!-- endsemconv -->

### Metric: `db.client.connections.max`
### Metric: `db.client.connection.max`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.max(metric_table) -->
<!-- semconv metric.db.client.connection.max(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.max` | UpDownCounter | `{connection}` | The maximum number of open connections allowed |
| `db.client.connection.max` | UpDownCounter | `{connection}` | The maximum number of open connections allowed |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.max(full) -->
<!-- semconv metric.db.client.connection.max(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
<!-- endsemconv -->

### Metric: `db.client.connections.pending_requests`
### Metric: `db.client.connection.pending_requests`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.pending_requests(metric_table) -->
<!-- semconv metric.db.client.connection.pending_requests(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.pending_requests` | UpDownCounter | `{request}` | The number of pending requests for an open connection, cumulative for the entire pool |
| `db.client.connection.pending_requests` | UpDownCounter | `{request}` | The number of pending requests for an open connection, cumulative for the entire pool |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.pending_requests(full) -->
<!-- semconv metric.db.client.connection.pending_requests(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
<!-- endsemconv -->

### Metric: `db.client.connections.timeouts`
### Metric: `db.client.connection.timeouts`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.timeouts(metric_table) -->
<!-- semconv metric.db.client.connection.timeouts(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.timeouts` | Counter | `{timeout}` | The number of connection timeouts that have occurred trying to obtain a connection from the pool |
| `db.client.connection.timeouts` | Counter | `{timeout}` | The number of connection timeouts that have occurred trying to obtain a connection from the pool |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.timeouts(full) -->
<!-- semconv metric.db.client.connection.timeouts(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
<!-- endsemconv -->

### Metric: `db.client.connections.create_time`
### Metric: `db.client.connection.create_time`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.create_time(metric_table) -->
<!-- semconv metric.db.client.connection.create_time(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.create_time` | Histogram | `ms` | The time it took to create a new connection |
| `db.client.connection.create_time` | Histogram | `ms` | The time it took to create a new connection |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.create_time(full) -->
<!-- semconv metric.db.client.connection.create_time(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
<!-- endsemconv -->

### Metric: `db.client.connections.wait_time`
### Metric: `db.client.connection.wait_time`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.wait_time(metric_table) -->
<!-- semconv metric.db.client.connection.wait_time(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.wait_time` | Histogram | `ms` | The time it took to obtain an open connection from the pool |
| `db.client.connection.wait_time` | Histogram | `ms` | The time it took to obtain an open connection from the pool |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.wait_time(full) -->
<!-- semconv metric.db.client.connection.wait_time(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
<!-- endsemconv -->

### Metric: `db.client.connections.use_time`
### Metric: `db.client.connection.use_time`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.db.client.connections.use_time(metric_table) -->
<!-- semconv metric.db.client.connection.use_time(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `db.client.connections.use_time` | Histogram | `ms` | The time between borrowing a connection and returning it to the pool |
| `db.client.connection.use_time` | Histogram | `ms` | The time between borrowing a connection and returning it to the pool |
<!-- endsemconv -->

<!-- semconv metric.db.client.connections.use_time(full) -->
<!-- semconv metric.db.client.connection.use_time(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
Expand Down
36 changes: 18 additions & 18 deletions model/metrics/database-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,82 +24,82 @@ groups:
should be used
examples: ["myDataSource"]

- id: metric.db.client.connections.usage
- id: metric.db.client.connection.usage
type: metric
metric_name: db.client.connections.usage
metric_name: db.client.connection.usage
brief: "The number of connections that are currently in state described by the `state` attribute"
instrument: updowncounter
unit: "{connection}"
attributes:
- ref: state
- ref: pool.name

- id: metric.db.client.connections.idle.max
- id: metric.db.client.connection.idle.max
type: metric
metric_name: db.client.connections.idle.max
metric_name: db.client.connection.idle.max
brief: "The maximum number of idle open connections allowed"
instrument: updowncounter
unit: "{connection}"
attributes:
- ref: pool.name

- id: metric.db.client.connections.idle.min
- id: metric.db.client.connection.idle.min
type: metric
metric_name: db.client.connections.idle.min
metric_name: db.client.connection.idle.min
brief: "The minimum number of idle open connections allowed"
instrument: updowncounter
unit: "{connection}"
attributes:
- ref: pool.name

- id: metric.db.client.connections.max
- id: metric.db.client.connection.max
type: metric
metric_name: db.client.connections.max
metric_name: db.client.connection.max
brief: "The maximum number of open connections allowed"
instrument: updowncounter
unit: "{connection}"
attributes:
- ref: pool.name

- id: metric.db.client.connections.pending_requests
- id: metric.db.client.connection.pending_requests
type: metric
metric_name: db.client.connections.pending_requests
metric_name: db.client.connection.pending_requests
brief: "The number of pending requests for an open connection, cumulative for the entire pool"
instrument: updowncounter
unit: "{request}"
attributes:
- ref: pool.name

- id: metric.db.client.connections.timeouts
- id: metric.db.client.connection.timeouts
type: metric
metric_name: db.client.connections.timeouts
metric_name: db.client.connection.timeouts
brief: "The number of connection timeouts that have occurred trying to obtain a connection from the pool"
instrument: counter
unit: "{timeout}"
attributes:
- ref: pool.name

- id: metric.db.client.connections.create_time
- id: metric.db.client.connection.create_time
type: metric
metric_name: db.client.connections.create_time
metric_name: db.client.connection.create_time
brief: "The time it took to create a new connection"
instrument: histogram
unit: "ms"
attributes:
- ref: pool.name

- id: metric.db.client.connections.wait_time
- id: metric.db.client.connection.wait_time
type: metric
metric_name: db.client.connections.wait_time
metric_name: db.client.connection.wait_time
brief: "The time it took to obtain an open connection from the pool"
instrument: histogram
unit: "ms"
attributes:
- ref: pool.name

- id: metric.db.client.connections.use_time
- id: metric.db.client.connection.use_time
type: metric
metric_name: db.client.connections.use_time
metric_name: db.client.connection.use_time
brief: "The time between borrowing a connection and returning it to the pool"
instrument: histogram
unit: "ms"
Expand Down
11 changes: 11 additions & 0 deletions schema-next.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,17 @@ versions:
- jvm.buffer.usage
- jvm.buffer.limit
- jvm.buffer.count
# https://github.com/open-telemetry/semantic-conventions/pull/259
- rename_metrics:
db.client.connections.usage: db.client.connection.usage
db.client.connections.idle.max: db.client.connection.idle.max
db.client.connections.idle.min: db.client.connection.idle.min
db.client.connections.max: db.client.connection.max
db.client.connections.pending_requests: db.client.connection.pending_requests
db.client.connections.timeouts: db.client.connection.timeouts
db.client.connections.create_time: db.client.connection.create_time
db.client.connections.wait_time: db.client.connection.wait_time
db.client.connections.use_time: db.client.connection.use_time
1.21.0:
spans:
changes:
Expand Down