feat: event log of bots (#1441)

* feat: basic arch of event log

* feat: complete event log framework

* fix: bad struct in bot log api

* feat: add event logging to all platform adapters

Co-Authored-By: wangcham233@gmail.com <651122857@qq.com>

* feat: add event logging to client classes

Co-Authored-By: wangcham233@gmail.com <651122857@qq.com>

* refactor: bot log getting api

* perf: logger for aiocqhttp and gewechat

* fix: add ignored logger in dingtalk

* fix: seq id bug in log getting

* feat: add logger in dingtalk,QQ official,Slack, wxoa

* feat: add logger for wecom

* feat: add logger for wecomcs

* perf(event logger): image processing

* 完成机器人日志的前端部分 (#1479)

* feat: webui  bot log framework done

* feat: bot log complete

* perf(bot-log): style

* chore: fix incompleted i18n

* feat: support message session copy

* fix: filter and badge text

* perf: styles

* feat: add bot toggle switch in bot card

* fix: linter errors

---------

Co-authored-by: Junyan Qin <rockchinq@gmail.com>

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: wangcham233@gmail.com <651122857@qq.com>
Co-authored-by: HYana <65863826+KaedeSAMA@users.noreply.github.com>

libs/dingtalk_api/api.py

@@ -17,6 +17,7 @@ class DingTalkClient:
         robot_name: str,
         robot_code: str,
         markdown_card: bool,
+        logger: None,
     ):
         """初始化 WebSocket 连接并自动启动"""
         self.credential = dingtalk_stream.Credential(client_id, client_secret)
@@ -34,6 +35,7 @@ class DingTalkClient:
         self.robot_code = robot_code
         self.access_token_expiry_time = ''
         self.markdown_card = markdown_card
+        self.logger = logger
 
     async def get_access_token(self):
         url = 'https://api.dingtalk.com/v1.0/oauth2/accessToken'
@@ -48,7 +50,7 @@ class DingTalkClient:
                     expires_in = int(response_data.get('expireIn', 7200))
                     self.access_token_expiry_time = time.time() + expires_in - 60
             except Exception as e:
-                raise Exception(e)
+                await self.logger.error("failed to get access token in dingtalk")
 
     async def is_token_expired(self):
         """检查token是否过期"""
@@ -73,7 +75,7 @@ class DingTalkClient:
                 result = response.json()
                 download_url = result.get('downloadUrl')
             else:
-                raise Exception(f'Error: {response.status_code}, {response.text}')
+                await self.logger.error(f"failed to get download url: {response.json()}")
 
         if download_url:
             return await self.download_url_to_base64(download_url)
@@ -87,7 +89,7 @@ class DingTalkClient:
                 base64_str = base64.b64encode(file_bytes).decode('utf-8')  # 返回字符串格式
                 return base64_str
             else:
-                raise Exception('获取文件失败')
+                await self.logger.error(f"failed to get files: {response.json()}")
 
     async def get_audio_url(self, download_code: str):
         if not await self.check_access_token():
@@ -103,7 +105,7 @@ class DingTalkClient:
                 if download_url:
                     return await self.download_url_to_base64(download_url)
                 else:
-                    raise Exception('获取音频失败')
+                    await self.logger.error(f"failed to get audio: {response.json()}")
             else:
                 raise Exception(f'Error: {response.status_code}, {response.text}')
 
@@ -115,7 +117,7 @@ class DingTalkClient:
             if event:
                 await self._handle_message(event)
 
-    async def send_message(self, content: str, incoming_message,at:bool):
+    async def send_message(self, content: str, incoming_message,at:bool):      
         if self.markdown_card:
             if at:
                 self.EchoTextHandler.reply_markdown(
@@ -190,8 +192,11 @@ class DingTalkClient:
             copy_message_data = message_data.copy()
             del copy_message_data['IncomingMessage']
             # print("message_data:", json.dumps(copy_message_data, indent=4, ensure_ascii=False))
-        except Exception:
-            traceback.print_exc()
+        except Exception as e:
+            if self.logger:
+                await self.logger.error(f"Error in get_message: {traceback.format_exc()}")
+            else:
+                traceback.print_exc()
 
         return message_data
 
@@ -214,9 +219,12 @@ class DingTalkClient:
         }
         try:
             async with httpx.AsyncClient() as client:
-                await client.post(url, headers=headers, json=data)
+                response = await client.post(url, headers=headers, json=data)
+                if response.status_code == 200:
+                    return
         except Exception:
-            traceback.print_exc()
+            await self.logger.error(f"failed to send proactive massage to person: {traceback.format_exc()}")
+            raise Exception(f"failed to send proactive massage to person: {traceback.format_exc()}")
 
     async def send_proactive_message_to_group(self, target_id: str, content: str):
         if not await self.check_access_token():
@@ -237,9 +245,12 @@ class DingTalkClient:
         }
         try:
             async with httpx.AsyncClient() as client:
