Skip to content

Commit

Permalink
address feedbacks
Browse files Browse the repository at this point in the history
  • Loading branch information
cijothomas committed Feb 15, 2025
1 parent 73cac57 commit def53a9
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 11 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,22 @@ release.
- Deprecate `exception.escaped` attribute, add link to in-development semantic-conventions
on how to record errors across signals.
([#4368](https://github.com/open-telemetry/opentelemetry-specification/pull/4368))
- Clarify STDOUT exporter format is unspecified.
([#4418](https://github.com/open-telemetry/opentelemetry-specification/pull/4418))

### Metrics

- Clarify STDOUT exporter format is unspecified.
([#4418](https://github.com/open-telemetry/opentelemetry-specification/pull/4418))

### Logs

- Define how SDK implements `Logger.Enabled`.
([#4381](https://github.com/open-telemetry/opentelemetry-specification/pull/4381))
- Logs API should have functionality for reusing Standard Attributes.
([#4373](https://github.com/open-telemetry/opentelemetry-specification/pull/4373))
- Clarify STDOUT exporter format is unspecified.
([#4418](https://github.com/open-telemetry/opentelemetry-specification/pull/4418))

### Baggage

Expand Down
22 changes: 11 additions & 11 deletions specification/logs/sdk_exporters/stdout.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ linkTitle: Stdout
"Standard output" LogRecord Exporter is a [LogRecord
Exporter](../sdk.md#logrecordexporter) which outputs the logs to stdout/console.

The exporters output format is unspecified and may vary between
implementations. Documentation SHOULD caution users about this. The following
wording is recommended:

This exporter is intended for debugging and learning purposes. It is not
recommended for production use. The output format is not standardized and may
change at any time.

"If a standardized format for exporting logs to stdout is desired, consider using
the [File Exporter](../../protocol/file-exporter.md). However, please note that
the File Exporter is experimental and may not be available in all languages."
The exporter's output format is unspecified and can vary between
implementations. Documentation SHOULD warn users about this. The following
wording is recommended (modify as needed):

> This exporter is intended for debugging and learning purposes. It is not
> recommended for production use. The output format is not standardized and can
> change at any time.
>
> If a standardized format for exporting logs to stdout is desired, consider
> using the [File Exporter](../../protocol/file-exporter.md), if available.
> However, please note that the File Exporter specification is experimental.
[OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic
name for their language. For example, ConsoleExporter, StdoutExporter,
Expand Down
12 changes: 12 additions & 0 deletions specification/metrics/sdk_exporters/stdout.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ linkTitle: Stdout
Exporter](../sdk.md#push-metric-exporter) which outputs the metrics to
stdout/console.

The exporter's output format is unspecified and can vary between
implementations. Documentation SHOULD warn users about this. The following
wording is recommended (modify as needed):

> This exporter is intended for debugging and learning purposes. It is not
> recommended for production use. The output format is not standardized and can
> change at any time.
>
> If a standardized format for exporting logs to stdout is desired, consider
> using the [File Exporter](../../protocol/file-exporter.md), if available.
> However, please note that the File Exporter specification is experimental.
[OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic
name for their language. For example, ConsoleExporter, StdoutExporter,
StreamExporter, etc.
Expand Down
12 changes: 12 additions & 0 deletions specification/trace/sdk_exporters/stdout.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ linkTitle: Stdout
Exporter](../sdk.md#span-exporter) which outputs the spans to
stdout/console.

The exporter's output format is unspecified and can vary between
implementations. Documentation SHOULD warn users about this. The following
wording is recommended (modify as needed):

> This exporter is intended for debugging and learning purposes. It is not
> recommended for production use. The output format is not standardized and can
> change at any time.
>
> If a standardized format for exporting logs to stdout is desired, consider
> using the [File Exporter](../../protocol/file-exporter.md), if available.
> However, please note that the File Exporter specification is experimental.
[OpenTelemetry SDK](../../overview.md#sdk) authors MAY choose the best idiomatic
name for their language. For example, ConsoleExporter, StdoutExporter,
StreamExporter, LoggingExporter etc.
Expand Down

0 comments on commit def53a9

Please sign in to comment.