如何为默认的Spring Boot 2指标定义附加或自定义标签

最近我用Micrometer切换到Spring Boot 2。当我得到这些闪亮的新指标时，我与我们的DevOps人员进行了交谈，并开始将它们导出到Telegraf。

为了区分不同的应用程序和应用程序节点，我们决定使用标记。这非常适用于自定义度量，但现在我开始考虑预定义的度量。为了实现默认度量的相同效果，我还需要为它们添加额外的标签。

有可能做到这一点吗？我这样做对吗？

编辑：我尝试了下一种方法：

@Component
public class MyMetricsImpl implements MyMetrics {
@Autowired
protected MyProperties myProperties;
@Autowired
protected MeterRegistry meterRegistry;
@PostConstruct
public void initialize() {
this.meterRegistry.config()
.commonTags(commonTags());
}
@Override
public List<Tag> commonTags() {
List<Tag> tags = new ArrayList<>();
tags.add(Tag.of("application", myProperties.getApplicationName()));
tags.add(Tag.of("node", myProperties.getNodeName()));
return tags;
}
}

问题是我的度量行为正确，甚至Boot的一些度量(至少是http.server.requests(也看到了我的标记。但jvm.*、system.*、tomcat.*和许多其他标签仍然没有所需的标签。

如果您正在寻找通用标签支持，可以通过注册MeterFilter来实现。

有关示例，请参见此提交或此分支。

对于即将推出的Spring Boot 2.1.0.M1，您可以使用以下属性：

management.metrics.tags.*= # Common tags that are applied to every meter.

有关详细信息，请参阅参考资料。

更新：由于问题已经更新，我用这种基于MeterFilter的方法检查了更新后的问题，并确认它的工作原理如下：

请求：http://localhost:8080/actuator/metrics/jvm.gc.memory.allocated

响应：

{
"name" : "jvm.gc.memory.allocated",
"measurements" : [ {
"statistic" : "COUNT",
"value" : 1.98180864E8
} ],
"availableTags" : [ {
"tag" : "stack",
"values" : [ "prod" ]
}, {
"tag" : "region",
"values" : [ "us-east-1" ]
} ]
}

我没有检查更新问题中提供的方法，但我只会使用经过验证的基于MeterFilter的方法，除非有任何理由坚持这种方法。

第二次更新：我研究了这种方法，并能够用这个分支复制它。

在@PostConstruct中应用通用标签为时已晚，因为一些度量已经注册。http.server.requests工作的原因是它将与第一个请求一起注册。如果你感兴趣的话，试着在过滤器的应用程序上设置一个断点

简而言之，尝试上面的方法，它类似于即将推出的SpringBoot开箱即用支持。

对于服务器：
(即@RestController(
除了弹簧启动框架提供的默认标记之外，还为反应式弹簧启动应用程序添加自定义度量标记。

提供一个或多个实现WebFluxTagsContributor的@Beans
或
若要替换默认标记，请提供一个implements WebFluxTagsProvider的@Bean
使用Spring-WebMVC作为答案之一的参考实现
参考：

下面的实现是在groovy中实现的。

import io.micrometer.core.instrument.Tag
import org.springframework.boot.actuate.metrics.web.reactive.server.WebFluxTagsContributor
import org.springframework.http.HttpMethod
import org.springframework.http.HttpStatus
import org.springframework.stereotype.Component
import org.springframework.web.server.ServerWebExchange
@Component
class CustomWebClientExchangeTagsProvider implements WebFluxTagsContributor {
final KEY = "key"
/**
* Provides tags to be associated with metrics for the given {@code exchange}.
* @param exchange the exchange
* @param ex the current exception (maybe {@code null})
* @return tags to associate with metrics for the request and response exchange
*/
@Override
Iterable<Tag> httpRequestTags(ServerWebExchange exchange, Throwable ex) {
String apiKey = exchange.request.queryParams[KEY] ?: "default_api_key"
HttpStatus status = exchange.response.statusCode ?: HttpStatus.INTERNAL_SERVER_ERROR
HttpMethod method = exchange.request.method ?: HttpMethod.OPTIONS
String group = (status.value() >= 500 ? "5XX" : (status.value() >= 400) ? "4XX" : (status.value() >= 300) ? "3XX" : "NONE")
Tag statusTag = Tag.of("status", status.value().toString())
Tag methodTag = Tag.of("method", method.toString())
Tag apiKeyTag = Tag.of(KEY, apiKey)
Tag groupTag = Tag.of("group", group)
return Arrays.asList(statusTag, methodTag, apiKeyTag, groupTag)
}
}

度量标签：

验证客户端：metrichttp.client.requests.percentile或http.client.requests

http://localhost:8010/metrics/http.client.requests

验证服务器：

http://localhost:8010/metrics/http.server.requests

类似地，将为http.server.requests.percentile度量添加标签

{
"name": "http.server.requests",
"description": null,
"base_unit": "milliseconds",
"measurements": [
{
"statistic": "COUNT",
"value": 17.0
},
{
"statistic": "TOTAL_TIME",
"value": 8832.186054
},
{
"statistic": "MAX",
"value": 6.514132
}
],
"available_tags": [
{
"tag": "exception",
"values": [
"None",
"ResponseStatusException"
]
},
{
"tag": "method",
"values": [
"GET"
]
},
{
"tag": "application",
"values": [
"myapplication"
]
},
{
"tag": "uri",
"values": [
"/myapplication/v1/abcd",
"/manage/metrics/{requiredMetricName}",
"/manage",
"/manage/metrics",
"/myapplication/v1/windows",
"/**"
]
},
{
"tag": "outcome",
"values": [
"CLIENT_ERROR",
"SERVER_ERROR",
"SUCCESS"
]
},
{
"tag": "key",
"values": [
"default_api_key",
"[abcd]"
]
},
{
"tag": "status",
"values": [
"404",
"200",
"502"
]
},
{
"tag": "group",
"values": [
"4XX",
"NONE",
"5XX"
]
}
]
}

或

如果您使用prometheus
，您可以按照以下验证自定义标签

http://localhost:8010/prometheus

客户端：

http_client_requests_seconds_count{application="myapplication",clientName="myhostname.com",method="POST",outcome="CLIENT_ERROR",status="403",uri="/urlIamTryingToHit/v1/list",} 1.0

客户端只有spring boot提供的默认标记，没有自定义标记。

服务器：

http_server_requests_seconds_sum{application="myapplication",exception="None",group="4XX",key="default_api_key",method="GET",outcome="CLIENT_ERROR",status="404",uri="/manage/metrics/{requiredMetricName}",} 0.004154207

我们可以观察到group="4XX"、key="default_api_key"、method="GET"、status="404"以及现有的默认标签。

对于客户端：
要自定义标签，根据您选择的客户端，您可以提供@Bean、implements RestTemplateExchangeTagsProvider或WebClientExchangeTagsProvider
RestTemplateExchangeTags和WebClientExchangeTags中有方便的静态函数
参考：

为了回应我最初问题下的评论，这里有一个添加自定义度量的小例子：

package io.github.stepio.examples.metrics;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
@Component
public class MyImportantComponent {
protected static final String CONNECTIONS_CURRENT = "connections.created";
protected static final String CONNECTIONS_IDLE = "connections.idle";
protected static final String CONNECTIONS_MAX = "connections.max";
protected static final String PREFIX_REQUESTS_FOR_SERVICE = "requests";
protected static final String SERVICE = "service";
protected AtomicInteger connectionMax = new AtomicInteger();
@Autowired
protected MeterRegistry meterRegistry;
@Override
public List<Tag> tags() {
return new ArrayList<>();
}
@Override
public void trackConnectorsCurrent(AtomicInteger counter) {
this.meterRegistry.gauge(CONNECTIONS_CURRENT, tags(), counter);
}
@Override
public void trackConnectorsIdle(Collection<?> collection) {
this.meterRegistry.gaugeCollectionSize(CONNECTIONS_IDLE, tags(), collection);
}
@Override
public void submitConnectorsMax(final int value) {
this.meterRegistry.gauge(CONNECTIONS_MAX, tags(), this.connectionMax).set(value);
}
@Override
public void incrementRequestsForService(String serviceName) {
this.meterRegistry.counter(PREFIX_REQUESTS_FOR_SERVICE, tags(SERVICE, serviceName)).increment();
}
}

如果使用spring-boot-actuator并且需要向默认度量添加动态标记简单地定义一个WebMvcTagsProviderbean：

/**
* Default implementation of WebMvcTagsProvider.<br>
* @author Jon Schneider<br>
* @since 2.0.0
*/
public class DefaultWebMvcTagsProvider implements WebMvcTagsProvider {
@Override
public Iterable<Tag> getTags(HttpServletRequest request, HttpServletResponse response, Object handler,
Throwable exception) {
return Tags.of(WebMvcTags.method(request), WebMvcTags.uri(request, response), WebMvcTags.exception(exception),
WebMvcTags.status(response), WebMvcTags.outcome(response));
}
@Override
public Iterable<Tag> getLongRequestTags(HttpServletRequest request, Object handler) {
return Tags.of(WebMvcTags.method(request), WebMvcTags.uri(request, null));
}
}

相关内容

最新更新

热门标签：