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

Add log appender / bridge to glossary #3335

Merged
merged 7 commits into from
Mar 28, 2023

Conversation

jack-berg
Copy link
Member

Related to #2911.

cc @dyladan who brought up naming in the 3/13 maintainers SIG.

@jack-berg jack-berg requested review from a team March 22, 2023 20:01
@dyladan
Copy link
Member

dyladan commented Mar 23, 2023

I thought in the meeting we agreed to use only one term. Using both terms is unlikely to reduce user confusion.

1 similar comment
@dyladan
Copy link
Member

dyladan commented Mar 23, 2023

I thought in the meeting we agreed to use only one term. Using both terms is unlikely to reduce user confusion.

@jack-berg
Copy link
Member Author

As much as I'd like to have a single term, after thinking about it more, I think there's too much momentum behind both terms. Appender is a popular term in the logging domain and is used in multiple language ecosystems. Authors of these components are going to inevitably call them appenders. Bridge is a useful term in the spec, and is used in the opencensus, opentracing, and metric producer specs. These components are definitely bridges in the same sense the term is used elsewhere.

I think we should standardize on the term "bridge" across the spec to refer to any component that bridges data into OpenTelemetry from another API / framework, but also be ok with aliases for these components that reflect the domain.

@reyang
Copy link
Member

reyang commented Mar 23, 2023

I think we should standardize on the term "bridge" across the spec to refer to any component that bridges data into OpenTelemetry from another API / framework, but also be ok with aliases for these components that reflect the domain.

Personally (very subjective), I prefer "provider" than "bridge" because "bridge" sounds like a bi-directional thing to me. But I'm 100% supportive of whatever term as long as we 1) make it explicit/clear 2) stick to the one that we picked.

@tigrannajaryan
Copy link
Member

tigrannajaryan commented Mar 23, 2023

I think our preference should be to use the term "bridge" but in some contexts it is inevitable that we need to mention the "appender" because that's the term used by those external libraries. I think defining both in the glossary is the right approach.

@arminru arminru added editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. spec:logs Related to the specification/logs directory labels Mar 27, 2023
specification/logs/bridge-api.md Outdated Show resolved Hide resolved
specification/logs/bridge-api.md Outdated Show resolved Hide resolved
specification/logs/bridge-api.md Outdated Show resolved Hide resolved
@arminru arminru merged commit 4e5bc75 into open-telemetry:main Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. spec:logs Related to the specification/logs directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants