消息返回的LOG格式想法讨论

[nevstop]

2026/08/21 10:05:34.723 [10:05:34.722] [Sync Message] CSMScenarioExample | API: Get Level -@ SubModule0
2026/08/21 10:05:34.723 [10:05:34.723] [State Change] SubModule0 | API: Get Level <- CSMScenarioExample
2026/08/21 10:05:34.723 [10:05:34.723] [Sync Message] SubModule0 | API: Get Level(Complete) -@ CSMScenarioExample
2026/08/21 10:05:34.723 [10:05:34.723] [State Change] CSMScenarioExample | Response >> 0.500000 <- SubModule0 >>>> API: Get Level
2026/08/21 10:05:34.724 [10:05:34.724] [State Change] CSMScenarioExample | 

这段log 是同步消息的log，目前有这么几个问题：

1.[Sync Message] SubModule0 | API: Get Level(Complete) -@ CSMScenarioExample 这条使用 Sync Message 作为分组不太直观
2. 消息没有携带返回值，log不完整，在API方式调用下，由于没有 Response 消息，log 中不会记录任何返回值

我在思考如何修改：

1. 添加 [SyncMsg Completed] 分组，将这个结束记录放入这个分组；同样对于异步消息设置 AsyncMsg Completed 分组
2. 在完成的消息参数中记录 Response

改成：

2026/08/21 10:05:34.723 [10:05:34.722] [Sync Message] CSMScenarioExample | API: Get Level -@ SubModule0
2026/08/21 10:05:34.723 [10:05:34.723] [State Change] SubModule0 | API: Get Level <- CSMScenarioExample
2026/08/21 10:05:34.723 [10:05:34.723] [SyncMsg Completed] SubModule0 | API: Get Level(Complete) >> 0.500000 -@ CSMScenarioExample
2026/08/21 10:05:34.723 [10:05:34.723] [State Change] CSMScenarioExample | Response >> 0.500000 <- SubModule0 >>>> API: Get Level
2026/08/21 10:05:34.724 [10:05:34.724] [State Change] CSMScenarioExample | 

@NEVSTOP-LAB/csm-community @NEVSTOP-LAB/csm-committee 有没有什么想法

[KivenJia]

1. SyncMsg 和 ASync Msg 新增分组，还是考虑二次分类？ Not Completed & Completed。 直观理解， Completed / NotCompleted 是不是属于消息的执行状态标签。
2. 这个可以，但是如果确实没有返回值，需要标注一个“无返回值 Null” 的标识吗？但是为了不引起歧义，需要明确唯一性，某个标识就是说明 API 本身无返回值，而不是通讯有错。

[nevstop]

1. 添加这两个分组是为了把他们从 Sync Message 和 Async Message 这两个分组里面取出来；类似 Module Created 这样的log，是一个系统的重要状态，感觉还是缩写好一点，log 长度小一点
2. 可以看看这个直观不

2026/08/21 14:52:34.301 [14:52:34.301] [Sync Message] CSMScenarioExample | API: Get Level >> abc -@ SubModule0
2026/08/21 14:52:34.301 [14:52:34.301] [State Change] SubModule0 | API: Get Level >> abc <- CSMScenarioExample
2026/08/21 14:52:34.301 [14:52:34.301] [SyncMsg Complete] SubModule0 | API: Get Level(Complete) >> abc <- CSMScenarioExample >>>> <response> >> 0.500000
2026/08/21 14:52:34.301 [14:52:34.301] [State Change] CSMScenarioExample | Response >> 0.500000 <- SubModule0 >>>> API: Get Level >> abc