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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micrometer-tracing Show documentation

Facade over tracing concepts

The newest version!

/**
 * Copyright 2024 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 io.micrometer.common.lang.Nullable;

import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;

/**
 * {@link SpanReporter} with access to stored {@link FinishedSpan}.
 *
 * @author Marcin Grzejszczak
 * @since 1.3.0
 */
public class TestSpanReporter implements SpanReporter {

    private final Queue spans = new ConcurrentLinkedQueue<>();

    /**
     * Polls stored spans for the latest entry.
     * @return latest stored span
     */
    @Nullable
    public FinishedSpan poll() {
        return this.spans.poll();
    }

    /**
     * Returns collected spans.
     * @return collected spans
     */
    public Queue spans() {
        return new ConcurrentLinkedQueue<>(this.spans);
    }

    @Override
    public void report(FinishedSpan span) {
        this.spans.add(span);
    }

    @Override
    public void close() throws Exception {
        this.spans.clear();
    }

}