生产就绪的功能

由于 Spring Boot 依赖于 Spring Security 的默认设置，因此默认情况下会打开 CSRF 保护。这意味着，当使用默认安全配置时，需要 a POST（关闭和记录器端点）、 aPUT或 a 的执行器端点会收到 403（禁止）错误。DELETE

您可以在Spring Security 参考指南中找到有关 CSRF 保护的更多信息。

端点上的操作通过其参数接收输入。当通过网络公开时，这些参数的值取自 URL 的查询参数和 JSON 请求正文。当通过 JMX 公开时，参数将映射到 MBean 操作的参数。默认情况下需要参数。@javax.annotation.Nullable通过使用或进行注释，可以将它们设为可选@org.springframework.lang.Nullable。

您可以将 JSON 请求正文中的每个根属性映射到端点的参数。考虑以下 JSON 请求正文：

String name您可以使用它来调用采用和参数的写入操作int counter，如以下示例所示：

@Endpoint、@WebEndpoint、 或上的操作@EndpointWebExtension会使用 Jersey、Spring MVC 或 Spring WebFlux 通过 HTTP 自动公开。如果 Jersey 和 Spring MVC 都可用，则使用 Spring MVC。

@ServletEndpoint通过实现一个也实现了注释的类，可以将 Servlet 公开为端点Supplier<EndpointServlet>。Servlet 端点提供与 servlet 容器更深入的集成，但以牺牲可移植性为代价。它们旨在用于将现有 servlet 公开为端点。对于新端点，应尽可能首选@Endpoint和注释。@WebEndpoint

您可以使用@ControllerEndpoint和@RestControllerEndpoint来实现仅由 Spring MVC 或 Spring WebFlux 公开的端点。通过使用 Spring MVC 和 Spring WebFlux 的标准注释（例如@RequestMapping和 ）来映射方法@GetMapping，并将端点的 ID 用作路径的前缀。控制器端点提供了与 Spring Web 框架的更深入的集成，但以牺牲可移植性为代价。应尽可能首选@Endpoint和注释。@WebEndpoint

在适当的情况下，Spring Boot 会自动配置HealthIndicators下表中列出的内容。您还可以通过配置来启用或禁用选定的指标management.health.key.enabled，key如下表所列：

其他HealthIndicators可用但默认情况下未启用：

要提供自定义健康信息，您可以注册实现该HealthIndicator接口的 Spring bean。您需要提供该方法的实现health()并返回Health响应。响应Health应包含状态，并且可以选择包含要显示的其他详细信息。以下代码显示了示例HealthIndicator实现：

除了 Spring Boot 的预定义Status类型之外，还可以返回表示新系统状态的Health自定义类型。Status在这种情况下，您还需要提供StatusAggregator接口的自定义实现，或者必须使用management.endpoint.health.status.order配置属性配置默认实现。

例如，假设您的实现之一正在使用Status代码为 的新代码。要配置严重性顺序，请将以下属性添加到应用程序属性中：FATALHealthIndicator

响应中的 HTTP 状态代码反映了整体健康状况。默认情况下，OUT_OF_SERVICE和DOWN映射到 503。任何未映射的运行状况状态（包括 ）UP都会映射到 200。如果您通过 HTTP 访问运行状况端点，您可能还需要注册自定义状态映射。DOWN配置自定义映射会禁用和 的默认映射OUT_OF_SERVICE。如果要保留默认映射，则必须显式配置它们以及任何自定义映射。例如，以下属性映射FATAL到 503（服务不可用）并保留DOWN和的默认映射OUT_OF_SERVICE：

下表显示了内置状态的默认状态映射：

对于反应式应用程序（例如使用 Spring WebFlux 的应用程序），ReactiveHealthContributor提供了用于获取应用程序运行状况的非阻塞契约。与传统的 类似HealthContributor，健康信息是从 a 的内容中收集的ReactiveHealthContributorRegistry（默认情况下，是在您的 中定义的所有HealthContributor和ReactiveHealthContributor实例ApplicationContext）。HealthContributors不检查反应式 API 的常规内容在弹性调度程序上执行。

