com.couchbase.client.tracing.opentracing.OpenTracingRequestSpan 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.msg.RequestContext;
import io.opentracing.Scope;
import io.opentracing.Span;
import io.opentracing.Tracer;

import java.time.Instant;
import java.time.temporal.ChronoUnit;

import static com.couchbase.client.core.util.Validators.notNull;

/**
 * Wraps an OpenTracing span, ready to be passed in into options for each operation into the SDK as a parent.
 */
public class OpenTracingRequestSpan implements RequestSpan {

  /**
   * The OT parent span.
   */
  private final Span span;

  /**
   * The OT tracer in use.
   */
  private final Tracer tracer;

  private OpenTracingRequestSpan(final Tracer tracer, final Span span) {
    notNull(tracer, "Tracer");
    notNull(span, "Span");
    this.tracer = tracer;
    this.span = span;
  }

  /**
   * Wraps an OpenTracing span so that it can be passed in to the SDK-operation options as a parent.
   *
   * @param span the span that should act as the parent.
   * @return the created wrapped span.
   */
  public static OpenTracingRequestSpan wrap(final Tracer tracer, final Span span) {
    return new OpenTracingRequestSpan(tracer, span);
  }

  /**
   * Returns the wrapped OpenTracing span.
   */
  public Span span() {
    return span;
  }

  @Override
  public void attribute(String key, String value) {
    if (value != null) {
      span.setTag(key, value);
    }
  }

  @Override
  public void attribute(String key, boolean value) {
    span.setTag(key, value);
  }

  @Override
  public void attribute(String key, long value) {
    span.setTag(key, value);
  }

  @Override
  public void event(String name, Instant timestamp) {
    span.log(ChronoUnit.MICROS.between(Instant.EPOCH, timestamp), name);
  }

  @Override
  public void status(StatusCode status) {
    attribute("error", true);
  }

  @Override
  public void end() {
    try (Scope scope = this.tracer.activateSpan(span)) {
      span.finish();
    }
  }

  @Override
  public void requestContext(final RequestContext requestContext) {
    // the request context is not needed at this point
  }

}