diff --git a/CHANGELOG.md b/CHANGELOG.md index 6fabdcc303e..24461d75248 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,9 @@ release. ### Traces +- Add definition for standard output span exporter. + ([#3740](https://github.com/open-telemetry/opentelemetry-specification/pull/3740)) + ### Metrics - Add optional configuration for Prometheus exporters to promote resource attributes to metric attributes diff --git a/specification/baggage/api.md b/specification/baggage/api.md index ffccfe17fe8..fb6cb392ede 100644 --- a/specification/baggage/api.md +++ b/specification/baggage/api.md @@ -146,7 +146,7 @@ reasons. The API layer or an extension package MUST include the following `Propagator`s: -* A `TextMapPropagator` implementing the [W3C Baggage Specification](https://w3c.github.io/baggage). +* A `TextMapPropagator` implementing the [W3C Baggage Specification](https://www.w3.org/TR/baggage). See [Propagators Distribution](../context/api-propagators.md#propagators-distribution) for how propagators are to be distributed. diff --git a/specification/context/api-propagators.md b/specification/context/api-propagators.md index a1c85ee0f6c..762b309ef01 100644 --- a/specification/context/api-propagators.md +++ b/specification/context/api-propagators.md @@ -333,9 +333,9 @@ Required parameters: The official list of propagators that MUST be maintained by the OpenTelemetry organization and MUST be distributed as OpenTelemetry extension packages: -* [W3C TraceContext](https://www.w3.org/TR/trace-context/). MAY alternatively +* [W3C TraceContext](https://www.w3.org/TR/trace-context). MAY alternatively be distributed as part of the OpenTelemetry API. -* [W3C Baggage](https://w3c.github.io/baggage). MAY alternatively +* [W3C Baggage](https://www.w3.org/TR/baggage). MAY alternatively be distributed as part of the OpenTelemetry API. * [B3](https://github.com/openzipkin/b3-propagation). * [Jaeger](https://www.jaegertracing.io/docs/latest/client-libraries/#propagation-format). diff --git a/specification/logs/README.md b/specification/logs/README.md index b0c3fb5acbe..eaf1ab28212 100644 --- a/specification/logs/README.md +++ b/specification/logs/README.md @@ -284,7 +284,7 @@ auto-instrumenting solutions that modify trace logging libraries used by the application to automatically output the trace context such as the trace id or span id with every log statement. The trace context can be automatically extracted from incoming requests if standard compliant request propagation is -used, e.g. via [W3C TraceContext](https://w3c.github.io/trace-context/). In +used, e.g. via [W3C TraceContext](https://www.w3.org/TR/trace-context). In addition, the requests outgoing from the application may be injected with the same trace context data, thus resulting in context propagation through the application and creating an opportunity to have full trace context in logs diff --git a/specification/protocol/exporter.md b/specification/protocol/exporter.md index aeaee3baa50..32c8bc5c69e 100644 --- a/specification/protocol/exporter.md +++ b/specification/protocol/exporter.md @@ -155,7 +155,7 @@ release). ### Specifying headers via environment variables -The `OTEL_EXPORTER_OTLP_HEADERS`, `OTEL_EXPORTER_OTLP_TRACES_HEADERS`, `OTEL_EXPORTER_OTLP_METRICS_HEADERS`, `OTEL_EXPORTER_OTLP_LOGS_HEADERS` environment variables will contain a list of key value pairs, and these are expected to be represented in a format matching to the [W3C Correlation-Context](https://github.com/w3c/baggage/blob/master/baggage/HTTP_HEADER_FORMAT.md), except that additional semi-colon delimited metadata is not supported, i.e.: key1=value1,key2=value2. All attribute values MUST be considered strings. +The `OTEL_EXPORTER_OTLP_HEADERS`, `OTEL_EXPORTER_OTLP_TRACES_HEADERS`, `OTEL_EXPORTER_OTLP_METRICS_HEADERS`, `OTEL_EXPORTER_OTLP_LOGS_HEADERS` environment variables will contain a list of key value pairs, and these are expected to be represented in a format matching to the [W3C Baggage](https://www.w3.org/TR/baggage/#header-content), except that additional semi-colon delimited metadata is not supported, i.e.: key1=value1,key2=value2. All attribute values MUST be considered strings. ## Retry diff --git a/specification/resource/sdk.md b/specification/resource/sdk.md index 86e83ee215f..2c3df621323 100644 --- a/specification/resource/sdk.md +++ b/specification/resource/sdk.md @@ -137,7 +137,7 @@ has higher priority. The `OTEL_RESOURCE_ATTRIBUTES` environment variable will contain of a list of key value pairs, and these are expected to be represented in a format matching -to the [W3C Baggage](https://w3c.github.io/baggage), except that additional +to the [W3C Baggage](https://www.w3.org/TR/baggage/#header-content), except that additional semi-colon delimited metadata is not supported, i.e.: `key1=value1,key2=value2`. All attribute values MUST be considered strings and characters outside the `baggage-octet` range MUST be percent-encoded. diff --git a/specification/trace/sdk_exporters/stdout.md b/specification/trace/sdk_exporters/stdout.md new file mode 100644 index 00000000000..0ec93f343b5 --- /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 spans to +stdout/console. + +[OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic +name for their language. For example, ConsoleExporter, StdoutExporter, +StreamExporter, LoggingExporter 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 standard output exporter SHOULD be paired with a [simple +processor](../sdk.md#simple-processor).