指标和管理

本节介绍如何捕获 Spring Integration 的指标。在最近的版本中，我们更加依赖 Micrometer（参见 micrometer.io），我们计划在未来的版本中更多地使用 Micrometer。spring-doc.cn

在高容量环境中禁用日志记录

您可以在主消息流中控制调试日志记录。在非常大容量的应用程序中，对于某些日志记录子系统，调用 to 可能非常昂贵。您可以禁用所有此类日志记录以避免此开销。异常日志记录（debug 或其他）不受此设置的影响。isDebugEnabled()spring-doc.cn

以下清单显示了用于控制日志记录的可用选项：spring-doc.cn

Javaspring-doc.cn
XMLspring-doc.cn

@Configuration
@EnableIntegration
@EnableIntegrationManagement(
    defaultLoggingEnabled = "true" <1>)

public static class ContextConfiguration {
...
}

<int:management default-logging-enabled="true"/> (1)

1	设置为以禁用主消息流中的所有日志记录，而不管日志系统类别设置如何。设置为 'true' 以启用调试日志记录（如果日志记录子系统也启用了）。仅在未在 Bean 定义中显式配置设置时应用。默认值为 .`falsetrue`

defaultLoggingEnabled仅当尚未在 Bean 定义中显式配置相应的设置时，才适用。

千分尺集成

概述

从版本 5.0.3 开始，应用程序上下文中存在的 Micrometer 会触发对 Micrometer 度量的支持。MeterRegistryspring-doc.cn

要使用 Micrometer，请将其中一个 bean 添加到应用程序上下文中。MeterRegistryspring-doc.cn

对于每个和，都会注册计时器。对于每个，都会注册一个计数器。MessageHandlerMessageChannelMessageSourcespring-doc.cn

这仅适用于扩展、、和的对象（大多数框架组件都是这种情况）。AbstractMessageHandlerAbstractMessageChannelAbstractMessageSourcespring-doc.cn

消息通道上发送操作的 Meter 具有以下名称或标签：Timerspring-doc.cn

name:spring.integration.sendspring-doc.cn
tag:type:channelspring-doc.cn
tag:name:<componentName>spring-doc.cn
tag:result:(success|failure)spring-doc.cn
tag:exception:(none|exception simple class name)spring-doc.cn
description:Send processing timespring-doc.cn

（结果异常表示通道的操作返回了。failurenonesend()falsespring-doc.cn

用于轮询消息通道上的接收操作的 Meters 具有以下名称或标签：Counterspring-doc.cn

name:spring.integration.receivespring-doc.cn
tag:type:channelspring-doc.cn
tag:name:<componentName>spring-doc.cn
tag:result:(success|failure)spring-doc.cn
tag:exception:(none|exception simple class name)spring-doc.cn
description:Messages receivedspring-doc.cn

消息处理程序上的操作计量具有以下名称或标签：Timerspring-doc.cn

name:spring.integration.sendspring-doc.cn
tag:type:handlerspring-doc.cn
tag:name:<componentName>spring-doc.cn
tag:result:(success|failure)spring-doc.cn
tag:exception:(none|exception simple class name)spring-doc.cn
description:Send processing timespring-doc.cn

消息源的计量器具有以下名称/标签：Counterspring-doc.cn

name:spring.integration.receivespring-doc.cn
tag:type:sourcespring-doc.cn
tag:name:<componentName>spring-doc.cn
tag:result:successspring-doc.cn
tag:exception:nonespring-doc.cn
description:Messages receivedspring-doc.cn

此外，还有三个 Meter：Gaugespring-doc.cn

spring.integration.channels：应用程序中的数量。MessageChannelsspring-doc.cn
spring.integration.handlers：应用程序中的数量。MessageHandlersspring-doc.cn
spring.integration.sources：应用程序中的数量。MessageSourcesspring-doc.cn

通过提供的子类，可以自定义由集成组件创建的名称和标记。 MicrometerCustomMetricsTests 测试用例显示了如何执行此操作的简单示例。您还可以通过重载 builder 子类上的方法来进一步自定义计量器。MetersMicrometerMetricsCaptorbuild()spring-doc.cn

从版本 5.1.13 开始，公开了队列大小和剩余容量的 Micrometer 仪表：QueueChannelspring-doc.cn

name:spring.integration.channel.queue.sizespring-doc.cn
tag:type:channelspring-doc.cn
tag:name:<componentName>spring-doc.cn
description:The size of the queue channelspring-doc.cn

和spring-doc.cn

name:spring.integration.channel.queue.remaining.capacityspring-doc.cn
tag:type:channelspring-doc.cn
tag:name:<componentName>spring-doc.cn
description:The remaining capacity of the queue channelspring-doc.cn

禁用仪表

默认情况下，所有计量在首次使用时都会注册。现在，使用 Micrometer，您可以向中添加 s 以防止部分或全部被注册。您可以按提供的任何属性、、等过滤（拒绝）仪表。有关更多信息，请参阅 Micrometer 文档中的 Meter Filters。MeterFilterMeterRegistrynametagspring-doc.cn

