From 59bfe9564d5fbb9d08c99c3ed36daf282f0a9075 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 26 Oct 2023 09:31:08 -0700 Subject: [PATCH 1/5] add definition for standard output trace exporter This is mostly a copy of the definition already present for the metrics exporter. It doesn't specify a format for the output itself. Signed-off-by: Alex Boten --- CHANGELOG.md | 2 ++ specification/trace/sdk_exporters/stdout.md | 22 +++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 specification/trace/sdk_exporters/stdout.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 517e63ac1f1..9d385950e69 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ release. - Add a new AddLink() operation to Span (experimental). ([#3678](https://github.com/open-telemetry/opentelemetry-specification/pull/3678)) +- Add definition for standard output trace exporter. + ([#3740](https://github.com/open-telemetry/opentelemetry-specification/pull/3740)) ### Metrics diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md new file mode 100644 index 00000000000..1ca25682590 --- /dev/null +++ b/specification/trace/sdk_exporters/stdout.md @@ -0,0 +1,22 @@ + + +# OpenTelemetry Span Exporter - Standard output + +**Status**: [Stable](../../document-status.md) + +"Standard output" Span Exporter is a [Span +Exporter](../sdk.md#span-exporter) which outputs the metrics to +stdout/console. + +[OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic +name for their language. For example, ConsoleExporter, StdoutExporter, +StreamExporter, etc. + +If a language provides a mechanism to automatically configure a +[Span processor](../sdk.md#span-processor) to pair with the associated +exporter (e.g., using the [`OTEL_TRACES_EXPORTER` environment +variable](../../configuration/sdk-environment-variables.md#exporter-selection)), by +default the exporter MUST be paired with a [batching +processor](../sdk.md#batching-processor). From 3ad466f1acc0d128daa4db0712bf7536bfe274a4 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 26 Oct 2023 09:42:10 -0700 Subject: [PATCH 2/5] Apply suggestions from code review --- CHANGELOG.md | 2 +- specification/trace/sdk_exporters/stdout.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d385950e69..9f221c9aefd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ release. - Add a new AddLink() operation to Span (experimental). ([#3678](https://github.com/open-telemetry/opentelemetry-specification/pull/3678)) -- Add definition for standard output trace exporter. +- Add definition for standard output span exporter. ([#3740](https://github.com/open-telemetry/opentelemetry-specification/pull/3740)) ### Metrics diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md index 1ca25682590..0ceb4e05b93 100644 --- a/specification/trace/sdk_exporters/stdout.md +++ b/specification/trace/sdk_exporters/stdout.md @@ -7,7 +7,7 @@ linkTitle: Stdout **Status**: [Stable](../../document-status.md) "Standard output" Span Exporter is a [Span -Exporter](../sdk.md#span-exporter) which outputs the metrics to +Exporter](../sdk.md#span-exporter) which outputs the spans to stdout/console. [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic From aaa9c87167effc8de5f561452b40d53e7018231f Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 7 Nov 2023 22:15:09 -0600 Subject: [PATCH 3/5] Update specification/trace/sdk_exporters/stdout.md Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com> --- specification/trace/sdk_exporters/stdout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md index 0ceb4e05b93..6dbfc4b7501 100644 --- a/specification/trace/sdk_exporters/stdout.md +++ b/specification/trace/sdk_exporters/stdout.md @@ -12,7 +12,7 @@ stdout/console. [OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic name for their language. For example, ConsoleExporter, StdoutExporter, -StreamExporter, etc. +StreamExporter, LoggingExporter etc. If a language provides a mechanism to automatically configure a [Span processor](../sdk.md#span-processor) to pair with the associated From 7536907f916439927f27bc534c752b6877043eb2 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Wed, 8 Nov 2023 09:29:50 -0600 Subject: [PATCH 4/5] Update specification/trace/sdk_exporters/stdout.md --- specification/trace/sdk_exporters/stdout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md index 6dbfc4b7501..abf0e7b1131 100644 --- a/specification/trace/sdk_exporters/stdout.md +++ b/specification/trace/sdk_exporters/stdout.md @@ -18,5 +18,5 @@ If a language provides a mechanism to automatically configure a [Span processor](../sdk.md#span-processor) to pair with the associated exporter (e.g., using the [`OTEL_TRACES_EXPORTER` environment variable](../../configuration/sdk-environment-variables.md#exporter-selection)), by -default the exporter MUST be paired with a [batching +default the standard output exporter MUST be paired with a [batching processor](../sdk.md#batching-processor). From 3ac402b3c7e087e3fe1650d35e8ca3187f58a3ef Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 14 Nov 2023 08:45:52 -0800 Subject: [PATCH 5/5] update to recommend simple processor --- specification/trace/sdk_exporters/stdout.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md index abf0e7b1131..0ec93f343b5 100644 --- a/specification/trace/sdk_exporters/stdout.md +++ b/specification/trace/sdk_exporters/stdout.md @@ -18,5 +18,5 @@ If a language provides a mechanism to automatically configure a [Span processor](../sdk.md#span-processor) to pair with the associated exporter (e.g., using the [`OTEL_TRACES_EXPORTER` environment variable](../../configuration/sdk-environment-variables.md#exporter-selection)), by -default the standard output exporter MUST be paired with a [batching -processor](../sdk.md#batching-processor). +default the standard output exporter SHOULD be paired with a [simple +processor](../sdk.md#simple-processor).