要从反应式 API 提供自定义运行状况信息，您可以注册实现该ReactiveHealthIndicator接口的 Spring bean。以下代码显示了示例ReactiveHealthIndicator实现：

在适当的时候，Spring Boot 会自动配置以下内容ReactiveHealthIndicators：

有时，将健康指标组织成可用于不同目的的组很有用。

要创建运行状况指示器组，您可以使用management.endpoint.health.group.<name>属性并将运行状况指示器 ID 列表指定为include或exclude。例如，要创建仅包含数据库指标的组，您可以定义以下内容：

然后您可以通过点击 来检查结果localhost:8080/actuator/health/custom。

同样，要创建一个从组中排除数据库指标并包含所有其他指标的组，您可以定义以下内容：

默认情况下，如果运行状况组包含或排除不存在的运行状况指示器，启动将失败。要禁用此行为，请设置management.endpoint.health.validate-group-membership为false。

默认情况下，组继承与系统运行状况相同的StatusAggregator设置HttpCodeStatusMapper。但是，您也可以按组定义它们。如果需要，您还可以覆盖show-details和roles属性：

健康组还可以包括/排除CompositeHealthContributor. 您还可以仅包含/排除CompositeHealthContributor. 这可以使用组件的完全限定名称来完成，如下所示：

在上面的示例中，custom组将包含 ，其HealthContributor名称primary是 复合 的一个组件test。这里，primary它本身是一个组合，HealthContributor带有该名称的b将被排除在custom组之外。

可以通过主端口或管理端口上的附加路径提供健康组。这在 Kubernetes 等云环境中非常有用，出于安全目的，为执行器端点使用单独的管理端口是很常见的。拥有单独的端口可能会导致运行状况检查不可靠，因为即使运行状况检查成功，主应用程序也可能无法正常工作。健康组可以配置额外的路径，如下所示：

这将使live运行状况组在位于 的主服务器端口上可用/healthz。前缀是强制性的，并且必须是server:（表示主服务器端口）或management:（表示管理端口，如果已配置）。路径必须是单个路径段。

运行DataSource状况指示器显示标准数据源和路由数据源 bean 的运行状况。路由数据源的健康状况包括其每个目标数据源的健康状况。在运行状况端点的响应中，每个路由数据源的目标均使用其路由键来命名。如果您不想在指标的输出中包含路由数据源，请设置management.health.db.ignore-routing-data-sources为true。

Actuator 将“liveness”和“readiness”探针配置为健康组。这意味着他们可以使用所有健康组功能。例如，您可以配置其他运行状况指标：

默认情况下，Spring Boot 不会向这些组添加其他健康指标。

“活跃度”探测不应依赖于外部系统的健康检查。如果应用程序的活动状态被破坏，Kubernetes 会尝试通过重新启动应用程序实例来解决该问题。这意味着，如果外部系统（例如数据库、Web API 或外部缓存）发生故障，Kubernetes 可能会重新启动所有应用程序实例并造成级联故障。

对于“就绪”探测，应用程序开发人员必须谨慎选择检查外部系统。因此，Spring Boot 不会在就绪探针中包含任何额外的运行状况检查。如果应用程序实例的就绪状态未就绪，Kubernetes 不会将流量路由到该实例。某些外部系统可能不会被应用程序实例共享，在这种情况下，它们可以包含在就绪探针中。其他外部系统可能对应用程序不是必需的（应用程序可能有断路器和回退），在这种情况下绝对不应该包含它们。不幸的是，由所有应用程序实例共享的外部系统很常见，您必须做出判断：将其包含在就绪探针中，并期望当外部服务关闭时应用程序停止服务或将其排除在外并处理堆栈高层的故障，也许可以通过在调用者中使用断路器来处理。

此外，如果应用程序使用 Kubernetes自动缩放，它可能会对从负载均衡器中取出的应用程序做出不同的反应，具体取决于其自动缩放器配置。

Kubernetes Probes 支持的一个重要方面是它与应用程序生命周期的一致性。AvailabilityState（应用程序的内存中内部状态）和实际探针（公开该状态）之间存在显着差异。根据应用程序生命周期的阶段，探测器可能不可用。

