ratpack.zipkin.SpanNameProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of brave-ratpack Show documentation

Brave instrumentation for Ratpack

There is a newer version: 2.6.5

/*
 * Copyright 2016-2018 The OpenZipkin 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 ratpack.zipkin;

import ratpack.path.PathBinding;

import java.util.Optional;

/**
 * Functional interface for span name customizers.
 */
@FunctionalInterface
public interface SpanNameProvider {
  /**
   * Given a request and response, return the name to be used for the Span.
   * @param request the request
   * @param pathBinding Optional of PathBinding. With RatPack, the PathBinding
   *                    is only available right before the response is sent.
   *                    This function is called *twice* - once when the server
   *                    request is *received* (with an empty pathBinding value)
   *                    and again before the response is *sent* (this time
   *                    the Optional will have a value).
   *
   * @return the Span name
   */
  String spanName(ServerRequest request, Optional pathBinding);
}