com.palantir.conjure.java.okhttp.OkhttpTraceInterceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okhttp-clients Show documentation
Palantir open source project
The newest version!
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * 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
 *
 *     http://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.palantir.conjure.java.okhttp;

import com.palantir.tracing.CloseableSpan;
import com.palantir.tracing.DetachedSpan;
import com.palantir.tracing.OkhttpTraceInterceptor2;
import com.palantir.tracing.api.SpanType;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;

/** An OkHttp interceptor that adds Zipkin-style trace/span/parent-span headers to the HTTP request. */
public final class OkhttpTraceInterceptor implements Interceptor {

    /** The HTTP header used to communicate API endpoint names internally. Not considered public API. */
    public static final String PATH_TEMPLATE_HEADER = "hr-path-template";

    static final Interceptor INSTANCE = new OkhttpTraceInterceptor();

    private static final Interceptor addHeaders = OkhttpTraceInterceptor2.create(OkhttpTraceInterceptor::createSpan);

    @Override
    public Response intercept(Chain chain) throws IOException {
        Tags.AttemptSpan attemptSpanTag = chain.request().tag(Tags.AttemptSpan.class);
        if (attemptSpanTag == null) {
            return chain.proceed(chain.request());
        }
        try {
            return addHeaders.intercept(chain);
        } finally {
            // when we reach this point, we've got a 'Response' object (so the headers have come back), but the server
            // hasn't necessarily filled in the request body.
            DetachedSpan waitForBody =
                    attemptSpanTag.attemptSpan().childDetachedSpan("OkHttp: wait-for-body", SpanType.CLIENT_OUTGOING);

            chain.request().tag(Tags.SettableWaitForBodySpan.class).setWaitForBodySpan(waitForBody);
        }
    }

    @SuppressWarnings("MustBeClosedChecker") // the OkhttpTraceInterceptor2 will definitely close this
    private static CloseableSpan createSpan(Request request) {
        return request.tag(Tags.AttemptSpan.class)
                .attemptSpan()
                .childSpan("OkHttp: wait-for-headers", SpanType.CLIENT_OUTGOING);
    }

    private OkhttpTraceInterceptor() {}
}