Skip to content

Clarify that STDOUT exporter format is unspecified #3935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MrAlias wants to merge 4 commits into from
Closed

Clarify that STDOUT exporter format is unspecified #3935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b22f796
STDOUT exporter format is unspecified
MrAlias Mar 12, 2024
386d122
Merge branch 'main' into unspecified-out-fmt
MrAlias Mar 13, 2024
ccb5fce
Relax logs requirement to recommendation
MrAlias Mar 13, 2024
60ea13a
Add perf reason to doc recommendation
MrAlias Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,25 @@ 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

- 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

- 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))

### Events

### Resource
Expand Down
6 changes: 6 additions & 0 deletions specification/logs/sdk_exporters/stdout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ linkTitle: Stdout
Exporter](../sdk.md#logrecordexporter) which outputs the logs to
stdout/console.

The output format of the exporter is unspecified. The exporter SHOULD be
Copy link
Copy Markdown
Member

@tigrannajaryan tigrannajaryan Mar 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we actually specify some requirements for the format (e.g. that it is not performance optimized) I wonder if it is better to say:

Suggested change
The output format of the exporter is unspecified. The exporter SHOULD be
The output format of the exporter is implementation-dependant. The exporter SHOULD be

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,
Comment thread
cijothomas marked this conversation as resolved.
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.
Expand Down
6 changes: 6 additions & 0 deletions specification/metrics/sdk_exporters/stdout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ 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 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,
StreamExporter, etc.
Expand Down
6 changes: 6 additions & 0 deletions specification/trace/sdk_exporters/stdout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ 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
Comment thread
cijothomas marked this conversation as resolved.
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,
StreamExporter, LoggingExporter etc.
Expand Down