例如，给定：spring-doc.cn

@Bean
public QueueChannel noMeters() {
    return new QueueChannel(10);
}

您可以通过以下方式禁止此通道的计量注册：spring-doc.cn

registry.config().meterFilter(MeterFilter.deny(id ->
        "channel".equals(id.getTag("type")) &&
        "noMeters".equals(id.getTag("name"))));

千分尺观察

从版本 6.0 开始， Spring 集成利用了千分尺观察抽象，它可以通过适当的配置来处理度量和跟踪。ObservationHandlerspring-doc.cn

只要应用程序上下文中存在 bean 并且配置了，就会在组件上启用观察处理。要自定义应检测的组件集，需要在 Comments 上公开一个属性。有关模式匹配算法，请参阅其 javadocs。IntegrationManagementObservationRegistry@EnableIntegrationManagementobservationPatterns()@EnableIntegrationManagementspring-doc.cn

默认情况下，没有组件使用 Bean 进行检测。可以配置为匹配所有组件。IntegrationManagementObservationRegistry*

在这种情况下，计量不是独立收集的，而是委托给提供的 .ObservationHandlerObservationRegistryspring-doc.cn

以下 Spring 集成组件使用 observe logic 进行检测，每个组件都有各自的约定：spring-doc.cn

MessageProducerSupport作为流的入站终端节点，被视为 span 类型并使用 API;CONSUMERIntegrationObservation.HANDLERspring-doc.cn
MessagingGatewaySupport' 是入站请求-回复终端节点，被视为 span 类型。它使用 API;SERVERIntegrationObservation.GATEWAYspring-doc.cn
操作是它生成消息的唯一 Spring 集成 API。因此，它被视为 span 类型并使用 API。当通道是分布式实现时（例如或），并且必须将跟踪信息添加到消息中。因此，观察是基于 Spring Integration 提供 a 以允许后续跟踪添加 Headers，以便它们可供消费者使用;AbstractMessageChannel.send()PRODUCERIntegrationObservation.PRODCUERPublishSubscribeKafkaChannelZeroMqChannelIntegrationObservation.PRODUCERMessageSenderContextMutableMessagePropagatorspring-doc.cn
An 是 span 类型，使用 API。AbstractMessageHandlerCONSUMERIntegrationObservation.HANDLERspring-doc.cn

组件的观察生产可以通过配置进行定制。例如，an 期望通过其 API.IntegrationManagementObservationConventionAbstractMessageHandlerMessageReceiverObservationConventionsetObservationConvention()spring-doc.cn

以下是观察 API 支持的指标、跨度和约定：spring-doc.cn

可观测性 - 指标

您可以在下面找到此项目声明的所有指标的列表。spring-doc.cn

网关

对入站消息网关的观察。spring-doc.cn

度量名称（由 convention class 定义）。键入。spring.integration.gatewayo.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConventiontimerspring-doc.cn

度量名称（由 convention class 定义）。键入。spring.integration.gateway.activeo.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConventionlong task timerspring-doc.cn

*.active 指标中可能缺少在开始观察后添加的 KeyValue。

Micrometer 内部用于 baseunit。但是，每个后端都决定了实际的 baseunit。（即 Prometheus 使用秒）nanoseconds

封闭类的完全限定名称。o.s.i.support.management.observation.IntegrationObservationspring-doc.cn

所有标签都必须以 prefix 为前缀！spring.integration.

表 1.低基数键
名字spring-doc.cn	描述spring-doc.cn
`spring.integration.name` （必填）spring-doc.cn	消息网关组件的名称。spring-doc.cn
`spring.integration.outcome` （必填）spring-doc.cn	请求/回复执行的结果。spring-doc.cn
`spring.integration.type` （必填）spring-doc.cn	组件类型 - 'gateway'。spring-doc.cn

处理器

消息处理程序的观察。spring-doc.cn

度量名称（由 convention class 定义）。键入。spring.integration.handlero.s.i.support.management.observation.DefaultMessageReceiverObservationConventiontimerspring-doc.cn

度量名称（由 convention class 定义）。键入。spring.integration.handler.activeo.s.i.support.management.observation.DefaultMessageReceiverObservationConventionlong task timerspring-doc.cn

*.active 指标中可能缺少在开始观察后添加的 KeyValue。

Micrometer 内部用于 baseunit。但是，每个后端都决定了实际的 baseunit。（即 Prometheus 使用秒）nanoseconds

封闭类的完全限定名称。o.s.i.support.management.observation.IntegrationObservationspring-doc.cn

所有标签都必须以 prefix 为前缀！spring.integration.

表 2.低基数键
名字spring-doc.cn	描述spring-doc.cn
`spring.integration.name` （必填）spring-doc.cn	消息处理程序组件的名称。spring-doc.cn
`spring.integration.type` （必填）spring-doc.cn	组件的类型 - 'handler'。spring-doc.cn

制作人

对消息生产者（例如通道）的观察。spring-doc.cn