Spring Boot 在启动和关闭期间发布应用程序事件，探针可以侦听此类事件并公开AvailabilityState信息。

下表显示了AvailabilityStateHTTP 连接器在不同阶段的状态。

当 Spring Boot 应用程序启动时：

当 Spring Boot 应用程序关闭时：

在适当的时候，Spring 会自动配置以下InfoContributorbean：

是否启用单个贡献者由其属性控制management.info.<id>.enabled。不同的贡献者对此属性有不同的默认值，具体取决于他们的先决条件和他们公开的信息的性质。

由于没有任何先决条件表明应启用它们，因此默认情况下会禁用env、java和贡献者。每个都可以通过将其属性设置为 来os启用。management.info.<id>.enabledtrue

默认情况下启用 和 信息贡献者build。每个都可以通过将其属性git设置为 来禁用。或者，要禁用通常默认启用的每个贡献者，请将属性设置为。management.info.<id>.enabledfalsemanagement.info.defaults.enabledfalse

启用贡献者后，您可以通过设置Spring 属性来自env定义端点公开的数据。该密钥下的所有属性都会自动公开。例如，您可以将以下设置添加到您的文件中：infoinfo.*Environmentinfoapplication.properties

端点的另一个有用功能是它能够在项目构建时info发布有关源代码存储库状态的信息。git如果GitPropertiesbean 可用，您可以使用info端点来公开这些属性。

默认情况下，端点公开git.branch、git.commit.id和git.commit.time属性（如果存在）。如果您不希望端点响应中出现任何这些属性，则需要将它们从文件中排除git.properties。如果要显示完整的git信息（即完整内容git.properties），请使用该management.info.git.mode属性，如下：

要完全禁用来自端点的 git 提交信息info，请将management.info.git.enabled属性设置为false，如下所示：

如果BuildPropertiesbean 可用，info端点还可以发布有关您的构建的信息。如果META-INF/build-info.properties类路径中存在可用文件，就会发生这种情况。

端点info发布有关您的 Java 运行时环境的信息，请参阅JavaInfo参考资料 获取更多详细信息。

端点info发布有关您的操作系统的信息，请参阅OsInfo参考资料 获取更多详细信息。

要提供自定义应用程序信息，您可以注册实现该InfoContributor接口的 Spring bean。

以下示例提供example具有单个值的条目：

如果您到达info端点，您应该会看到包含以下附加条目的响应：

默认情况下，AppOptics 注册表会定期将指标推送到api.appoptics.com/v1/measurements. 要将指标导出到 SaaS AppOptics，必须提供您的 API 令牌：

默认情况下，指标会导出到本地计算机上运行的Atlas 。您可以提供Atlas 服务器的位置：

Datadog 注册表定期将指标推送到datadoghq。要将指标导出到Datadog，您必须提供 API 密钥：

如果您另外提供应用程序密钥（可选），则还将导出仪表描述、类型和基本单位等元数据：

默认情况下，指标会发送到 Datadog US站点( api.datadoghq.com)。如果您的 Datadog 项目托管在其他站点之一，或者您需要通过代理发送指标，请相应配置 URI：

您还可以更改将指标发送到 Datadog 的时间间隔：

Dynatrace 提供了两个指标摄取 API，这两个 API 都是针对Micrometer实现的。您可以在此处找到有关 Micrometer 指标摄取的 Dynatrace 文档。命名空间中的配置属性仅在导出到Timeseries v1 APIv1时适用。命名空间中的配置属性仅在导出到Metrics v2 API时适用。请注意，此集成一次只能导出到API 的或版本，这是首选。如果在命名空间中设置了（v1 所需但 v2 中未使用），则指标将导出到端点。否则，假设。v2v1v2v2device-idv1v1v2

默认情况下，指标会导出到本地计算机上运行的Elastic 。您可以使用以下属性提供要使用的弹性服务器的位置：

默认情况下，指标会导出到本地计算机上运行的Ganglia 。您可以提供Ganglia 服务器主机和端口，如以下示例所示：

默认情况下，指标会导出到本地计算机上运行的Graphite 。您可以提供Graphite 服务器主机和端口，如以下示例所示：

