From 5a81bf3655a09a744172a07d83d68525a411588c Mon Sep 17 00:00:00 2001 From: Crypt Keeper <64215+codefromthecrypt@users.noreply.github.com> Date: Tue, 9 Jan 2024 06:39:57 +0800 Subject: [PATCH] Docs: adds note about explicit reporter dependencies (#1402) Signed-off-by: Adrian Cole --- brave/README.md | 3 +++ spring-beans/README.md | 6 ++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/brave/README.md b/brave/README.md index 3d1c5918fd..efdf8cec50 100644 --- 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 index 8874e478e5..6383dedc1d 100644 --- 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