度量名称（由 convention class 定义）。键入。spring.integration.producero.s.i.support.management.observation.DefaultMessageSenderObservationConventiontimerspring-doc.cn

度量名称（由 convention class 定义）。键入。spring.integration.producer.activeo.s.i.support.management.observation.DefaultMessageSenderObservationConventionlong task timerspring-doc.cn

*.active 指标中可能缺少在开始观察后添加的 KeyValue。

Micrometer 内部用于 baseunit。但是，每个后端都决定了实际的 baseunit。（即 Prometheus 使用秒）nanoseconds

封闭类的完全限定名称。o.s.i.support.management.observation.IntegrationObservationspring-doc.cn

所有标签都必须以 prefix 为前缀！spring.integration.

表 3.低基数键
名字spring-doc.cn	描述spring-doc.cn
`spring.integration.name` （必填）spring-doc.cn	消息处理程序组件的名称。spring-doc.cn
`spring.integration.type` （必填）spring-doc.cn	组件的类型 - 'producer'。spring-doc.cn

可观测性 - Span

您可以在下面找到此项目声明的所有 span 的列表。spring-doc.cn

网关跨度

对入站消息网关的观察。spring-doc.cn

Span name （由 convention class 定义）。spring.integration.gatewayo.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConventionspring-doc.cn

封闭类的完全限定名称。o.s.i.support.management.observation.IntegrationObservationspring-doc.cn

所有标签都必须以 prefix 为前缀！spring.integration.

表 4.标签键
名字spring-doc.cn	描述spring-doc.cn
`spring.integration.name` （必填）spring-doc.cn	消息网关组件的名称。spring-doc.cn
`spring.integration.outcome` （必填）spring-doc.cn	请求/回复执行的结果。spring-doc.cn
`spring.integration.type` （必填）spring-doc.cn	组件类型 - 'gateway'。spring-doc.cn

处理程序 Span

消息处理程序的观察。spring-doc.cn

Span name （由 convention class 定义）。spring.integration.handlero.s.i.support.management.observation.DefaultMessageReceiverObservationConventionspring-doc.cn

封闭类的完全限定名称。o.s.i.support.management.observation.IntegrationObservationspring-doc.cn

所有标签都必须以 prefix 为前缀！spring.integration.

表 5.标签键
名字spring-doc.cn	描述spring-doc.cn
`spring.integration.name` （必填）spring-doc.cn	消息处理程序组件的名称。spring-doc.cn
`spring.integration.type` （必填）spring-doc.cn	组件的类型 - 'handler'。spring-doc.cn

生产者跨度

对消息生产者（例如通道）的观察。spring-doc.cn

Span name （由 convention class 定义）。spring.integration.producero.s.i.support.management.observation.DefaultMessageSenderObservationConventionspring-doc.cn

封闭类的完全限定名称。o.s.i.support.management.observation.IntegrationObservationspring-doc.cn

所有标签都必须以 prefix 为前缀！spring.integration.

表 6.标签键
名字spring-doc.cn	描述spring-doc.cn
`spring.integration.name` （必填）spring-doc.cn	消息处理程序组件的名称。spring-doc.cn
`spring.integration.type` （必填）spring-doc.cn	组件的类型 - 'producer'。spring-doc.cn

可观测性 - 约定

您可以在下面找到该项目声明的所有列表。GlobalObservationConventionObservationConventionspring-doc.cn

表 7.ObservationConvention 实现
ObservationConvention 类名spring-doc.cn	适用的 ObservationContext 类名spring-doc.cn
`o.s.i.support.management.observation.DefaultMessageReceiverObservationConvention`spring-doc.cn	`MessageReceiverContext`spring-doc.cn
`o.s.i.support.management.observation.MessageReceiverObservationConvention`spring-doc.cn	`MessageReceiverContext`spring-doc.cn
`o.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConvention`spring-doc.cn	`MessageRequestReplyReceiverContext`spring-doc.cn
`o.s.i.support.management.observation.MessageRequestReplyReceiverObservationConvention`spring-doc.cn	`MessageRequestReplyReceiverContext`spring-doc.cn
`o.s.i.support.management.observation.DefaultMessageSenderObservationConvention`spring-doc.cn	`MessageSenderContext`spring-doc.cn
`o.s.i.support.management.observation.MessageSenderObservationConvention`spring-doc.cn	`MessageSenderContext`spring-doc.cn

观测传播

要在一个跟踪中提供连接的 span 链，而与消息传递流的性质无关，即使 a 是持久的和分布式的，也必须在此通道和此通道的使用者（订阅者）上启用观察。这样，跟踪信息在传播到使用者线程或持久化到数据库中之前，会先存储在消息标头中。这是通过上述方式完成的。使用者（a ）端使用 a 从这些标头中恢复跟踪信息，并启动一个新的子项。MessageChannelMessageSenderContextMessageHandlerMessageReceiverContextObservationspring-doc.cn

Spring 集成 JMX 支持

另请参阅 JMX 支持。spring-doc.cn