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

Moved system metrics semconv #154

Merged
merged 1 commit into from
Jul 3, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions specification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Semantic Conventions are defined for the following areas:
* [Exceptions](exceptions/README.md): Semantic Conventions for Exceptions.
* [HTTP](http/README.md): Semantic Conventions for HTTP client and server operations.
* [Database](database/README.md): Semantic Conventions for database operations.
* [System](system/README.md): System Semantic Conventions.
* *Other areas can be found in the signal specific Semantic Conventions below*

Semantic Conventions by signals:
Expand Down
9 changes: 5 additions & 4 deletions specification/general/metrics-general.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ The following semantic conventions surrounding metrics are defined:
* [HTTP](/specification/http/http-metrics.md): For HTTP client and server metrics.
* [RPC](/specification/metrics/semantic_conventions/rpc-metrics.md): For RPC client and server metrics.
* [Database](/specification/database/database-metrics.md): For SQL and NoSQL client metrics.
* [System](/specification/metrics/semantic_conventions/system-metrics.md): For standard system metrics.
* [Process](/specification/metrics/semantic_conventions/process-metrics.md): For standard process metrics.
* [Runtime Environment](/specification/metrics/semantic_conventions/runtime-environment-metrics.md): For runtime environment metrics.
* [FaaS](/specification/metrics/semantic_conventions/faas-metrics.md): For [Function as a Service](https://en.wikipedia.org/wiki/Function_as_a_service) metrics.
* [Hardware](/specification/metrics/semantic_conventions/hardware-metrics.md): For hardware-related metrics.
* **System metrics**
* [System](/specification/system/system-metrics.md): For standard system metrics.
* [Hardware](/specification/system/hardware-metrics.md): For hardware-related metrics.
* [Process](/specification/system/process-metrics.md): For standard process metrics.
* [Runtime Environment](/specification/system/runtime-environment-metrics.md): For runtime environment metrics.

Apart from semantic conventions for metrics, [traces](trace-general.md), [logs](logs-general.md), and [events](events-general.md), OpenTelemetry also
defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/resource/sdk.md) with
Expand Down
14 changes: 14 additions & 0 deletions specification/system/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# System semantic conventions

**Status**: [Experimental][DocumentStatus]

This document defines semantic conventions for systems (such as processes, runtimes, hardware, etc.).

System semantic conventions are defined for the following metrics:

* [System](system-metrics.md): For standard system metrics.
* [Hardware](hardware-metrics.md): For hardware-related metrics.
* [Process](process-metrics.md): For standard process metrics.
* [Runtime Environment](runtime-environment-metrics.md): For runtime environment metrics.

[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ when creating instruments not explicitly defined in the specification.

## Common hardware attributes

All metrics in `hw.` instruments should be attached to a [Host Resource](../../resource/semantic_conventions/host.md)
All metrics in `hw.` instruments should be attached to a [Host Resource](/specification/resource/semantic_conventions/host.md)
and therefore inherit its attributes, like `host.id` and `host.name`.

Additionally, all metrics in `hw.` instruments have the following attributes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ Below is a table of Process metric instruments.

## Attributes

Process metrics SHOULD be associated with a [`process`](../../resource/semantic_conventions/process.md#process) resource whose attributes provide additional context about the process.
Process metrics SHOULD be associated with a [`process`](/specification/resource/semantic_conventions/process.md#process) resource whose attributes provide additional context about the process.

[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ consider, for example pthreads vs green thread implementations.

## Attributes

[`process.runtime`](../../resource/semantic_conventions/process.md#process-runtimes) resource attributes SHOULD be included on runtime metric events as appropriate.
[`process.runtime`](/specification/resource/semantic_conventions/process.md#process-runtimes) resource attributes SHOULD be included on runtime metric events as appropriate.

## JVM Metrics

Expand Down