Production-ready Features

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

您可以在Spring Security Reference Guide中找到有关CSRF保护的其他信息。

端点上的操作通过它们的参数接收输入。在Web上公开时，这些参数的值取自URL的查询参数和JSON请求正文。当通过JMX公开时，参数被映射到MBean操作的参数。默认情况下，参数是必需的。可以通过使用@javax.注解.Nullable或@org.springframework.lang.Nullable.来注释它们，从而使它们成为可选的

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

您可以使用它来调用一个写入操作，该操作接受字符串名称和整型计数器参数，如下例所示：

@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的标准注释来映射，例如@Requestmap和@Getmap，并将端点的ID用作路径的前缀。控制器端点提供了与Spring Web框架的更深层次的集成，但以可移植性为代价。应尽可能使用@Endpoint和@WebEndpoint注释。

如果合适，Spring Boot会自动配置下表中列出的HealthIndicator。您也可以通过配置Management.Health.key.Enabled来启用或禁用选定的指标，键如下表所示：

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

要提供定制的健康信息，您可以注册实现HealthIndicator接口的SpringBean。您需要提供Health()方法的实现并返回Health响应。运行状况响应应包括状态，并且可以选择性地包括要显示的其他详细信息。以下代码显示了一个示例HealthIndicator实现：

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

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

响应中的HTTP状态代码反映整体运行状况。默认情况下，out_of_service和down映射到503。任何未映射的运行状况状态，包括up，都映射到200。如果通过HTTP访问健康端点，您可能还希望注册自定义状态映射。配置自定义映射将禁用down和out_of_service的默认映射。如果要保留默认映射，则必须与任何自定义映射一起显式配置它们。例如，以下属性将致命映射到503(服务不可用)，并保留down和out_of_service的默认映射：

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

对于反应式应用程序，比如那些使用Spring WebFlux的应用程序，Reactive HealthContributor为确保应用程序健康提供了一个非阻塞契约。与传统的 ReactiveHealthContributorRegistry>HealthContributor类似，健康信息是从 ReactiveHealthContributorRegistry(默认情况下，您的 ApplicationContext中定义的所有 和ReactiveHealthContributor实例)的内容中收集的。不对照反应性API进行检查的常规HealthContributor在弹性调度程序上执行。

要从反应式API提供定制的健康信息，您可以注册实现ReactiveHealthIndicator接口的SpringBean。下面的代码显示了一个示例Reactive HealthIndicator实现：

如果合适，Spring Boot会自动配置以下Reactive HealthIndicator：

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

若要创建运行状况指示器组，可以使用management.endpoint.health.group.<；name>；属性并指定要包括或排除的运行状况指示器ID列表。例如，要创建仅包括数据库指示符的组，您可以定义以下内容：

然后，您可以通过点击<代码>localhost:8080/actuator/health/custom.查看结果

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

默认情况下，组继承与系统运行状况相同的StatusAggregator和HttpCodeStatusMapper设置。但是，您也可以在每个组的基础上定义这些。如果需要，您还可以覆盖show-Details和Roles属性：

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

在上面的示例中，自定义组将包括名为主的HealthContributor，它是复合测试的一个组件。这里，主要本身是一个复合体，名为b的HealthContributor将从自定义组中排除。

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

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

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

执行机构将“活跃度”和“就绪性”探测器配置为健康组。这意味着他们可以使用所有健康组功能。例如，您可以配置其他运行状况指示器：

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

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

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

此外，如果应用程序使用Kubernetesautoscaling，它可能会对应用程序从负载均衡器中移除做出不同的反应，这取决于它的autoscaler配置。

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

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

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

当Spring Boot应用程序启动时：

当Spring Boot应用程序关闭时：

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

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

在没有指示应启用它们的前提条件的情况下，env、Java和os贡献者默认处于禁用状态。可以通过将其management.info.<；id>；.enabled属性设置为TRUE来启用每个属性。

默认情况下启用内部版本和git信息贡献器。可以通过将其management.info.<；id>；.enabled属性设置为FALSE来禁用它们。或者，要禁用通常在默认情况下启用的每个参与者，请将Management.info.defaults.Enabled属性设置为FALSE。

