io.micrometer.core.instrument.binder.httpcomponents.MicrometerHttpClientInterceptor Maven / Gradle / Ivy
Show all versions of micrometer-core Show documentation
/**
* Copyright 2020 VMware, Inc.
*
* 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.core.instrument.binder.httpcomponents;
import io.micrometer.core.annotation.Incubating;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.Timer;
import org.apache.http.HttpRequest;
import org.apache.http.HttpRequestInterceptor;
import org.apache.http.HttpResponseInterceptor;
import org.apache.http.protocol.HttpContext;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
/**
* Provides {@link HttpRequestInterceptor} and {@link HttpResponseInterceptor} for
* configuring with an {@link org.apache.http.nio.client.HttpAsyncClient}. Usage example:
*
{@code
* MicrometerHttpClientInterceptor interceptor = new MicrometerHttpClientInterceptor(registry,
* request -> request.getRequestLine().getUri(),
* Tags.empty(),
* true);
*
* CloseableHttpAsyncClient httpAsyncClient = HttpAsyncClients.custom()
* .addInterceptorFirst(interceptor.getRequestInterceptor())
* .addInterceptorLast(interceptor.getResponseInterceptor())
* .build();
* }
*
* @author Jon Schneider
* @since 1.4.0
*/
@Incubating(since = "1.4.0")
public class MicrometerHttpClientInterceptor {
private static final String METER_NAME = "httpcomponents.httpclient.request";
private final Map timerByHttpContext = new ConcurrentHashMap<>();
private final HttpRequestInterceptor requestInterceptor;
private final HttpResponseInterceptor responseInterceptor;
/**
* Create a {@code MicrometerHttpClientInterceptor} instance.
*
* @param meterRegistry meter registry to bind
* @param uriMapper URI mapper to create {@code uri} tag
* @param extraTags extra tags
* @param exportTagsForRoute whether to export tags for route
*/
public MicrometerHttpClientInterceptor(MeterRegistry meterRegistry,
Function uriMapper,
Iterable extraTags,
boolean exportTagsForRoute) {
this.requestInterceptor = (request, context) -> timerByHttpContext.put(context, Timer.resource(meterRegistry, METER_NAME)
.tags("method", request.getRequestLine().getMethod(), "uri", uriMapper.apply(request)));
this.responseInterceptor = (response, context) -> {
timerByHttpContext.remove(context)
.tag("status", Integer.toString(response.getStatusLine().getStatusCode()))
.tags(exportTagsForRoute ? HttpContextUtils.generateTagsForRoute(context) : Tags.empty())
.tags(extraTags)
.close();
};
}
/**
* Create a {@code MicrometerHttpClientInterceptor} instance with {@link DefaultUriMapper}.
*
* @param meterRegistry meter registry to bind
* @param extraTags extra tags
* @param exportTagsForRoute whether to export tags for route
*/
public MicrometerHttpClientInterceptor(MeterRegistry meterRegistry,
Iterable extraTags,
boolean exportTagsForRoute) {
this(meterRegistry, new DefaultUriMapper(), extraTags, exportTagsForRoute);
}
public HttpRequestInterceptor getRequestInterceptor() {
return requestInterceptor;
}
public HttpResponseInterceptor getResponseInterceptor() {
return responseInterceptor;
}
}