From b22f79682472d0ea77518ad957b9eaf94bca82bf Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Tue, 12 Mar 2024 07:57:31 -0700 Subject: [PATCH 1/3] STDOUT exporter format is unspecified --- CHANGELOG.md | 13 +++++++++++++ specification/logs/sdk_exporters/stdout.md | 5 +++++ specification/metrics/sdk_exporters/stdout.md | 5 +++++ specification/trace/sdk_exporters/stdout.md | 5 +++++ 4 files changed, 28 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2bfb0713f4a..061590fad7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,12 +13,21 @@ release. ### Traces +- Clarify STDOUT exporter format is unspecified. + ([#3935](https://github.com/open-telemetry/opentelemetry-specification/pull/3935)) +- Recommend documentation of the STDOUT exporter format. + ([#3935](https://github.com/open-telemetry/opentelemetry-specification/pull/3935)) + ### Metrics - Remove implementation specific specification from metric API. ([#3890](https://github.com/open-telemetry/opentelemetry-specification/pull/3890)) - Formalize the interaction between cardinality limit and overflow attribute. ([#3912](https://github.com/open-telemetry/opentelemetry-specification/pull/3912)) +- Clarify STDOUT exporter format is unspecified. + ([#3935](https://github.com/open-telemetry/opentelemetry-specification/pull/3935)) +- Recommend documentation of the STDOUT exporter format. + ([#3935](https://github.com/open-telemetry/opentelemetry-specification/pull/3935)) ### Logs @@ -28,6 +37,10 @@ release. ([#3852](https://github.com/open-telemetry/opentelemetry-specification/pull/3852)) - Add support for empty values. ([#3853](https://github.com/open-telemetry/opentelemetry-specification/pull/3853)) +- Clarify STDOUT exporter format is unspecified. + ([#3935](https://github.com/open-telemetry/opentelemetry-specification/pull/3935)) +- Require documentation of the STDOUT exporter format. + ([#3935](https://github.com/open-telemetry/opentelemetry-specification/pull/3935)) ### Resource diff --git a/specification/logs/sdk_exporters/stdout.md b/specification/logs/sdk_exporters/stdout.md index 63efd060f44..c3a71114bde 100644 --- a/specification/logs/sdk_exporters/stdout.md +++ b/specification/logs/sdk_exporters/stdout.md @@ -10,6 +10,11 @@ linkTitle: Stdout Exporter](../sdk.md#logrecordexporter) which outputs the logs to stdout/console. +The output format of the exporter is unspecified. The exporter MUST be +documented that its output is not a standardized format across OpenTelemetry +nor is it a stable format. The documentation SHOULD suggest the OTLP exporter +for users that want a stable and standarized output format. + [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, StreamExporter, etc. diff --git a/specification/metrics/sdk_exporters/stdout.md b/specification/metrics/sdk_exporters/stdout.md index 4b39ca2861c..bc4d5c36271 100644 --- a/specification/metrics/sdk_exporters/stdout.md +++ b/specification/metrics/sdk_exporters/stdout.md @@ -10,6 +10,11 @@ linkTitle: Stdout Exporter](../sdk.md#push-metric-exporter) which outputs the metrics to stdout/console. +The output format of the exporter is unspecified. The exporter SHOULD be +documented that its output is not a standardized format across OpenTelemetry +nor is it a stable format. The documentation SHOULD suggest the OTLP exporter +for users that want a stable and standarized output format. + [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, StreamExporter, etc. diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md index 0ec93f343b5..da6f58a7cd9 100644 --- a/specification/trace/sdk_exporters/stdout.md +++ b/specification/trace/sdk_exporters/stdout.md @@ -10,6 +10,11 @@ linkTitle: Stdout Exporter](../sdk.md#span-exporter) which outputs the spans to stdout/console. +The output format of the exporter is unspecified. The exporter SHOULD be +documented that its output is not a standardized format across OpenTelemetry +nor is it a stable format. The documentation SHOULD suggest the OTLP exporter +for users that want a stable and standarized output format. + [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, StreamExporter, LoggingExporter etc. From ccb5fce7c4199d1388bc1f1140883b7268e3e450 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Wed, 13 Mar 2024 12:05:07 -0700 Subject: [PATCH 2/3] Relax logs requirement to recommendation --- specification/logs/sdk_exporters/stdout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/logs/sdk_exporters/stdout.md b/specification/logs/sdk_exporters/stdout.md index 4b192538d68..1d5c7f75b97 100644 --- a/specification/logs/sdk_exporters/stdout.md +++ b/specification/logs/sdk_exporters/stdout.md @@ -10,7 +10,7 @@ linkTitle: Stdout Exporter](../sdk.md#logrecordexporter) which outputs the logs to stdout/console. -The output format of the exporter is unspecified. The exporter MUST be +The output format of the exporter is unspecified. The exporter SHOULD be documented that its output is not a standardized format across OpenTelemetry nor is it a stable format. The documentation SHOULD suggest the OTLP exporter for users that want a stable and standarized output format. From 60ea13adeba61145e33b4131dce282a81928be92 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Wed, 13 Mar 2024 12:09:12 -0700 Subject: [PATCH 3/3] Add perf reason to doc recommendation --- specification/logs/sdk_exporters/stdout.md | 7 ++++--- specification/metrics/sdk_exporters/stdout.md | 7 ++++--- specification/trace/sdk_exporters/stdout.md | 7 ++++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/specification/logs/sdk_exporters/stdout.md b/specification/logs/sdk_exporters/stdout.md index 1d5c7f75b97..ddeef1cfbf7 100644 --- a/specification/logs/sdk_exporters/stdout.md +++ b/specification/logs/sdk_exporters/stdout.md @@ -11,9 +11,10 @@ Exporter](../sdk.md#logrecordexporter) which outputs the logs to stdout/console. The output format of the exporter is unspecified. The exporter SHOULD be -documented that its output is not a standardized format across OpenTelemetry -nor is it a stable format. The documentation SHOULD suggest the OTLP exporter -for users that want a stable and standarized output format. +documented that its output is not a standardized format across OpenTelemetry, +nor is it a performance optimized or stable format. The documentation SHOULD +suggest the OTLP exporter for users that want a performance optimized, stable, +and standarized output format. [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, diff --git a/specification/metrics/sdk_exporters/stdout.md b/specification/metrics/sdk_exporters/stdout.md index bc4d5c36271..6c54f064834 100644 --- a/specification/metrics/sdk_exporters/stdout.md +++ b/specification/metrics/sdk_exporters/stdout.md @@ -11,9 +11,10 @@ Exporter](../sdk.md#push-metric-exporter) which outputs the metrics to stdout/console. The output format of the exporter is unspecified. The exporter SHOULD be -documented that its output is not a standardized format across OpenTelemetry -nor is it a stable format. The documentation SHOULD suggest the OTLP exporter -for users that want a stable and standarized output format. +documented that its output is not a standardized format across OpenTelemetry, +nor is it a performance optimized or stable format. The documentation SHOULD +suggest the OTLP exporter for users that want a performance optimized, stable, +and standarized output format. [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md index da6f58a7cd9..10d0d184eda 100644 --- a/specification/trace/sdk_exporters/stdout.md +++ b/specification/trace/sdk_exporters/stdout.md @@ -11,9 +11,10 @@ Exporter](../sdk.md#span-exporter) which outputs the spans to stdout/console. The output format of the exporter is unspecified. The exporter SHOULD be -documented that its output is not a standardized format across OpenTelemetry -nor is it a stable format. The documentation SHOULD suggest the OTLP exporter -for users that want a stable and standarized output format. +documented that its output is not a standardized format across OpenTelemetry, +nor is it a performance optimized or stable format. The documentation SHOULD +suggest the OTLP exporter for users that want a performance optimized, stable, +and standarized output format. [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter,