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.

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

Jump to bottom

Remove "Built-in exporters" section in Log SDK #3003

Closed
alanwest opened this issue Dec 2, 2022 · 0 comments · Fixed by #3031
Closed

Remove "Built-in exporters" section in Log SDK #3003

alanwest opened this issue Dec 2, 2022 · 0 comments · Fixed by #3031
Assignees
@alanwest
Labels
area:sdk Related to the SDK spec:logs Related to the specification/logs directory triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal

Comments

@alanwest
Copy link
Member

alanwest commented Dec 2, 2022

The log SDK spec contains the skeleton for a "built-in exporters" section. It only contains things specific to OTLP.

opentelemetry-specification/specification/logs/sdk.md

Lines 369 to 385 in 150451d

### Built-in exporters
TODO: Break out into files under `./sdk_exporters`.
#### OTLP Exporter
Exports to an OTLP network destination via OTLP/gRPC or OTLP/HTTP.
#### OTLP File exporter
Writes to a file or stdout in either OTLP JSON or OTLP Protobuf binary format.
![Logging to File](img/otlp-file.png)
TODO: clarify how this functionality co-exists with the overlapping
functionality in logging libraries that allow specifying how logs are written to
a file.

At this time, the trace SDK does not contain a trace-specific OTLP exporter spec - only a Jaeger and Zipkin exporter spec - see: https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/sdk_exporters. It would seem that the OTLP exporter spec sufficiently covers most things for all signals. Metrics is a small exception as there are metric-specific OTLP configuration options.

It seems there could be a discussion of a greater reorganization of OTLP exporter related specs. For example, maybe centralizing specifics for all signals into the main OTLP exporter spec.

For now, though, I recommend we remove this section from the log SDK spec. We can introduce an sdk_exporters directory under the log specification or decide to reorganize things at a later date if necessary.
@alanwest alanwest added the spec:logs Related to the specification/logs directory label Dec 2, 2022
@alanwest alanwest mentioned this issue Dec 6, 2022
Closed
25 tasks
@tigrannajaryan tigrannajaryan added the triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal label Dec 7, 2022
@tigrannajaryan tigrannajaryan assigned alanwest and unassigned arminru Dec 7, 2022
@alanwest alanwest mentioned this issue Dec 13, 2022
Merged
@arminru arminru added the area:sdk Related to the SDK label Dec 19, 2022
tigrannajaryan pushed a commit that referenced this issue Jan 3, 2023
@alanwest
Reorganize specification related to OTLP file exporter (#3031)
56c20c2 
Fixes #3003 
Contributes to #2911

## Changes

This PR moves and reorganizes parts of the specification relevant to exporting OTLP data to a file.

* Removes the "Build-in exporters" section from the Log SDK. The OTLP exporter has its own specification covering all signals. The part regarding a file exporter is not unique to logs. Exporting OTLP data to a file is also applicable to trace and metric data.
* Moves the file describing OTLP JSON serialization under the `protocol` subdirectory. As discussed in the Logs SIG (12/7/2022), this file provides a foundation for further progress on specifying an OTLP file exporter.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alanwest alanwest

Labels
area:sdk Related to the SDK spec:logs Related to the specification/logs directory triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Reorganize specification related to OTLP file exporter alanwest/opentelemetry-specification
3 participants
@alanwest @tigrannajaryan @arminru