Merge branch 'main' into gcp-cloud-run-service-version

open-telemetry · May 1, 2023 · 4f92d44 · 4f92d44
2 parents 5b58946 + f9c26af
commit 4f92d44
Show file tree

Hide file tree

Showing 14 changed files with 71 additions and 53 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,10 @@ release.
  ([#3345](https:/open-telemetry/opentelemetry-specification/pull/3354))
 - Drop logger include_trace_context parameter.
  ([#3397](https:/open-telemetry/opentelemetry-specification/pull/3397))
+- Mark logs bridge API / SDK as stable.
+ ([#3376](https:/open-telemetry/opentelemetry-specification/pull/3376))
+- Mark LogRecord Environment Variables as stable.
+ ([#3449](https:/open-telemetry/opentelemetry-specification/pull/3449))
 
 ### Resource
 
@@ -54,6 +58,9 @@ release.
  ([#3360](https:/open-telemetry/opentelemetry-specification/pull/3360))
 - Move file configuration schema to `opentelemetry-configuration`.
  ([#3412](https:/open-telemetry/opentelemetry-specification/pull/3412))
+- Move `sdk-configuration.md` and `sdk-environment-variables.md`
+ to `/specification/configuration/`.
+ ([#3434](https:/open-telemetry/opentelemetry-specification/pull/3434))
 
 ### Telemetry Schemas
 

diff --git a/semantic_conventions/resource/telemetry.yaml b/semantic_conventions/resource/telemetry.yaml
@@ -40,10 +40,12 @@ groups:
  value: "python"
  - id: ruby
  value: "ruby"
- - id: webjs
- value: "webjs"
+ - id: rust
+ value: "rust"
  - id: swift
  value: "swift"
+ - id: webjs
+ value: "webjs"
  requirement_level: required
  brief: >
  The language of the telemetry SDK.

diff --git a/specification/README.md b/specification/README.md
@@ -33,7 +33,7 @@ cascade:
  - [Metrics](metrics/sdk.md)
  - [Logs](logs/sdk.md)
  - [Resource](resource/sdk.md)
- - [Configuration](sdk-configuration.md)
+ - [Configuration](configuration/sdk-configuration.md)
 - Data Specification
  - [Semantic Conventions](overview.md#semantic-conventions)
  - [Protocol](protocol/README.md)

diff --git a/specification/compatibility/opencensus.md b/specification/compatibility/opencensus.md
@@ -1,6 +1,6 @@
 # OpenCensus Compatibility
 
-**Status**: [Experimental](../document-status.md), Unless otherwise specified.
+**Status**: [Stable](../document-status.md), Unless otherwise specified.
 
 The OpenTelemetry project aims to provide backwards compatibility with the
 [OpenCensus](https://opencensus.io) project in order to ease migration of
@@ -80,8 +80,6 @@ Starting with a library using OpenCensus Instrumentation:
 
 ## Trace Bridge
 
-**Status**: [Experimental, Feature Freeze](../document-status.md)
-
 The trace bridge is provided as a shim layer implementing the
 [OpenCensus Trace API](https:/census-instrumentation/opencensus-specs)
 using the OpenTelemetry Trace API. This layer MUST NOT rely on implementation

diff --git a/specification/configuration/file-configuration.md b/specification/configuration/file-configuration.md
@@ -19,9 +19,9 @@
 
 File configuration provides a mechanism for configuring OpenTelemetry which is
 more expressive and full-featured than
-the [environment variable](../sdk-environment-variables.md) based scheme, and
+the [environment variable](sdk-environment-variables.md) based scheme, and
 language agnostic in a way not possible
-with [programmatic configuration](../sdk-configuration.md#programmatic).
+with [programmatic configuration](sdk-configuration.md#programmatic).
 
 File configuration defines a [Configuration Model](#configuration-model),
 which can be expressed in a [configuration file](#configuration-file).

diff --git a/specification/sdk-configuration.md → ...cation/configuration/sdk-configuration.md b/specification/sdk-configuration.md → ...cation/configuration/sdk-configuration.md
@@ -8,6 +8,8 @@
 - [Abstract](#abstract)
 - [Configuration Interface](#configuration-interface)
  * [Programmatic](#programmatic)
+ * [Environment Variables](#environment-variables)
+ * [Configuration File](#configuration-file)
  * [Other Mechanisms](#other-mechanisms)
 
 <!-- tocstop -->
@@ -34,6 +36,14 @@ struct on an SDK builder class. From that, one could build a CLI that accepts a
 file (YAML, JSON, TOML, ...) and then transforms into that well-defined struct
 consumable by the programmatic interface.
 
+### Environment Variables
+
+See [OpenTelemetry Environment Variable Specification](./sdk-environment-variables.md).
+
+### Configuration File
+
+See [File Configuration](./file-configuration.md).
+
 ### Other Mechanisms
 
 Additional configuration mechanisms SHOULD be provided in whatever

diff --git a/specification/sdk-environment-variables.md → ...onfiguration/sdk-environment-variables.md b/specification/sdk-environment-variables.md → ...onfiguration/sdk-environment-variables.md
diff --git a/specification/metrics/sdk.md b/specification/metrics/sdk.md
@@ -1262,7 +1262,7 @@ If a batch of [Metric points](./data-model.md#metric-points) can include
 ## Defaults and configuration
 
 The SDK MUST provide configuration according to the [SDK environment
-variables](../sdk-environment-variables.md) specification.
+variables](../configuration/sdk-environment-variables.md) specification.
 
 ## Numerical limits handling
 

diff --git a/specification/metrics/sdk_exporters/in-memory.md b/specification/metrics/sdk_exporters/in-memory.md
@@ -16,6 +16,6 @@ In-memory Metrics Exporter MUST support both Cumulative and Delta
 If a language provides a mechanism to automatically configure a
 [MetricReader](../sdk.md#metricreader) to pair with the associated
 exporter (e.g., using the [`OTEL_METRICS_EXPORTER` environment
-variable](../../sdk-environment-variables.md#exporter-selection)), by
+variable](../../configuration/sdk-environment-variables.md#exporter-selection)), by
 default the exporter MUST be paired with a [periodic exporting
 MetricReader](../sdk.md#periodic-exporting-metricreader).
diff --git a/specification/metrics/sdk_exporters/otlp.md b/specification/metrics/sdk_exporters/otlp.md
@@ -21,7 +21,7 @@ Exporter](../../protocol/exporter.md) specification.
 If a language provides a mechanism to automatically configure a
 [MetricReader](../sdk.md#metricreader) to pair with the associated
 Exporter (e.g., using the [`OTEL_METRICS_EXPORTER` environment
-variable](../../sdk-environment-variables.md#exporter-selection)),
+variable](../../configuration/sdk-environment-variables.md#exporter-selection)),
 then by default:
 
 * The exporter MUST be paired with a [periodic exporting

diff --git a/specification/metrics/sdk_exporters/stdout.md b/specification/metrics/sdk_exporters/stdout.md
@@ -20,7 +20,7 @@ StreamExporter, etc.
 If a language provides a mechanism to automatically configure a
 [MetricReader](../sdk.md#metricreader) to pair with the associated
 exporter (e.g., using the [`OTEL_METRICS_EXPORTER` environment
-variable](../../sdk-environment-variables.md#exporter-selection)), by
+variable](../../configuration/sdk-environment-variables.md#exporter-selection)), by
 default the exporter MUST be paired with a [periodic exporting
 MetricReader](../sdk.md#periodic-exporting-metricreader)
 with a default `exportIntervalMilliseconds` of 10000.
diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md
@@ -52,7 +52,7 @@ Given their significance some resource attributes are treated specifically as de
 ### Semantic Attributes with Dedicated Environment Variable
 
 These are the attributes which MAY be configurable via a dedicated environment variable
-as specified in [OpenTelemetry Environment Variable Specification](../../sdk-environment-variables.md):
+as specified in [OpenTelemetry Environment Variable Specification](../../configuration/sdk-environment-variables.md):
 
 - [`service.name`](#service)
 
@@ -149,8 +149,9 @@ All custom identifiers SHOULD be stable across different versions of an implemen
 | `php` | php |
 | `python` | python |
 | `ruby` | ruby |
-| `webjs` | webjs |
+| `rust` | rust |
 | `swift` | swift |
+| `webjs` | webjs |
 <!-- endsemconv -->
 
 ## Telemetry SDK (Experimental)

diff --git a/specification/vendors.md b/specification/vendors.md
@@ -20,7 +20,7 @@ The OpenTelemetry project consists of both a
 [specification](https:/open-telemetry/opentelemetry-specification)
 for the API, SDK, protocol and semantic conventions, as well as an
 implementation of each for a number of languages. The default SDK implementation
-is [highly configurable](sdk-configuration.md) and extendable, for example
+is [highly configurable](configuration/sdk-configuration.md) and extendable, for example
 through [Span Processors](trace/sdk.md#span-processor), to allow for additional
 logic needed by particular vendors to be added without having to implement a
 custom SDK. By not requiring a custom SDK means for most languages a user will

diff --git a/specification/versioning-and-stability.md b/specification/versioning-and-stability.md
@@ -247,7 +247,7 @@ instrumentations can use schemas to change the instrumentation they produce.
 
 **Exception:** Some resource attributes are embedded in various locations of the
 Specification, e.g. the `service.*` attributes which are required by SDKs to be
-produced and have corresponding [environment variables defined in general SDK configuration](sdk-environment-variables.md#general-sdk-configuration). These resource
+produced and have corresponding [environment variables defined in general SDK configuration](configuration/sdk-environment-variables.md#general-sdk-configuration). These resource
 attributes MUST NOT be ever changed. They are considered a hard-coded part of
 this specification.