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 vendors.md doc about what it means to support opentelemetry #594

Merged
merged 5 commits into from
May 21, 2020

Conversation

tsloughter
Copy link
Member

Threw this together this morning and think it is a good starting point.


## What it means to support OpenTelemetry

## Tracing, Metrics and Logging Qualifications
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably having the sections instead as Implements OpenTelemetry and Supports OpenTelemetry (with their respective clarifications and side notes) will be easier for new users to grasp.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, I'll update them.

@yurishkuro
Copy link
Member

what would be the meaning of "OpenTelemetry inside"? :-)
image

@austinlparker
Copy link
Member

@yurishkuro I think that'd be more for libraries or components that integrate otel for tracing or metrics, yeah?

Copy link
Member

@mtwo mtwo left a comment

Choose a reason for hiding this comment

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

LGTM modulo a suggestion to clarify the two ways of supporting OpenTelemetry

specification/vendors.md Outdated Show resolved Hide resolved
specification/vendors.md Outdated Show resolved Hide resolved
specification/vendors.md Outdated Show resolved Hide resolved
specification/vendors.md Outdated Show resolved Hide resolved
@arminru arminru linked an issue May 18, 2020 that may be closed by this pull request
@tsloughter
Copy link
Member Author

@mtwo I've updated based on your suggested changes, can you check that I got it right?

@tsloughter
Copy link
Member Author

Oh, should I add this to the main table of contents or link to it from somewhere else specific? Currently it is only discoverable by manually going to the spec dir and opening the markdown file.

Comment on lines +36 to +38
SDK through one of two mechanisms:

- By providing an exporter for the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/) and / or the OpenTelemetry SDKs
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
SDK through one of two mechanisms:
- By providing an exporter for the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/) and / or the OpenTelemetry SDKs
SDK through one of the following mechanisms:
- By providing an exporter for the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/) and / or the OpenTelemetry SDKs
- By providing an exporter for the OpenTelemetry SDKs they support

I would argue a vendor wouldn't have to implement exporters for all language implementations out there but only for the ones they claim support for.

Copy link
Member Author

Choose a reason for hiding this comment

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

I would not consider that "supporting opentelemetry". If we want to add an option that explicitly limits what their support is that is fine, but the goal here is to not allow vendors to claim "support for opentelemetry" and for users to then find out the otel sdk they use isn't supported.

Copy link
Member

Choose a reason for hiding this comment

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

I see. I think it would make sense to add the (SDK) language as a qualification in addition to the signal types (traces|metrics|logs) then.

specification/vendors.md Outdated Show resolved Hide resolved
@bogdandrutu bogdandrutu merged commit df48497 into open-telemetry:master May 21, 2020
@carlosalberto carlosalberto added this to the v0.5 milestone May 28, 2020
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
…-telemetry#594)

* add vendors.md doc about what it means to support opentelemetry

* rework section titles

* Update specification/vendors.md

Co-authored-by: Morgan McLean <[email protected]>

* update based on mtwo's suggested changes

* Update specification/vendors.md

Co-authored-by: Armin Ruech <[email protected]>

Co-authored-by: Morgan McLean <[email protected]>
Co-authored-by: Armin Ruech <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What it will mean for a vendor to "support OpenTelemetry"
7 participants