-
Notifications
You must be signed in to change notification settings - Fork 897
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
+53
−0
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5c62b24
add vendors.md doc about what it means to support opentelemetry
tsloughter ddbc042
rework section titles
tsloughter f82a975
Update specification/vendors.md
tsloughter ccfddcc
update based on mtwo's suggested changes
tsloughter 7171462
Update specification/vendors.md
tsloughter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Vendors | ||
|
||
<details> | ||
<summary>Table of Contents</summary> | ||
|
||
* [Abstract](#abstract) | ||
* [What it means to support OpenTelemetry](#what-it-means-to-support-opentelemetry) | ||
|
||
</details> | ||
|
||
## Abstract | ||
|
||
The OpenTelemetry project consists of both a | ||
[specification](https://github.com/open-telemetry/opentelemetry-specification) | ||
for the API, SDK, protocol and semantic conventions, as well as an | ||
implementation of each for a number of languages. The default SDK implementation | ||
is [highly configurable](sdk-configuration.md) and extendable, for example | ||
through [Span Processors](trace/sdk.md#span-processor), to allow for additional | ||
logic needed by particular vendors to be added without having to implement a | ||
custom SDK. By not requiring a custom SDK means for most languages a user will | ||
already find an implementation to use and if not they'll have a well documented | ||
specification to follow for implementing in a new language. | ||
|
||
The goal is for users to be able to easily switch between vendors while also | ||
ensuring that any language with an OpenTelemetry SDK implementation is able to | ||
work with any vendor who claims support for OpenTelemetry. | ||
|
||
This document will explain what is required of a vendor to be considered to | ||
"Support OpenTelemetry" or "Implements OpenTelemetry". | ||
|
||
## What it means to support OpenTelemetry | ||
|
||
## Tracing, Metrics and Logging Qualifications | ||
|
||
A vendor can qualify their support for OpenTelemetry with the type of telemetry | ||
they support. For example, a vendor that accepts the OpenTelemetry protocol | ||
exports for metrics only will be listed as "Supports OpenTelemetry Metrics". | ||
|
||
### Default SDK and the OpenTelemetry Protocol | ||
|
||
"Supports OpenTelemetry" means the vendor must accept the output of the default | ||
SDK through the OpenTelemetry Protocol either directly -- meaning the vendor's | ||
tsloughter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
endpoint/collector/agent implements the receiver end of the protocol -- or as an | ||
tsloughter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
exporter that works with the [OpenTelemetry | ||
tsloughter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Collector](https://github.com/open-telemetry/opentelemetry-collector/). | ||
tsloughter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Custom SDK | ||
|
||
A vendor with a custom SDK implementation will be listed as "Implements | ||
OpenTelemetry". If the custom SDK is optional then the vendor can be listed as | ||
"Supports OpenTelemetry". |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
andSupports OpenTelemetry
(with their respective clarifications and side notes) will be easier for new users to grasp.There was a problem hiding this comment.
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.