Add documentation for spring starters #1035
Merged
Conversation
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
mabdinur
force-pushed
the
add_spring_starter_documentation
branch
from
9afdf39
to
dc2b77a
Compare
mabdinur
requested review from
anuraaga,
iNikem,
jkwatson,
trask and
tylerbenson
as code owners
trask
reviewed
Aug 18, 2020
instrumentation-core/spring/spring-boot-autoconfigure/README.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Add these dependencies to your project. | ||
|
|
||
| Replace `OPENTELEMETRY_VERSION` with the latest stable [release](https://mvnrepository.com/artifact/io.opentelemetry). |
There was a problem hiding this comment.
I think better to link to official site, e.g. https://search.maven.org/search?q=g:io.opentelemetry
also, we aren't publishing to maven central yet from opentelemetry-java-instrumentation, so maybe include somewhere that for now you need to add our bintray maven repository: https://dl.bintray.com/open-telemetry/maven/
| <version>OPENTELEMETRY_VERSION</version> | ||
| </dependency> | ||
|
|
||
| <!-- Slf4j log correlation support --> |
There was a problem hiding this comment.
Not yet. This work is blocked by this issue: open-telemetry/opentelemetry-java#922. I left it in as a placeholder. But since logging support is not required for GA I don't think this issue will be resolve in the next few weeks. I'll remove this for now.
instrumentation-core/spring/spring-boot-autoconfigure/README.md
Outdated
Show resolved
Hide resolved
instrumentation-core/spring/spring-boot-autoconfigure/README.md
Outdated
Show resolved
Hide resolved
instrumentation-core/spring/starters/jaeger-exporter-starter/README.md
Outdated
Show resolved
Hide resolved
instrumentation-core/spring/starters/otlp-exporter-starter/README.md
Outdated
Show resolved
Hide resolved
instrumentation-core/spring/starters/zipkin-exporter-starter/README.md
Outdated
Show resolved
Hide resolved
Comment on lines
407
to
416
| |Feature |Property |Default Value | ||
| |--- |--- |--- | ||
| |Otlp Exporter |opentelemetry.trace.exporters.otlp.servicename |OtlpGrpcSpanExporter.DEFAULT_SERVICE_NAME | ||
| | |opentelemetry.trace.exporters.otlp.endpoint |OtlpGrpcSpanExporter.DEFAULT_ENDPOINT | ||
| | |opentelemetry.trace.exporters.otlp.spantimeout |OtlpGrpcSpanExporter.DEFAULT_DEADLINE_MS | ||
| |Jaeger Exporter |opentelemetry.trace.exporters.jaeger.servicename |JaegerGrpcSpanExporter.DEFAULT_SERVICE_NAME | ||
| | |opentelemetry.trace.exporters.jaeger.endpoint |JaegerGrpcSpanExporter.DEFAULT_ENDPOINT | ||
| | |opentelemetry.trace.exporters.jaeger.spantimeout |JaegerGrpcSpanExporter.DEFAULT_DEADLINE_MS | ||
| |Zipkin Exporter |opentelemetry.trace.exporters.jaeger.servicename |ZipkinSpanExporter.DEFAULT_SERVICE_NAME | ||
| | |opentelemetry.trace.exporters.jaeger.endpoint |ZipkinSpanExporter.DEFAULT_ENDPOINT |
There was a problem hiding this comment.
for the documentation, i think nice to include the real default values
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
…EADME.md Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
…DME.md Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
…EADME.md Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
anuraaga
approved these changes
Aug 21, 2020
instrumentation-core/spring/spring-boot-autoconfigure/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Anuraag Agrawal <anuraaga@gmail.com>
trask
approved these changes
Aug 21, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add documentation for:
Opentelemetry-spring-boot-autoconfigure
Opentelemetry-spring-starter
Opentelemetry-zipkin-exporter-starter
Opentelemetry-jaeger-exporter-starter
Opentelemetry-otlp-exporter-starter
Minor clean up: I removed 2 fields from WithSpanAspectTest that are not being used in any tests.