From 4ca18cc81ed03b3f22301650701d0c7f854e14b9 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 26 Oct 2023 09:40:02 -0700 Subject: [PATCH 1/3] add definition for standard output logging exporter This is the mostly a copy of the metrics standard output exporter definition but for the logging signal. Signed-off-by: Alex Boten --- CHANGELOG.md | 3 +++ specification/logs/sdk_exporters/stdout.md | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 specification/logs/sdk_exporters/stdout.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 517e63ac1f1..f8e8f9875e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,9 @@ release. ### Logs +- Add definition for standard output log record exporter. + ([#3741](https://github.com/open-telemetry/opentelemetry-specification/pull/3741)) + ### Resource ### OpenTelemetry Protocol diff --git a/specification/logs/sdk_exporters/stdout.md b/specification/logs/sdk_exporters/stdout.md new file mode 100644 index 00000000000..4642e1822e4 --- /dev/null +++ b/specification/logs/sdk_exporters/stdout.md @@ -0,0 +1,22 @@ + + +# OpenTelemetry LogRecord Exporter - Standard output + +**Status**: [Experimental](../../document-status.md) + +"Standard output" LogRecord Exporter is a [LogRecord +Exporter](../sdk.md#logrecordexporter) which outputs the logs 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 +[LogRecordProcessor](../sdk.md#logrecordprocessor) to pair with the associated +exporter (e.g., using the [`OTEL_LOGS_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 ee09d4c09044f20ec447fcdd55ca20274d9f6cf3 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 14 Nov 2023 09:50:46 -0800 Subject: [PATCH 2/3] Update specification/logs/sdk_exporters/stdout.md Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com> --- 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 4642e1822e4..08987f200a2 100644 --- a/specification/logs/sdk_exporters/stdout.md +++ b/specification/logs/sdk_exporters/stdout.md @@ -18,5 +18,5 @@ If a language provides a mechanism to automatically configure a [LogRecordProcessor](../sdk.md#logrecordprocessor) to pair with the associated exporter (e.g., using the [`OTEL_LOGS_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 458c6fa075930b537bfde07373daf45408886c2b Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 14 Nov 2023 09:51:06 -0800 Subject: [PATCH 3/3] Update stdout.md --- specification/logs/sdk_exporters/stdout.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/logs/sdk_exporters/stdout.md b/specification/logs/sdk_exporters/stdout.md index 08987f200a2..63efd060f44 100644 --- a/specification/logs/sdk_exporters/stdout.md +++ b/specification/logs/sdk_exporters/stdout.md @@ -18,5 +18,5 @@ If a language provides a mechanism to automatically configure a [LogRecordProcessor](../sdk.md#logrecordprocessor) to pair with the associated exporter (e.g., using the [`OTEL_LOGS_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).