notes on deps

Signed-off-by: Adrian Cole <[email protected]>
openzipkin · Jan 5, 2024 · 3262320 · 3262320
1 parent 5939d22
commit 3262320
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/brave/pom.xml b/brave/pom.xml
@@ -41,7 +41,17 @@
       <groupId>${project.groupId}</groupId>
       <artifactId>zipkin-reporter</artifactId>
       <version>${project.version}</version>
+      <!-- Exclude the Zipkin dependency by default because
+           AsyncZipkinSpanHandler avoids zipkin types. -->
+      <exclusions>
+        <exclusion>
+          <groupId>io.zipkin.zipkin2</groupId>
+          <artifactId>zipkin</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
+    <!-- Those using ZipkinSpanHandler.create or newBuilder need zipkin types
+         as they are passing a zipkin2.Span reporter. -->
     <dependency>
       <groupId>io.zipkin.zipkin2</groupId>
       <artifactId>zipkin</artifactId>

diff --git a/core/pom.xml b/core/pom.xml
@@ -37,11 +37,12 @@
   </properties>
 
   <dependencies>
+    <!-- This dependency can be excluded for those not using
+         zipkin2.reporter.AsyncReporter, which uses zipkin2 types. -->
     <dependency>
       <groupId>io.zipkin.zipkin2</groupId>
       <artifactId>zipkin</artifactId>
       <version>${zipkin.version}</version>
-      <optional>true</optional>
     </dependency>
   </dependencies>