com.linecorp.armeria.internal.tracing.SpanContextUtil.java Source code

Introduction

Here is the source code for com.linecorp.armeria.internal.tracing.SpanContextUtil.java

Source

/*
 * Copyright 2017 LINE Corporation
 *
 * LINE Corporation licenses this file to you 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 com.linecorp.armeria.internal.tracing;

import com.linecorp.armeria.common.RequestContext;
import com.linecorp.armeria.common.logging.RequestLog;

import brave.Span;
import brave.Tracer;
import brave.Tracer.SpanInScope;
import io.netty.util.concurrent.FastThreadLocal;

/**
 * Utility for pushing and popping a {@link Span} via a {@link RequestContext}.
 */
public final class SpanContextUtil {

    /**
     * Sets up the {@link RequestContext} to push and pop the {@link Span} whenever it is entered/exited.
     */
    public static void setupContext(FastThreadLocal<SpanInScope> threadLocalSpan, RequestContext ctx, Span span,
            Tracer tracer) {
        ctx.onEnter(unused -> threadLocalSpan.set(tracer.withSpanInScope(span)));
        ctx.onExit(unused -> {
            SpanInScope spanInScope = threadLocalSpan.get();
            if (spanInScope != null) {
                spanInScope.close();
                threadLocalSpan.remove();
            }
        });
    }

    /**
     * Adds logging tags to the provided {@link Span} and closes it.
     * The span cannot be used further after this method has been called.
     */
    public static void closeSpan(Span span, RequestLog log) {
        SpanTags.addTags(span, log);
        span.finish();
    }

    private SpanContextUtil() {
    }
}