com.couchbase.client.tracing.opentracing.OpenTracingRequestTracer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tracing-opentracing Show documentation

Provides interoperability with OpenTracing

There is a newer version: 1.5.3

/*
 * Copyright (c) 2019 Couchbase, Inc.
 *
 * Licensed 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 com.couchbase.client.tracing.opentracing;

import com.couchbase.client.core.cnc.RequestSpan;
import com.couchbase.client.core.cnc.RequestTracer;
import com.couchbase.client.core.error.TracerException;
import io.opentracing.Span;
import io.opentracing.Tracer;
import reactor.core.publisher.Mono;

import java.time.Duration;

/**
 * Wraps the OpenTracing tracer so it is suitable to be passed in into the couchbase environment and picked up
 * by the rest of the SDK as a result.
 */
public class OpenTracingRequestTracer implements RequestTracer {

  /**
   * Holds the actual OT tracer.
   */
  private final Tracer tracer;

  /**
   * Wraps the OpenTracing tracer and returns a datatype that can be passed into the requestTracer method of the
   * environment.
   *
   * @param tracer the tracer to wrap.
   * @return the wrapped tracer ready to be passed in.
   */
  public static OpenTracingRequestTracer wrap(final Tracer tracer) {
    return new OpenTracingRequestTracer(tracer);
  }

  private OpenTracingRequestTracer(Tracer tracer) {
    this.tracer = tracer;
  }

  private Span castSpan(final RequestSpan requestSpan) {
    if (requestSpan == null) {
      return null;
    }

    if (requestSpan instanceof OpenTracingRequestSpan) {
      return ((OpenTracingRequestSpan) requestSpan).span();
    } else {
      throw new IllegalArgumentException("RequestSpan must be of type OpenTracingRequestSpan");
    }
  }

  @Override
  public RequestSpan requestSpan(final String operationName, final RequestSpan parent) {
    try {
      Tracer.SpanBuilder builder = tracer.buildSpan(operationName);
      if (parent != null) {
        builder.asChildOf(castSpan(parent));
      }
      Span span = builder.start();
      tracer.activateSpan(span).close();
      return OpenTracingRequestSpan.wrap(tracer, span);
    } catch (Exception ex) {
      throw new TracerException("Failed to create OpenTracingRequestSpan", ex);
    }
  }

  /**
   * Returns the inner OpenTracing tracer.
   */
  public Tracer tracer() {
    return  tracer;
  }

  @Override
  public Mono start() {
    return Mono.empty(); // Tracer is not started by us
  }

  @Override
  public Mono stop(Duration timeout) {
    return Mono.empty(); // Tracer should not be stopped by us
  }

}