对于最新稳定版本,请使用 Spring Integration 7.0.0spring-doc.cadn.net.cn

指标与管理

本节介绍如何捕捉 Spring 集成的指标。 在最近的版本中,我们更多地依赖Micrometer(见 micrometer.io),并计划在未来的版本中更多地使用Micrometer。spring-doc.cadn.net.cn

在高流量环境中禁用日志

你可以在主消息流中控制调试日志。 在非常大批量的应用中,调用isDebugEnabled()对于某些日志子系统来说,成本可能相当高。 你可以关闭所有此类日志,以避免这些开销。 异常日志记录(无论是调试还是其他方式)不受此设置影响。spring-doc.cadn.net.cn

以下列表展示了控制日志的可用选项:spring-doc.cadn.net.cn

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

public static class ContextConfiguration {
...
}
<int:management default-logging-enabled="true"/> (1)
1 设置为false禁用主消息流中的所有日志,无论日志系统类别设置如何。 设置为“true”以启用调试日志(如果日志子系统也启用了)。 只有在你没有在豆子定义中明确配置该设置时才会应用。 默认为true.
默认日志启用只有在你没有在豆子定义中明确配置对应的设置时才会应用。

微米积分

概述

从5.0.3版本开始,出现了Micrometer MeterRegistry在应用环境中,触发对微米级度制的支持。spring-doc.cadn.net.cn

使用千分尺时,添加其中一个MeterRegistry应用上下文。spring-doc.cadn.net.cn

对于每个消息处理器消息频道,计时器被注册。 对于每个消息源,计数器被注册。spring-doc.cadn.net.cn

这只适用于延伸的物体摘要消息处理器,摘要消息频道摘要消息源(大多数框架组件都是如此)。spring-doc.cadn.net.cn

定时器用于消息通道发送作的计量器有以下名称或标签:spring-doc.cadn.net.cn

(A失败结果为没有例外是指频道的发送()返回行动false.)spring-doc.cadn.net.cn

计数器可轮询消息信道上的接收作计量器具有以下名称或标签:spring-doc.cadn.net.cn

定时器用于消息处理程序作的计量器具有以下名称或标签:spring-doc.cadn.net.cn

计数器消息源的计量器具有以下名称/标签:spring-doc.cadn.net.cn

此外,还有三个轨距米:spring-doc.cadn.net.cn

可以自定义 的名称和标签通过积分组件提供 的子类微米计量Captor. MicrometerCustomMetricsTests 测试用例展示了一个简单的示例。 你还可以通过超载来进一步自定义能量条build()建造子类方法。spring-doc.cadn.net.cn

从版本5.1.13开始,队列通道展示队列大小和剩余容量的微米仪表:spring-doc.cadn.net.cn

禁用仪表

默认情况下,所有电表在首次使用时都会被登记。 现在,有了Micrometer,你可以加计量Filters到theMeterRegistry以防止部分或全部被注册。 你可以根据提供的任意属性过滤(拒绝)电表,名称,标记等。 更多信息请参见Micrometer文档中的米Filterspring-doc.cadn.net.cn

例如,给定:spring-doc.cadn.net.cn

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

你可以通过以下方式抑制仅针对该频道的电表注册:spring-doc.cadn.net.cn

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

微米观测

从6.0版本开始,Spring Integration采用了微米观测抽象,既能处理度量,也能通过适当的方式进行追踪观察处理器配置。spring-doc.cadn.net.cn

观测处理已在集成管理观测登记册BEAN 存在于应用上下文中,并且@EnableIntegrationManagement已配置。 为了自定义应安装哪些组件,需要观察模式()属性在@EnableIntegrationManagement注解。 请参见其 javadocs 中的模式匹配算法。spring-doc.cadn.net.cn

默认情况下,没有任何集成管理组件通过观测登记册豆。 可以配置为匹配所有组件。*

在这种情况下,这些电表并非独立收集,而是委托给适当的人观察处理器配置在提供的观测登记册.spring-doc.cadn.net.cn

