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

Jump to bottom

Add resource semantic conventions for operating systems #693

Merged
merged 11 commits into from
Jul 15, 2020
Merged

Add resource semantic conventions for operating systems #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3a965d9
Run markdown-toc on current file
arminru Jul 8, 2020
1c2b944
Fix markdown
arminru Jul 8, 2020
02230e0
Add resource semantic conventions for operating systems
arminru Jul 8, 2020
97471a7
Update TOC
arminru Jul 8, 2020
7411b49
Wording
arminru Jul 9, 2020
2fe2218
Add BSD
arminru Jul 10, 2020
f0cb9cb
Soften pre-defined value requirement
arminru Jul 10, 2020
4d0e81b
Add BSD descendants directly instead of family
arminru Jul 13, 2020
b34a54c
Merge branch 'master' into semconv-resource-os
arminru Jul 13, 2020
91130a8
DRAGONFLY_BSD -> DRAGONFLYBSD
arminru Jul 13, 2020
759acf7
Fix section hierarchy
arminru Jul 14, 2020
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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- Add semantic convention for NGINX custom HTTP 499 status code.

## v0.6.0 (07-01-2020)
Expand All @@ -21,6 +27,7 @@ New:
- Add peer.service to provide a user-configured name for a remote service ([#652](https://github.com/open-telemetry/opentelemetry-specification/pull/652))

Updates:

- Improve root Span description ([#645](https://github.com/open-telemetry/opentelemetry-specification/pull/645))
- Extend semantic conventions for RPC and allow non-gRPC calls ([#604](https://github.com/open-telemetry/opentelemetry-specification/pull/604))
- Revise and extend semantic conventions for databases ([#575](https://github.com/open-telemetry/opentelemetry-specification/pull/575))
Expand Down
43 changes: 41 additions & 2 deletions specification/resource/semantic_conventions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->

<!-- toc -->

- [TODOs](#todos)
- [Document Conventions](#document-conventions)
- [Service](#service)
- [Telemetry SDK](#telemetry-sdk)
- [Compute Unit](#compute-unit)
Expand All @@ -14,7 +20,9 @@ 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)

<!-- tocstop -->

Expand All @@ -26,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."

Expand Down Expand Up @@ -98,6 +106,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`
Expand Down Expand Up @@ -172,7 +181,37 @@ 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]"`<br>`"Ubuntu 18.04.1 LTS"` | No |

`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 |
|---|---|
| `WINDOWS` | Microsoft Windows |
| `LINUX` | Linux |
arminru marked this conversation as resolved.
Show resolved Hide resolved
| `DARWIN` | Apple Darwin |
| `FREEBSD` | FreeBSD |
| `NETBSD` | NetBSD|
| `OPENBSD` | OpenBSD |
| `DRAGONFLYBSD` | DragonFly BSD |
| `HPUX` | HP-UX (Hewlett Packard Unix) |
| `AIX` | AIX (Advanced Interactive eXecutive) |
| `SOLARIS` | Oracle Solaris |
| `ZOS` | IBM z/OS |

### Cloud

Expand Down