为Spring WebClient默认指标添加标签

Question

我目前正在从事一个Spring webflux项目，该项目具有执行器、测微计依赖项，如下所示，

    <dependency>
        <groupId>io.micrometer</groupId>
        <artifactId>micrometer-registry-prometheus</artifactId>
    </dependency>
    <dependency>
        <groupId>io.micrometer</groupId>
        <artifactId>micrometer-core</artifactId>
    </dependency>

公开默认指标（包括Spring webClient指标）。我使用Spring WebClient调用了4个不同的endpoint。我想知道是否有一种方法可以将特定的标签添加到每个被添加到默认指标的webclient调用中。我有一些指标，比如Webclient在/actuator/prometheusendpoint公开的直方图，如下所示，

http_client_requests_seconds_bucket{clientName="my-app.com",method="GET",outcome="SUCCESS",status="200",uri="/shops",le="0.001048576",} 0.0
http_client_requests_seconds_bucket{clientName="my-app.com",method="GET",outcome="SUCCESS",status="200",uri="/shops",le="0.002088576",} 1.0

在我的代码中，我想在Webclient调用中添加一些额外的标记，以满足上述所有指标的需要。比如像这样的，

http_client_requests_seconds_bucket{clientName="my-app.com",method="GET",outcome="SUCCESS",status="200",uri="/shops",le="0.001048576",investor="A", version="v1"} 0.0
http_client_requests_seconds_bucket{clientName="my-app.com",method="GET",outcome="SUCCESS",status="200",uri="/shops",le="0.002088576",investor="A", version="v1"} 1.0

请注意我添加的2个自定义标记investor=“A”，version=“v1”。我在找一些可能是这样的代码，

@Autowire
private WebClient webclient; // Assume there is already a bean created for us

public Mono<String> getShopsList(String... extraTags) {
     return webclient.baseUrl("http://my-app.com")
         .build()
         .get()
         .uri("/shops")
         .tags(extraTags) // Some extra tags I want callers of the method to pass. Note there are only 4-5 methods that call "getShopsList()" method
         .retrieve() 
         .bodyToMono(String.class);
 }
 

Answer 1

预期的方法是引入您的自定义标签提供程序：

@Component
public class CustomWebClientExchangeTagsProvider extends DefaultWebClientExchangeTagsProvider {

  public static final String VERSION_ATTRIBUTE = "custom.webclient.version";
  public static final String INVESTOR_ATTRIBUTE = "custom.webclient.investor";

  @Override
  public Iterable<Tag> tags(ClientRequest request, ClientResponse response, Throwable throwable) {
    Tag method = WebClientExchangeTags.method(request);
    Tag investor = getInvestorTag(request);
    Tag version = getVersionTag(request);
    return asList(method, investor, version, WebClientExchangeTags.status(response, throwable), WebClientExchangeTags.outcome(response));
  }

  private Tag getInvestorTag(ClientRequest request) {
    return request.attribute(INVESTOR_ATTRIBUTE)
        .map(name -> Tag.of("investor", (String) name))
        .orElse(WebClientExchangeTags.clientName(request));
  }

  private Tag getVersionTag(ClientRequest request) {
    return request.attribute(VERSION_ATTRIBUTE)
        .map(uri -> Tag.of("version", (String) uri))
        .orElse(WebClientExchangeTags.uri(request));
  }

}

您必须以这种方式检测您的自定义Web客户端：

@Bean
public WebClient webClient(MetricsWebClientCustomizer metricsCustomizer) {
    TcpClient timeoutClient = ...
    WebClient.Builder builder = WebClient.builder();
    metricsCustomizer.customize(builder);
    return ...;
}

最后，您需要像这样设置两个属性：

return webClient.get()
        .uri(filePath)
        .attribute(INVESTOR_ATTRIBUTE, "A")
        .attribute(VERSION_ATTRIBUTE, "v1")
        .retrieve()
        .bodyToMono(String.class);

示例结果：

http_client_requests_seconds_count{investor="A",method="GET",outcome="CLIENT_ERROR",status="401",version="v1",} 1.0
http_client_requests_seconds_sum{investor="A",method="GET",outcome="CLIENT_ERROR",status="401",version="v1",} 0.073818807

编辑

根据文件：

S属性（消费者

提供对迄今为止声明的每个属性的访问，并可以添加、替换或删除值。

因此，可以使用它添加多个属性。