From 3a965d977d550eceb9dbb9bb99491f112453eb7f Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Wed, 8 Jul 2020 17:38:14 +0200 Subject: [PATCH 01/10] Run markdown-toc on current file --- specification/resource/semantic_conventions/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index f9db5041620..3005352a024 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -3,6 +3,12 @@ This document defines standard attributes for resources. These attributes are typically used in the [Resource](../sdk.md) and are also recommended to be used anywhere else where there is a need to describe a resource in a consistent manner. The majority of these attributes are inherited from [OpenCensus Resource standard](https://github.com/census-instrumentation/opencensus-specs/blob/master/resource/StandardResources.md). + + + + +- [TODOs](#todos) + * [Document Conventions](#document-conventions) - [Service](#service) - [Telemetry SDK](#telemetry-sdk) - [Compute Unit](#compute-unit) @@ -15,6 +21,7 @@ This document defines standard attributes for resources. These attributes are ty * [Host](#host) - [Environment](#environment) * [Cloud](#cloud) +- [Version Attributes](#version-attributes) From 1c2b94494b90aa657a49c3980da5aa450bd8a21c Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Wed, 8 Jul 2020 18:15:08 +0200 Subject: [PATCH 02/10] Fix markdown --- specification/resource/semantic_conventions/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 3005352a024..9efa417df50 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -105,6 +105,7 @@ Attributes defining a compute unit (e.g. Container, Process, Function as a Servi | container.image.tag | Container image tag. | `0.1` | [identify Docker containers]: https://docs.docker.com/engine/reference/run/#container-identification + ### Function as a Service **type:** `faas` From 02230e096b64ef03dc0234c6189e591c412e13a5 Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Wed, 8 Jul 2020 18:53:58 +0200 Subject: [PATCH 03/10] Add resource semantic conventions for operating systems --- CHANGELOG.md | 6 +++++ .../resource/semantic_conventions/README.md | 27 ++++++++++++++++++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47b2e21bc9e..ebfc65420cd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ the release. ## Unreleased +New: + +- Add resource semantic conventions for operating systems ([#693](https://github.com/open-telemetry/opentelemetry-specification/pull/693)) + +Updates: + ## v0.6.0 (07-01-2020) New: diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 9efa417df50..07dbb8dd36d 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -180,7 +180,32 @@ Attributes defining a computing instance (e.g. host). ## Environment -Attributes defining a running environment (e.g. Cloud, Data Center). +Attributes defining a running environment (e.g. Operating System, Cloud, Data Center). + +### Operating System + +**type:** `os` + +**Description**: The operating system (OS) on which the process represented by this resource is running. + +In case of virtualized environments, this is the operating system as it is observed by the process, i.e., the virtualized guest rather than the underlying host. + +| Attribute | Type | Description | Example | Required | +|---|---|---|---|---| +| `os.type` | string | The operating system type. | `"WINDOWS"` | Yes | +| `os.description` | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `"Microsoft Windows [Version 10.0.18363.778]"`
`"Ubuntu 18.04.1 LTS"` | No | + +`os.type` MUST be one of the following or, if none of the listed values apply, a custom value: + +| Value | Description | +|---|---| +| `WINDOWS` | Microsoft Windows | +| `LINUX` | Linux | +| `DARWIN` | Apple Darwin | +| `HPUX` | HP-UX (Hewlett Packard Unix) | +| `AIX` | AIX (Advanced Interactive eXecutive) | +| `SOLARIS` | Oracle Solaris | +| `ZOS` | IBM z/OS | ### Cloud From 97471a738915873a5a2d8c2dcbd5f29c38a166e3 Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Wed, 8 Jul 2020 19:04:07 +0200 Subject: [PATCH 04/10] Update TOC --- specification/resource/semantic_conventions/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 07dbb8dd36d..096ebfb438f 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -20,6 +20,7 @@ This document defines standard attributes for resources. These attributes are ty - [Compute Instance](#compute-instance) * [Host](#host) - [Environment](#environment) + * [Operating System](#operating-system) * [Cloud](#cloud) - [Version Attributes](#version-attributes) From 7411b493b138a4d97f62c650560d2bef4e6585db Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Thu, 9 Jul 2020 09:56:31 +0200 Subject: [PATCH 05/10] Wording --- specification/resource/semantic_conventions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 096ebfb438f..2e8f415fd42 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -196,7 +196,7 @@ In case of virtualized environments, this is the operating system as it is obser | `os.type` | string | The operating system type. | `"WINDOWS"` | Yes | | `os.description` | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `"Microsoft Windows [Version 10.0.18363.778]"`
`"Ubuntu 18.04.1 LTS"` | No | -`os.type` MUST be one of the following or, if none of the listed values apply, a custom value: +`os.type` MUST be one of the following or, if none of the listed values apply, a custom value best describing the family the operating system belongs to: | Value | Description | |---|---| From 2fe2218da802890835494bd6bd99ebd719129d88 Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Fri, 10 Jul 2020 10:25:15 +0200 Subject: [PATCH 06/10] Add BSD --- specification/resource/semantic_conventions/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 2e8f415fd42..64aef461eb5 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -203,6 +203,7 @@ In case of virtualized environments, this is the operating system as it is obser | `WINDOWS` | Microsoft Windows | | `LINUX` | Linux | | `DARWIN` | Apple Darwin | +| `BSD` | BSD (Berkeley Software Distribution) family | | `HPUX` | HP-UX (Hewlett Packard Unix) | | `AIX` | AIX (Advanced Interactive eXecutive) | | `SOLARIS` | Oracle Solaris | From f0cb9cbfbe16df09e6e1e7036bfa3208bac5921d Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Fri, 10 Jul 2020 10:25:32 +0200 Subject: [PATCH 07/10] Soften pre-defined value requirement --- specification/resource/semantic_conventions/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 64aef461eb5..e46f067253b 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -196,7 +196,8 @@ In case of virtualized environments, this is the operating system as it is obser | `os.type` | string | The operating system type. | `"WINDOWS"` | Yes | | `os.description` | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `"Microsoft Windows [Version 10.0.18363.778]"`
`"Ubuntu 18.04.1 LTS"` | No | -`os.type` MUST be one of the following or, if none of the listed values apply, a custom value best describing the family the operating system belongs to: +`os.type` SHOULD be set to one of the values listed below. +If none of the listed values apply, a custom value best describing the family the operating system belongs to CAN be used. | Value | Description | |---|---| From 4d0e81b9f112328387d820cbdaef51ccb61e1b42 Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Mon, 13 Jul 2020 12:07:55 +0200 Subject: [PATCH 08/10] Add BSD descendants directly instead of family --- specification/resource/semantic_conventions/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index e46f067253b..3a0568f81c2 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -204,7 +204,10 @@ If none of the listed values apply, a custom value best describing the family th | `WINDOWS` | Microsoft Windows | | `LINUX` | Linux | | `DARWIN` | Apple Darwin | -| `BSD` | BSD (Berkeley Software Distribution) family | +| `FREEBSD` | FreeBSD | +| `NETBSD` | NetBSD| +| `OPENBSD` | OpenBSD | +| `DRAGONFLY_BSD` | DragonFly BSD | | `HPUX` | HP-UX (Hewlett Packard Unix) | | `AIX` | AIX (Advanced Interactive eXecutive) | | `SOLARIS` | Oracle Solaris | From 91130a8b06ff523ab7c98ec8ddd7f3471cdc3b70 Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Mon, 13 Jul 2020 13:27:30 +0200 Subject: [PATCH 09/10] DRAGONFLY_BSD -> DRAGONFLYBSD MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Christian Neumüller --- specification/resource/semantic_conventions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 6e072eff047..f59e742029b 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -207,7 +207,7 @@ If none of the listed values apply, a custom value best describing the family th | `FREEBSD` | FreeBSD | | `NETBSD` | NetBSD| | `OPENBSD` | OpenBSD | -| `DRAGONFLY_BSD` | DragonFly BSD | +| `DRAGONFLYBSD` | DragonFly BSD | | `HPUX` | HP-UX (Hewlett Packard Unix) | | `AIX` | AIX (Advanced Interactive eXecutive) | | `SOLARIS` | Oracle Solaris | From 759acf768f22f7b1e72b0d185498affa6a946ada Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Tue, 14 Jul 2020 14:24:04 +0200 Subject: [PATCH 10/10] Fix section hierarchy --- specification/resource/semantic_conventions/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index f59e742029b..1b641bfd308 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -8,7 +8,7 @@ This document defines standard attributes for resources. These attributes are ty - [TODOs](#todos) - * [Document Conventions](#document-conventions) +- [Document Conventions](#document-conventions) - [Service](#service) - [Telemetry SDK](#telemetry-sdk) - [Compute Unit](#compute-unit) @@ -34,7 +34,7 @@ This document defines standard attributes for resources. These attributes are ty * Consider to add optional/required for each attribute and combination of attributes (e.g when supplying a k8s resource all k8s may be required). -### Document Conventions +## Document Conventions Attributes are grouped logically by the type of the concept that they described. Attributes in the same group have a common prefix that ends with a dot. For example all attributes that describe Kubernetes properties start with "k8s."