You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ep...@apache.org on 2022/07/06 16:06:36 UTC
[solr] branch main updated: SOLR-16236: Clarify use of GSON jar in jaegertracer-configurator (#894)
This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new 856d55b0195 SOLR-16236: Clarify use of GSON jar in jaegertracer-configurator (#894)
856d55b0195 is described below
commit 856d55b0195af6d374775d97ba216bc04899906b
Author: Eric Pugh <ep...@opensourceconnections.com>
AuthorDate: Wed Jul 6 12:06:30 2022 -0400
SOLR-16236: Clarify use of GSON jar in jaegertracer-configurator (#894)
* consensus was to keep gson dependency, so update based on that.
---
solr/modules/jaegertracer-configurator/README.md | 10 +++++-----
.../test/org/apache/solr/jaeger/TestJaegerConfigurator.java | 3 +--
.../modules/deployment-guide/pages/distributed-tracing.adoc | 3 +--
3 files changed, 7 insertions(+), 9 deletions(-)
diff --git a/solr/modules/jaegertracer-configurator/README.md b/solr/modules/jaegertracer-configurator/README.md
index 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.java
index 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.adoc
index 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 Javaagen
The `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: