Production-ready Features

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

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

端点上的操作通过其参数接收输入。在Web上公开时，这些参数的值来自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注释的类并实现Supplier<EndpointServlet>，可以将Servlet公开为端点。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 配置属性配置默认实现。

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

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

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

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

要从响应式API提供自定义健康信息，您可以注册实现ReactiveHealthIndicator接口的Spring bean。以下代码显示了一个示例ReactiveHealthIndicator实现：

在适当的情况下，Spring Boot会自动配置以下ReactiveHealthIndicators：

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

要创建健康指标组，您可以使用management.endpoint.health.group.<name>属性，并指定要包含或排除的健康指标ID列表。例如，要创建仅包含数据库指标的组，您可以定义如下内容：

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

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

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

默认情况下，组会继承与系统健康相同的StatusAggregator和HttpCodeStatusMapper设置。但是，您也可以在每个组上定义这些设置。如果需要，还可以覆盖show-details和roles属性：

健康组还可以包含/排除CompositeHealthContributor。您还可以仅包含/排除CompositeHealthContributor的某个组件。可以通过组件的完全限定名称来执行此操作，如下所示：

在上面的示例中，custom组将包含名称为primary的HealthContributor，该组件是test的一个组件。在这里，primary本身是一个组合，名称为b的HealthContributor将从custom组中排除。

健康组可以在主端口或管理端口的附加路径上提供。这在云环境（如Kubernetes）中很有用，因为通常会为执行器端点使用单独的管理端口以提高安全性。使用单独的端口可能导致健康检查不可靠，因为即使健康检查成功，主应用程序可能也无法正常工作。可以如下配置健康组的附加路径：

这将使live健康组在主服务器端口上的/healthz路径上可用。前缀是必需的，必须是server:（表示主服务器端口）或management:（表示管理端口，如果已配置）。路径必须是单个路径段。

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

执行器将“存活性”和“就绪性”探针配置为健康组。这意味着所有健康组功能对它们都是可用的。例如，您可以配置额外的健康指标：

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

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

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

此外，如果应用程序使用Kubernetes自动缩放，它可能会根据其自动缩放器配置对被从负载均衡器中移除的应用程序做出不同的反应。

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

Spring Boot在启动和关闭过程中发布应用程序事件，探针可以监听这些事件并公开AvailabilityState信息。

以下表格显示了AvailabilityState和不同阶段的HTTP连接器状态。

当Spring Boot应用程序启动时：

当Spring Boot应用程序关闭时：

在适当的情况下，Spring会自动配置以下InfoContributor bean：

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

没有指示它们应该启用的先决条件，env、java和os贡献者默认情况下是禁用的。可以通过将其management.info.<id>.enabled属性设置为true来启用每个贡献者。

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

当启用env贡献者时，您可以通过设置info.* Spring属性来自定义info端点公开的数据。所有Environment属性在info键下都会自动公开。例如，您可以将以下设置添加到您的application.properties文件中：

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

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

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

如果存在一个BuildProperties bean，则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 美国 站点（api.datadoghq.com）。如果您的 Datadog 项目托管在其他站点之一，或者需要通过代理发送指标，请相应配置 URI：

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

Dynatrace提供了两种指标摄取API，这两种API都已为 实现。您可以在 指标摄取的Dynatrace文档中找到Dynatrace文档 在这里。在 v1命名空间中的配置属性仅在导出到 Timeseries v1 API时应用。在 v2命名空间中的配置属性仅在导出到 Metrics v2 API时应用。请注意，此集成一次只能导出到 v1或 v2 API版本之一， v2为首选。如果在 v1命名空间中设置了 device-id（v1必需但在v2中未使用），则将指标导出到 v1端点。否则，将假定为 v2。

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

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

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

Micrometer提供了一个默认的 HierarchicalNameMapper，用于管理维度计量标识如何 映射到平面分层名称。

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

您还应配置一个或多个标签，以标识将指标推送到的数据源：

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

Micrometer提供了一个层次映射到JMX，主要作为一种便宜且便携的方式在本地查看指标。默认情况下，指标会导出到metrics JMX域。您可以通过以下方式提供要使用的域：

Micrometer提供了一个默认的HierarchicalNameMapper，用于管理维度计量ID如何映射到平面层次结构名称。

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

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

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

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

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

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

