diff --git a/.chloggen/fix_connections_count.yaml b/.chloggen/fix_connections_count.yaml new file mode 100644 index 0000000000..388032448b --- /dev/null +++ b/.chloggen/fix_connections_count.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: system + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Changes system.network.connections to system.network.connection.count + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [1800] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index e9604f12e4..30e7293622 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -53,7 +53,7 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam - [Metric: `system.network.packets`](#metric-systemnetworkpackets) - [Metric: `system.network.errors`](#metric-systemnetworkerrors) - [Metric: `system.network.io`](#metric-systemnetworkio) - - [Metric: `system.network.connections`](#metric-systemnetworkconnections) + - [Metric: `system.network.connection.count`](#metric-systemnetworkconnectioncount) - [Aggregate system process metrics](#aggregate-system-process-metrics) - [Metric: `system.process.count`](#metric-systemprocesscount) - [Metric: `system.process.created`](#metric-systemprocesscreated) @@ -1026,11 +1026,11 @@ This metric is [recommended][MetricRecommended]. -### Metric: `system.network.connections` +### Metric: `system.network.connection.count` This metric is [recommended][MetricRecommended]. - + @@ -1039,7 +1039,7 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | -| `system.network.connections` | UpDownCounter | `{connection}` | | ![Development](https://img.shields.io/badge/-development-blue) | `host` | +| `system.network.connection.count` | UpDownCounter | `{connection}` | | ![Development](https://img.shields.io/badge/-development-blue) | `host` | | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| diff --git a/model/system/deprecated/metrics-deprecated.yaml b/model/system/deprecated/metrics-deprecated.yaml new file mode 100644 index 0000000000..0d192f7559 --- /dev/null +++ b/model/system/deprecated/metrics-deprecated.yaml @@ -0,0 +1,17 @@ +groups: + - id: metric.system.network.connections + type: metric + metric_name: system.network.connections + stability: development + deprecated: + reason: renamed + renamed_to: system.network.connection.count + brief: "Deprecated, use `system.network.connection.count` instead" + instrument: updowncounter + unit: "{connection}" + attributes: + - ref: network.interface.name + - ref: network.connection.state + - ref: network.transport + entity_associations: + - host diff --git a/model/system/metrics.yaml b/model/system/metrics.yaml index 0908e0f415..9d358d3d85 100644 --- a/model/system/metrics.yaml +++ b/model/system/metrics.yaml @@ -399,9 +399,9 @@ groups: entity_associations: - host - - id: metric.system.network.connections + - id: metric.system.network.connection.count type: metric - metric_name: system.network.connections + metric_name: system.network.connection.count stability: development brief: "" instrument: updowncounter diff --git a/schema-next.yaml b/schema-next.yaml index 4b6d3b1b4b..5c630f0bdd 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -2,6 +2,11 @@ file_format: 1.1.0 schema_url: https://opentelemetry.io/schemas/next versions: next: + metrics: + changes: + # https://github.com/open-telemetry/semantic-conventions/issues/1800 + - rename_metrics: + system.network.connections: system.network.connection.count attributes: changes: # https://github.com/open-telemetry/semantic-conventions/pull/1698