以下 Spring Integration 组件采用了各自的观察逻辑,并各自采用相应的惯例:spring-doc.cadn.net.cn

  • MessageProducerSupport,作为流的入站端点,被视为消费者跨度类型,并使用IntegrationObservation.HANDLER应用程序接口;spring-doc.cadn.net.cn

  • MessagingGatewaySupport' 是一个入站请求-回复端点,被视为服务器span类型。 它使用IntegrationObservation.GATEWAY应用程序接口;spring-doc.cadn.net.cn

  • 摘要消息频道.send()operation 是唯一一个能生成消息的 Spring 集成 API。 因此,它被视为制作人跨度类型,并使用IntegrationObservation.PRODCUER应用程序接口。 当通道是分布式实现时(例如,发布订阅Kafka频道零Mq频道)并且必须在消息中添加跟踪信息。 所以,集成观察。生产者观察基于消息发送者上下文其中 Spring Integration 提供可变消息以便进行后续的追踪传播器添加头部,使其对消费者开放;spring-doc.cadn.net.cn

  • 摘要消息处理器消费者跨度类型,并使用IntegrationObservation.HANDLER应用程序接口。spring-doc.cadn.net.cn

关于集成管理组件可以通过以下方式进行定制观察大会配置。 例如,一个摘要消息处理器期望消息接收者观察约定通过其setObservationConvention()应用程序接口。spring-doc.cadn.net.cn

以下是Observation API支持的度量、范围和惯例:spring-doc.cadn.net.cn

可观测性 - 指标

以下是该项目宣布的所有指标列表。spring-doc.cadn.net.cn

网关

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

公制名称 Spring.integration.gateway(由约定类定义o.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConvention).类型 定时器.spring-doc.cadn.net.cn

公制名称 spring.integration.gateway.active(由约定类定义o.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConvention).类型 长任务计时器.spring-doc.cadn.net.cn

启动观察后添加的KeyValue可能缺失在*.active指标中。
微米内部用途纳 秒为基单元。然而,每个后端都决定了实际的基单元。(即普罗米修斯用秒)

包围类别的完全限定名称o.s.i.support.management.observation.集成观察.spring-doc.cadn.net.cn

所有标签必须以spring.integration。前缀!
表1。低基数密钥

spring.integration.name (必填)spring-doc.cadn.net.cn

消息网关组件的名称。spring-doc.cadn.net.cn

spring.integration.outcome(春.整合.结果) (必填)spring-doc.cadn.net.cn

请求/回复执行的结果。spring-doc.cadn.net.cn

spring.integration.type (必填)spring-doc.cadn.net.cn

组件类型——“网关”。spring-doc.cadn.net.cn

处理器

为消息处理者提供观察。spring-doc.cadn.net.cn

公制名称 Spring.integration.handler(由约定类定义o.s.i.support.management.observation.DefaultMessageReceiverObservationConvention).类型 定时器.spring-doc.cadn.net.cn

公制名称 Spring.integration.handler.active(由约定类定义o.s.i.support.management.observation.DefaultMessageReceiverObservationConvention).类型 长任务计时器.spring-doc.cadn.net.cn

启动观察后添加的KeyValue可能缺失在*.active指标中。
微米内部用途纳 秒为基单元。然而,每个后端都决定了实际的基单元。(即普罗米修斯用秒)

包围类别的完全限定名称o.s.i.support.management.observation.集成观察.spring-doc.cadn.net.cn

所有标签必须以spring.integration。前缀!
表2。低基数密钥

spring.integration.name (必填)spring-doc.cadn.net.cn

消息处理组件的名称。spring-doc.cadn.net.cn

spring.integration.type (必填)spring-doc.cadn.net.cn

组件类型——“handler”。spring-doc.cadn.net.cn

制作人

为消息生产者(如通道)进行观察。spring-doc.cadn.net.cn

公制名称 spring.integration.producer(由约定类定义o.s.i.support.management.observation.DefaultMessageSenderObservationConvention).类型 定时器.spring-doc.cadn.net.cn

公制名称 spring.integration.producer.active(由约定类定义o.s.i.support.management.observation.DefaultMessageSenderObservationConvention).类型 长任务计时器.spring-doc.cadn.net.cn

启动观察后添加的KeyValue可能缺失在*.active指标中。
微米内部用途纳 秒为基单元。然而,每个后端都决定了实际的基单元。(即普罗米修斯用秒)

包围类别的完全限定名称o.s.i.support.management.observation.集成观察.spring-doc.cadn.net.cn

所有标签必须以spring.integration。前缀!
表3。低基数密钥

spring.integration.name (必填)spring-doc.cadn.net.cn

