You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ja...@apache.org on 2023/01/05 23:48:56 UTC

[solr] branch branch_9x updated: SOLR-16534 Deprecate Jaegertracer-Configurator (#1270)

This is an automated email from the ASF dual-hosted git repository.

janhoy pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git


The following commit(s) were added to refs/heads/branch_9x by this push:
     new 59cbf04855a SOLR-16534 Deprecate Jaegertracer-Configurator (#1270)
59cbf04855a is described below

commit 59cbf04855a7c9d911523dc87b81b390b6ffe231
Author: Jan Høydahl <ja...@users.noreply.github.com>
AuthorDate: Fri Jan 6 00:47:26 2023 +0100

    SOLR-16534 Deprecate Jaegertracer-Configurator (#1270)
---
 solr/CHANGES.txt                                                   | 2 ++
 solr/modules/jaegertracer-configurator/README.md                   | 2 ++
 .../src/java/org/apache/solr/jaeger/JaegerTracerConfigurator.java  | 4 ++++
 .../modules/deployment-guide/pages/distributed-tracing.adoc        | 7 ++++++-
 .../modules/upgrade-notes/pages/major-changes-in-solr-9.adoc       | 5 +++++
 5 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 86acd429dfe..0ccc88371f6 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -182,6 +182,8 @@ Other Changes
 
 * SOLR-16574: Demonstrate Dense Vectors and KNN as part of the Films example (Gabriel Magno via Eric Pugh)
 
+* SOLR-16534: Jaegertracer-Configurator is now deprecated. From v10.0 we'll only support OpenTelemetry (janhoy)
+
 ==================  9.1.1 ==================
 
 Bug Fixes
diff --git a/solr/modules/jaegertracer-configurator/README.md b/solr/modules/jaegertracer-configurator/README.md
index b5603739282..3856ea1d673 100644
--- a/solr/modules/jaegertracer-configurator/README.md
+++ b/solr/modules/jaegertracer-configurator/README.md
@@ -18,6 +18,8 @@
 Welcome to Apache Solr Jaeger Tracer Configurator
 ========
 
+**WARNING**: This module is deprecated for removal in v10.0.
+
 Apache Solr Jaeger Tracer Configurator provides a way for you to expose Solr's tracing to Jaeger.
 
 # Setup Jaeger Tracer Configurator
diff --git a/solr/modules/jaegertracer-configurator/src/java/org/apache/solr/jaeger/JaegerTracerConfigurator.java b/solr/modules/jaegertracer-configurator/src/java/org/apache/solr/jaeger/JaegerTracerConfigurator.java
index f9b9f1711c5..d99f7848392 100644
--- a/solr/modules/jaegertracer-configurator/src/java/org/apache/solr/jaeger/JaegerTracerConfigurator.java
+++ b/solr/modules/jaegertracer-configurator/src/java/org/apache/solr/jaeger/JaegerTracerConfigurator.java
@@ -21,6 +21,10 @@ import io.jaegertracing.Configuration;
 import io.opentracing.Tracer;
 import org.apache.solr.core.TracerConfigurator;
 
+/**
+ * @deprecated This module will be removed in v10.0
+ */
+@Deprecated(forRemoval = true, since = "9.2")
 public class JaegerTracerConfigurator extends TracerConfigurator {
 
   @Override
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 d16127d4f77..3303f11a346 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
@@ -20,7 +20,7 @@ Solr includes a general tracing framework based on OpenTracing that can be used
 
 Tracing data can be configured to send to various backends, either directly or via an agent. Solr can send traces directly in OTLP/gRPC and Jaeger/Thrift formats. You can support many other destinations and cloud providers by installing an agent on each node and sending traces to localhost.
 
-A sampled distributed tracing query request displayed in Jaeger looks like this:
+A sampled distributed tracing query request displayed in Jaeger UI looks like this:
 
 .Tracing of a Solr query
 image::distributed-tracing/query-request-tracing.png[]
@@ -105,6 +105,11 @@ OTEL_EXPORTER_ZIPKIN_ENDPOINT=http://localhost:9411/api/v2/spans
 
 == Jaeger Tracer Module
 
+[WARNING]
+====
+This module is deprecated as of Solr 9.2, and will be removed in version 10. Users should migrate to OpenTelemetry.
+====
+
 The module `jagertracer-configurator` provides a default implementation for setting up Jaeger Tracer. Enable the module with either system property `-Dsolr.modules=jaegertracer-configurator` or environment variable `SOLR_MODULES=jaegertracer-configurator`.
 
 Learn more about the available samplers at https://www.jaegertracing.io/docs/sampling/#client-sampling-configuration.
diff --git a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
index b34892014e4..11f6b1c1f40 100644
--- a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
+++ b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
@@ -70,6 +70,11 @@ Due to changes in Lucene 9, that isn't possible any more.
 This is an improvement to the binary release artifact, but Jetty does not allow web-apps (Solr) to share these libraries by default.
 The `server/contexts/solr-jetty-context.xml` now explicitly removes these restrictions, allowing Solr to share these "server" jars which now live in `server/lib/ext`.
 
+=== Tracing
+* A new `opentelemetry` module is added, with support for OTEL tracing in `OTLP` format using gRPC.
+  At the same time, the `jaegertracer-configurator` module is deprecated for removal in Solr 10.
+  Users should start migrating to the new module to prepare for a smooth transition.
+
 == Solr 9.1
 === Querying and Indexing
 * Added Lucene91HnswVectorsFormat codec for DenseVectorField. In order to use the new codec, reindex is necessary.