如何为Axon Framework消息监控指标添加Segment ID标签？

针对你在Axon Framework 4.5.2（计划升级4.6.x）中需要给自定义消息监控器添加Segment ID标签的需求，以下是几种无需修改官方API的落地方案：

方案1：线程本地变量关联Segment ID（最直接） #

核心思路是通过监听Segment的生命周期事件，将处理线程与对应的Segment ID绑定，在消息监控时取出作为标签：

1. 定义线程本地存储类

public class SegmentThreadLocal {
    private static final ThreadLocal<Integer> CURRENT_SEGMENT_ID = new ThreadLocal<>();

    public static void setSegmentId(Integer segmentId) {
        CURRENT_SEGMENT_ID.set(segmentId);
    }

    public static Integer getSegmentId() {
        return CURRENT_SEGMENT_ID.get();
    }

    public static void clear() {
        CURRENT_SEGMENT_ID.remove();
    }
}

2. 给TrackingEventProcessor注册Segment状态监听器
   在处理器配置中添加监听器，监听Segment的认领/释放事件：

@Bean
public EventProcessorConfiguration eventProcessorConfiguration() {
    return EventProcessorConfiguration.forTrackingEventProcessor()
        .listener((eventProcessor, event) -> {
            if (event instanceof SegmentStatusUpdateEvent statusUpdateEvent) {
                if (statusUpdateEvent.getStatus() == SegmentStatusUpdateEvent.Status.CLAIMED) {
                    SegmentThreadLocal.setSegmentId(statusUpdateEvent.getSegmentId());
                } else if (statusUpdateEvent.getStatus() == SegmentStatusUpdateEvent.Status.RELEASED) {
                    SegmentThreadLocal.clear();
                }
            }
        });
}

注意：若使用自定义线程池，需在afterExecute方法中清理线程本地变量，避免内存泄漏。

3. 在自定义MessageMonitor中使用Segment ID
   在onMessageIngested方法中提取Segment ID并添加到指标标签：

@Override
public void onMessageIngested(Message<?> message) {
    Integer segmentId = SegmentThreadLocal.getSegmentId();
    // 组合原有标签与Segment ID标签
    Iterable<Tag> tags = combineTagsWithSegmentId(segmentId);
    // 上报带Segment标签的指标
    metricRegistry.timer("event.processor.latency", tags).update(...);
}

方案2：从Message属性提取Segment ID（若Axon默认支持） #

部分Axon版本中，TrackingEventProcessor会将Segment ID存入Message的attributes集合，可直接提取：

@Override
public void onMessageIngested(Message<?> message) {
    Integer segmentId = (Integer) message.attributes().get("segment-id");
    if (segmentId != null) {
        // 添加Segment ID到指标标签
    }
}

如果你的4.5.2版本未默认添加该属性，可自定义MessageHandlerInterceptor，在消息处理前将Segment ID注入Message属性。

方案3：升级到4.6.x后的原生支持 #

Axon Framework 4.6.x对事件处理器监控做了增强，部分新的监控接口提供了包含Segment信息的ProcessingContext参数，可直接获取Segment ID，无需线程本地变量的hack方式，建议升级后优先使用原生API。

注意事项 #

• 确保线程本地变量在Segment释放或线程回收时被清理，避免内存泄漏。
• 若处理器配置单线程处理多Segment（不推荐），需调整存储逻辑（如用Map关联消息与Segment ID）。
• 添加Segment ID标签会增加指标基数，需确认监控系统能支撑更高维度的指标数据。

内容的提问来源于stack exchange，提问作者kagof