消息处理组件的名称。spring-doc.cadn.net.cn

spring.integration.type (必填)spring-doc.cadn.net.cn

组件类型——“生产者”。spring-doc.cadn.net.cn

可观测性——跨度

以下是该项目宣布的所有跨度列表。spring-doc.cadn.net.cn

门户跨度

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

跨区名称 Spring.integration.gateway(由约定类定义o.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConvention).spring-doc.cadn.net.cn

包围类别的完全限定名称o.s.i.support.management.observation.集成观察.spring-doc.cadn.net.cn

所有标签必须以spring.integration。前缀!
表4。标签密钥

名称spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

spring.integration.name (必填)spring-doc.cadn.net.cn

消息网关组件的名称。spring-doc.cadn.net.cn

spring.integration.outcome(春.整合.结果) (必填)spring-doc.cadn.net.cn

请求/回复执行的结果。spring-doc.cadn.net.cn

spring.integration.type (必填)spring-doc.cadn.net.cn

组件类型——“网关”。spring-doc.cadn.net.cn

牵引员

为消息处理者提供观察。spring-doc.cadn.net.cn

跨区名称 Spring.integration.handler(由约定类定义o.s.i.support.management.observation.DefaultMessageReceiverObservationConvention).spring-doc.cadn.net.cn

包围类别的完全限定名称o.s.i.support.management.observation.集成观察.spring-doc.cadn.net.cn

所有标签必须以spring.integration。前缀!
表5。标签密钥

名称spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

spring.integration.name (必填)spring-doc.cadn.net.cn

消息处理组件的名称。spring-doc.cadn.net.cn

spring.integration.type (必填)spring-doc.cadn.net.cn

组件类型——“handler”。spring-doc.cadn.net.cn

制作人斯潘

为消息生产者(如通道)进行观察。spring-doc.cadn.net.cn

跨区名称 spring.integration.producer(由约定类定义o.s.i.support.management.observation.DefaultMessageSenderObservationConvention).spring-doc.cadn.net.cn

包围类别的完全限定名称o.s.i.support.management.observation.集成观察.spring-doc.cadn.net.cn

所有标签必须以spring.integration。前缀!
表6。标签密钥

名称spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

spring.integration.name (必填)spring-doc.cadn.net.cn

消息处理组件的名称。spring-doc.cadn.net.cn

spring.integration.type (必填)spring-doc.cadn.net.cn

组件类型——“生产者”。spring-doc.cadn.net.cn

可观测性 - 约定

下面你可以找到所有的列表全球观察大会观察大会该项目宣布。spring-doc.cadn.net.cn

表7。ObservationConvention 实现

ObservationConvention 类别名称spring-doc.cadn.net.cn

适用的观察上下文类名称spring-doc.cadn.net.cn

o.s.i.support.management.observation.DefaultMessageReceiverObservationConventionspring-doc.cadn.net.cn

消息接收者上下文spring-doc.cadn.net.cn

o.s.i.support.management.observation.MessageReceiverObservationConventionspring-doc.cadn.net.cn

消息接收者上下文spring-doc.cadn.net.cn

o.s.i.support.management.observation.DefaultMessageRequestReplyReceiverObservationConventionspring-doc.cadn.net.cn

消息请求回复接收者上下文spring-doc.cadn.net.cn

o.s.i.support.management.observation.MessageRequestReplyReceiverObservationConventionspring-doc.cadn.net.cn

消息请求回复接收者上下文spring-doc.cadn.net.cn

o.s.i.support.management.observation.DefaultMessageSenderObservationConventionspring-doc.cadn.net.cn

消息发送者上下文spring-doc.cadn.net.cn

o.s.i.support.management.observation.MessageSenderObservationConventionspring-doc.cadn.net.cn

消息发送者上下文spring-doc.cadn.net.cn

观测传播

在一条线中提供一条连接的跨链,无论消息流的性质如何,即使消息频道是持久且分布式的,必须在该频道及该频道的消费者(用户)上启用该观察。 这样,追踪信息会在消息头部存储,然后再传播到消费者线程或持久化到数据库中。 这可以通过上述方式实现消息发送者上下文. 消费者(a消息处理器) 侧面恢复这些头部的追踪信息,使用消息接收者上下文并开始了一个新孩子观察.spring-doc.cadn.net.cn

Spring 集成 JMX 支持