[英]Including spring boot endpoint path variable as a metric dimension
我有 api 端点:/user/{tenant}/create
我正在使用带有千分尺的弹簧靴 2 作为指标。
默认情况下,spring boot 2 端点的@Timer 注释包括以下标签:异常、方法、uri、状态
我想为 api 参数“tenant”添加传递的值作为端点的额外标签
我如何用弹簧靴 2 和千分尺做到这一点
@Bean
public WebMvcTagsProvider webMvcTagsProvider() {
return new CustomWebMvcTagsProvider();
}
public class CustomWebMvcTagsProvider extends DefaultWebMvcTagsProvider {
public Iterable<Tag> getTags(HttpServletRequest request, HttpServletResponse response, Object handler, Throwable exception) {
return Tags.of(super.getTags(request, response, handler, exception)).and(getTenantTag(request));
}
private Tag getTenantTag(HttpServletRequest request) {
String tenant = ((Map<String, String>)request.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE)).get("tenant");
if(tenant == null){
tenant = "na";
}
return Tag.of("tenant", tenant);
}
}
使用自定义WebMvcTagsProvider
,例如:
@Bean
public WebMvcTagsProvider webMvcTagsProvider() {
return new WebMvcTagsProvider() {
@Override
public Iterable<Tag> getTags(HttpServletRequest request, HttpServletResponse response, Object handler, Throwable exception) {
return ((Map<String, String>) request.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE))
.entrySet()
.stream()
.map(entry -> new ImmutableTag(entry.getKey(), entry.getValue()))
.collect(Collectors.toList());
}
@Override
public Iterable<Tag> getLongRequestTags(HttpServletRequest request, Object handler) {
return new ArrayList<>();
}
};
}
从 Spring Boot 2.3.0 开始,如果你想为某些请求添加额外的标签到默认标签,更好的方法是添加一个 WebMvcTagsContributor 类的 @Bean。 这样您的代码就不必担心放入默认标签。
在https://github.com/spring-projects/spring-boot/issues/20175 中实现
代码如下所示:
@Bean
public WebMvcTagsContributor webMvcTagsContributor() {
return new WebMvcTagsContributor() {
@Override
public Iterable<Tag> getTags(HttpServletRequest request, HttpServletResponse response, Object handler, Throwable exception) {
Tags tags = Tags.empty();
tags = tags.and(Tag.of("my_tag", "somevalue"));
return tags;
}
@Override
public Iterable<Tag> getLongRequestTags(HttpServletRequest request, Object handler) {
return null;
}
};
}
一种将路径变量添加到默认标签的方法:
import io.micrometer.core.instrument.Tag;
import org.springframework.boot.actuate.metrics.web.servlet.WebMvcTagsContributor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerMapping;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Map;
import java.util.stream.Collectors;
@Configuration
public class WebMvcTagsProviderConfig {
@Bean
public WebMvcTagsContributor webMvcTagsContributor() {
return new WebMvcTagsContributor() {
@Override
public Iterable<Tag> getTags(
HttpServletRequest request, HttpServletResponse response, Object handler, Throwable exception
) {
Map<String, String> pathVariables = ((Map<String, String>) request.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE));
return pathVariables == null
? null
: pathVariables
.entrySet()
.stream()
.map(entry -> Tag.of(entry.getKey(), entry.getValue()))
.collect(Collectors.toList());
}
@Override
public Iterable<Tag> getLongRequestTags(HttpServletRequest request, Object handler) {
return null;
}
};
}
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.