org.apache.solr.util.tracing.TraceUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Apache Solr (module: core)
There is a newer version: 9.7.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.solr.util.tracing;

import io.opentracing.Span;
import io.opentracing.Tracer;
import io.opentracing.Tracer.SpanBuilder;
import io.opentracing.noop.NoopSpan;
import io.opentracing.propagation.Format;
import io.opentracing.tag.Tags;
import io.opentracing.util.GlobalTracer;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Predicate;
import org.apache.http.HttpRequest;
import org.apache.solr.request.SolrQueryRequest;
import org.eclipse.jetty.client.api.Request;

/** Utilities for distributed tracing. */
public class TraceUtils {

  public static final Predicate DEFAULT_IS_RECORDING =
      (span) -> span != null && !(span instanceof NoopSpan);

  /**
   * this should only be changed in the context of testing, otherwise it would risk not recording
   * trace data.
   */
  public static Predicate IS_RECORDING = DEFAULT_IS_RECORDING;

  public static void setDbInstance(SolrQueryRequest req, String coreOrColl) {
    if (req != null && coreOrColl != null) {
      ifNotNoop(req.getSpan(), (span) -> span.setTag(Tags.DB_INSTANCE, coreOrColl));
    }
  }

  public static void ifNotNoop(Span span, Consumer consumer) {
    if (IS_RECORDING.test(span)) {
      consumer.accept(span);
    }
  }

  public static void injectTraceContext(Request req, Span span) {
    Tracer tracer = GlobalTracer.get();
    if (span != null) {
      tracer.inject(span.context(), Format.Builtin.HTTP_HEADERS, new SolrJettyRequestCarrier(req));
    }
  }

  public static void injectTraceContext(HttpRequest req) {
    Tracer tracer = GlobalTracer.get();
    Span span = tracer.activeSpan();
    if (span != null) {
      tracer.inject(
          span.context(), Format.Builtin.HTTP_HEADERS, new SolrApacheHttpRequestCarrier(req));
    }
  }

  public static void setOperations(SolrQueryRequest req, String clazz, List ops) {
    if (!ops.isEmpty()) {
      req.getSpan().setTag("ops", String.join(",", ops));
      req.getSpan().setTag("class", clazz);
    }
  }

  public static Span startCollectionApiCommandSpan(
      Tracer tracer, String name, String collection, boolean isAsync) {
    SpanBuilder spanBuilder =
        tracer
            .buildSpan(name)
            .asChildOf(tracer.activeSpan())
            .withTag(Tags.SPAN_KIND, isAsync ? Tags.SPAN_KIND_PRODUCER : Tags.SPAN_KIND_CLIENT)
            .withTag(Tags.DB_INSTANCE, collection);
    return spanBuilder.start();
  }
}