Micrometer 提供了一个默认值HierarchicalNameMapper，用于控制如何将维度计量表 ID映射到平面分层名称。

默认情况下，Humio 注册表会定期将指标推送到cloud.humio.com。要将指标导出到 SaaS Humio，您必须提供 API 令牌：

您还应该配置一个或多个标签来识别指标推送到的数据源：

默认情况下，指标将导出到使用默认配置在本地计算机上运行的Influx v1 实例。要将指标导出到 InfluxDB v2，请配置org、bucket和token写入指标的身份验证。您可以通过以下方式提供要使用的Influx 服务器的位置：

Micrometer 提供了到JMX 的分层映射，主要作为一种廉价且可移植的本地查看指标的方式。默认情况下，指标导出到metricsJMX 域。您可以使用以下方式提供要使用的域：

Micrometer 提供了一个默认值HierarchicalNameMapper，用于控制如何将维度计量表 ID映射到平面分层名称。

默认情况下，指标将导出到本地计算机上运行的KairosDB 。您可以通过以下方式提供要使用的KairosDB 服务器的位置：

New Relic 注册表会定期将指标推送到New Relic。要将指标导出到New Relic，您必须提供 API 密钥和帐户 ID：

您还可以更改将指标发送到 New Relic 的时间间隔：

默认情况下，指标通过 REST 调用发布，但如果类路径上有 Java Agent API，您也可以使用它：

最后，您可以通过定义自己的 bean 来完全控制NewRelicClientProvider。

默认情况下，指标将导出到本地计算机上运行的OpenTelemetry 。您可以通过以下方式提供要使用的OpenTelemetry 指标端点的位置：

Prometheus希望抓取或轮询各个应用程序实例的指标。Spring Boot 提供了一个执行器端点来/actuator/prometheus以适当的格式呈现Prometheus 抓取。

以下示例scrape_config添加到prometheus.yml：

还支持Prometheus Exemlars 。要启用此功能，SpanContextSupplier应该存在一个 bean。如果您使用Micrometer Tracing，系统会自动为您配置该功能，但如果您愿意，您可以随时创建自己的配置。请检查Prometheus Docs，因为此功能需要在 Prometheus 端显式启用，并且仅支持使用OpenMetrics格式。

对于可能存在时间不够长而无法被抓取的临时作业或批处理作业，您可以使用Prometheus Pushgateway支持将指标公开给 Prometheus。要启用 Prometheus Pushgateway 支持，请将以下依赖项添加到您的项目中：

当类路径上存在 Prometheus Pushgateway 依赖项并且该management.prometheus.metrics.export.pushgateway.enabled属性设置为 时true，PrometheusPushGatewayManager会自动配置 bean。它管理将指标推送到 Prometheus Pushgateway。

PrometheusPushGatewayManager您可以使用 下的属性来调整management.prometheus.metrics.export.pushgateway。对于高级配置，您还可以提供自己的PrometheusPushGatewayManagerbean。

SignalFx 注册表定期将指标推送到SignalFx。要将指标导出到SignalFx，您必须提供访问令牌：

您还可以更改将指标发送到 SignalFx 的时间间隔：

Micrometer 附带一个简单的内存后端，如果没有配置其他注册表，该后端会自动用作后备。这使您可以查看指标端点中收集了哪些指标。

一旦您使用任何其他可用后端，内存后端就会自行禁用。您还可以显式禁用它：

Stackdriver 注册表会定期将指标推送到Stackdriver。要将指标导出到 SaaS Stackdriver，您必须提供您的 Google Cloud 项目 ID：

您还可以更改指标发送到 Stackdriver 的时间间隔：

StatsD 注册表急切地将指标通过 UDP 推送到 StatsD 代理。默认情况下，指标将导出到本地计算机上运行的StatsD代理。您可以通过以下方式提供要使用的 StatsD 代理主机、端口和协议：

您还可以更改要使用的 StatsD 线路协议（默认为 Datadog）：

Wavefront 注册表定期将指标推送到Wavefront。如果您直接将指标导出到Wavefront，则必须提供 API 令牌：

