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.

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

Adding os.build_id resource attribute and discussion why os.sdk.version isn't required #293

Merged
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ release.
([#252](https://github.com/open-telemetry/semantic-conventions/pull/252))
- Simplify HTTP metric briefs.
([#276](https://github.com/open-telemetry/semantic-conventions/pull/276))
- Added `os.build` and `os.sdk_version` resource attributes.
([#293](https://github.com/open-telemetry/semantic-conventions/pull/293))

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

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ key, but non-obvious, aspects:
- All descriptions, normative language are defined in the `docs/`
directory.
- We provide tooling to generate Markdown documentation from the formal
YAML definitons. See [Yaml to Markdown](#yaml-to-markdown).
YAML definitons. See [Yaml to Markdown](#yaml-to-markdown).
- We use Hugo to render [semantic conventions on our website](https://opentelemetry.io/docs/specs/semconv/).
You will see `<!--- Hugo front matter used to generate ...` sections
in markdown. See [Hugo frontmatter](#hugo-frontmatter) for details.
in markdown. See [Hugo frontmatter](#hugo-frontmatter) for details.
- All changes to existing attributes, metrics, etc. MUST be allowed as
per our [stability guarantees](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/versioning-and-stability.md#semantic-conventions-stability) and
defined in a schema file. As part of any contribution, you should
defined in a schema file. As part of any contribution, you should
include attribute changes defined in the `schema-next.yaml` file.
For details, please read [the schema specification](https://opentelemetry.io/docs/specs/otel/schemas/).
- After creating a pull request, please update the [CHANGELOG](CHANGELOG.md) file with
a description of your changes.

Please make sure all Pull Requests are compliant with these rules!

### Hugo frontmatter
Expand Down
4 changes: 3 additions & 1 deletion docs/resource/os.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ In case of virtualized environments, this is the operating system as it is obser
| `os.type` | string | The operating system type. | `windows` | Required |
| `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` | Recommended |
| `os.name` | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | Recommended |
| `os.version` | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` | Recommended |
| `os.version` | string | The major version string of the operating system. Additionally, build numbers can be added in os.build attribute. | `14.2.1`; `18.04.1` | Recommended |
surbhiia marked this conversation as resolved.
Show resolved Hide resolved
| `os.build` | string | Unique identifier for a particular build or compilation of software. | `TQ3C.230805.001.B2`; `20E247` | Recommended |
| `os.sdk_version` | string | Identifies the set of development tools and APIs used for building the software. | `26`; `6.1.1` | Recommended |
surbhiia marked this conversation as resolved.
Show resolved Hide resolved

`os.type` 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.

Expand Down
12 changes: 10 additions & 2 deletions model/resource/os.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ groups:
- id: version
type: string
brief: >
The version string of the operating system as defined in
[Version Attributes](/docs/resource/README.md#version-attributes).
The major version string of the operating system.
Additionally, build numbers can be added in os.build attribute.
examples: ['14.2.1', '18.04.1']
- id: build
surbhiia marked this conversation as resolved.
Show resolved Hide resolved
type: string
brief: 'Unique identifier for a particular build or compilation of software.'
examples: ['TQ3C.230805.001.B2', '20E247']
- id: sdk_version
type: string
brief: 'Identifies the set of development tools and APIs used for building the software.'
examples: ['26', '6.1.1']
Loading