From a8ef4a9b25b04ba844f5c5fb60ffffd53683b17b Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 13 Jul 2020 16:31:37 -0700 Subject: [PATCH 1/3] Add otel-java version interop warning --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index eb2ef8d0a701..4523193f1f75 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,12 @@ you can enable it by add the following system property: ## Manually instrumenting +> :warning: prior to version 1.0, `opentelemetry-javaagent--all.jar` +only supports interoperability with the same version of `opentelemetry-api`. +E.g. `opentelemetry-javaagent-0.6.0-all.jar` only interoperates with `opentelemetry-api-0.6.0`. +Starting with 1.0, the Java agent will start supporting multiple (1.0+) versions of +`opentelemetry-api`. + You can use the OpenTelemetry `getTracer` or the `@WithSpan` annotation to manually instrument your Java application. From 88702405a6818098dfa3189d42e5d2090c792ab6 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 13 Jul 2020 16:38:42 -0700 Subject: [PATCH 2/3] Two fixes --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4523193f1f75..4d347c082846 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ at `localhost:55680`. Configuration parameters are passed as Java system properties (`-D` flags) or as environment variables (see below for full list). For example: ``` -java -javaagent:path/to/opentelemetry-auto-all.jar \ +java -javaagent:path/to/opentelemetry-javaagent-all.jar \ -Dota.exporter=zipkin -jar myapp.jar ``` @@ -184,11 +184,11 @@ you can enable it by add the following system property: ## Manually instrumenting -> :warning: prior to version 1.0, `opentelemetry-javaagent--all.jar` +> :warning: prior to version 1.0, `opentelemetry-javaagent-all.jar` only supports interoperability with the same version of `opentelemetry-api`. -E.g. `opentelemetry-javaagent-0.6.0-all.jar` only interoperates with `opentelemetry-api-0.6.0`. -Starting with 1.0, the Java agent will start supporting multiple (1.0+) versions of -`opentelemetry-api`. +E.g. version 0.6.0 of `opentelemetry-javaagent-all.jar` only interoperates with version 0.6.0 of +`opentelemetry-api`. Starting with 1.0, the Java agent will start supporting multiple (1.0+) +versions of `opentelemetry-api`. You can use the OpenTelemetry `getTracer` or the `@WithSpan` annotation to manually instrument your Java application. From 96a2b569de1d281874b9b02b18ac625bf18faceb Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 13 Jul 2020 16:47:14 -0700 Subject: [PATCH 3/3] Improvements --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4d347c082846..cf34d99340c2 100644 --- a/README.md +++ b/README.md @@ -184,11 +184,10 @@ you can enable it by add the following system property: ## Manually instrumenting -> :warning: prior to version 1.0, `opentelemetry-javaagent-all.jar` -only supports interoperability with the same version of `opentelemetry-api`. -E.g. version 0.6.0 of `opentelemetry-javaagent-all.jar` only interoperates with version 0.6.0 of -`opentelemetry-api`. Starting with 1.0, the Java agent will start supporting multiple (1.0+) -versions of `opentelemetry-api`. +> :warning: starting with 0.6.0, and prior to version 1.0.0, `opentelemetry-javaagent-all.jar` +only supports manual instrumentation using the `opentelemetry-api` version with the same version +number as the Java agent you are using. Starting with 1.0.0, the Java agent will start supporting +multiple (1.0.0+) versions of `opentelemetry-api`. You can use the OpenTelemetry `getTracer` or the `@WithSpan` annotation to manually instrument your Java application.