|
此版本仍在开发中,尚未视为稳定版。如需最新稳定版本,请使用 Spring Boot 4.0.4! |
指标
快速开始
Spring Boot 会自动配置一个复合的 MeterRegistry,并为它在类路径中找到的每个受支持的实现向该复合对象添加一个注册表。
只要在运行时类路径中存在对 micrometer-registry-{system} 的依赖,Spring Boot 就足以配置该注册表。
大多数注册中心具有共同的特性。 例如,即使 Micrometer 注册中心的实现位于类路径中,你也可以禁用某个特定的注册中心。 以下示例禁用了 Datadog:
-
Properties
-
YAML
management.datadog.metrics.export.enabled=false
management:
datadog:
metrics:
export:
enabled: false
你也可以禁用所有注册表,除非注册表特定的属性另有说明,如下例所示:
-
Properties
-
YAML
management.defaults.metrics.export.enabled=false
management:
defaults:
metrics:
export:
enabled: false
Spring Boot 还会将所有自动配置的注册表添加到 Metrics 类上的全局静态组合注册表中,除非您明确指示它不要这样做:
-
Properties
-
YAML
management.metrics.use-global-registry=false
management:
metrics:
use-global-registry: false
在将任何指标注册到注册表之前,您可以注册任意数量的 MeterRegistryCustomizer Bean 以进一步配置注册表,例如应用通用标签:
-
Java
-
Kotlin
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyMeterRegistryConfiguration {
@Bean
public MeterRegistryCustomizer<MeterRegistry> metricsCommonTags() {
return (registry) -> registry.config().commonTags("region", "us-east-1");
}
}
import io.micrometer.core.instrument.MeterRegistry
import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyMeterRegistryConfiguration {
@Bean
fun metricsCommonTags(): MeterRegistryCustomizer<MeterRegistry> {
return MeterRegistryCustomizer { registry ->
registry.config().commonTags("region", "us-east-1")
}
}
}
你可以通过更具体地指定泛型类型,对特定的注册表实现应用自定义配置:
-
Java
-
Kotlin
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.config.NamingConvention;
import io.micrometer.graphite.GraphiteMeterRegistry;
import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyMeterRegistryConfiguration {
@Bean
public MeterRegistryCustomizer<GraphiteMeterRegistry> graphiteMetricsNamingConvention() {
return (registry) -> registry.config().namingConvention(this::name);
}
private String name(String name, Meter.Type type, String baseUnit) {
return ...
}
}
import io.micrometer.core.instrument.Meter
import io.micrometer.core.instrument.config.NamingConvention
import io.micrometer.graphite.GraphiteMeterRegistry
import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyMeterRegistryConfiguration {
@Bean
fun graphiteMetricsNamingConvention(): MeterRegistryCustomizer<GraphiteMeterRegistry> {
return MeterRegistryCustomizer { registry: GraphiteMeterRegistry ->
registry.config().namingConvention(this::name)
}
}
private fun name(name: String, type: Meter.Type, baseUnit: String?): String {
return ...
}
}
Spring Boot 还配置了内置的监控指标,你可以通过配置或专用的注解标记来控制这些指标。
支持的监控系统
本节简要描述了每个受支持的监控系统。
AppOptics
默认情况下,AppOptics 注册表会定期将指标推送到 api.appoptics.com/v1/measurements。
要将指标导出到 SaaS 版 AppOptics,必须提供您的 API Tokens:
-
Properties
-
YAML
management.appoptics.metrics.export.api-token=YOUR_TOKEN
management:
appoptics:
metrics:
export:
api-token: "YOUR_TOKEN"
Atlas
-
Properties
-
YAML
management.atlas.metrics.export.uri=https://atlas.example.com:7101/api/v1/publish
management:
atlas:
metrics:
export:
uri: "https://atlas.example.com:7101/api/v1/publish"
Datadog
-
Properties
-
YAML
management.datadog.metrics.export.api-key=YOUR_KEY
management:
datadog:
metrics:
export:
api-key: "YOUR_KEY"
如果你额外提供一个应用程序密钥(可选),那么诸如计量器描述、类型和基本单位等元数据也将被导出:
-
Properties
-
YAML
management.datadog.metrics.export.api-key=YOUR_API_KEY
management.datadog.metrics.export.application-key=YOUR_APPLICATION_KEY
management:
datadog:
metrics:
export:
api-key: "YOUR_API_KEY"
application-key: "YOUR_APPLICATION_KEY"
默认情况下,指标会被发送到 Datadog 美国站点(api.datadoghq.com)。
如果你的 Datadog 项目托管在其他站点之一,或者你需要通过代理发送指标,请相应地配置 URI:
-
Properties
-
YAML
management.datadog.metrics.export.uri=https://api.datadoghq.eu
management:
datadog:
metrics:
export:
uri: "https://api.datadoghq.eu"
你也可以更改将指标发送到 Datadog 的时间间隔:
-
Properties
-
YAML
management.datadog.metrics.export.step=30s
management:
datadog:
metrics:
export:
step: "30s"
Dynatrace
Dynatrace 提供两种指标摄入 API,二者均已为 Micrometer 实现。
您可以在此处找到有关 Micrometer 指标摄入的 Dynatrace 文档。
v1 命名空间中的配置属性仅在导出到 Timeseries v1 API 时适用。
v2 命名空间中的配置属性仅在导出到 Metrics v2 API 时适用。
请注意,此集成一次只能导出到 API 的 v1 或 v2 版本,其中优先使用 v2。
如果在 v1 命名空间中设置了 device-id(v1 必需但 v2 不使用),则指标将导出到 v1 端点。
否则,默认假定为 v2。
v2 API
你可以通过两种方式使用 v2 API。
Auto-configuration
对于由 OneAgent 或 Kubernetes 的 Dynatrace Operator 监控的主机,可使用 Dynatrace 自动配置功能。
本地 OneAgent:如果主机上正在运行 OneAgent,指标将自动导出到本地 OneAgent 摄取端点。 该摄取端点会将指标转发至 Dynatrace 后端。
Dynatrace Kubernetes Operator:在安装了 Dynatrace Operator 的 Kubernetes 环境中运行时,注册表将自动从该 Operator 获取您的端点 URI 和 API Tokens。
这是默认行为,除了需要依赖 io.micrometer:micrometer-registry-dynatrace 之外,无需进行任何特殊设置。
手动配置
如果没有可用的自动配置,则需要提供Metrics v2 API 的端点和一个 API Tokens。
该API Tokens必须具有“摄取指标”(metrics.ingest)权限。
我们建议将该Tokens的权限范围限制为仅此一项。
您必须确保端点 URI 中包含路径(例如,/api/v2/metrics/ingest):
指标 API v2 的数据摄入端点 URL 根据您的部署选项而有所不同:
-
SaaS:
https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest -
托管部署:
https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest
下面的示例使用 example 环境 ID 配置指标导出:
-
Properties
-
YAML
management.dynatrace.metrics.export.uri=https://example.live.dynatrace.com/api/v2/metrics/ingest
management.dynatrace.metrics.export.api-token=YOUR_TOKEN
management:
dynatrace:
metrics:
export:
uri: "https://example.live.dynatrace.com/api/v2/metrics/ingest"
api-token: "YOUR_TOKEN"
使用 Dynatrace v2 API 时,可使用以下可选功能(更多详细信息请参见Dynatrace 文档):
-
指标键前缀:设置一个前缀,该前缀将被添加到所有导出的指标键之前。
-
使用 Dynatrace 元数据进行增强:如果 OneAgent 或 Dynatrace Operator 正在运行,则使用额外的元数据(例如关于主机、进程或 Pod 的信息)来增强指标。
-
默认维度:指定将添加到所有导出指标中的键值对。 如果使用 Micrometer 指定了具有相同键的标签,它们会覆盖默认维度。
-
使用 Dynatrace 摘要指标(Summary instruments):在某些情况下,Micrometer 的 Dynatrace 注册表所创建的指标被拒绝了。 在 Micrometer 1.9.x 中,此问题已通过引入 Dynatrace 专用的摘要指标得到修复。 将此开关设置为
false会强制 Micrometer 回退到 1.9.x 版本之前默认的行为。 仅在从 Micrometer 1.8.x 迁移到 1.9.x 时遇到问题的情况下才应使用此选项。 -
导出指标元数据:从 Micrometer 1.12.0 版本开始,Dynatrace 导出器默认也会导出指标的元数据,例如单位和描述。 使用
export-meter-metadata开关可关闭此功能。
可以不指定 URI 和 API Tokens,如下例所示。 在这种情况下,将使用自动配置的端点:
-
Properties
-
YAML
management.dynatrace.metrics.export.v2.metric-key-prefix=your.key.prefix
management.dynatrace.metrics.export.v2.enrich-with-dynatrace-metadata=true
management.dynatrace.metrics.export.v2.default-dimensions.key1=value1
management.dynatrace.metrics.export.v2.default-dimensions.key2=value2
management.dynatrace.metrics.export.v2.use-dynatrace-summary-instruments=true
management.dynatrace.metrics.export.v2.export-meter-metadata=true
management:
dynatrace:
metrics:
export:
# Specify uri and api-token here if not using the local OneAgent endpoint.
v2:
metric-key-prefix: "your.key.prefix"
enrich-with-dynatrace-metadata: true
default-dimensions:
key1: "value1"
key2: "value2"
use-dynatrace-summary-instruments: true # (default: true)
export-meter-metadata: true # (default: true)
v1 API(旧版)
Dynatrace v1 API 指标注册表会定期使用Timeseries v1 API将指标推送到配置的 URI。
为了向后兼容现有设置,当设置了 device-id(v1 所必需,但在 v2 中未使用)时,指标将被导出到 Timeseries v1 端点。
要将指标导出到Dynatrace,必须提供您的 API Tokens、设备 ID 和 URI:
-
Properties
-
YAML
management.dynatrace.metrics.export.uri=https://{your-environment-id}.live.dynatrace.com
management.dynatrace.metrics.export.api-token=YOUR_TOKEN
management.dynatrace.metrics.export.v1.device-id=YOUR_DEVICE_ID
management:
dynatrace:
metrics:
export:
uri: "https://{your-environment-id}.live.dynatrace.com"
api-token: "YOUR_TOKEN"
v1:
device-id: "YOUR_DEVICE_ID"
对于 v1 API,您必须指定不带路径的基础环境 URI,因为 v1 端点路径会自动添加。
与版本无关的设置
除了 API 端点和Tokens之外,您还可以更改向 Dynatrace 发送指标的时间间隔。
默认的导出间隔为 60s。
以下示例将导出间隔设置为 30 秒:
-
Properties
-
YAML
management.dynatrace.metrics.export.step=30s
management:
dynatrace:
metrics:
export:
step: "30s"
您可以在Micrometer 文档和Dynatrace 文档中找到有关如何为 Micrometer 设置 Dynatrace 导出器的更多信息。
Elastic
默认情况下,指标会被导出到运行在本地机器上的Elastic。 你可以通过以下属性来指定要使用的 Elastic 服务器的位置:
-
Properties
-
YAML
management.elastic.metrics.export.host=https://elastic.example.com:8086
management:
elastic:
metrics:
export:
host: "https://elastic.example.com:8086"
Ganglia
默认情况下,指标会被导出到运行在本地机器上的Ganglia。 您可以提供Ganglia 服务器的主机和端口,如下例所示:
-
Properties
-
YAML
management.ganglia.metrics.export.host=ganglia.example.com
management.ganglia.metrics.export.port=9649
management:
ganglia:
metrics:
export:
host: "ganglia.example.com"
port: 9649
Graphite
默认情况下,指标会被导出到运行在本地机器上的Graphite。 您可以提供Graphite 服务器的主机和端口,如下例所示:
-
Properties
-
YAML
management.graphite.metrics.export.host=graphite.example.com
management.graphite.metrics.export.port=9004
management:
graphite:
metrics:
export:
host: "graphite.example.com"
port: 9004
Micrometer 提供了一个默认的 HierarchicalNameMapper,用于规范维度化指标 ID 如何 映射到扁平的分层名称。
|
要控制此行为,请定义您的
|
Humio
默认情况下,Humio 注册表会定期将指标推送到 cloud.humio.com。 要将指标导出到 SaaS 版 Humio,您必须提供您的 API Tokens:
-
Properties
-
YAML
management.humio.metrics.export.api-token=YOUR_TOKEN
management:
humio:
metrics:
export:
api-token: "YOUR_TOKEN"
你还应配置一个或多个标签,用于标识指标数据推送的目标数据源:
-
Properties
-
YAML
management.humio.metrics.export.tags.alpha=a
management.humio.metrics.export.tags.bravo=b
management:
humio:
metrics:
export:
tags:
alpha: "a"
bravo: "b"
Influx
默认情况下,指标会被导出到运行在本地机器上的 Influx v1 实例,并使用默认配置。
要将指标导出到 InfluxDB v2,请配置用于写入指标的 org、bucket 和认证 token。
你可以通过以下方式指定要使用的 Influx 服务器 的位置:
-
Properties
-
YAML
management.influx.metrics.export.uri=https://influx.example.com:8086
management:
influx:
metrics:
export:
uri: "https://influx.example.com:8086"
JMX
Micrometer 提供了一种分层映射到 JMX 的方式,主要作为一种廉价且可移植的方法,用于在本地查看指标。
默认情况下,指标会被导出到 metrics JMX 域。
你可以通过以下方式指定要使用的域:
-
Properties
-
YAML
management.jmx.metrics.export.domain=com.example.app.metrics
management:
jmx:
metrics:
export:
domain: "com.example.app.metrics"
Micrometer 提供了一个默认的 HierarchicalNameMapper,用于规范维度化指标 ID 如何 映射到扁平的分层名称。
|
要控制此行为,请定义您的
|
KairosDB
默认情况下,指标会被导出到运行在本地机器上的KairosDB。 你可以通过以下方式指定要使用的KairosDB 服务器的位置:
-
Properties
-
YAML
management.kairos.metrics.export.uri=https://kairosdb.example.com:8080/api/v1/datapoints
management:
kairos:
metrics:
export:
uri: "https://kairosdb.example.com:8080/api/v1/datapoints"
New Relic
-
Properties
-
YAML
management.newrelic.metrics.export.api-key=YOUR_KEY
management.newrelic.metrics.export.account-id=YOUR_ACCOUNT_ID
management:
newrelic:
metrics:
export:
api-key: "YOUR_KEY"
account-id: "YOUR_ACCOUNT_ID"
你也可以更改将指标发送到 New Relic 的时间间隔:
-
Properties
-
YAML
management.newrelic.metrics.export.step=30s
management:
newrelic:
metrics:
export:
step: "30s"
默认情况下,指标通过 REST 调用发布,但如果你的类路径中包含 Java Agent API,也可以使用该 API:
-
Properties
-
YAML
management.newrelic.metrics.export.client-provider-type=insights-agent
management:
newrelic:
metrics:
export:
client-provider-type: "insights-agent"
最后,您可以通过定义自己的 NewRelicClientProvider Bean 来完全掌控。
OTLP
默认情况下,指标会通过OpenTelemetry 协议(OTLP)导出到您本地机器上运行的消费者。
要导出到其他位置,请使用 https://opentelemetry.io/ 配置项提供OTLP 指标端点的位置:
-
Properties
-
YAML
management.otlp.metrics.export.url=https://otlp.example.com:4318/v1/metrics
management:
otlp:
metrics:
export:
url: "https://otlp.example.com:4318/v1/metrics"
也可以使用 management.otlp.metrics.export.headers.* 属性来提供自定义标头,例如用于身份验证的标头。
如果存在一个 OtlpMetricsSender Bean,Spring Boot 将在自动配置的 OtlpMeterRegistry 上对其进行配置。
Prometheus
Prometheus 期望通过抓取(scrape)或轮询(poll)各个应用程序实例来获取指标。
Spring Boot 在 /actuator/prometheus 提供了一个 Actuator 端点,以适当的格式呈现 Prometheus 抓取 所需的数据。
| 默认情况下,该端点不可用,必须显式暴露。更多详情请参见暴露端点。 |
以下示例 scrape_config 添加到 prometheus.yml 中:
scrape_configs:
- job_name: "spring"
metrics_path: "/actuator/prometheus"
static_configs:
- targets: ["HOST:PORT"]
Prometheus Exemplars 也受支持。
要启用此功能,必须存在一个 SpanContext Bean。
如果您使用的是已弃用的 Prometheus simpleclient 支持并希望启用该功能,则必须存在一个 SpanContextSupplier Bean。
如果您使用 Micrometer Tracing,系统将为您自动配置,但您也可以根据需要自行创建。
请查阅 Prometheus 文档,因为此功能需要在 Prometheus 端显式启用,且仅支持 OpenMetrics 格式。
对于那些生命周期较短、可能无法被及时抓取的临时性任务或批处理作业,您可以使用Prometheus Pushgateway支持,将指标暴露给 Prometheus。
要启用 Prometheus Pushgateway 支持,请在您的项目中添加以下依赖项:
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-pushgateway</artifactId>
</dependency>
当类路径上存在 Prometheus Pushgateway 依赖且 management.prometheus.metrics.export.pushgateway.enabled 属性设置为 true 时,将自动配置一个 PrometheusPushGatewayManager Bean。
此 Bean 负责将指标推送到 Prometheus Pushgateway。
您可以通过使用 management.prometheus.metrics.export.pushgateway 下的属性来调整 PrometheusPushGatewayManager。
对于高级配置,您还可以提供自己的 PrometheusPushGatewayManager Bean。
简单的
Micrometer 自带一个简单的内存后端,如果未配置其他注册表,该后端将自动作为后备方案使用。 这使得你可以在指标端点中查看所收集的指标。
一旦你使用了任何其他可用的后端,内存中的后端就会自动禁用。 你也可以显式地将其禁用:
-
Properties
-
YAML
management.simple.metrics.export.enabled=false
management:
simple:
metrics:
export:
enabled: false
Stackdriver
Stackdriver 注册表会定期将指标推送到 Stackdriver。 要将指标导出到 SaaS Stackdriver,您必须提供您的 Google Cloud 项目 ID:
-
Properties
-
YAML
management.stackdriver.metrics.export.project-id=my-project
management:
stackdriver:
metrics:
export:
project-id: "my-project"
你也可以更改将指标发送到 Stackdriver 的时间间隔:
-
Properties
-
YAML
management.stackdriver.metrics.export.step=30s
management:
stackdriver:
metrics:
export:
step: "30s"
StatsD
StatsD 注册表会通过 UDP 主动将指标推送到 StatsD 代理。 默认情况下,指标会被导出到运行在本地机器上的 StatsD 代理。 您可以通过以下方式指定要使用的 StatsD 代理的主机、端口和协议:
-
Properties
-
YAML
management.statsd.metrics.export.host=statsd.example.com
management.statsd.metrics.export.port=9125
management.statsd.metrics.export.protocol=udp
management:
statsd:
metrics:
export:
host: "statsd.example.com"
port: 9125
protocol: "udp"
你也可以更改 StatsD 行协议以使用(默认为 Datadog):
-
Properties
-
YAML
management.statsd.metrics.export.flavor=etsy
management:
statsd:
metrics:
export:
flavor: "etsy"
Wavefront
-
Properties
-
YAML
management.wavefront.api-token=YOUR_API_TOKEN
management:
wavefront:
api-token: "YOUR_API_TOKEN"
或者,您可以在环境中使用 Wavefront 边车(sidecar)或内部代理,将指标数据转发到 Wavefront API 主机:
-
Properties
-
YAML
management.wavefront.uri=proxy://localhost:2878
management:
wavefront:
uri: "proxy://localhost:2878"
如果你将指标发布到 Wavefront 代理(如Wavefront 文档中所述),主机地址必须采用 proxy://HOST:PORT 格式。 |
你也可以更改将指标发送到 Wavefront 的时间间隔:
-
Properties
-
YAML
management.wavefront.metrics.export.step=30s
management:
wavefront:
metrics:
export:
step: "30s"
支持的指标和仪表
Spring Boot 为各种技术提供了自动的指标注册功能。 在大多数情况下,默认配置会提供合理的指标,这些指标可以发布到任何受支持的监控系统中。
JVM 指标
自动配置通过使用 Micrometer 的核心类来启用 JVM 指标。
JVM 指标以 jvm. 作为计量器名称发布。
提供以下 JVM 指标:
-
各种内存和缓冲池的详细信息
-
与垃圾回收相关的统计信息
-
线程利用率
-
虚拟线程统计信息(为此,类路径中必须包含
io.micrometer:micrometer-java21) -
已加载和已卸载的类的数量
-
JVM 版本信息
-
JIT 编译时间
系统指标
自动配置通过使用 Micrometer 的核心类来启用系统指标。
系统指标以 system.、process. 和 disk. 作为计量器名称发布。
提供以下系统指标:
-
CPU 指标
-
文件描述符指标
-
运行时间指标(包括应用程序已运行的时间量,以及一个表示绝对启动时间的固定仪表)
-
可用磁盘空间
应用启动指标
自动配置会暴露应用程序启动时间的指标:
-
application.started.time:启动应用程序所花费的时间。 -
application.ready.time:应用程序准备好处理请求所花费的时间。
指标会以应用程序类的全限定名作为标签。
任务执行与调度指标
自动配置能够对所有可用的 ThreadPoolTaskExecutor 和 ThreadPoolTaskScheduler Bean 进行监控插桩,前提是底层的 ThreadPoolExecutor 可用。
指标会通过执行器的名称进行标记,该名称源自 Bean 的名称。
JMS 指标
自动配置支持对所有可用的 JmsTemplate Bean 和 @JmsListener 注解方法进行埋点。
这将分别生成 "jms.message.publish" 和 "jms.message.process" 指标。
有关所生成观测信息的更多内容,请参阅 Spring Framework 参考文档。
Spring MVC 指标
自动配置会为所有由 Spring MVC 控制器和函数式处理器处理的请求启用指标采集。
默认情况下,生成的指标名称为 http.server.requests。
你可以通过设置 management.observations.http.server.requests.name 属性来自定义该名称。
有关生成的观测信息,请参阅Spring Framework 参考文档。
若要添加到默认标签,请提供一个继承自 org.springframework.http.server.observation 包中 DefaultServerRequestObservationConvention 的 @Bean。
若要替换默认标签,请提供一个实现 ServerRequestObservationConvention 的 @Bean。
| 在某些情况下,Web 控制器中处理的异常不会被记录为请求指标的标签。 应用程序可以通过将已处理的异常设置为请求属性来选择记录这些异常。 |
默认情况下,所有请求都会被处理。
要自定义过滤器,请提供一个实现了 FilterRegistrationBean<ServerHttpObservationFilter> 的 @Bean。
Spring WebFlux 指标
自动配置会为所有由 Spring WebFlux 控制器和函数式处理器处理的请求启用监控。
默认情况下,生成的指标名称为 http.server.requests。
你可以通过设置 management.observations.http.server.requests.name 属性来自定义该名称。
有关生成的观测信息,请参阅Spring Framework 参考文档。
若要添加到默认标签,请提供一个继承自 org.springframework.http.server.reactive.observation 包中 DefaultServerRequestObservationConvention 的 @Bean。
若要替换默认标签,请提供一个实现 ServerRequestObservationConvention 的 @Bean。
| 在某些情况下,控制器和处理函数中处理的异常不会被记录为请求指标的标签。 应用程序可以通过将已处理的异常设置为请求属性来选择记录这些异常。 |
Jersey 服务器指标
自动配置会启用对所有由 Jersey JAX-RS 实现处理的请求进行监控。
默认情况下,生成的指标名称为 http.server.requests。
你可以通过设置 management.observations.http.server.requests.name 属性来自定义该名称。
默认情况下,Jersey 服务器指标会带有以下信息标签:
| 标签 | <description> </description> |
|---|---|
|
处理请求时抛出的任何异常的简单类名。 |
|
请求的方法(例如, |
|
请求的结果,基于响应的状态码。
1xx 表示 |
|
响应的 HTTP 状态码(例如, |
|
请求的 URI 模板(在变量替换之前,如果可能的话),例如: |
要自定义标签,请提供一个实现了 JerseyObservationConvention 的 @Bean。
SSL 绑定指标
Spring Boot Actuator 会发布有关 SSL 证书包的过期指标。
指标 ssl.chain.expiry 以秒为单位衡量每个证书链的过期时间。
如果证书链已经过期,该数值将为负数。
此指标带有以下标签信息:
| 标签 | <description> </description> |
|---|---|
|
包含证书链的密钥库的名称 |
|
证书链中最早到期的证书的序列号(十六进制格式) |
|
证书链的名称。 |
HTTP 客户端指标
Spring Boot Actuator 负责管理 RestTemplate、WebClient 和 RestClient 的监控指标。
为此,您需要注入自动配置的构建器并使用它来创建实例:
您还可以手动应用负责此仪器化的自定义器,即 ObservationRestTemplateCustomizer、ObservationWebClientCustomizer 和 ObservationRestClientCustomizer。
默认情况下,指标会以名称 http.client.requests 生成。
你可以通过设置 management.observations.http.client.requests.name 属性来自定义该名称。
有关生成的观测信息,请参阅Spring Framework 参考文档。
当使用 RestTemplate 或 RestClient 时,若要自定义标签,请提供一个来自 org.springframework.http.client.observation 包的、实现了 ClientRequestObservationConvention 接口的 @Bean。
当使用 WebClient 时,若要自定义标签,请提供一个来自 org.springframework.web.reactive.function.client 包的、实现了 ClientRequestObservationConvention 接口的 @Bean。
Tomcat 指标
自动配置仅在启用了 MBean Registry 时,才会启用对 Tomcat 的监控。
默认情况下,MBean 注册表是禁用的,但您可以通过将 server.tomcat.mbeanregistry.enabled 设置为 true 来启用它。
Tomcat 指标以 tomcat. 作为计量器名称发布。
缓存指标
自动配置使得在启动时能够对所有可用的 Cache 实例进行监控,其指标前缀为 cache。
缓存监控已针对一组基本指标进行了标准化。
此外,还提供特定于缓存的其他指标。
支持以下缓存库:
-
Cache2k
-
Caffeine
-
Hazelcast
-
任何符合规范的 JCache(JSR-107)实现
-
Redis
| 应启用指标(Metrics),以便自动配置能够识别它们。 有关更多详细信息,请参阅您所使用的缓存库的文档。 |
指标按缓存名称和 CacheManager 的名称进行标记,后者派生自 Bean 名称。
仅在启动时配置的缓存才会绑定到注册表。
对于未在缓存配置中定义的缓存(例如在启动阶段后动态创建或以编程方式创建的缓存),需要进行显式注册。
提供了一个 CacheMetricsRegistrar Bean 以简化该过程。 |
数据源指标
自动配置能够对所有可用的 DataSource 对象进行监控插桩,并使用以 jdbc.connections 为前缀的指标。
数据源插桩会生成仪表盘(gauges),用于表示连接池中当前活跃、空闲、最大允许和最小允许的连接数。
指标还会根据基于 Bean 名称计算的 DataSource 的名称进行标记。
默认情况下,Spring Boot 为所有支持的数据源提供元数据。
如果您的首选数据源不受支持,您可以添加额外的 DataSourcePoolMetadataProvider Bean。
请参阅 DataSourcePoolMetadataProvidersConfiguration 获取示例。 |
此外,Hikari 特有的指标会以 hikaricp 前缀公开。
每个指标都通过连接池的名称进行标记(你可以通过 spring.datasource.name 来控制该名称)。
Hibernate 指标
如果 org.hibernate.orm:hibernate-micrometer 在类路径上,所有可用的且已启用统计信息的 Hibernate EntityManagerFactory 实例都将通过名为 hibernate 的指标进行增强。
指标还会通过 EntityManagerFactory 的名称进行标记,该名称派生自 Bean 的名称。
要启用统计信息,必须将标准 JPA 属性 hibernate.generate_statistics 设置为 true。
您可以在自动配置的 EntityManagerFactory 上启用该功能:
-
Properties
-
YAML
spring.jpa.properties[hibernate.generate_statistics]=true
spring:
jpa:
properties:
"[hibernate.generate_statistics]": true
Spring Data 仓库指标
自动配置启用了对所有 Spring Data Repository 方法调用的监控。
默认情况下,生成的指标名称为 spring.data.repository.invocations。
您可以通过设置 management.metrics.data.repository.metric-name 属性来自定义该名称。
来自 io.micrometer.core.annotation 包的 @Timed 注解支持用于 Repository 接口和方法。
如果您不希望记录所有 Repository 调用的指标,可以将 management.metrics.data.repository.autotime.enabled 设置为 false,并仅使用 @Timed 注解。
带有 longTask = true 的 @Timed 注解可为方法启用长任务计时器。
长任务计时器需要独立的指标名称,并且可以与短任务计时器叠加使用。 |
默认情况下,与仓库调用相关的指标会带有以下信息标签:
| 标签 | <description> </description> |
|---|---|
|
源 |
|
被调用的 |
|
结果状态( |
|
从调用中抛出的任何异常的简单类名。 |
要替换默认标签,请提供一个实现了 RepositoryTagsProvider 的 @Bean。
Spring 集成指标
只要存在 MeterRegistry Bean,Spring Integration 就会自动提供 Micrometer 支持。
指标将在 spring.integration. 计量名称下发布。
Kafka 指标
自动配置会分别为自动配置的消费者工厂和生产者工厂注册一个 MicrometerConsumerListener 和一个 MicrometerProducerListener。
它还会为 StreamsBuilderFactoryBean 注册一个 KafkaStreamsMicrometerListener。
有关更多详细信息,请参阅 Spring Kafka 文档中的 Micrometer 原生指标 部分。
MongoDB 指标
本节简要介绍了 MongoDB 可用的指标。
MongoDB 命令指标
自动配置会向自动配置的 MongoClient 注册一个 MongoMetricsCommandListener。
为发送到底层 MongoDB 驱动程序的每个命令创建一个名为 mongodb.driver.commands 的计时器指标。
默认情况下,每个指标都带有以下信息标签:
| 标签 | <description> </description> |
|---|---|
|
所发出命令的名称。 |
|
所发送命令的目标集群的标识符。 |
|
发送命令的目标服务器地址。 |
|
命令的执行结果( |
要替换默认的指标标签,请定义一个 MongoCommandTagsProvider Bean,如下例所示:
-
Java
-
Kotlin
import io.micrometer.core.instrument.binder.mongodb.MongoCommandTagsProvider;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyCommandTagsProviderConfiguration {
@Bean
public MongoCommandTagsProvider customCommandTagsProvider() {
return new CustomCommandTagsProvider();
}
}
import io.micrometer.core.instrument.binder.mongodb.MongoCommandTagsProvider
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyCommandTagsProviderConfiguration {
@Bean
fun customCommandTagsProvider(): MongoCommandTagsProvider? {
return CustomCommandTagsProvider()
}
}
要禁用自动配置的命令指标,请设置以下属性:
-
Properties
-
YAML
management.metrics.mongo.command.enabled=false
management:
metrics:
mongo:
command:
enabled: false
MongoDB 连接池指标
自动配置会向自动配置的 MongoClient 注册一个 MongoMetricsConnectionPoolListener。
为连接池创建了以下仪表指标(gauge metrics):
-
mongodb.driver.pool.size报告当前连接池的大小,包括空闲和正在使用的连接。 -
mongodb.driver.pool.checkedout报告当前正在使用的连接数量。 -
mongodb.driver.pool.waitqueuesize报告当前从连接池获取连接的等待队列的大小。
每个指标默认都会附带以下信息标签:
| 标签 | <description> </description> |
|---|---|
|
连接池所对应的集群的标识符。 |
|
连接池所对应的服务器地址。 |
要替换默认的指标标签,请定义一个 MongoConnectionPoolTagsProvider Bean:
-
Java
-
Kotlin
import io.micrometer.core.instrument.binder.mongodb.MongoConnectionPoolTagsProvider;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyConnectionPoolTagsProviderConfiguration {
@Bean
public MongoConnectionPoolTagsProvider customConnectionPoolTagsProvider() {
return new CustomConnectionPoolTagsProvider();
}
}
import io.micrometer.core.instrument.binder.mongodb.MongoConnectionPoolTagsProvider
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyConnectionPoolTagsProviderConfiguration {
@Bean
fun customConnectionPoolTagsProvider(): MongoConnectionPoolTagsProvider {
return CustomConnectionPoolTagsProvider()
}
}
要禁用自动配置的连接池指标,请设置以下属性:
-
Properties
-
YAML
management.metrics.mongo.connectionpool.enabled=false
management:
metrics:
mongo:
connectionpool:
enabled: false
Jetty 指标
自动配置通过 Micrometer 的 JettyServerThreadPoolMetrics 为 Jetty 的 ThreadPool 绑定指标。
Jetty 的 Connector 实例的指标是通过 Micrometer 的 JettyConnectionMetrics 绑定的,并且当 server.ssl.enabled 设置为 true 时,还会使用 Micrometer 的 JettySslHandshakeMetrics。
Redis 指标
自动配置会为自动配置的 MicrometerCommandLatencyRecorder 注册一个 LettuceConnectionFactory。
有关更多详情,请参阅 Lettuce 文档的 可观测性部分。
注册自定义指标
要注册自定义指标,请将 MeterRegistry 注入到您的组件中:
-
Java
-
Kotlin
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tags;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
private final Dictionary dictionary;
public MyBean(MeterRegistry registry) {
this.dictionary = Dictionary.load();
registry.gauge("dictionary.size", Tags.empty(), this.dictionary.getWords().size());
}
}
import io.micrometer.core.instrument.MeterRegistry
import io.micrometer.core.instrument.Tags
import org.springframework.stereotype.Component
@Component
class MyBean(registry: MeterRegistry) {
private val dictionary: Dictionary
init {
dictionary = Dictionary.load()
registry.gauge("dictionary.size", Tags.empty(), dictionary.words.size)
}
}
如果您的指标依赖于其他 Bean,我们建议您使用 MeterBinder 来注册它们:
-
Java
-
Kotlin
import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.binder.MeterBinder;
import org.springframework.context.annotation.Bean;
public class MyMeterBinderConfiguration {
@Bean
public MeterBinder queueSize(Queue queue) {
return (registry) -> Gauge.builder("queueSize", queue::size).register(registry);
}
}
import io.micrometer.core.instrument.Gauge
import io.micrometer.core.instrument.binder.MeterBinder
import org.springframework.context.annotation.Bean
class MyMeterBinderConfiguration {
@Bean
fun queueSize(queue: Queue): MeterBinder {
return MeterBinder { registry ->
Gauge.builder("queueSize", queue::size).register(registry)
}
}
}
使用 MeterBinder 可确保正确设置依赖关系,并在检索指标值时保证 Bean 可用。
如果您发现需要在多个组件或应用中反复对一组指标进行埋点,那么 MeterBinder 实现也会非常有用。
默认情况下,来自所有 MeterBinder Bean 的指标会自动绑定到由 Spring 管理的 MeterRegistry。 |
自定义独立指标
如果您需要对特定的 Meter 实例应用自定义设置,可以使用 MeterFilter 接口。
例如,如果你想将所有以 mytag.region 开头的 meter ID 中的标签 mytag.area 重命名为 com.example,你可以执行以下操作:
-
Java
-
Kotlin
import io.micrometer.core.instrument.config.MeterFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyMetricsFilterConfiguration {
@Bean
public MeterFilter renameRegionTagMeterFilter() {
return MeterFilter.renameTag("com.example", "mytag.region", "mytag.area");
}
}
import io.micrometer.core.instrument.config.MeterFilter
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyMetricsFilterConfiguration {
@Bean
fun renameRegionTagMeterFilter(): MeterFilter {
return MeterFilter.renameTag("com.example", "mytag.region", "mytag.area")
}
}
默认情况下,所有 MeterFilter Bean 都会自动绑定到由 Spring 管理的 MeterRegistry。
请务必使用由 Spring 管理的 MeterRegistry 来注册您的指标,而不要使用 Metrics 上的任何静态方法。
这些静态方法使用的是未被 Spring 管理的全局注册表。 |
常用标签
通用标签通常用于对运行环境进行维度下钻分析,例如主机(host)、实例(instance)、区域(region)、堆栈(stack)等。 通用标签会应用到所有计量器(meter)上,并且可以进行配置,如下例所示:
-
Properties
-
YAML
management.metrics.tags.region=us-east-1
management.metrics.tags.stack=prod
management:
metrics:
tags:
region: "us-east-1"
stack: "prod"
前面的示例分别为所有指标添加了 region 和 stack 标签,其值分别为 us-east-1 和 prod。
如果您使用 Graphite,公共标签的顺序非常重要。
由于使用此方法无法保证公共标签的顺序,建议 Graphite 用户定义自定义的 MeterFilter。 |
每米属性
除了 MeterFilter Bean 之外,您还可以使用属性对每个指标(meter)应用有限的自定义设置。
每个指标的自定义设置会通过 Spring Boot 的 PropertiesMeterFilter 应用于所有以指定名称开头的指标 ID。
以下示例将过滤掉所有 ID 以 example.remote 开头的指标。
-
Properties
-
YAML
management.metrics.enable.example.remote=false
management:
metrics:
enable:
example:
remote: false
以下属性允许对每个计量器进行自定义:
| <property> </property> | <description> </description> |
|---|---|
|
是否接受具有特定 ID 的指标。
未被接受的指标将从 |
|
是否发布一个适用于计算可聚合(跨维度)百分位近似值的直方图。 |
|
通过限制预期值的范围来发布更少的直方图桶。 |
|
发布应用程序中计算的百分位数值 |
|
通过将近期样本累积在环形缓冲区中,赋予它们更高的权重;这些缓冲区在可配置的过期时间后轮转,并具有可配置的缓冲区长度。 |
|
发布一个累积直方图,其分桶由您的服务级别目标(SLO)定义。 |
有关 percentiles-histogram、percentiles 和 slo 背后概念的更多详细信息,请参阅 Micrometer 文档中的直方图与百分位数部分。
指标端点
Spring Boot 提供了一个 metrics 端点,你可以用它来诊断性地检查应用程序收集的指标。
该端点默认不可用,必须显式暴露。
更多详细信息,请参阅暴露端点。
导航到 /actuator/metrics 会显示可用的计量器名称列表。
您可以通过提供计量器名称作为选择器来深入查看特定计量器的信息,例如 /actuator/metrics/jvm.memory.max。
|
此处使用的名称应与代码中使用的名称一致,而不是与发送到监控系统后根据其命名规范标准化后的名称一致。
换句话说,如果由于 Prometheus 采用蛇形命名法(snake case), |
你还可以在 URL 末尾添加任意数量的 tag=KEY:VALUE 查询参数,以对指标进行维度下钻 —— 例如,/actuator/metrics/jvm.memory.max?tag=area:nonheap。
|
所报告的测量值是所有匹配指定指标名称及已应用标签的计量器统计信息的总和。
在前面的示例中,返回的 |
与 Micrometer 观测的集成
一个 DefaultMeterObservationHandler 会自动注册到 ObservationRegistry 上,从而为每个完成的观测创建指标。