Move runtime semconv to its own folder (#371)
This commit is contained in:
parent
4efa49f4e8
commit
559bf8bd66
|
|
@ -35,7 +35,7 @@ The following semantic conventions surrounding metrics are defined:
|
||||||
* [System](/docs/system/system-metrics.md): For standard system metrics.
|
* [System](/docs/system/system-metrics.md): For standard system metrics.
|
||||||
* [Hardware](/docs/system/hardware-metrics.md): For hardware-related metrics.
|
* [Hardware](/docs/system/hardware-metrics.md): For hardware-related metrics.
|
||||||
* [Process](/docs/system/process-metrics.md): For standard process metrics.
|
* [Process](/docs/system/process-metrics.md): For standard process metrics.
|
||||||
* [Runtime Environment](/docs/system/runtime-environment-metrics.md): For runtime environment metrics.
|
* [Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics.
|
||||||
|
|
||||||
Apart from semantic conventions for metrics, [traces](trace.md), [logs](logs.md), and [events](events.md), OpenTelemetry also
|
Apart from semantic conventions for metrics, [traces](trace.md), [logs](logs.md), and [events](events.md), OpenTelemetry also
|
||||||
defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/resource/sdk.md) with
|
defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/resource/sdk.md) with
|
||||||
|
|
|
||||||
|
|
@ -1,28 +1,24 @@
|
||||||
<!--- Hugo front matter used to generate the website version of this page:
|
<!--- Hugo front matter used to generate the website version of this page:
|
||||||
linkTitle: Runtime Environment
|
linkTitle: Semantic Conventions for Runtime Environment
|
||||||
--->
|
--->
|
||||||
|
|
||||||
# Semantic Conventions for Runtime Environment Metrics
|
# Semantic Conventions for Runtime Environment
|
||||||
|
|
||||||
**Status**: [Experimental][DocumentStatus]
|
**Status**: [Experimental][DocumentStatus]
|
||||||
|
|
||||||
This document includes semantic conventions for runtime environment level
|
This document defines semantic conventions for
|
||||||
metrics in OpenTelemetry. Also consider the [general
|
runtime environment spans, metrics and logs.
|
||||||
metric](/docs/general/metrics.md#general-metric-semantic-conventions), [system
|
|
||||||
metrics](system-metrics.md) and [OS Process metrics](process-metrics.md)
|
|
||||||
semantic conventions when instrumenting runtime environments.
|
|
||||||
|
|
||||||
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
|
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
|
||||||
|
|
||||||
<!-- toc -->
|
<!-- toc -->
|
||||||
|
|
||||||
- [Metric Instruments](#metric-instruments)
|
- [Metrics](#metrics)
|
||||||
* [Runtime Environment Specific Metrics - `process.runtime.{environment}.`](#runtime-environment-specific-metrics---processruntimeenvironment)
|
* [Attributes](#attributes)
|
||||||
- [Attributes](#attributes)
|
|
||||||
|
|
||||||
<!-- tocstop -->
|
<!-- tocstop -->
|
||||||
|
|
||||||
## Metric Instruments
|
## Metrics
|
||||||
|
|
||||||
Runtime environments vary widely in their terminology, implementation, and
|
Runtime environments vary widely in their terminology, implementation, and
|
||||||
relative values for a given metric. For example, Go and Python are both
|
relative values for a given metric. For example, Go and Python are both
|
||||||
|
|
@ -32,26 +28,30 @@ does not propose any standard top-level runtime metric instruments. See [OTEP
|
||||||
108](https://github.com/open-telemetry/oteps/pull/108/files) for additional
|
108](https://github.com/open-telemetry/oteps/pull/108/files) for additional
|
||||||
discussion.
|
discussion.
|
||||||
|
|
||||||
### Runtime Environment Specific Metrics - `process.runtime.{environment}.`
|
|
||||||
|
|
||||||
Metrics specific to a certain runtime environment should be prefixed with
|
Metrics specific to a certain runtime environment should be prefixed with
|
||||||
`process.runtime.{environment}.` and follow the semantic conventions outlined in
|
the runtime's top-level namespace `{environment}.*`, e.g., `jvm.*` and follow the
|
||||||
[general metric semantic
|
[general metric semantic convention guidelines](/docs/general/metrics.md#general-metric-semantic-conventions).
|
||||||
conventions](/docs/general/metrics.md#general-metric-semantic-conventions). Authors of
|
|
||||||
runtime instrumentations are responsible for the choice of `{environment}` to
|
Authors of runtime instrumentations are responsible for the choice of
|
||||||
avoid ambiguity when interpreting a metric's name or values.
|
`{environment}` to avoid ambiguity when interpreting a metric's name or values.
|
||||||
|
|
||||||
For example, some programming languages have multiple runtime environments
|
For example, some programming languages have multiple runtime environments
|
||||||
that vary significantly in their implementation, like [Python which has many
|
that vary significantly in their implementation, like [Python which has many
|
||||||
implementations](https://wiki.python.org/moin/PythonImplementations). For
|
implementations](https://wiki.python.org/moin/PythonImplementations). For
|
||||||
such languages, consider using specific `{environment}` prefixes to avoid
|
such languages, consider using specific `{environment}` prefixes to avoid
|
||||||
ambiguity, like `process.runtime.cpython.` and `process.runtime.pypy.`.
|
ambiguity, like `cpython.*` and `pypy.*`.
|
||||||
|
|
||||||
There are other dimensions even within a given runtime environment to
|
Also consider the
|
||||||
consider, for example pthreads vs green thread implementations.
|
[general metrics](/docs/general/metrics.md#general-metric-semantic-conventions),
|
||||||
|
[system metrics](/docs/system/system-metrics.md) and
|
||||||
|
[OS process metrics](/docs/system/process-metrics.md)
|
||||||
|
semantic conventions when instrumenting runtime environments.
|
||||||
|
|
||||||
## Attributes
|
- [JVM](jvm-metrics.md)
|
||||||
|
|
||||||
[`process.runtime`](/docs/resource/process.md#process-runtimes) resource attributes SHOULD be included on runtime metric events as appropriate.
|
### Attributes
|
||||||
|
|
||||||
|
[`process.runtime`](/docs/resource/process.md#process-runtimes)
|
||||||
|
resource attributes SHOULD be included on runtime metric events as appropriate.
|
||||||
|
|
||||||
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/document-status.md
|
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/document-status.md
|
||||||
|
|
@ -16,6 +16,6 @@ System semantic conventions are defined for the following metrics:
|
||||||
* [System](system-metrics.md): For standard system metrics.
|
* [System](system-metrics.md): For standard system metrics.
|
||||||
* [Hardware](hardware-metrics.md): For hardware-related metrics.
|
* [Hardware](hardware-metrics.md): For hardware-related metrics.
|
||||||
* [Process](process-metrics.md): For standard process metrics.
|
* [Process](process-metrics.md): For standard process metrics.
|
||||||
* [Runtime Environment](runtime-environment-metrics.md): For runtime environment metrics.
|
* [Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics.
|
||||||
|
|
||||||
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/document-status.md
|
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/document-status.md
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@ instruments not explicitly defined in this document. OS process metrics are
|
||||||
not related to the runtime environment of the program, and should take
|
not related to the runtime environment of the program, and should take
|
||||||
measurements from the operating system. For runtime environment metrics see
|
measurements from the operating system. For runtime environment metrics see
|
||||||
[semantic conventions for runtime environment
|
[semantic conventions for runtime environment
|
||||||
metrics](runtime-environment-metrics.md).
|
metrics](/docs/runtime/README.md#metrics).
|
||||||
|
|
||||||
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
|
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue