io.opentracing.contrib.jdbi.SpanDecorator Maven / Gradle / Ivy

Go to download

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

OpenTracing Instrumentation for JDBI

There is a newer version: 0.6.2

/*
 * Copyright 2016-2018 The OpenTracing Authors
 *
 * 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 io.opentracing.contrib.jdbi;

import io.opentracing.Span;
import io.opentracing.Tracer;
import org.skife.jdbi.v2.StatementContext;

/**
 * SpanDecorator allows the OpenTracingCollector user to control the precise naming and
 * decoration of OpenTracing
 * Spans emitted by the collector.
 *
 * @see OpenTracingCollector#OpenTracingCollector(Tracer, SpanDecorator)
 */
public interface SpanDecorator {

  SpanDecorator DEFAULT = new SpanDecorator() {


    public String generateOperationName(StatementContext ctx) {
      return "DBI Statement";
    }

    @Override
    public void decorateSpan(Span jdbiSpan, long elapsedNanos, StatementContext ctx) {
    }
  };

  /**
   * Transform an DBI StatementContext into an OpenTracing Span operation name.
   *
   * @param ctx the StatementContext passed to TimingCollector.collect()
   * @return an operation name suitable for the associated OpenTracing Span
   */
  String generateOperationName(StatementContext ctx);

  /**
   * Decorate the given span with additional tags or logs. Implementations may or may not
   * need to refer
   * to the StatementContext.
   *
   * @param jdbiSpan the JDBI Span to decorate (before `finish` is called)
   * @param elapsedNanos the elapsedNanos passed to TimingCollector.collect()
   * @param ctx the StatementContext passed to TimingCollector.collect()
   */
  void decorateSpan(Span jdbiSpan, long elapsedNanos, StatementContext ctx);
}