Skip to content
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.

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

Clarify that STDOUT exporter format is unspecified #3935

Closed
wants to merge 4 commits into from

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Mar 12, 2024

Resolve #3565

Changes

The output format of the STDOUT exporter is unique to each OpenTelemetry language implementation. Reflect this in the specification and add normative requirements and suggestions for language implementations to document the exporter appropriately.

@MrAlias MrAlias added spec:metrics Related to the specification/metrics directory spec:logs Related to the specification/logs directory spec:trace Related to the specification/trace directory labels Mar 12, 2024
@MrAlias MrAlias force-pushed the unspecified-out-fmt branch from 4adb602 to b22f796 Compare March 12, 2024 15:06
@MrAlias MrAlias closed this Mar 12, 2024
@MrAlias
Copy link
Contributor Author

MrAlias commented Mar 12, 2024

This approach has not been decided on: #3565

@MrAlias MrAlias deleted the unspecified-out-fmt branch March 12, 2024 15:09
@cijothomas
Copy link
Member

@MrAlias Do you plan to re-open this, and add this language to the spec wording for stdout? This looks a good addition!

@MrAlias MrAlias restored the unspecified-out-fmt branch March 13, 2024 19:01
@MrAlias
Copy link
Contributor Author

MrAlias commented Mar 13, 2024

@MrAlias Do you plan to re-open this, and add this language to the spec wording for stdout? This looks a good addition!

👍

@MrAlias MrAlias reopened this Mar 13, 2024
@MrAlias MrAlias marked this pull request as ready for review March 13, 2024 19:10
@MrAlias MrAlias requested review from a team March 13, 2024 19:10
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Mar 21, 2024
@tigrannajaryan tigrannajaryan changed the title STDOUT exporter format is unspecified Clarify that STDOUT exporter format is unspecified Mar 21, 2024
@@ -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
Member

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

Copy link

github-actions bot commented Apr 2, 2024

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions bot closed this Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:logs Related to the specification/logs directory spec:metrics Related to the specification/metrics directory spec:trace Related to the specification/trace directory Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Do we need a spec for console output format?
6 participants