SpanFromContextRetriever.java

/*
 * Copyright 2013-2021 the original author or 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
 *
 *      https://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.springframework.cloud.sleuth.instrument.web;

import java.util.regex.Pattern;

import reactor.util.context.Context;

import org.springframework.cloud.sleuth.Span;

/**
 * Provides a URL {@link Pattern} for spans that should be not sampled.
 *
 * @author Marcin Grzejszczak
 * @since 3.0.2
 */
public interface SpanFromContextRetriever {

	/**
	 * @param context - Reactor context
	 * @return span or {@code null} if no span present
	 */
	default Span findSpan(Context context) {
		return null;
	};

}