<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Runtime Environment
--->

# Semantic Conventions for Runtime Environment

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

This document defines semantic conventions for
runtime environment spans, metrics and logs.

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

<!-- toc -->

- [Metrics](#metrics)
  * [Attributes](#attributes)

<!-- tocstop -->

## Metrics

Runtime environments vary widely in their terminology, implementation, and
relative values for a given metric. For example, Go and Python are both
garbage collected languages, but comparing heap usage between the Go and
CPython runtimes directly is not meaningful. For this reason, this document
does not propose any standard top-level runtime metric instruments. See [OTEP
108](https://github.com/open-telemetry/oteps/pull/108/files) for additional
discussion.

Metrics specific to a certain runtime environment should be prefixed with
the runtime's top-level namespace `{environment}.*`, e.g., `jvm.*` and follow the
[general metric semantic convention guidelines](/docs/general/metrics.md#general-metric-semantic-conventions).

Authors of runtime instrumentations are responsible for the choice of
`{environment}` to avoid ambiguity when interpreting a metric's name or values.

For example, some programming languages have multiple runtime environments
that vary significantly in their implementation, like [Python which has many
implementations](https://wiki.python.org/moin/PythonImplementations). For
such languages, consider using specific `{environment}` prefixes to avoid
ambiguity, like `cpython.*` and `pypy.*`.

Also consider the
[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.

- [JVM](jvm-metrics.md)

### 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.26.0/specification/document-status.md
