diff --git a/README.md b/README.md index 418ef73fbd2..97d8f58a19d 100644 --- a/README.md +++ b/README.md @@ -214,71 +214,71 @@ dependency as follows, replacing `{{artifact-id}}` with the value from the "Arti ### Bill of Material -| Component | Description | Artifact ID | Version | -|----------------------------------------------|----------------------------------------|---------------------------|-------------------------------------------------------------| -| [Bill of Materials (BOM)](./bom) | Bill of materials for stable artifacts | `opentelemetry-bom` | 1.23.1 | -| [Alpha Bill of Materials (BOM)](./bom-alpha) | Bill of materials for alpha artifacts | `opentelemetry-bom-alpha` | 1.23.1-alpha | +| Component | Description | Artifact ID | Version | Javadoc | +|----------------------------------------------|----------------------------------------|---------------------------|-------------------------------------------------------------|---------| +| [Bill of Materials (BOM)](./bom) | Bill of materials for stable artifacts | `opentelemetry-bom` | 1.23.1 | N/A | +| [Alpha Bill of Materials (BOM)](./bom-alpha) | Bill of materials for alpha artifacts | `opentelemetry-bom-alpha` | 1.23.1-alpha | N/A | ### API -| Component | Description | Artifact ID | Version | -|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------|----------------------------|-------------------------------------------------------------| -| [API](./api/all) | OpenTelemetry API, including metrics, traces, baggage, context | `opentelemetry-api` | 1.23.1 | -| [Events API](./api/logs) | OpenTelemetry Event API for emitting events. | `opentelemetry-api-events` | 1.23.1-alpha | -| [Logs API](./api/logs) | OpenTelemetry Log API for bridging log frameworks (NOT a replacement for application logging frameworks like SLF4J, JUL, etc.) | `opentelemetry-api-logs` | 1.23.1-alpha | -| [Context API](./context) | OpenTelemetry context API | `opentelemetry-context` | 1.23.1 | -| [Semantic Conventions](./semconv) | Generated code for OpenTelemetry semantic conventions | `opentelemetry-semconv` | 1.23.1-alpha | +| Component | Description | Artifact ID | Version | Javadoc | +|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------|----------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [API](./api/all) | OpenTelemetry API, including metrics, traces, baggage, context | `opentelemetry-api` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api) | +| [Events API](./api/logs) | OpenTelemetry Event API for emitting events. | `opentelemetry-api-events` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api-events.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api-events) | +| [Logs API](./api/logs) | OpenTelemetry Log API for bridging log frameworks (NOT a replacement for application logging frameworks like SLF4J, JUL, etc.) | `opentelemetry-api-logs` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api-logs.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api-logs) | +| [Context API](./context) | OpenTelemetry context API | `opentelemetry-context` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-context.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-context) | +| [Semantic Conventions](./semconv) | Generated code for OpenTelemetry semantic conventions | `opentelemetry-semconv` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-semconv.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-semconv) | ### API Extensions -| Component | Description | Artifact ID | Version | -|---------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|-------------------------------------------------------------| -| [Kotlin Extension](./extensions/kotlin) | Context extension for coroutines | `opentelemetry-extension-kotlin` | 1.23.1 | -| [Trace Propagators Extension](./extensions/trace-propagators) | Trace propagators, including B3, Jaeger, OT Trace | `opentelemetry-extension-trace-propagators` | 1.23.1 | -| [Incubator Extension](./extensions/incubator) | API incubator, including pass through propagator, and extended tracer | `opentelemetry-extension-incubator` | 1.23.1-alpha | +| Component | Description | Artifact ID | Version | Javadoc | +|---------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|-------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Kotlin Extension](./extensions/kotlin) | Context extension for coroutines | `opentelemetry-extension-kotlin` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-extension-kotlin.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-extension-kotlin) | +| [Trace Propagators Extension](./extensions/trace-propagators) | Trace propagators, including B3, Jaeger, OT Trace | `opentelemetry-extension-trace-propagators` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-extension-trace-propagators.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-extension-trace-propagators) | +| [Incubator Extension](./extensions/incubator) | API incubator, including pass through propagator, and extended tracer | `opentelemetry-extension-incubator` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-extension-incubator.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-extension-incubator) | ### SDK -| Component | Description | Artifact ID | Version | -|----------------------------------------|--------------------------------------------------------|----------------------------------|-------------------------------------------------------------| -| [SDK](./sdk/all) | OpenTelemetry SDK, including metrics, traces, and logs | `opentelemetry-sdk` | 1.23.1 | -| [Metrics SDK](./sdk/metrics) | OpenTelemetry metrics SDK | `opentelemetry-sdk-metrics` | 1.23.1 | -| [Trace SDK](./sdk/trace) | OpenTelemetry trace SDK | `opentelemetry-sdk-trace` | 1.23.1 | -| [Log SDK](./sdk/logs) | OpenTelemetry log SDK | `opentelemetry-sdk-logs` | 1.23.1-alpha | -| [SDK Common](./sdk/common) | Shared SDK components | `opentelemetry-sdk-common` | 1.23.1 | -| [SDK Testing](./sdk/testing) | Components for testing OpenTelemetry instrumentation | `opentelemetry-sdk-testing` | 1.23.1 | -| [SDK Logs Testing](./sdk/logs-testing) | Components for testing OpenTelemetry logs | `opentelemetry-sdk-logs-testing` | 1.23.1-alpha | +| Component | Description | Artifact ID | Version | Javadoc | +|----------------------------------------|--------------------------------------------------------|----------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [SDK](./sdk/all) | OpenTelemetry SDK, including metrics, traces, and logs | `opentelemetry-sdk` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk) | +| [Metrics SDK](./sdk/metrics) | OpenTelemetry metrics SDK | `opentelemetry-sdk-metrics` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-metrics.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics) | +| [Trace SDK](./sdk/trace) | OpenTelemetry trace SDK | `opentelemetry-sdk-trace` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-trace.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace) | +| [Log SDK](./sdk/logs) | OpenTelemetry log SDK | `opentelemetry-sdk-logs` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-logs.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs) | +| [SDK Common](./sdk/common) | Shared SDK components | `opentelemetry-sdk-common` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-common.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common) | +| [SDK Testing](./sdk/testing) | Components for testing OpenTelemetry instrumentation | `opentelemetry-sdk-testing` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-testing.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-testing) | +| [SDK Logs Testing](./sdk/logs-testing) | Components for testing OpenTelemetry logs | `opentelemetry-sdk-logs-testing` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-logs-testing.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs-testing) | ### SDK Exporters -| Component | Description | Artifact ID | Version | -|-----------------------------------------------------|-------------------------------------------------------------------------------------|---------------------------------------|-------------------------------------------------------------| -| [OTLP Exporters](./exporters/otlp/all) | OTLP gRPC & HTTP exporters, including metrics and trace | `opentelemetry-exporter-otlp` | 1.23.1 | -| [OTLP Log Exporters](./exporters/otlp/logs) | OTLP gRPC & HTTP log exporters | `opentelemetry-exporter-otlp-logs` | 1.23.1-alpha | -| [OTLP Common](./exporters/otlp/common) | Shared OTLP components (internal) | `opentelemetry-exporter-otlp-common` | 1.23.1 | -| [Jaeger gRPC Exporter](./exporters/jaeger) | Jaeger gRPC trace exporter | `opentelemetry-exporter-jaeger` | 1.23.1 | -| [Jaeger Thrift Exporter](./exporters/jaeger-thrift) | Jaeger thrift trace exporter | `opentelemetry-exporter-jaeger-thift` | 1.23.1 | -| [Logging Exporter](./exporters/logging) | Logging exporters, includings metrics, traces, and logs | `opentelemetry-exporter-logging` | 1.23.1 | -| [OTLP Logging Exporter](./exporters/logging-otlp) | Logging exporters in OTLP protobuf JSON format, including metrics, traces, and logs | `opentelemetry-exporter-logging-otlp` | 1.23.1 | -| [Zipkin Exporter](./exporters/zipkin) | Zipkin trace exporter | `opentelemetry-exporter-zipkin` | 1.23.1 | -| [Prometheus Exporter](./exporters/prometheus) | Prometheus metric exporter | `opentelemetry-exporter-prometheus` | 1.23.1-alpha | -| [Exporter Common](./exporters/common) | Shared exporter components (internal) | `opentelemetry-exporter-common` | 1.23.1 | +| Component | Description | Artifact ID | Version | Javadoc | +|-----------------------------------------------------|-------------------------------------------------------------------------------------|---------------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [OTLP Exporters](./exporters/otlp/all) | OTLP gRPC & HTTP exporters, including metrics and trace | `opentelemetry-exporter-otlp` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-otlp.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-otlp) | +| [OTLP Log Exporters](./exporters/otlp/logs) | OTLP gRPC & HTTP log exporters | `opentelemetry-exporter-otlp-logs` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-otlp-logs.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-otlp-logs) | +| [OTLP Common](./exporters/otlp/common) | Shared OTLP components (internal) | `opentelemetry-exporter-otlp-common` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-otlp-common.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-otlp-common) | +| [Jaeger gRPC Exporter](./exporters/jaeger) | Jaeger gRPC trace exporter | `opentelemetry-exporter-jaeger` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-jaeger.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-jaeger) | +| [Jaeger Thrift Exporter](./exporters/jaeger-thrift) | Jaeger thrift trace exporter | `opentelemetry-exporter-jaeger-thift` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-jaeger-thrift.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-jaeger-thrift) | +| [Logging Exporter](./exporters/logging) | Logging exporters, includings metrics, traces, and logs | `opentelemetry-exporter-logging` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-logging.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-logging) | +| [OTLP Logging Exporter](./exporters/logging-otlp) | Logging exporters in OTLP protobuf JSON format, including metrics, traces, and logs | `opentelemetry-exporter-logging-otlp` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-logging-otlp.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-logging-otlp) | +| [Zipkin Exporter](./exporters/zipkin) | Zipkin trace exporter | `opentelemetry-exporter-zipkin` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-zipkin.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-zipkin) | +| [Prometheus Exporter](./exporters/prometheus) | Prometheus metric exporter | `opentelemetry-exporter-prometheus` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-prometheus.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-prometheus) | +| [Exporter Common](./exporters/common) | Shared exporter components (internal) | `opentelemetry-exporter-common` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-common.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-common) | ### SDK Extensions -| Component | Description | Artifact ID | Version | -|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------| -| [SDK Autoconfigure Extension](./sdk-extensions/autoconfigure) | Autoconfigure OpenTelemetry SDK from env vars, system properties, and SPI | `opentelemetry-sdk-extension-autoconfigure` | 1.23.1-alpha | -| [SDK Autoconfigure SPI](./sdk-extensions/autoconfigure-spi) | Service Provider Interface (SPI) definitions for autoconfigure | `opentelemetry-sdk-extension-autoconfigure-spi` | 1.23.1 | -| [SDK Jaeger Remote Sampler Extension](./sdk-extensions/jaeger-remote-sampler) | Sampler which obtains sampling configuration from remote Jaeger server | `opentelemetry-sdk-extension-jaeger-remote-sampler` | 1.23.1 | -| [SDK Incubator](./sdk-extensions/incubator) | SDK incubator, including YAML based view configuration, LeakDetectingSpanProcessor, and zPages | `opentelemetry-sdk-extension-incubator` | 1.23.1-alpha | +| Component | Description | Artifact ID | Version | Javadoc | +|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [SDK Autoconfigure Extension](./sdk-extensions/autoconfigure) | Autoconfigure OpenTelemetry SDK from env vars, system properties, and SPI | `opentelemetry-sdk-extension-autoconfigure` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure) | +| [SDK Autoconfigure SPI](./sdk-extensions/autoconfigure-spi) | Service Provider Interface (SPI) definitions for autoconfigure | `opentelemetry-sdk-extension-autoconfigure-spi` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi) | +| [SDK Jaeger Remote Sampler Extension](./sdk-extensions/jaeger-remote-sampler) | Sampler which obtains sampling configuration from remote Jaeger server | `opentelemetry-sdk-extension-jaeger-remote-sampler` | 1.23.1 | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler) | +| [SDK Incubator](./sdk-extensions/incubator) | SDK incubator, including YAML based view configuration, LeakDetectingSpanProcessor, and zPages | `opentelemetry-sdk-extension-incubator` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-incubator.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-incubator) | ### Shims -| Component | Description | Artifact ID | Version | -|----------------------------------------|--------------------------------------------------------------|----------------------------------|-------------------------------------------------------------| -| [OpenCensus Shim](./opencensus-shim) | Bridge opencensus metrics into the OpenTelemetry metrics SDK | `opentelemetry-opencensus-shim` | 1.23.1-alpha | -| [OpenTracing Shim](./opentracing-shim) | Bridge opentracing spans into the OpenTelemetry trace API | `opentelemetry-opentracing-shim` | 1.23.1-alpha | +| Component | Description | Artifact ID | Version | Javadoc | +|----------------------------------------|--------------------------------------------------------------|----------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [OpenCensus Shim](./opencensus-shim) | Bridge opencensus metrics into the OpenTelemetry metrics SDK | `opentelemetry-opencensus-shim` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-opencensus-shim.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-opencensus-shim) | +| [OpenTracing Shim](./opentracing-shim) | Bridge opentracing spans into the OpenTelemetry trace API | `opentelemetry-opentracing-shim` | 1.23.1-alpha | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-opentracing-shim.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-opentracing-shim) | ## Contributing diff --git a/api/all/README.md b/api/all/README.md index a8093e10002..86c14664fdd 100644 --- a/api/all/README.md +++ b/api/all/README.md @@ -1,22 +1,7 @@ # OpenTelemetry API -[![Javadocs][javadoc-image]][javadoc-url] +#### API Misuse Logging -* The code in this module is the implementation of stable OpenTelemetry signals. -* Semantic Conventions for OpenTelemetry are in the `opentelemetry-semconv` module. -* The default implementation of the interfaces in this module is in the OpenTelemetry SDK module. -* The interfaces in this directory can be implemented to create alternative - implementations of the OpenTelemetry library. +API misuse information is logged under logger named `io.opentelemetry.ApiUsageLogging`. -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api - ---- -#### Running micro-benchmarks -From the root of the repo run `./gradlew clean :api:jmh` to run all the benchmarks -or run `./gradlew clean :api:jmh -PjmhIncludeSingleClass=` -to run a specific benchmark class. - ---- -#### Logging API mis-use -Define `logging.level.io.opentelemetry.ApiUsageLogging=TRACE` to enable TRACE logging for invalid API calls. +To access, enable `FINEST` level logs. diff --git a/context/README.md b/context/README.md deleted file mode 100644 index f2ad11c09c1..00000000000 --- a/context/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry Context - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-context.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-context diff --git a/exporters/common/README.md b/exporters/common/README.md deleted file mode 100644 index 6f9184bab1d..00000000000 --- a/exporters/common/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry - Exporter Common - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-common.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-common diff --git a/exporters/jaeger-proto/README.md b/exporters/jaeger-proto/README.md index 7d5e7aaf23d..f7e8a0497d8 100644 --- a/exporters/jaeger-proto/README.md +++ b/exporters/jaeger-proto/README.md @@ -1,8 +1,3 @@ # OpenTelemetry - Jaeger Proto (DEPRECATED) -> **NOTICE**: External use of this artifact is deprecated. It will not have any changes in the future but will continue to be published as is until 2.0.0. - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-jaeger-proto.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-jaeger-proto +> **NOTICE**: External use of this artifact is deprecated. diff --git a/exporters/jaeger-thrift/README.md b/exporters/jaeger-thrift/README.md deleted file mode 100644 index cb770718b61..00000000000 --- a/exporters/jaeger-thrift/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# OpenTelemetry - Jaeger Exporter - Thrift - -[![Javadocs][javadoc-image]][javadoc-url] - -This is the OpenTelemetry exporter, sending span data to Jaeger via Thrift over HTTP. - -## Configuration - -The Jaeger Thrift span exporter can be configured programmatically. - -An example of simple Jaeger Thrift exporter initialization. In this case -spans will be sent to a Jaeger Thrift endpoint running on `localhost`: - -```java -JaegerThriftSpanExporter exporter = - JaegerThriftSpanExporter.builder() - .setEndpoint("http://localhost:14268/api/traces") - .build(); -``` - -If you need configuration via environment variables and/or system properties, you will want to use -the [autoconfigure](../../sdk-extensions/autoconfigure) module. - -## Compatibility - -As with the OpenTelemetry SDK itself, this exporter is compatible with Java 8+ and Android API level 24+. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-jaeger-thrift.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-jaeger-thrift diff --git a/exporters/jaeger/README.md b/exporters/jaeger/README.md deleted file mode 100644 index 7c4df73ef9b..00000000000 --- a/exporters/jaeger/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# OpenTelemetry - Jaeger Exporter - gRPC - -[![Javadocs][javadoc-image]][javadoc-url] - -This is the OpenTelemetry exporter, sending span data to Jaeger via gRPC. - -## Configuration - -The Jaeger gRPC span exporter can be configured programmatically. - -An example of simple Jaeger gRPC exporter initialization. In this case -spans will be sent to a Jaeger gRPC endpoint running on `localhost`: - -```java -JaegerGrpcSpanExporter exporter = - JaegerGrpcSpanExporter.builder() - .setEndpoint("http://localhost:14250") - .build(); -``` - -If you need configuration via environment variables and/or system properties, you will want to use -the [autoconfigure](../../sdk-extensions/autoconfigure) module. - -## Compatibility - -As with the OpenTelemetry SDK itself, this exporter is compatible with Java 8+ and Android API level 24+. - -## Proto files - -The proto files in this repository were copied over from the [Jaeger main repository][proto-origin]. -At this moment, they have to be manually synchronized, 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 -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-jaeger.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-jaeger diff --git a/exporters/logging-otlp/README.md b/exporters/logging-otlp/README.md deleted file mode 100644 index 82018d4cdd1..00000000000 --- a/exporters/logging-otlp/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# OpenTelemetry - OTLP JSON Logging Exporter - -[![Javadocs][javadoc-image]][javadoc-url] - -Exporters for writing data to logs using OTLP JSON format. They are appropriate for writing spans or -metrics to logs in a way that is both human-readable and structured for machine parsing. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-logging-otlp.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-logging-otlp diff --git a/exporters/logging/README.md b/exporters/logging/README.md deleted file mode 100644 index 1609476a396..00000000000 --- a/exporters/logging/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry - Logging Exporter - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-logging.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-logging diff --git a/exporters/otlp/all/README.md b/exporters/otlp/all/README.md deleted file mode 100644 index c02178ee94a..00000000000 --- a/exporters/otlp/all/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry - OTLP gRPC Exporters - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-otlp.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-otlp diff --git a/exporters/otlp/common/README.md b/exporters/otlp/common/README.md deleted file mode 100644 index f0805343886..00000000000 --- a/exporters/otlp/common/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# OpenTelemetry - OTLP Common - -[![Javadocs][javadoc-image]][javadoc-url] - -This module contains common utility code used by other OpenTelemetry OTLP modules, including conversion between OpenTelemetry API or SDK objects and proto objects. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-otlp-common.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-otlp-common diff --git a/exporters/prometheus/README.md b/exporters/prometheus/README.md deleted file mode 100644 index af2e89660e5..00000000000 --- a/exporters/prometheus/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# OpenTelemetry - Prometheus Exporter - -[![Javadocs][javadoc-image]][javadoc-url] - -This is the OpenTelemetry's Prometheus exporter, allowing Prometheus to query metrics data. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-prometheus.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-prometheus diff --git a/exporters/zipkin/README.md b/exporters/zipkin/README.md index 21c27587ac0..9fb38662a12 100644 --- a/exporters/zipkin/README.md +++ b/exporters/zipkin/README.md @@ -1,33 +1,7 @@ # OpenTelemetry - Zipkin Span Exporter -[![Javadocs][javadoc-image]][javadoc-url] - -This is an OpenTelemetry exporter that sends span data using the [io.zipkin.reporter2:zipkin-reporter](https://github.com/openzipkin/zipkin-reporter-java) library. - -By default, this POSTs json in [Zipkin format](https://zipkin.io/zipkin-api/#/default/post_spans) to -a specified HTTP URL. This could be to a [Zipkin](https://zipkin.io) service, or anything that -consumes the same format. - -You can alternatively use other formats, such as protobuf, or override the `Sender` to use a non-HTTP transport, such as Kafka. - -## Configuration - -The Zipkin span exporter can be configured programmatically. - -An example of simple Zipkin exporter initialization. In this case -spans will be sent to a Zipkin endpoint running on `localhost`: - -```java -ZipkinSpanExporter exporter = - ZipkinSpanExporter.builder() - .setEndpoint("http://localhost/api/v2/spans") - .build(); -``` - ## Attribution The code in this module is based on the [OpenCensus Zipkin exporter][oc-origin] code. -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-zipkin.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-zipkin [oc-origin]: https://github.com/census-instrumentation/opencensus-java/ diff --git a/extensions/incubator/README.md b/extensions/incubator/README.md deleted file mode 100644 index aaeec552def..00000000000 --- a/extensions/incubator/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry Extension Incubator - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-extension-incubator.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-extension-incubator diff --git a/extensions/kotlin/README.md b/extensions/kotlin/README.md deleted file mode 100644 index cf05ae83ac0..00000000000 --- a/extensions/kotlin/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry Extension Kotlin - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-extension-kotlin.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-extension-kotlin diff --git a/extensions/trace-propagators/README.md b/extensions/trace-propagators/README.md deleted file mode 100644 index 57b33cab7ba..00000000000 --- a/extensions/trace-propagators/README.md +++ /dev/null @@ -1,23 +0,0 @@ -OpenTelemetry Extension Trace Propagators -====================================================== - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-extension-trace-propagators.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-extension-trace-propagators - -This repository provides several -[trace propagators](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md), -used to propagate context across a distributed trace. - -OpenTelemetry Java provides first-party support for -[B3 (OpenZipkin)](https://github.com/openzipkin/b3-propagation) and -[Jaeger](https://github.com/jaegertracing/jaeger) propagators. Issues with those propagators -should be filed against this repo. - ---- -#### Running micro-benchmarks -From the root of the repo run `./gradlew clean :opentelemetry-extension-trace-propagators:jmh` -to run all the benchmarks -or run `./gradlew clean :opentelemetry-extension-trace-propagators:jmh -PjmhIncludeSingleClass=` -to run a specific benchmark class. diff --git a/integration-tests/README.md b/integration-tests/README.md deleted file mode 100644 index 0632073ccd5..00000000000 --- a/integration-tests/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# OpenTelemetry Integration Tests - - -* Integration Test code lives here diff --git a/opencensus-shim/README.md b/opencensus-shim/README.md index 9e54ba4adac..69c9f3319cd 100644 --- a/opencensus-shim/README.md +++ b/opencensus-shim/README.md @@ -1,7 +1,5 @@ # OpenTelemetry OpenCensus Shim -[![Javadocs][javadoc-image]][javadoc-url] - The OpenCensus shim allows applications and libraries that are instrumented with OpenTelemetry, but depend on other libraries instrumented with OpenCensus, to export trace spans from both OpenTelemetry and OpenCensus with the correct @@ -24,33 +22,24 @@ To allow the shim to work for metrics, add the shim as a dependency. Applications also need to attach OpenCensus metrics to their metric readers on registration. -``` +```java +PeriodicMetricReader reader = ... SdkMeterProvider.builder() - .registerMetricReader( - OpenCensusMetrics.attachTo(readerFactory) - ) - .buildAndRegisterGlobal(); + .registerMetricReader(OpenCensusMetrics.attachTo(reader)) + .buildAndRegisterGlobal(); ``` For example, if a logging exporter were configured, the following would be added: -``` -LoggingMetricExporter metricExporter = new LoggingMetricExporter(); +```java +LoggingMetricExporter metricExporter = LoggingMetricExporter.create(); SdkMeterProvider.builder() - .registerMetricReader( - OpenCensusMetrics.attachTo( - PeriodicMetricReader.builder(metricExporter) - .newMetricReaderFactory() - ) - ) - .buildAndRegisterGlobal(); + .registerMetricReader(OpenCensusMetrics.attachTo(PeriodicMetricReader.create(metricExporter))) + .build(); ``` ## Known Problems * OpenCensus links added after an OpenCensus span is created will not be exported, as OpenTelemetry only supports links added when a span is created. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-opencensus-shim.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-opencensus-shim diff --git a/opentracing-shim/README.md b/opentracing-shim/README.md index 9bb308663d6..55e01814828 100644 --- a/opentracing-shim/README.md +++ b/opentracing-shim/README.md @@ -1,7 +1,5 @@ # OpenTelemetry - OpenTracing Shim -[![Javadocs][javadoc-image]][javadoc-url] - The OpenTracing shim is a bridge layer from OpenTelemetry to the OpenTracing API. It takes OpenTelemetry Tracer and exposes it as an implementation of an OpenTracing Tracer. @@ -21,6 +19,3 @@ Optionally register the tracer as the OpenTracing GlobalTracer: ```java GlobalTracer.registerIfAbsent(tracer); ``` - -[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 diff --git a/sdk-extensions/autoconfigure-spi/README.md b/sdk-extensions/autoconfigure-spi/README.md deleted file mode 100644 index 475f7efed35..00000000000 --- a/sdk-extensions/autoconfigure-spi/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# OpenTelemetry SDK Autoconfigure SPI - -[![Javadocs][javadoc-image]][javadoc-url] - -This artifact provides Java Service Provider Interfaces (SPI) for controlling [SDK autoconfiguration](../autoconfigure). -Visit the autoconfigure module for more information on how to use autoconfiguration. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi diff --git a/sdk-extensions/autoconfigure/README.md b/sdk-extensions/autoconfigure/README.md index 33aef2bccdd..a39000c16b9 100644 --- a/sdk-extensions/autoconfigure/README.md +++ b/sdk-extensions/autoconfigure/README.md @@ -1,7 +1,5 @@ # OpenTelemetry SDK Autoconfigure -[![Javadocs][javadoc-image]][javadoc-url] - This artifact implements environment-based autoconfiguration of the OpenTelemetry SDK. This can be an alternative to programmatic configuration using the normal SDK builders. @@ -314,6 +312,3 @@ These properties can be used to control the maximum size of spans by placing lim Autoconfiguration exposes SPI [hooks](../autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi) for customizing behavior programmatically as needed. It's recommended to use the above configuration properties where possible, only implementing the SPI to add functionality not found in the SDK by default. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure diff --git a/sdk-extensions/incubator/README.md b/sdk-extensions/incubator/README.md index d01145e3d26..e035c839c29 100644 --- a/sdk-extensions/incubator/README.md +++ b/sdk-extensions/incubator/README.md @@ -1,7 +1,5 @@ # OpenTelemetry Incubator -[![Javadocs][javadoc-image]][javadoc-url] - This artifact contains experimental code related to the trace and metric SDKs. ## View File Configuration @@ -180,17 +178,3 @@ The /traceconfigz zPage displays information about the currently active tracing provides an interface for users to modify relevant parameters. Here is what the web page looks like: ![traceconfigz](img/traceconfigz.png) - -### Benchmark Testing - -This module contains two sets of benchmark tests: one for adding spans to an instance of -TracezSpanBuckets and another for retrieving counts and spans with TracezDataAggregator. You can run -the tests yourself with the following commands: - -``` -./gradlew -PjmhIncludeSingleClass=TracezSpanBucketsBenchmark clean :opentelemetry-sdk-extension-zpages:jmh -./gradlew -PjmhIncludeSingleClass=TracezDataAggregatorBenchmark clean :opentelemetry-sdk-extension-zpages:jmh -``` - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-tracing-incubator.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-tracing-incubator diff --git a/sdk-extensions/jaeger-remote-sampler/README.md b/sdk-extensions/jaeger-remote-sampler/README.md index e4c632116d5..0c4af5fa7b4 100644 --- a/sdk-extensions/jaeger-remote-sampler/README.md +++ b/sdk-extensions/jaeger-remote-sampler/README.md @@ -1,7 +1,5 @@ # Jaeger Remote Sampler -[![Javadocs][javadoc-image]][javadoc-url] - This module implements [Jaeger remote sampler](https://www.jaegertracing.io/docs/latest/sampling/#collector-sampling-configuration). The sampler configuration is received from collector's gRPC endpoint. @@ -18,6 +16,3 @@ return SdkTracerProvider.builder() .setSampler(sampler) .build(); ``` - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler diff --git a/sdk/all/README.md b/sdk/all/README.md deleted file mode 100644 index 9ee9006a4b0..00000000000 --- a/sdk/all/README.md +++ /dev/null @@ -1,13 +0,0 @@ -OpenTelemetry SDK -====================================================== - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk - ---- -#### Running micro-benchmarks -From the root of the repo run `./gradlew clean :opentelemetry-sdk:jmh` to run all the benchmarks -or run `./gradlew clean :opentelemetry-sdk:jmh -PjmhIncludeSingleClass=` -to run a specific benchmark class. diff --git a/sdk/common/README.md b/sdk/common/README.md deleted file mode 100644 index ca0d8b5d9b8..00000000000 --- a/sdk/common/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry SDK Common - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-common.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common diff --git a/sdk/logs-testing/README.md b/sdk/logs-testing/README.md deleted file mode 100644 index 8f6c8ec7c8c..00000000000 --- a/sdk/logs-testing/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry Logs SDK Testing - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-logs-testing.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs-testing diff --git a/sdk/logs/README.md b/sdk/logs/README.md deleted file mode 100644 index a939cdba53f..00000000000 --- a/sdk/logs/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# OpenTelemetry Experimental Logging Support - -[![Javadocs][javadoc-image]][javadoc-url] - -This project contains experimental support for transport of logs via OpenTelemetry. The API -presented is intended for the use of logging library adapters to enable resource and request -correlation with other observability signals and transport of logs through the OpenTelemetry -collector. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-logging.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-logging diff --git a/sdk/metrics/README.md b/sdk/metrics/README.md deleted file mode 100644 index 1b18aaca21e..00000000000 --- a/sdk/metrics/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry Metrics SDK - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-metrics.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics diff --git a/sdk/metrics/histograms.png b/sdk/metrics/histograms.png deleted file mode 100644 index a8ca2de8615..00000000000 Binary files a/sdk/metrics/histograms.png and /dev/null differ diff --git a/sdk/testing/README.md b/sdk/testing/README.md deleted file mode 100644 index f57880691e8..00000000000 --- a/sdk/testing/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry SDK Testing - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-testing.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-testing diff --git a/sdk/trace/README.md b/sdk/trace/README.md deleted file mode 100644 index 7798d150306..00000000000 --- a/sdk/trace/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# OpenTelemetry Trace SDK - -[![Javadocs][javadoc-image]][javadoc-url] - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-trace.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace diff --git a/semconv/README.md b/semconv/README.md index cf626b4bae9..c70c47abe06 100644 --- a/semconv/README.md +++ b/semconv/README.md @@ -1,10 +1,5 @@ # OpenTelemetry Semantic Conventions -[![Javadocs][javadoc-image]][javadoc-url] - * This module contains generated code for the Semantic Conventions defined by the OpenTelemetry specification. * Scripts for generating the classes live in the `buildscripts/semantic-convention` directory at the top level of the project. - -[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-semconv.svg -[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-semconv