Apache Solr open-source search software
SOLR-16236: Clarify use of GSON jar in jaegertracer-configurator (#894)
Eric Pugh856d55b0195a
diff --git a/solr/modules/jaegertracer-configurator/README.md b/solr/modules/jaegertracer-configurator/README.mdindex 8750b22db5f..b5603739282 100644--- a/solr/modules/jaegertracer-configurator/README.md+++ b/solr/modules/jaegertracer-configurator/README.md@@ -18,13 +18,13 @@Welcome to Apache Solr Jaeger Tracer Configurator========-Apache Solr Jaeger Tracer Configurator (solr-jaegertracer) provides a way for you to expose Solr's tracing to Jaeger.+Apache Solr Jaeger Tracer Configurator provides a way for you to expose Solr's tracing to Jaeger.# Setup Jaeger Tracer Configurator-Add the solr-jaegertracer JAR file and the other JARs provided with this module to your Solr installation, ideally to each node.-GSON is a dependency that is only used by Jaeger's "remote" sampler,-which is the default. Solr doesn't distribute it, so you'll need to add GSON yourself or configure a different sampler.+Add this Solr Module to your Solr installation by enabling it via `-Dsolr.modules=jaegertracer-configurator`++There are a number of sampler's available to Jaeger. Learn more about the available samplers at https://www.jaegertracing.io/docs/sampling/#client-sampling-configuration.The Jaeger Tracer Configurator is added to `solr.xml` like this:@@ -43,4 +43,4 @@ or System property:```bin/solr start -DJAEGER_SAMPLER_TYPE=probabilistic-```\ No newline at end of file+```diff --git a/solr/modules/jaegertracer-configurator/src/test/org/apache/solr/jaeger/TestJaegerConfigurator.java b/solr/modules/jaegertracer-configurator/src/test/org/apache/solr/jaeger/TestJaegerConfigurator.javaindex 78e44a26aea..4a8cdd9498b 100644--- a/solr/modules/jaegertracer-configurator/src/test/org/apache/solr/jaeger/TestJaegerConfigurator.java+++ b/solr/modules/jaegertracer-configurator/src/test/org/apache/solr/jaeger/TestJaegerConfigurator.java@@ -45,8 +45,7 @@ public class TestJaegerConfigurator extends SolrTestCaseJ4 {resetGlobalTracer();ExecutorUtil.resetThreadLocalProviders();- // The default sampler is one that uses GSON but we don't bother with that dependency.- // So we change it to something simple.+ // "remote" is the default sampler, however we want to use something simpler in the tests.System.setProperty("JAEGER_SAMPLER_TYPE", "const");}diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/distributed-tracing.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/distributed-tracing.adocindex 5b2c48ac2de..0c992d19fa9 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/distributed-tracing.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/distributed-tracing.adoc@@ -55,8 +55,7 @@ https://docs.datadoghq.com/tracing/setup/java/[datadog-java-agent] uses JavaagenThe `modules/jagertracer-configurator` provides a default implementation for setting up Jaeger Tracer.Add the solr-jaegertracer JAR file and the other JARs provided with this module to your Solr installation, ideally to each node.-https://github.com/google/gson[GSON] is a dependency that is only used by Jaeger's "remote" sampler,-which is the default. Solr doesn't distribute it, so you'll need to add GSON yourself or configure a different sampler.+Learn more about the available samplers at https://www.jaegertracing.io/docs/sampling/#client-sampling-configuration.Then Jaeger tracer is configured in `solr.xml` like this: