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

Rename Logs API to Logs Bridge API to prevent confusion #3197

Merged

Conversation

tigrannajaryan
Copy link
Member

We keep seeing confusion about what Log API is. There was a proposal [1] to use the term Bridge API to help prevent the confusion.

Please take a look and comment on whether you think this renaming helps and is reasonable.

[1] #3187 (comment)

@tigrannajaryan tigrannajaryan requested review from a team February 9, 2023 19:22
@tigrannajaryan tigrannajaryan changed the title Rename Log API to Log Bridge API to prevent confusion Rename Logs API to Logs Bridge API to prevent confusion Feb 9, 2023
@yurishkuro
Copy link
Member

Not a fan of the name Bridge for this. It conflicts with the use of this term in OpenTracing/OpenCensus Bridge, and it's not immediately apparent what it even means, i.e. it could easily mean the opposite: User -> Bridge -> language logging API.

Why not use the term we already use - Log Exporter API?

@Aneurysm9
Copy link
Member

I think this is very analogous to the existing bridges we provide for OpenTracing and OpenCensus, but for logging libraries like log4j or logrus. It provides a way for existing uses of those libraries to integrate with OTel without requiring changes to instrumentation code.

@tigrannajaryan
Copy link
Member Author

tigrannajaryan commented Feb 9, 2023

Why not use the term we already use - Log Exporter API?

Log Exporter interface is already part of Log SDK. I think naming this document a Log Exporter API would be confusing.

@jkwatson
Copy link
Contributor

big fan!

@tigrannajaryan
Copy link
Member Author

@open-telemetry/specs-logs-approvers please review.

@arminru arminru added spec:logs Related to the specification/logs directory area:api Cross language API specification issue labels Feb 14, 2023
CHANGELOG.md Outdated Show resolved Hide resolved
We keep seeing confusion about what Logs API is. There was a proposal [1]
to use the term Bridge API to help prevent the confusion.

Please take a look and comment on whether you think this renaming helps
and is reasonable.

[1] open-telemetry#3187 (comment)
@jmacd
Copy link
Contributor

jmacd commented Feb 14, 2023

Have a look at consistent naming with the MetricProducer which is similar.

@jsuereth
Copy link
Contributor

This has enough approvals to merge, but there's concerns around the name bridge.

@tigrannajaryan If you want to entertain the suggestion to use "LogsProducer" like @jmacd suggests, let me know. Will give this another two days to marinate.

@tigrannajaryan
Copy link
Member Author

We have a Log SIG meeting today. I will run the "Producer" suggestion with the SIG. Let's keep this open for 1-2 more days.

@jack-berg
Copy link
Member

jack-berg commented Feb 15, 2023

I prefer bridge to producer - somehow bridge conveys more clearly that this isn't meant to be used by end users. A user might think it's appropriate for them to be a log producer, but less so that they should be writing a log bridge.

I think MetricProducer might benefit from changing to MetricBridge to help avoid users accidentally using the producer / bridge interface instead of async instruments.

Copy link

@zenmoto zenmoto left a comment

Choose a reason for hiding this comment

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

I think "bridge" makes the intent much clearer.

@tigrannajaryan
Copy link
Member Author

Discussed this in Log SIG today and there was not much support for the name "Producer API". If anyone strongly believes that "Producer API" is a better name for the Logs API please open a PR and link from here.

I will wait for another day to give that alternate a chance to be proposed (and if proposed and we see support for it we can extend the waiting period).

If no alternate PR is created within a day I am going to merge this PR.

@open-telemetry/specs-approvers last chance to object.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Cross language API specification issue spec:logs Related to the specification/logs directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.