启用env贡献器后，您可以通过设置info.*Spring属性来自定义info.*终结点公开的数据。自动显示INFO项下的所有Environment属性。例如，您可以将以下设置添加到应用程序.属性文件中：

info终结点的另一个有用功能是，它能够在生成项目时发布有关Git源代码存储库状态的信息。如果有GitPropertiesBean可用，则可以使用info终结点来公开这些属性。

默认情况下，终结点公开git.Branch、git.Comm.id和git.Comm.time属性(如果存在)。如果您不希望在端点响应中包含这些属性，则需要将它们从git.properties文件中排除。如果要显示完整的Git信息(即git.properties的完整内容)，请使用madement.info.git.mode属性，如下所示：

若要完全禁用来自info终结点的GIT提交信息，请将Management.info.git.Enabled属性设置为FALSE，如下所示：

如果BuildPropertiesBean可用，info终结点还可以发布有关您的构建的信息。如果类路径中有META-INF/Build-info.Properties文件，就会发生这种情况。

info终结点发布有关Java运行时环境的信息，有关更多详细信息，请参阅Java Info。

INFO终结点发布有关您的操作系统的信息，有关详细信息，请参阅OsInfo。

要提供定制应用程序信息，您可以注册实现InfoContributor接口的SpringBean。

下面的示例提供了一个具有单个值的示例条目：

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

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

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

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

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

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

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

Dynatrace提供了两个指标摄取API，这两个API都是针对微米实现的。您可以在此处找到关于微米指标摄取的Dynatrace文档。v1命名空间中的配置属性仅在导出到Timeseries v1 API时适用。v2命名空间中的配置属性仅在导出到Metrics v2 API时适用。请注意，此集成一次只能导出到API的v1或v2版本，首选v2。如果在v1命名空间中设置了Device-id(v1需要，但在v2中未使用)，则指标将导出到v1终结点。否则，假定为v2。

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

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

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

Microeter提供了一个默认的HierarchicalNameMapper，它控制如何将维度仪表ID映射到平面分层名称。

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

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

默认情况下，指标将以默认配置导出到您的本地计算机上运行的inumxv1实例。要将指标导出到InfluxDB v2，需要配置org、存储桶和用于编写指标的身份验证令牌。您可以使用以下命令提供要使用的流入服务器的位置：

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

Microeter提供了一个默认的HierarchicalNameMapper，它控制如何将维度仪表ID映射到平面分层名称。

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

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

您还可以更改将度量发送到New Relic的间隔：

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

最后，您可以通过定义自己的NewRelicClientProviderBean来实现完全控制。

默认情况下，指标会导出到您的本地计算机上运行的OpenTelemeter。您可以使用以下命令提供要使用的OpenTelemtry指标终结点的位置：

Prometheus希望抓取或轮询单个应用程序实例的指标。Spring Boot在/Actuator/Prometheus处提供了一个执行器终结点，以便以适当的格式显示Prometheus sccrp。

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

还支持普罗米修斯样本。若要启用此功能，应存在span ConextSupplierBean。如果您使用微米跟踪，这将自动为您配置，但如果您愿意，您始终可以创建自己的。请查看Prometheus Docs，因为此功能需要在Prometheus端明确启用，并且仅使用OpenMetrics格式支持。

对于可能存在的时间不够长而无法抓取的临时或批处理作业，您可以使用Prometheus Pushateway支持向Prometheus公开指标。要启用普罗米修斯推送网关支持，请向您的项目添加以下依赖项：

当类路径上存在Prometheus PushGateway依赖项并且management.prometheus.metrics.export.pushgateway.enabled属性设置为True时，将自动配置一个PrometheusPushGatewayManagerBean。它管理将指标推送到普罗米修斯推送网关。

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

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

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

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

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

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

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

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

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

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

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

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

自动配置通过使用核心微米类启用JVM指标。JVM指标以JVM.计量器名称发布。

提供了以下JVM指标：

自动配置通过使用核心微米类启用系统指标。系统指标发布在系统.、进程.和磁盘.计量器名称下。

提供了以下系统指标：

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

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

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

自动配置允许检测所有可用的ThreadPoolTaskExecutor和ThreadPoolTaskSchedulerBean，只要下面的ThreadPoolExecutor可用。指标由Executor的名称标记，该名称派生自Bean名称。

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