-                await client.post(url, headers=headers, json=data)
+                response = await client.post(url, headers=headers, json=data)
+                if response.status_code == 200:
+                    return
         except Exception:
-            traceback.print_exc()
+            await self.logger.error(f"failed to send proactive massage to group: {traceback.format_exc()}")
+            raise Exception(f"failed to send proactive massage to group: {traceback.format_exc()}")
 
     async def start(self):
         """启动 WebSocket 连接，监听消息"""

libs/official_account_api/api.py

@@ -23,7 +23,7 @@ xml_template = """
 
 
 class OAClient:
-    def __init__(self, token: str, EncodingAESKey: str, AppID: str, Appsecret: str):
+    def __init__(self, token: str, EncodingAESKey: str, AppID: str, Appsecret: str, logger: None):
         self.token = token
         self.aes = EncodingAESKey
         self.appid = AppID
@@ -43,6 +43,7 @@ class OAClient:
         self.access_token_expiry_time = None
         self.msg_id_map = {}
         self.generated_content = {}
+        self.logger = logger
 
     async def handle_callback_request(self):
         try:
@@ -54,6 +55,7 @@ class OAClient:
             echostr = request.args.get('echostr', '')
             msg_signature = request.args.get('msg_signature', '')
             if msg_signature is None:
+                await self.logger.error(f'msg_signature不在请求体中')
                 raise Exception('msg_signature不在请求体中')
 
             if request.method == 'GET':
@@ -64,6 +66,7 @@ class OAClient:
                 if check_signature == signature:
                     return echostr  # 验证成功返回echostr
                 else:
+                    await self.logger.error(f'拒绝请求')
                     raise Exception('拒绝请求')
             elif request.method == 'POST':
                 encryt_msg = await request.data
@@ -72,8 +75,9 @@ class OAClient:
                 xml_msg = xml_msg.decode('utf-8')
 
                 if ret != 0:
+                    await self.logger.error(f'消息解密失败')
                     raise Exception('消息解密失败')
-
+                
                 message_data = await self.get_message(xml_msg)
                 if message_data:
                     event = OAEvent.from_payload(message_data)
@@ -114,6 +118,7 @@ class OAClient:
                     return ''
 
         except Exception:
+            await self.logger.error(f'handle_callback_request失败: {traceback.format_exc()}')
             traceback.print_exc()
 
     async def get_message(self, xml_msg: str):
@@ -176,6 +181,7 @@ class OAClientForLongerResponse:
         AppID: str,
         Appsecret: str,
         LoadingMessage: str,
+        logger: None,
     ):
         self.token = token
         self.aes = EncodingAESKey
@@ -197,6 +203,7 @@ class OAClientForLongerResponse:
         self.loading_message = LoadingMessage
         self.msg_queue = {}
         self.user_msg_queue = {}
+        self.logger = logger
 
     async def handle_callback_request(self):
         try:
@@ -207,6 +214,7 @@ class OAClientForLongerResponse:
             msg_signature = request.args.get('msg_signature', '')
 
             if msg_signature is None:
+                await self.logger.error(f'msg_signature不在请求体中')
                 raise Exception('msg_signature不在请求体中')
 
             if request.method == 'GET':
@@ -221,7 +229,9 @@ class OAClientForLongerResponse:
                 xml_msg = xml_msg.decode('utf-8')
 
                 if ret != 0:
+                    await self.logger.error(f'消息解密失败')
                     raise Exception('消息解密失败')
+                
 
                 # 解析 XML
                 root = ET.fromstring(xml_msg)
@@ -270,6 +280,7 @@ class OAClientForLongerResponse:
                         return response_xml
 
         except Exception:
+            await self.logger.error(f'handle_callback_request失败: {traceback.format_exc()}')
             traceback.print_exc()
 
     async def get_message(self, xml_msg: str):

libs/qq_official_api/api.py

@@ -34,7 +34,7 @@ def handle_validation(body: dict, bot_secret: str):
 
 
 class QQOfficialClient:
-    def __init__(self, secret: str, token: str, app_id: str):
+    def __init__(self, secret: str, token: str, app_id: str, logger: None):
         self.app = Quart(__name__)
         self.app.add_url_rule(
             '/callback/command',
@@ -49,6 +49,7 @@ class QQOfficialClient:
         self.base_url = 'https://api.sgroup.qq.com'
         self.access_token = ''
         self.access_token_expiry_time = None
+        self.logger = logger
 
     async def check_access_token(self):
         """检查access_token是否存在"""
@@ -77,6 +78,7 @@ class QQOfficialClient:
                 if access_token:
                     self.access_token = access_token
             except Exception as e:
+                await self.logger.error(f'获取access_token失败: {response_data}')
                 raise Exception(f'获取access_token失败: {e}')
 
     async def handle_callback_request(self):
@@ -102,7 +104,7 @@ class QQOfficialClient:
             return {'code': 0, 'message': 'success'}
 
         except Exception as e:
-            traceback.print_exc()
+            await self.logger.error(f"Error in handle_callback_request: {traceback.format_exc()}")
             return {'error': str(e)}, 400
 
     async def run_task(self, host: str, port: int, *args, **kwargs):
@@ -166,6 +168,7 @@ class QQOfficialClient:
         if not await self.check_access_token():
             await self.get_access_token()
 
+
         url = self.base_url + '/v2/users/' + user_openid + '/messages'
         async with httpx.AsyncClient() as client:
             headers = {
@@ -178,9 +181,11 @@ class QQOfficialClient:
                 'msg_id': msg_id,
             }
             response = await client.post(url, headers=headers, json=data)
+            response_data = response.json()
             if response.status_code == 200:
                 return
             else:
+                await self.logger.error(f'发送私聊消息失败: {response_data}')
                 raise ValueError(response)
 
     async def send_group_text_msg(self, group_openid: str, content: str, msg_id: str):
@@ -188,6 +193,7 @@ class QQOfficialClient:
         if not await self.check_access_token():
             await self.get_access_token()
 
+
         url = self.base_url + '/v2/groups/' + group_openid + '/messages'
         async with httpx.AsyncClient() as client:
             headers = {
@@ -203,6 +209,7 @@ class QQOfficialClient:
             if response.status_code == 200:
                 return
             else:
+                await self.logger.error(f"发送群聊消息失败:{response.json()}")
                 raise Exception(response.read().decode())
 
     async def send_channle_group_text_msg(self, channel_id: str, content: str, msg_id: str):
@@ -210,6 +217,7 @@ class QQOfficialClient:
         if not await self.check_access_token():
             await self.get_access_token()
 
+
         url = self.base_url + '/channels/' + channel_id + '/messages'
         async with httpx.AsyncClient() as client:
             headers = {
@@ -225,12 +233,14 @@ class QQOfficialClient:
             if response.status_code == 200:
                 return True
             else:
+                await self.logger.error(f'发送频道群聊消息失败: {response.json()}')
                 raise Exception(response)
 
     async def send_channle_private_text_msg(self, guild_id: str, content: str, msg_id: str):
         """发送频道私聊消息"""
         if not await self.check_access_token():
             await self.get_access_token()
+        
 
         url = self.base_url + '/dms/' + guild_id + '/messages'
         async with httpx.AsyncClient() as client:
@@ -247,6 +257,7 @@ class QQOfficialClient:
             if response.status_code == 200:
                 return True
             else:
+                await self.logger.error(f'发送频道私聊消息失败: {response.json()}')
                 raise Exception(response)
 
     async def is_token_expired(self):

libs/slack_api/api.py

@@ -1,4 +1,5 @@
 import json
+import traceback
 from quart import Quart, jsonify, request
 from slack_sdk.web.async_client import AsyncWebClient
 from .slackevent import SlackEvent
@@ -7,7 +8,7 @@ from pkg.platform.types import events as platform_events
 
 
 class SlackClient:
-    def __init__(self, bot_token: str, signing_secret: str):
+    def __init__(self, bot_token: str, signing_secret: str, logger: None):
         self.bot_token = bot_token
         self.signing_secret = signing_secret
         self.app = Quart(__name__)
@@ -19,6 +20,7 @@ class SlackClient:
             'example': [],
         }
         self.bot_user_id = None  # 避免机器人回复自己的消息
+        self.logger = logger
 
     async def handle_callback_request(self):
         try:
@@ -32,6 +34,7 @@ class SlackClient:
 
             if self.bot_user_id and bot_user_id == self.bot_user_id:
                 return jsonify({'status': 'ok'})
+            
 
             # 处理私信
             if data and data.get('event', {}).get('channel_type') in ['im']:
@@ -49,6 +52,7 @@ class SlackClient:
             return jsonify({'status': 'ok'})
 
         except Exception as e:
+            await self.logger.error(f"Error in handle_callback_request: {traceback.format_exc()}")
             raise (e)
 
     async def _handle_message(self, event: SlackEvent):
@@ -78,6 +82,7 @@ class SlackClient:
                 self.bot_user_id = response['message']['bot_id']
             return
         except Exception as e:
+            await self.logger.error(f"Error in send_message: {e}")
             raise e
 
     async def send_message_to_one(self, text: str, user_id: str):
@@ -88,6 +93,7 @@ class SlackClient:
 
             return
         except Exception as e:
+            await self.logger.error(f"Error in send_message: {traceback.format_exc()}")
             raise e
 
     async def run_task(self, host: str, port: int, *args, **kwargs):

libs/wechatpad_api/client.py

@@ -11,13 +11,14 @@ from libs.wechatpad_api.api.chatroom import ChatRoomApi
 
 
 class WeChatPadClient:
-    def __init__(self,base_url, token):
+    def __init__(self, base_url, token, logger=None):
         self._login_api = LoginApi(base_url, token)
         self._friend_api = FriendApi(base_url, token)
         self._message_api = MessageApi(base_url, token)
         self._user_api = UserApi(base_url, token)
         self._download_api = DownloadApi(base_url, token)
         self._chatroom_api = ChatRoomApi(base_url, token)
+        self.logger = logger
 
     def get_token(self,admin_key, day: int):
         '''获取token'''

libs/wecom_api/api.py

@@ -3,6 +3,7 @@ from .WXBizMsgCrypt3 import WXBizMsgCrypt
 import base64
 import binascii
 import httpx
+import traceback
 from quart import Quart
 import xml.etree.ElementTree as ET
 from typing import Callable, Dict, Any
@@ -19,6 +20,7 @@ class WecomClient:
         token: str,
         EncodingAESKey: str,
         contacts_secret: str,
+        logger: None,
     ):
         self.corpid = corpid
         self.secret = secret
@@ -28,6 +30,7 @@ class WecomClient:
         self.base_url = 'https://qyapi.weixin.qq.com/cgi-bin'
         self.access_token = ''
         self.secret_for_contacts = contacts_secret
+        self.logger = logger
         self.app = Quart(__name__)
         self.app.add_url_rule(
             '/callback/command',
@@ -54,6 +57,7 @@ class WecomClient:
             if 'access_token' in data:
                 return data['access_token']
             else:
+                await self.logger.error(f"获取accesstoken失败:{response.json()}")
                 raise Exception(f'未获取access token: {data}')
 
     async def get_users(self):
@@ -125,6 +129,7 @@ class WecomClient:
                 response = await client.post(url, json=params)
                 data = response.json()
             except Exception as e:
+                await self.logger.error(f"发送图片失败:{data}")
                 raise Exception('Failed to send image: ' + str(e))
 
             # 企业微信错误码40014和42001，代表accesstoken问题
@@ -159,6 +164,7 @@ class WecomClient:
                 self.access_token = await self.get_access_token(self.secret)
                 return await self.send_private_msg(user_id, agent_id, content)
             if data['errcode'] != 0:
+                await self.logger.error(f"发送消息失败:{data}")
                 raise Exception('Failed to send message: ' + str(data))
 
     async def handle_callback_request(self):
@@ -175,6 +181,7 @@ class WecomClient:
                 echostr = request.args.get('echostr')
                 ret, reply_echo_str = wxcpt.VerifyURL(msg_signature, timestamp, nonce, echostr)
                 if ret != 0:
+                    await self.logger.error("验证失败")
                     raise Exception(f'验证失败，错误码: {ret}')
                 return reply_echo_str
 
@@ -182,7 +189,9 @@ class WecomClient:
                 encrypt_msg = await request.data
                 ret, xml_msg = wxcpt.DecryptMsg(encrypt_msg, msg_signature, timestamp, nonce)
                 if ret != 0:
+                    await self.logger.error("消息解密失败")
                     raise Exception(f'消息解密失败，错误码: {ret}')
+                
 
                 # 解析消息并处理
                 message_data = await self.get_message(xml_msg)
@@ -193,6 +202,7 @@ class WecomClient:
 
                 return 'success'
         except Exception as e:
+            await self.logger.error(f"Error in handle_callback_request: {traceback.format_exc()}")
             return f'Error processing request: {str(e)}', 400
 
     async def run_task(self, host: str, port: int, *args, **kwargs):
@@ -291,6 +301,7 @@ class WecomClient:
             except binascii.Error as e:
                 raise ValueError(f'Invalid base64 string: {str(e)}')
         else:
+            await self.logger.error("Image对象出错")
             raise ValueError('image对象出错')
 
         # 设置 multipart/form-data 格式的文件
@@ -314,6 +325,7 @@ class WecomClient:
                 self.access_token = await self.get_access_token(self.secret)
                 media_id = await self.upload_to_work(image)
             if data.get('errcode', 0) != 0:
+                await self.logger.error(f"上传图片失败:{data}")
                 raise Exception('failed to upload file')
 
             media_id = data.get('media_id')

libs/wecom_customer_service_api/api.py

@@ -13,7 +13,7 @@ import aiofiles
 
 
 class WecomCSClient:
-    def __init__(self, corpid: str, secret: str, token: str, EncodingAESKey: str):
+    def __init__(self, corpid: str, secret: str, token: str, EncodingAESKey: str, logger: None):
         self.corpid = corpid
         self.secret = secret
         self.access_token_for_contacts = ''
@@ -21,6 +21,7 @@ class WecomCSClient:
         self.aes = EncodingAESKey
         self.base_url = 'https://qyapi.weixin.qq.com/cgi-bin'
         self.access_token = ''
+        self.logger = logger
         self.app = Quart(__name__)
         self.app.add_url_rule(
             '/callback/command', 'handle_callback', self.handle_callback_request, methods=['GET', 'POST']
@@ -186,6 +187,7 @@ class WecomCSClient:
                 self.access_token = await self.get_access_token(self.secret)
                 return await self.send_text_msg(open_kfid, external_userid, msgid, content)
             if data['errcode'] != 0:
+                await self.logger.error(f"发送消息失败：{data}")
                 raise Exception('Failed to send message')
             return data
 
@@ -224,7 +226,10 @@ class WecomCSClient:
 
                 return 'success'
         except Exception as e:
-            traceback.print_exc()
+            if self.logger:
+                await self.logger.error(f"Error in handle_callback_request: {traceback.format_exc()}")
+            else:
+                traceback.print_exc()
             return f'Error processing request: {str(e)}', 400
 
     async def run_task(self, host: str, port: int, *args, **kwargs):