Add javadoc link to all readmes (#981)
Signed-off-by: Bogdan Cristian Drutu <bogdandrutu@gmail.com>
This commit is contained in:
Bogdan Drutu
GitHub
parent
2080fe196c
commit
4c7072a1e4
|
|
@ -10,28 +10,16 @@ def subprojects = [
|
|||
project(':opentelemetry-context-prop'),
|
||||
project(':opentelemetry-contrib-runtime-metrics'),
|
||||
project(':opentelemetry-contrib-trace-utils'),
|
||||
project(':opentelemetry-exporters-logging'),
|
||||
project(':opentelemetry-exporters-inmemory'),
|
||||
project(':opentelemetry-exporters-jaeger'),
|
||||
project(':opentelemetry-exporters-otprotocol'),
|
||||
project(':opentelemetry-opentracing-shim'),
|
||||
project(':opentelemetry-sdk'),
|
||||
project(':opentelemetry-sdk-contrib-async-processor'),
|
||||
project(':opentelemetry-sdk-contrib-testbed'),
|
||||
project(':opentelemetry-sdk-contrib-auto-config'),
|
||||
]
|
||||
|
||||
// A subset of subprojects for which we want to publish javadoc.
|
||||
def subprojects_javadoc = [
|
||||
project(':opentelemetry-api'),
|
||||
project(':opentelemetry-context-prop'),
|
||||
project(':opentelemetry-contrib-runtime-metrics'),
|
||||
project(':opentelemetry-contrib-trace-utils'),
|
||||
project(':opentelemetry-exporters-inmemory'),
|
||||
project(':opentelemetry-exporters-jaeger'),
|
||||
project(':opentelemetry-opentracing-shim'),
|
||||
project(':opentelemetry-sdk'),
|
||||
project(':opentelemetry-sdk-contrib-async-processor'),
|
||||
project(':opentelemetry-sdk-contrib-otproto'),
|
||||
project(':opentelemetry-sdk-contrib-testbed'),
|
||||
project(':opentelemetry-sdk-contrib-auto-config'),
|
||||
]
|
||||
|
||||
for (subproject in rootProject.subprojects) {
|
||||
|
|
@ -45,19 +33,6 @@ dependencies {
|
|||
compile subprojects
|
||||
}
|
||||
|
||||
javadoc {
|
||||
classpath = files(subprojects_javadoc.collect { subproject ->
|
||||
subproject.javadoc.classpath
|
||||
})
|
||||
for (subproject in subprojects_javadoc) {
|
||||
if (subproject == project) {
|
||||
continue
|
||||
}
|
||||
source subproject.javadoc.source
|
||||
options.links subproject.javadoc.options.links.toArray(new String[0])
|
||||
}
|
||||
}
|
||||
|
||||
task jacocoMerge(type: JacocoMerge) {
|
||||
dependsOn(subprojects.jacocoTestReport.dependsOn)
|
||||
mustRunAfter(subprojects.jacocoTestReport.mustRunAfter)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
OpenTelemetry API
|
||||
======================================================
|
||||
# OpenTelemetry API
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
* Java 7 and Android 14 compatible.
|
||||
* The abstract classes in this directory can be subclassed to create alternative
|
||||
implementations of the OpenTelemetry library.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# OpenTelemetry Context Propagation
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
* Java 7 compatible.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-context-prop.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-context-prop
|
||||
|
|
@ -1,4 +1,9 @@
|
|||
OpenTelemetry Contrib Runtime Metrics
|
||||
======================================================
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
* Java 7 compatible.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-contrib-runtime-metrics.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-contrib-runtime-metrics
|
||||
|
|
|
|||
|
|
@ -1,4 +1,9 @@
|
|||
OpenTelemetry Contrib Trace Utils
|
||||
======================================================
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
* Java 7 compatible.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-contrib-trace-utils.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-contrib-trace-utils
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
# OpenTelemetry - In-Memory Exporter
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
* Java 7 compatible.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporters-inmemory.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporters-inmemory
|
||||
|
|
@ -1,5 +1,7 @@
|
|||
# OpenTelemetry - Jaeger Exporter - gRPC
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
This is the OpenTelemetry exporter, sending span data to Jaeger via gRPC.
|
||||
|
||||
## Proto files
|
||||
|
|
@ -7,4 +9,6 @@ This is the OpenTelemetry exporter, sending span data to Jaeger via gRPC.
|
|||
The proto files in this repository were copied over from the [Jaeger main repository][proto-origin]. At this moment, they have to be manually synchronize, but a [discussion exists][proto-discussion] on how to properly consume them in a more appropriate manner.
|
||||
|
||||
[proto-origin]: https://github.com/jaegertracing/jaeger/tree/5b8c1f40f932897b9322bf3f110d830536ae4c71/model/proto
|
||||
[proto-discussion]: https://github.com/open-telemetry/opentelemetry-java/issues/235
|
||||
[proto-discussion]: https://github.com/open-telemetry/opentelemetry-java/issues/235
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporters-jaeger.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporters-jaeger
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# OpenTelemetry - Logging Exporter
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
* Java 7 compatible.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporters-logging.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporters-logging
|
||||
|
|
@ -1,4 +1,8 @@
|
|||
# OpenTelemetry Protocol Exporter - gRPC
|
||||
# OpenTelemetry - OTLP Exporter - gRPC
|
||||
|
||||
This is the OpenTelemetry exporter, sending span data to OpenTelemetry collector
|
||||
via gRPC.
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
This is the OpenTelemetry exporter, sending span data to OpenTelemetry collector via gRPC.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporters-otprotocol.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporters-otprotocol
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# OpenTelemetry - OpenTracing Shim
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-opentracing-shim.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-opentracing-shim
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# OpenTelemetry - Protobuf messages
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-proto.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-proto
|
||||
|
|
@ -1,4 +1,9 @@
|
|||
OpenTelemetry SDK
|
||||
======================================================
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
* Java 7 and Android 14 compatible.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk
|
||||
|
|
@ -1,7 +1,12 @@
|
|||
# OpenTelemetry SDK Contrib Async Processor
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
An implementation of the trace `SpanProcessors` that uses
|
||||
[Disruptor](https://github.com/LMAX-Exchange/disruptor) to make all the `SpanProcessors` hooks run
|
||||
async.
|
||||
|
||||
* Java 8 compatible.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-contrib-async-processor.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-contrib-async-processor
|
||||
|
|
@ -1,5 +1,10 @@
|
|||
# OpenTelemetry SDK Contrib - Auto Instrumentation Configuration Utilities
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
This module contains code to assist with configuring the SDK for the auto-instrumentation
|
||||
project. It is temporarily a separate module from the SDK in order to stabilize
|
||||
the APIs, then it will be moved into the SDK project proper.
|
||||
the APIs, then it will be moved into the SDK project proper.
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-contrib-auto-config.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-contrib-auto-config
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# OpenTelemetry AWS Utils
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-aws-v1-support.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-aws-v1-support
|
||||
|
|
@ -1,4 +1,9 @@
|
|||
# OpenTelemetry Proto Utils
|
||||
|
||||
[![Javadocs][javadoc-image]][javadoc-url]
|
||||
|
||||
This module contains code to helps with conversions from OpenTelemetry proto objects to API or SDK
|
||||
objects (e.g. SpanId, TraceId, TraceConfig etc.).
|
||||
|
||||
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-contrib-otproto.svg
|
||||
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-contrib-otproto
|
||||
Loading…
Reference in New Issue