或者，您可以在环境中使用 Wavefront sidecar 或内部代理将指标数据转发到 Wavefront API 主机：

您还可以更改将指标发送到 Wavefront 的时间间隔：

自动配置通过使用核心 Micrometer 类来启用 JVM Metrics。JVM 指标以计量名称发布jvm.。

提供了以下 JVM 指标：

自动配置通过使用核心 Micrometer 类来启用系统指标。system.系统指标以、process.和disk.Meter 名称发布。

提供以下系统指标：

自动配置公开应用程序启动时间指标：

指标由应用程序类的完全限定名称标记。

自动配置启用 Logback 和 Log4J2 的事件指标。log4j2.events.详细信息以或计量名称发布logback.events.。

只要底层可用，自动配置就可以检测所有可用的ThreadPoolTaskExecutorBean 。指标由执行器的名称标记，该名称源自 bean 名称。ThreadPoolTaskSchedulerThreadPoolExecutor

自动配置可以检测 Spring MVC 控制器和功能处理程序处理的所有请求。默认情况下，生成的指标名称为http.server.requests。您可以通过设置属性来自定义名称management.observations.http.server.requests.name。

有关生成的观察结果的更多信息，请参阅Spring 框架参考文档。

要添加到默认标签，请提供从包@Bean扩展的标签。要替换默认标签，请提供实现.DefaultServerRequestObservationConventionorg.springframework.http.server.observation@BeanServerRequestObservationConvention

默认情况下，所有请求都会被处理。要自定义过滤器，请提供@Bean实现FilterRegistrationBean<WebMvcMetricsFilter>.

自动配置可以检测由 Spring WebFlux 控制器和功能处理程序处理的所有请求。默认情况下，生成的指标名称为http.server.requests。您可以通过设置属性来自定义名称management.observations.http.server.requests.name。

有关生成的观察结果的更多信息，请参阅Spring 框架参考文档。

要添加到默认标签，请提供从包@Bean扩展的标签。要替换默认标签，请提供实现.DefaultServerRequestObservationConventionorg.springframework.http.server.reactive.observation@BeanServerRequestObservationConvention

自动配置支持对 Jersey JAX-RS 实现处理的所有请求进行检测。默认情况下，生成的指标名称为http.server.requests。您可以通过设置属性来自定义名称management.observations.http.server.requests.name。

默认情况下，Jersey 服务器指标标记有以下信息：

要自定义标签，请提供@Bean实现JerseyTagsProvider.

RestTemplateSpring Boot Actuator 管理和的检测WebClient。为此，您必须注入自动配置的构建器并使用它来创建实例：

您还可以手动应用负责此检测的定制器，即ObservationRestTemplateCustomizer和ObservationWebClientCustomizer。

默认情况下，生成的指标名称为http.client.requests。您可以通过设置属性来自定义名称management.observations.http.client.requests.name。

有关生成的观察结果的更多信息，请参阅Spring 框架参考文档。

要在使用时自定义标签RestTemplate，请提供从包中@Bean实现的。要在使用时自定义标签，请提供从包中实现的。ClientRequestObservationConventionorg.springframework.http.client.observationWebClient@BeanClientRequestObservationConventionorg.springframework.web.reactive.function.client

MBeanRegistry仅当启用时，自动配置才会启用 Tomcat 的检测。默认情况下，该功能MBeanRegistry处于禁用状态，但您可以通过设置server.tomcat.mbeanregistry.enabled为 来启用它true。

Tomcat 指标以计量名称发布tomcat.。

自动配置可以Cache在启动时对所有可用实例进行检测，指标前缀为cache. 缓存检测针对一组基本指标进行了标准化。另外，还提供特定于缓存的指标。

支持以下缓存库：

指标通过缓存的名称和CacheManager源自 bean 名称的 名称进行标记。

请参阅Spring Batch 参考文档。

请参阅Spring GraphQL 参考文档。

自动配置可以使用DataSource前缀为 的指标来检测所有可用对象jdbc.connections。数据源检测结果会产生表示池中当前活动、空闲、允许的最大连接数和允许的最小连接数的仪表。

