Add additional API incubator docs#6356
Merged
jack-berg merged 1 commit intoopen-telemetry:mainfrom Apr 8, 2024
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6356 +/- ##
=========================================
Coverage 91.09% 91.09%
Complexity 5772 5772
=========================================
Files 627 627
Lines 16852 16852
Branches 1720 1720
=========================================
Hits 15351 15351
Misses 1006 1006
Partials 495 495 ☔ View full report in Codecov by Sentry. |
trask
approved these changes
Apr 5, 2024
| "io.jaegertracing:jaeger-client:1.8.1", | ||
| "io.opentelemetry.proto:opentelemetry-proto:1.1.0-alpha", | ||
| "io.opentelemetry.contrib:opentelemetry-aws-xray-propagator:1.29.0-alpha", | ||
| "io.opentelemetry.semconv:opentelemetry-semconv:1.21.0-alpha", |
Member
There was a problem hiding this comment.
Suggested change
| "io.opentelemetry.semconv:opentelemetry-semconv:1.21.0-alpha", | |
| "io.opentelemetry.semconv:opentelemetry-semconv:1.24.0-alpha", |
Member
There was a problem hiding this comment.
better yet, don't make that change, I'll send a PR so renovate will update it
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I've responded to several questions lately about how to use various incubating API features, and the only thing I can respond with is a link to the PR where the feature was added.
This PR adds little blurbs of code which demonstrate simple usage patterns of the experimental API features. The code is put in test classes so we can verify it compiles and that the minimal set of assertions work. The incubator API readme links to these usage test classes.
With this, we can funnel anyone interested to the incubator readme and they should be able to self-help most of the time.
Once a particular feature is stable, we can delete these usage tests and consider moving the documentation to opentelemetry.io. In an experimental state, there's too great an opportunity for breaking API changes and drift between static opentelemetry.io content.