Docs: adds note about explicit reporter dependencies (#1402)

Signed-off-by: Adrian Cole <adrian@tetrate.io>
openzipkin · Jan 8, 2024 · 5a81bf3 · 5a81bf3
1 parent cf8dbf9
commit 5a81bf3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/brave/README.md b/brave/README.md
@@ -52,6 +52,9 @@ reporter = AsyncReporter.builder(sender)
 zipkinSpanHandler = ZipkinSpanHandler.create(reporter)
 ```
 
+*Note*: `ZipkinSpanHandler` requires an explicit dependency on
+[io.zipkin.reporter2:zipkin-reporter](https://github.com/openzipkin/zipkin-reporter-java/tree/master/core)
+
 ## Tracing
 
 The tracer creates and joins spans that model the latency of potentially

diff --git a/spring-beans/README.md b/spring-beans/README.md
@@ -1,10 +1,12 @@
 # brave-spring-beans
 This module contains Spring Factory Beans that allow you to configure
-tracing with only XML
+tracing with only XML.
+
+*Note*: zipkin2.reporter beans require a dependency on
+[io.zipkin.reporter2:zipkin-reporter-spring-beans](https://github.com/openzipkin/zipkin-reporter-java/tree/master/spring-beans)
 
 ## Configuration
 Bean Factories exist for the following types:
-* EndpointFactoryBean - for configuring the service name, IP etc representing this host
 * TracingFactoryBean - wires most together, like reporter and log integration
 * RpcTracingFactoryBean - for RPC tagging and sampling policy
 * HttpTracingFactoryBean - for HTTP tagging and sampling policy