From 2c30cf69fe005c1c6cc2fdbbda755b317cc7db74 Mon Sep 17 00:00:00 2001 From: jason plumb <75337021+breedx-splk@users.noreply.github.com> Date: Thu, 5 Oct 2023 08:04:22 -0700 Subject: [PATCH 1/4] Add semconv-mobile-approvers (#368) Co-authored-by: Armin Ruech --- .github/CODEOWNERS | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 0c016ce011..f541bc6faa 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -41,4 +41,8 @@ /docs/resource/host.md @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-system-approvers /model/resource/host.yaml @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-system-approvers +# Mobile semantic conventions approvers +/docs/mobile/ @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-mobile-approvers +/model/logs/mobile* @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-mobile-approvers + # TODO - Add semconv area experts From 5436da468d5b5f1889ef90ccba800ef65d6a429e Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Fri, 6 Oct 2023 05:29:07 -0700 Subject: [PATCH 2/4] Improve HTTP metric briefs (#366) Co-authored-by: Joao Grassi --- CHANGELOG.md | 2 ++ docs/http/http-metrics.md | 14 +++++++------- model/metrics/http.yaml | 14 +++++++------- 3 files changed, 16 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5e010a3da2..7f766e2eb8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -132,6 +132,8 @@ release. - BREAKING: Rename `telemetry.auto.version` resource attribute to `telemetry.distro.version` and add `telemetry.distro.name` resource attribute ([#178](https://github.com/open-telemetry/semantic-conventions/pull/178)) +- Improve HTTP metric briefs. + ([#366](https://github.com/open-telemetry/semantic-conventions/pull/366)) ## v1.21.0 (2023-07-13) diff --git a/docs/http/http-metrics.md b/docs/http/http-metrics.md index c406fa9e9e..e90b3d9249 100644 --- a/docs/http/http-metrics.md +++ b/docs/http/http-metrics.md @@ -70,7 +70,7 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `http.server.request.duration` | Histogram | `s` | Measures the duration of inbound HTTP requests. | +| `http.server.request.duration` | Histogram | `s` | Duration of HTTP server requests. | @@ -172,7 +172,7 @@ This metric is optional. | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `http.server.active_requests` | UpDownCounter | `{request}` | Measures the number of concurrent HTTP requests that are currently in-flight. | +| `http.server.active_requests` | UpDownCounter | `{request}` | Number of active HTTP server requests. | @@ -240,7 +240,7 @@ This metric is optional. | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `http.server.request.body.size` | Histogram | `By` | Measures the size of HTTP request messages. [1] | +| `http.server.request.body.size` | Histogram | `By` | Size of HTTP server request bodies. [1] | **[1]:** The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. @@ -344,7 +344,7 @@ This metric is optional. | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `http.server.response.body.size` | Histogram | `By` | Measures the size of HTTP response messages. [1] | +| `http.server.response.body.size` | Histogram | `By` | Size of HTTP server response bodies. [1] | **[1]:** The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. @@ -456,7 +456,7 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `http.client.request.duration` | Histogram | `s` | Measures the duration of outbound HTTP requests. | +| `http.client.request.duration` | Histogram | `s` | Duration of HTTP client requests. | @@ -549,7 +549,7 @@ This metric is optional. | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `http.client.request.body.size` | Histogram | `By` | Measures the size of HTTP request messages. [1] | +| `http.client.request.body.size` | Histogram | `By` | Size of HTTP client request bodies. [1] | **[1]:** The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. @@ -644,7 +644,7 @@ This metric is optional. | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `http.client.response.body.size` | Histogram | `By` | Measures the size of HTTP response messages. [1] | +| `http.client.response.body.size` | Histogram | `By` | Size of HTTP client response bodies. [1] | **[1]:** The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. diff --git a/model/metrics/http.yaml b/model/metrics/http.yaml index 8e6f350929..89c54cb2c6 100644 --- a/model/metrics/http.yaml +++ b/model/metrics/http.yaml @@ -92,7 +92,7 @@ groups: - id: metric.http.server.request.duration type: metric metric_name: http.server.request.duration - brief: "Measures the duration of inbound HTTP requests." + brief: "Duration of HTTP server requests." instrument: histogram unit: "s" extends: metric_attributes.http.server @@ -100,7 +100,7 @@ groups: - id: metric.http.server.active_requests type: metric metric_name: http.server.active_requests - brief: "Measures the number of concurrent HTTP requests that are currently in-flight." + brief: "Number of active HTTP server requests." instrument: updowncounter unit: "{request}" attributes: @@ -138,7 +138,7 @@ groups: - id: metric.http.server.request.body.size type: metric metric_name: http.server.request.body.size - brief: "Measures the size of HTTP request messages." + brief: "Size of HTTP server request bodies." instrument: histogram unit: "By" note: > @@ -150,7 +150,7 @@ groups: - id: metric.http.server.response.body.size type: metric metric_name: http.server.response.body.size - brief: "Measures the size of HTTP response messages." + brief: "Size of HTTP server response bodies." instrument: histogram unit: "By" note: > @@ -162,7 +162,7 @@ groups: - id: metric.http.client.request.duration type: metric metric_name: http.client.request.duration - brief: "Measures the duration of outbound HTTP requests." + brief: "Duration of HTTP client requests." instrument: histogram unit: "s" extends: metric_attributes.http.client @@ -170,7 +170,7 @@ groups: - id: metric.http.client.request.body.size type: metric metric_name: http.client.request.body.size - brief: "Measures the size of HTTP request messages." + brief: "Size of HTTP client request bodies." instrument: histogram unit: "By" note: > @@ -182,7 +182,7 @@ groups: - id: metric.http.client.response.body.size type: metric metric_name: http.client.response.body.size - brief: "Measures the size of HTTP response messages." + brief: "Size of HTTP client response bodies." instrument: histogram unit: "By" note: > From 0af7e0efee513e0d0d075646301752bb9571cece Mon Sep 17 00:00:00 2001 From: Pablo Baeyens Date: Mon, 9 Oct 2023 07:28:44 +0200 Subject: [PATCH 3/4] [resource/host] Add semantic convention for IP addresses of a host (#203) Co-authored-by: Alexander Wert --- CHANGELOG.md | 2 ++ docs/resource/host.md | 3 +++ model/resource/host.yaml | 10 ++++++++++ 3 files changed, 15 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f766e2eb8..d823481daa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -134,6 +134,8 @@ release. ([#178](https://github.com/open-telemetry/semantic-conventions/pull/178)) - Improve HTTP metric briefs. ([#366](https://github.com/open-telemetry/semantic-conventions/pull/366)) +- Add `host.ip` resource attribute convention. + ([#203](https://github.com/open-telemetry/semantic-conventions/pull/203)) ## v1.21.0 (2023-07-13) diff --git a/docs/resource/host.md b/docs/resource/host.md index f216a78c92..77c7a707af 100644 --- a/docs/resource/host.md +++ b/docs/resource/host.md @@ -17,9 +17,12 @@ To report host metrics, the `system.*` namespace SHOULD be used. | `host.image.id` | string | VM image ID or host OS image ID. For Cloud, this value is from the provider. | `ami-07b06b442921831e5` | Recommended | | `host.image.name` | string | Name of the VM image or OS install the host was instantiated from. | `infra-ami-eks-worker-node-7d4ec78312`; `CentOS-8-x86_64-1905` | Recommended | | `host.image.version` | string | The version string of the VM image or host OS as defined in [Version Attributes](README.md#version-attributes). | `0.1` | Recommended | +| `host.ip` | string[] | Available IP addresses of the host, excluding loopback interfaces. [1] | `[192.168.1.140, fe80::abc2:4a28:737a:609e]` | Opt-In | | `host.name` | string | Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user. | `opentelemetry-test` | Recommended | | `host.type` | string | Type of host. For Cloud, this must be the machine type. | `n1-standard-1` | Recommended | +**[1]:** IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format. + `host.arch` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used. | Value | Description | diff --git a/model/resource/host.yaml b/model/resource/host.yaml index 2839d8f660..141ccd76bf 100644 --- a/model/resource/host.yaml +++ b/model/resource/host.yaml @@ -70,6 +70,16 @@ groups: The version string of the VM image or host OS as defined in [Version Attributes](README.md#version-attributes). examples: ['0.1'] + - id: ip + type: string[] + requirement_level: opt_in + brief: > + Available IP addresses of the host, excluding loopback interfaces. + note: > + IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses + MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format. + examples: ["192.168.1.140", "fe80::abc2:4a28:737a:609e"] + - id: host.cpu prefix: host.cpu type: resource From 4efa49f4e87254eea9c666541897883911f1eac1 Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Sun, 8 Oct 2023 22:35:41 -0700 Subject: [PATCH 4/4] Require two approvals from different companies before merging the PR (#364) Co-authored-by: Alexander Wert --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3bfe45c930..782fb79ca9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,6 +157,23 @@ To quickly fix typos, use make misspell-correction ``` +### How to get your PR merged + +A PR (pull request) is considered to be **ready to merge** when: + +* It has received at least two approvals from the [code + owners](./.github/CODEOWNERS) (if approvals are from only one company, they + won't count). +* There is no `request changes` from the [code owners](./.github/CODEOWNERS). +* It has been at least two working days since the last modification (except for + the trivial updates, such like typo, cosmetic, rebase, etc.). This gives + people reasonable time to review. +* Trivial changes (typos, cosmetic changes, CI improvements, etc.) don't have to + wait for two days. + +Any [maintainer](./README.md#contributing) can merge the PR once it is **ready +to merge**. + ## Updating the referenced specification version 1. Open the `./internal/tools/update_specification_version.sh` script.