org.springframework.cloud.sleuth.autoconfig.SleuthSpanFilterProperties Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-sleuth-autoconfigure Show documentation

Spring Cloud Sleuth AutoConfigure

There is a newer version: 3.1.11

Show newest version

/*
 * 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.autoconfig;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * Sleuth settings for span filtering.
 *
 * @author Marcin Grzejszczak
 * @since 1.0.11
 */
@ConfigurationProperties("spring.sleuth.span-filter")
public class SleuthSpanFilterProperties {

	/**
	 * Will turn on the default Sleuth handler mechanism. Might ignore exporting of
	 * certain spans;
	 */
	private boolean enabled;

	/**
	 * List of span names to ignore. They will not be sent to external systems.
	 */
	private List spanNamePatternsToSkip = Arrays.asList("^catalogWatchTaskScheduler$");

	/**
	 * Additional list of span names to ignore. Will be appended to
	 * {@link #spanNamePatternsToSkip}.
	 */
	private List additionalSpanNamePatternsToIgnore = Collections.emptyList();

	public boolean isEnabled() {
		return this.enabled;
	}

	public void setEnabled(boolean enabled) {
		this.enabled = enabled;
	}

	public List getSpanNamePatternsToSkip() {
		return this.spanNamePatternsToSkip;
	}

	public void setSpanNamePatternsToSkip(List spanNamePatternsToSkip) {
		this.spanNamePatternsToSkip = spanNamePatternsToSkip;
	}

	public List getAdditionalSpanNamePatternsToIgnore() {
		return this.additionalSpanNamePatternsToIgnore;
	}

	public void setAdditionalSpanNamePatternsToIgnore(List additionalSpanNamePatternsToIgnore) {
		this.additionalSpanNamePatternsToIgnore = additionalSpanNamePatternsToIgnore;
	}

}