io.micrometer.tracing.exporter.SpanIgnoringSpanExportingPredicate Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2022 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 io.micrometer.tracing.exporter;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import io.micrometer.common.util.StringUtils;
import io.micrometer.common.util.internal.logging.InternalLogger;
import io.micrometer.common.util.internal.logging.InternalLoggerFactory;

/**
 * {@link SpanExportingPredicate} that ignores spans via names.
 *
 * @author Marcin Grzejszczak
 * @since 1.0.0
 */
public class SpanIgnoringSpanExportingPredicate implements SpanExportingPredicate {

    static final Map cache = new ConcurrentHashMap<>();

    private static final InternalLogger log = InternalLoggerFactory
        .getInstance(SpanIgnoringSpanExportingPredicate.class);

    private final List spanNamePatternsToSkip;

    private final List additionalSpanNamePatternsToIgnore;

    /**
     * Creates a new instance of {@link SpanIgnoringSpanExportingPredicate}.
     * @param spanNamePatternsToSkip - name patterns to skip
     * @param additionalSpanNamePatternsToIgnore - additional span names to ignore
     */
    public SpanIgnoringSpanExportingPredicate(List spanNamePatternsToSkip,
            List additionalSpanNamePatternsToIgnore) {
        this.spanNamePatternsToSkip = spanNamePatternsToSkip;
        this.additionalSpanNamePatternsToIgnore = additionalSpanNamePatternsToIgnore;
    }

    private List spanNamesToIgnore() {
        return spanNames().stream()
            .map(regex -> cache.computeIfAbsent(regex, Pattern::compile))
            .collect(Collectors.toList());
    }

    private List spanNames() {
        List spanNamesToIgnore = new ArrayList<>(this.spanNamePatternsToSkip);
        spanNamesToIgnore.addAll(this.additionalSpanNamePatternsToIgnore);
        return spanNamesToIgnore;
    }

    @Override
    public boolean isExportable(FinishedSpan span) {
        List spanNamesToIgnore = spanNamesToIgnore();
        String name = span.getName();
        if (StringUtils.isNotEmpty(name) && spanNamesToIgnore.stream().anyMatch(p -> p.matcher(name).matches())) {
            if (log.isDebugEnabled()) {
                log.debug("Will ignore a span with name [" + name + "]");
            }
            return false;
        }
        return true;
    }

}