DataSource指标还通过基于 bean 名称的计算名称进行标记。

此外，Hikari 特定的指标也通过hikaricp前缀公开。每个指标都由池的名称标记（您可以使用 控制它spring.datasource.name）。

如果org.hibernate.orm:hibernate-micrometer位于类路径上，则所有启用了EntityManagerFactory统计信息的可用 Hibernate 实例都会使用名为 的指标进行检测hibernate。

指标还通过 的名称进行标记EntityManagerFactory，该名称源自 bean 名称。

要启用统计信息，标准 JPA 属性hibernate.generate_statistics必须设置为true。您可以在自动配置上启用它EntityManagerFactory：

自动配置可以检测所有 Spring DataRepository方法调用。默认情况下，生成的指标名称为spring.data.repository.invocations。您可以通过设置属性来自定义名称management.metrics.data.repository.metric-name。

接口和方法支持包@Timed中的注释。如果您不想记录所有调用的指标，则可以设置为并专门使用注释。io.micrometer.core.annotationRepositoryRepositorymanagement.metrics.data.repository.autotime.enabledfalse@Timed

默认情况下，与存储库调用相关的指标带有以下信息标记：

要替换默认标签，请提供@Bean实现RepositoryTagsProvider.

自动配置允许使用名为 的指标来检测所有可用的 RabbitMQ 连接工厂rabbitmq。

只要bean 可用， Spring Integration 就会自动提供Micrometer 支持。MeterRegistry指标以计量名称发布spring.integration.。

自动配置分别为自动配置的消费者工厂和生产者工厂注册了MicrometerConsumerListener和MicrometerProducerListener。它还注册了一个KafkaStreamsMicrometerListenerfor StreamsBuilderFactoryBean。有关更多详细信息，请参阅Spring Kafka 文档的Micrometer Native Metrics部分。

本节简要介绍 MongoDB 的可用指标。

自动配置ThreadPool通过使用 Micrometer 的来绑定 Jetty 的指标JettyServerThreadPoolMetrics。JettyConnector实例的指标通过使用 Micrometer 进行绑定JettyConnectionMetrics，并且当server.ssl.enabled设置为时true，使用 Micrometer 进行绑定JettySslHandshakeMetrics。

@Timed要在 Spring Boot 不直接支持的地方使用它，请参阅Micrometer 文档。

自动配置MicrometerCommandLatencyRecorder为自动配置的LettuceConnectionFactory. 有关更多详细信息，请参阅Lettuce 文档的微米度量部分。

通用标签一般用于对运行环境进行维度钻取，如主机、实例、区域、堆栈等。Commons 标签应用于所有仪表并且可以进行配置，如以下示例所示：

前面的示例分别向所有值为和 的仪表添加region和标签。stackus-east-1prod

除了MeterFilterBean 之外，您还可以使用属性在每米的基础上应用一组有限的自定义。使用 Spring Boot 将每米的自定义应用于PropertiesMeterFilter以给定名称开头的任何米 ID。以下示例过滤掉 ID 以 开头的所有仪表example.remote。

以下属性允许按米进行定制：

percentiles-histogram有关、percentiles和背后概念的更多详细信息slo，请参阅千分尺文档的“直方图和百分位数”部分。

使用 OpenTelemetry 进行跟踪并向 Zipkin 报告需要以下依赖项：

使用management.zipkin.tracing.*配置属性来配置向 Zipkin 的报告。

使用 OpenTelemetry 进行跟踪并向 Wavefront 报告需要以下依赖项：

使用management.wavefront.*配置属性配置向 Wavefront 的报告。

使用 OpenTelemetry 进行跟踪并使用 OTLP 进行报告需要以下依赖项：

使用management.otlp.tracing.*配置属性来配置使用 OTLP 的报告。

使用 OpenZipkin Brave 进行跟踪并向 Zipkin 报告需要以下依赖项：

使用management.zipkin.tracing.*配置属性来配置向 Zipkin 的报告。

使用 OpenZipkin Brave 进行跟踪并向 Wavefront 报告需要以下依赖项：

使用management.wavefront.*配置属性配置向 Wavefront 的报告。