From 0a1ee5e4f199289ce7841ae4c236d7abb2a942a1 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 26 Oct 2023 09:44:51 -0700 Subject: [PATCH 1/6] add console as a supported env variable exporter type This PR is a follow up to https://github.com/open-telemetry/opentelemetry-specification/pull/3740 and https://github.com/open-telemetry/opentelemetry-specification/pull/3741. As some languages (the ones I looked at were: python, js, ruby) already support the `console` type of exporter, I thought it would be good if the spec confirmed it. Signed-off-by: Alex Boten --- CHANGELOG.md | 2 ++ specification/configuration/sdk-environment-variables.md | 3 +++ 2 files changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b21d69656a8..dfabba3b924 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -77,6 +77,8 @@ release. - Rename/replace `(client|server).socket.(address|port)` attributes with `network.(peer|local).(address|port)`. ([#3713](https://github.com/open-telemetry/opentelemetry-specification/pull/3713)) +- Add `console` as an exporter type that is supported via environment variable configuration. + ([#3742](https://github.com/open-telemetry/opentelemetry-specification/pull/3742)) ### Supplementary Guidelines diff --git a/specification/configuration/sdk-environment-variables.md b/specification/configuration/sdk-environment-variables.md index 881591044da..25933ac62a6 100644 --- a/specification/configuration/sdk-environment-variables.md +++ b/specification/configuration/sdk-environment-variables.md @@ -236,17 +236,20 @@ Known values for `OTEL_TRACES_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/) (Defaults to [protobuf](https://github.com/openzipkin/zipkin-api/blob/master/zipkin.proto) format) +- `"console`: [Standard Output](../traces/sdk_exporters/stdout.md) - `"none"`: No automatically configured exporter for traces. Known values for `OTEL_METRICS_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"prometheus"`: [Prometheus](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md) +- `"console`: [Standard Output](../metrics/sdk_exporters/stdout.md) - `"none"`: No automatically configured exporter for metrics. Known values for `OTEL_LOGS_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) +- `"console`: [Standard Output](../logs/sdk_exporters/stdout.md) - `"none"`: No automatically configured exporter for logs. ## Metrics SDK Configuration From 1fcefbad7c73f232391cab1024f011a6a44b1a4e Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Mon, 20 Nov 2023 20:57:51 -0800 Subject: [PATCH 2/6] add note about logging keyword Signed-off-by: Alex Boten --- specification/configuration/sdk-environment-variables.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/configuration/sdk-environment-variables.md b/specification/configuration/sdk-environment-variables.md index 25933ac62a6..1c33315bd16 100644 --- a/specification/configuration/sdk-environment-variables.md +++ b/specification/configuration/sdk-environment-variables.md @@ -236,7 +236,7 @@ Known values for `OTEL_TRACES_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/) (Defaults to [protobuf](https://github.com/openzipkin/zipkin-api/blob/master/zipkin.proto) format) -- `"console`: [Standard Output](../traces/sdk_exporters/stdout.md) +- `"console`: [Standard Output](../trace/sdk_exporters/stdout.md) - `"none"`: No automatically configured exporter for traces. Known values for `OTEL_METRICS_EXPORTER` are: @@ -252,6 +252,9 @@ Known values for `OTEL_LOGS_EXPORTER` are: - `"console`: [Standard Output](../logs/sdk_exporters/stdout.md) - `"none"`: No automatically configured exporter for logs. +Note that `"logging"` is a reserved keyword and shouldn't be assigned for future use. Implementations that use `"logging"` as a value to configure the +standard output exporter MAY continue to do so for backwards compatibility. + ## Metrics SDK Configuration **Status**: [Mixed](../document-status.md) From 9b51e9bc11c595d28825678c28e2131101b9dcec Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Fri, 24 Nov 2023 08:24:36 -0800 Subject: [PATCH 3/6] update to put logging as a known value Signed-off-by: Alex Boten --- specification/configuration/sdk-environment-variables.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/specification/configuration/sdk-environment-variables.md b/specification/configuration/sdk-environment-variables.md index 1c33315bd16..8e18cfa8dca 100644 --- a/specification/configuration/sdk-environment-variables.md +++ b/specification/configuration/sdk-environment-variables.md @@ -237,6 +237,8 @@ Known values for `OTEL_TRACES_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/) (Defaults to [protobuf](https://github.com/openzipkin/zipkin-api/blob/master/zipkin.proto) format) - `"console`: [Standard Output](../trace/sdk_exporters/stdout.md) +- `"logging`: [Standard Output](../trace/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD +NOT be supported by new implementations. - `"none"`: No automatically configured exporter for traces. Known values for `OTEL_METRICS_EXPORTER` are: @@ -244,17 +246,18 @@ Known values for `OTEL_METRICS_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"prometheus"`: [Prometheus](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md) - `"console`: [Standard Output](../metrics/sdk_exporters/stdout.md) +- `"logging`: [Standard Output](../metrics/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD +NOT be supported by new implementations. - `"none"`: No automatically configured exporter for metrics. Known values for `OTEL_LOGS_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"console`: [Standard Output](../logs/sdk_exporters/stdout.md) +- `"logging`: [Standard Output](../logs/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD +NOT be supported by new implementations. - `"none"`: No automatically configured exporter for logs. -Note that `"logging"` is a reserved keyword and shouldn't be assigned for future use. Implementations that use `"logging"` as a value to configure the -standard output exporter MAY continue to do so for backwards compatibility. - ## Metrics SDK Configuration **Status**: [Mixed](../document-status.md) From 51f5aa4e9303303845d84622c53a1f9c30ce0838 Mon Sep 17 00:00:00 2001 From: Carlos Alberto Cortez Date: Mon, 27 Nov 2023 09:47:39 -0600 Subject: [PATCH 4/6] Update specification/configuration/sdk-environment-variables.md Co-authored-by: Tyler Yahn --- specification/configuration/sdk-environment-variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/configuration/sdk-environment-variables.md b/specification/configuration/sdk-environment-variables.md index 8e18cfa8dca..81f86e7bcb0 100644 --- a/specification/configuration/sdk-environment-variables.md +++ b/specification/configuration/sdk-environment-variables.md @@ -236,8 +236,8 @@ Known values for `OTEL_TRACES_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/) (Defaults to [protobuf](https://github.com/openzipkin/zipkin-api/blob/master/zipkin.proto) format) -- `"console`: [Standard Output](../trace/sdk_exporters/stdout.md) -- `"logging`: [Standard Output](../trace/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD +- `"console"`: [Standard Output](../trace/sdk_exporters/stdout.md) +- `"logging"`: [Standard Output](../trace/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD NOT be supported by new implementations. - `"none"`: No automatically configured exporter for traces. From 69dbdcb7193336ec0f746dcbbef1fe7b526d2f95 Mon Sep 17 00:00:00 2001 From: Carlos Alberto Cortez Date: Mon, 27 Nov 2023 09:48:03 -0600 Subject: [PATCH 5/6] Update specification/configuration/sdk-environment-variables.md Co-authored-by: Tyler Yahn --- specification/configuration/sdk-environment-variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/configuration/sdk-environment-variables.md b/specification/configuration/sdk-environment-variables.md index 81f86e7bcb0..6dd6cea0055 100644 --- a/specification/configuration/sdk-environment-variables.md +++ b/specification/configuration/sdk-environment-variables.md @@ -245,8 +245,8 @@ Known values for `OTEL_METRICS_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) - `"prometheus"`: [Prometheus](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md) -- `"console`: [Standard Output](../metrics/sdk_exporters/stdout.md) -- `"logging`: [Standard Output](../metrics/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD +- `"console"`: [Standard Output](../metrics/sdk_exporters/stdout.md) +- `"logging"`: [Standard Output](../metrics/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD NOT be supported by new implementations. - `"none"`: No automatically configured exporter for metrics. From 15bb97e8dc5fec4e5e6bd955544e872359680bc2 Mon Sep 17 00:00:00 2001 From: Carlos Alberto Cortez Date: Mon, 27 Nov 2023 09:48:16 -0600 Subject: [PATCH 6/6] Update specification/configuration/sdk-environment-variables.md Co-authored-by: Tyler Yahn --- specification/configuration/sdk-environment-variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/configuration/sdk-environment-variables.md b/specification/configuration/sdk-environment-variables.md index 6dd6cea0055..ef4794cb046 100644 --- a/specification/configuration/sdk-environment-variables.md +++ b/specification/configuration/sdk-environment-variables.md @@ -253,8 +253,8 @@ NOT be supported by new implementations. Known values for `OTEL_LOGS_EXPORTER` are: - `"otlp"`: [OTLP](../protocol/otlp.md) -- `"console`: [Standard Output](../logs/sdk_exporters/stdout.md) -- `"logging`: [Standard Output](../logs/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD +- `"console"`: [Standard Output](../logs/sdk_exporters/stdout.md) +- `"logging"`: [Standard Output](../logs/sdk_exporters/stdout.md). It is a deprecated value left for backwards compatibility. It SHOULD NOT be supported by new implementations. - `"none"`: No automatically configured exporter for logs.