默认情况下，Spring MVC相关指标使用以下信息进行标记：

要添加默认标记，需要提供一个@Bean，它从DefaultServerRequestObservationConvention包扩展org.springframework.http.observation。要替换默认标记，请提供实现ServerRequestObservationConvention.的<代码>@Bean

默认情况下，所有请求都会得到处理。要定制过滤器，请提供实现FilterRegistrationBean<；WebMvcMetricsFilter>；.的<代码>@Bean

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

默认情况下，WebFlux相关指标使用以下信息进行标记：

要添加默认标记，需要提供一个@Bean，它从DefaultServerRequestObservationConvention包扩展org.springframework.http.observation.reactive。要替换默认标记，请提供实现ServerRequestObservationConvention.的<代码>@Bean

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

默认情况下，Jersey服务器指标使用以下信息进行标记：

要定制标记，请提供实现JerseyTagsProvider的@Bean。

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

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

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

默认情况下，由插入指令的客户端生成的指标使用以下信息进行标记：

要在使用ClientRequestObservationConvention模板时自定义标记，请提供一个@Bean，它从org.springframework.http.client.observation包实现RESTTEMPLATE。要在使用WebClient时定制标记，请提供一个从ClientRequestObservationConvention包实现org.springframework.web.reactive.function.client的@Bean。

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

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

自动配置允许在启动时插入所有可用的缓存实例，指标以缓存为前缀。缓存插装针对一组基本指标进行了标准化。此外，还可以使用特定于缓存的其他指标。

支持以下缓存库：

指标由缓存的名称和从Bean名称派生的CacheManager的名称来标记。

自动配置允许检测任何支持的传输的GraphQL查询。

Spring Boot使用以下命令记录graph ql.Request计时器：

一个GraphQL查询可能涉及许多DataFetcher调用，因此有一个专用的graph ql.datafetcher计时器：

分布摘要统计非琐碎事件的数量此指标对于检测“N+1”数据获取问题和考虑批量加载非常有用；它提供数据获取程序调用的“总数”<代码>可用于<；<；application-properties#application-properties.actuator.management.metrics.distribution.maximum-expected-value，配置的更多选项

单个响应可以包含许多GraphQL错误，由Graphql.Error计数器计数：

自动配置支持对所有可用的DataSource对象进行检测，这些对象的度量以jDBC.Connections为前缀。数据源检测会产生表示池中当前活动、空闲、最大允许连接和最小允许连接的量规。

指标还通过根据Bean名称计算的DataSource的名称进行标记。

此外，特定于Hikari的指标使用hikaricp前缀公开。每个指标都由池的名称来标记(您可以使用spring.datource.name来控制它)。

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

指标还通过从Bean名称派生的EntityManagerFactory的名称进行标记。

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

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

Repository接口和方法支持来自io.micrometer.core.Annotation包的@Timed批注。如果不想记录所有<代码>存储库调用的指标，可以将management.metrics.data.repository.autotime.enabled设置为FALSE，并独占使用@Timed注释。

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

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

自动配置支持使用名为rabbitmq的指标对所有可用的RabbitMQ连接工厂进行检测。

只要有MeterRegistryBean，Spring集成就会自动提供微米支持。指标以spring.Integration.计量器名称发布。

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

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

自动配置通过使用Microeter的JettyServerThreadPoolMetrics绑定Jetty的ThreadPool的指标。使用Microeter的JettyConnectionMetrics绑定Jetty的连接器实例的指标，当server.ssl.Enabled设置为true时，绑定Microeter的JettySslHandshakeMetrics。

要在Spring Boot不直接支持的地方使用@timed，请参考微米文档。

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

通用标签通常用于操作环境的维度向下钻取，如主机、实例、区域、堆栈等。Commons标记应用于所有仪表，并且可以配置，如下例所示：

前面的示例将Region和Stack标记分别添加到值为us-East-1和prod的所有仪表。

除了MeterFilterBean之外，您还可以使用属性以每米为单位应用一组有限的定制。使用Spring Boot的PropertiesMeterFilter对以给定名称开头的任何仪表ID应用按仪表定制。下面的示例过滤掉ID以Example.Remote开头的所有仪表。

以下属性允许按米自定义：

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