Prometheus期望对指标进行抓取或轮询单个应用实例。Spring Boot提供了一个位于/actuator/prometheus的执行器端点，以展示适当格式的Prometheus抓取。

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

Prometheus示例也受支持。要启用此功能，应存在一个SpanContextSupplier bean。如果您使用Micrometer跟踪，则会为您自动配置，但如果您愿意，您也可以自行创建。请查看Prometheus文档，因为此功能需要在Prometheus端显式启用，并且仅支持使用OpenMetrics格式。

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

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

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

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指标。JVM指标发布在jvm.计量器名称下。

提供了以下JVM指标：

通过使用核心Micrometer类，自动配置启用了系统指标。系统指标发布在system.、process.和disk.计量器名称下。

提供了以下系统指标：

自动配置暴露了应用程序启动时间指标：

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

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

自动配置启用了所有可用的ThreadPoolTaskExecutor和ThreadPoolTaskScheduler bean的仪表化，只要底层的ThreadPoolExecutor可用。指标由执行器的名称标记，该名称是从bean名称派生的。

自动配置启用了所有可用的JmsTemplate bean和@JmsListener注解方法的仪表化。这将分别产生"jms.message.publish"和"jms.message.process"指标。有关生成的观察的更多信息，请参阅Spring Framework参考文档。

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

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

要添加默认标签，请提供一个扩展自org.springframework.http.server.observation包中的DefaultServerRequestObservationConvention的@Bean。要替换默认标签，请提供一个实现ServerRequestObservationConvention的@Bean。

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

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

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

要添加默认标签，请提供一个扩展自org.springframework.http.server.reactive.observation包中的DefaultServerRequestObservationConvention的@Bean。要替换默认标签，请提供一个实现ServerRequestObservationConvention的@Bean。

自动配置启用了Jersey JAX-RS实现处理的所有请求的仪表化。默认情况下，指标生成的名称为http.server.requests。您可以通过设置management.observations.http.server.requests.name属性来自定义名称。

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

要自定义标签，请提供一个实现JerseyTagsProvider的@Bean。

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。

仅当启用MBeanRegistry时，自动配置才会启用Tomcat的仪表化。默认情况下，MBeanRegistry是禁用的，但您可以通过将server.tomcat.mbeanregistry.enabled设置为true来启用它。

Tomcat指标发布在tomcat.计量器名称下。

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

支持以下缓存库：

指标按缓存的名称和CacheManager的名称进行标记，后者是从bean名称派生的。

请参阅Spring Batch参考文档。

请参阅Spring GraphQL参考文档。

自动配置启用所有可用的DataSource对象的仪表化，指标前缀为jdbc.connections。数据源仪表化会生成代表池中当前活动、空闲、最大允许和最小允许连接的计量器。

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

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

如果类路径上存在org.hibernate.orm:hibernate-micrometer，则所有可用的启用了统计信息的Hibernate EntityManagerFactory实例都会被仪表化，指标名为hibernate。

指标还按EntityManagerFactory的名称进行标记，该名称是从bean名称派生的。

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

自动配置启用所有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注解。

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

要替换默认标签，请提供一个实现RepositoryTagsProvider的@Bean。

自动配置启用所有可用的RabbitMQ连接工厂的仪表化，指标名为rabbitmq。

每当存在MeterRegistry bean时，Spring Integration会自动提供Micrometer支持。指标发布在spring.integration.计量器名称下。

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

本节简要描述了MongoDB的可用指标。

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

要启用@Timed注解的扫描，需要将management.observations.annotations.enabled属性设置为true。请参阅Micrometer文档。

自动配置为自动配置的LettuceConnectionFactory注册了一个MicrometerCommandLatencyRecorder。有关更多详细信息，请参阅Lettuce文档的Micrometer指标部分。

通用标签通常用于在操作环境上进行维度分析，例如主机、实例、区域、堆栈等。通用标签应用于所有计量器，并可以进行配置，如下例所示：

上述示例将region和stack标签添加到所有计量器中，值分别为us-east-1和prod。

除了MeterFilter bean外，您还可以使用属性在每个计量器基础上应用一组有限的自定义设置。使用Spring Boot的PropertiesMeterFilter，将应用每个以给定名称开头的计量器ID。以下示例过滤掉任何ID以example.remote开头的计量器。

以下属性允许每个计量器的自定义设置：

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

使用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报告。