您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

ops_trace_manager.py 34KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893
  1. import json
  2. import logging
  3. import os
  4. import queue
  5. import threading
  6. import time
  7. from datetime import timedelta
  8. from typing import Any, Optional, Union
  9. from uuid import UUID, uuid4
  10. from cachetools import LRUCache
  11. from flask import current_app
  12. from sqlalchemy import select
  13. from sqlalchemy.orm import Session
  14. from core.helper.encrypter import decrypt_token, encrypt_token, obfuscated_token
  15. from core.ops.entities.config_entity import (
  16. OPS_FILE_PATH,
  17. TracingProviderEnum,
  18. )
  19. from core.ops.entities.trace_entity import (
  20. DatasetRetrievalTraceInfo,
  21. GenerateNameTraceInfo,
  22. MessageTraceInfo,
  23. ModerationTraceInfo,
  24. SuggestedQuestionTraceInfo,
  25. TaskData,
  26. ToolTraceInfo,
  27. TraceTaskName,
  28. WorkflowTraceInfo,
  29. )
  30. from core.ops.utils import get_message_data
  31. from core.workflow.entities.workflow_execution import WorkflowExecution
  32. from extensions.ext_database import db
  33. from extensions.ext_storage import storage
  34. from models.model import App, AppModelConfig, Conversation, Message, MessageFile, TraceAppConfig
  35. from models.workflow import WorkflowAppLog, WorkflowRun
  36. from tasks.ops_trace_task import process_trace_tasks
  37. class OpsTraceProviderConfigMap(dict[str, dict[str, Any]]):
  38. def __getitem__(self, provider: str) -> dict[str, Any]:
  39. match provider:
  40. case TracingProviderEnum.LANGFUSE:
  41. from core.ops.entities.config_entity import LangfuseConfig
  42. from core.ops.langfuse_trace.langfuse_trace import LangFuseDataTrace
  43. return {
  44. "config_class": LangfuseConfig,
  45. "secret_keys": ["public_key", "secret_key"],
  46. "other_keys": ["host", "project_key"],
  47. "trace_instance": LangFuseDataTrace,
  48. }
  49. case TracingProviderEnum.LANGSMITH:
  50. from core.ops.entities.config_entity import LangSmithConfig
  51. from core.ops.langsmith_trace.langsmith_trace import LangSmithDataTrace
  52. return {
  53. "config_class": LangSmithConfig,
  54. "secret_keys": ["api_key"],
  55. "other_keys": ["project", "endpoint"],
  56. "trace_instance": LangSmithDataTrace,
  57. }
  58. case TracingProviderEnum.OPIK:
  59. from core.ops.entities.config_entity import OpikConfig
  60. from core.ops.opik_trace.opik_trace import OpikDataTrace
  61. return {
  62. "config_class": OpikConfig,
  63. "secret_keys": ["api_key"],
  64. "other_keys": ["project", "url", "workspace"],
  65. "trace_instance": OpikDataTrace,
  66. }
  67. case TracingProviderEnum.WEAVE:
  68. from core.ops.entities.config_entity import WeaveConfig
  69. from core.ops.weave_trace.weave_trace import WeaveDataTrace
  70. return {
  71. "config_class": WeaveConfig,
  72. "secret_keys": ["api_key"],
  73. "other_keys": ["project", "entity", "endpoint", "host"],
  74. "trace_instance": WeaveDataTrace,
  75. }
  76. case TracingProviderEnum.ARIZE:
  77. from core.ops.arize_phoenix_trace.arize_phoenix_trace import ArizePhoenixDataTrace
  78. from core.ops.entities.config_entity import ArizeConfig
  79. return {
  80. "config_class": ArizeConfig,
  81. "secret_keys": ["api_key", "space_id"],
  82. "other_keys": ["project", "endpoint"],
  83. "trace_instance": ArizePhoenixDataTrace,
  84. }
  85. case TracingProviderEnum.PHOENIX:
  86. from core.ops.arize_phoenix_trace.arize_phoenix_trace import ArizePhoenixDataTrace
  87. from core.ops.entities.config_entity import PhoenixConfig
  88. return {
  89. "config_class": PhoenixConfig,
  90. "secret_keys": ["api_key"],
  91. "other_keys": ["project", "endpoint"],
  92. "trace_instance": ArizePhoenixDataTrace,
  93. }
  94. case TracingProviderEnum.ALIYUN:
  95. from core.ops.aliyun_trace.aliyun_trace import AliyunDataTrace
  96. from core.ops.entities.config_entity import AliyunConfig
  97. return {
  98. "config_class": AliyunConfig,
  99. "secret_keys": ["license_key"],
  100. "other_keys": ["endpoint", "app_name"],
  101. "trace_instance": AliyunDataTrace,
  102. }
  103. case _:
  104. raise KeyError(f"Unsupported tracing provider: {provider}")
  105. provider_config_map: dict[str, dict[str, Any]] = OpsTraceProviderConfigMap()
  106. class OpsTraceManager:
  107. ops_trace_instances_cache: LRUCache = LRUCache(maxsize=128)
  108. @classmethod
  109. def encrypt_tracing_config(
  110. cls, tenant_id: str, tracing_provider: str, tracing_config: dict, current_trace_config=None
  111. ):
  112. """
  113. Encrypt tracing config.
  114. :param tenant_id: tenant id
  115. :param tracing_provider: tracing provider
  116. :param tracing_config: tracing config dictionary to be encrypted
  117. :param current_trace_config: current tracing configuration for keeping existing values
  118. :return: encrypted tracing configuration
  119. """
  120. # Get the configuration class and the keys that require encryption
  121. config_class, secret_keys, other_keys = (
  122. provider_config_map[tracing_provider]["config_class"],
  123. provider_config_map[tracing_provider]["secret_keys"],
  124. provider_config_map[tracing_provider]["other_keys"],
  125. )
  126. new_config = {}
  127. # Encrypt necessary keys
  128. for key in secret_keys:
  129. if key in tracing_config:
  130. if "*" in tracing_config[key]:
  131. # If the key contains '*', retain the original value from the current config
  132. new_config[key] = current_trace_config.get(key, tracing_config[key])
  133. else:
  134. # Otherwise, encrypt the key
  135. new_config[key] = encrypt_token(tenant_id, tracing_config[key])
  136. for key in other_keys:
  137. new_config[key] = tracing_config.get(key, "")
  138. # Create a new instance of the config class with the new configuration
  139. encrypted_config = config_class(**new_config)
  140. return encrypted_config.model_dump()
  141. @classmethod
  142. def decrypt_tracing_config(cls, tenant_id: str, tracing_provider: str, tracing_config: dict):
  143. """
  144. Decrypt tracing config
  145. :param tenant_id: tenant id
  146. :param tracing_provider: tracing provider
  147. :param tracing_config: tracing config
  148. :return:
  149. """
  150. config_class, secret_keys, other_keys = (
  151. provider_config_map[tracing_provider]["config_class"],
  152. provider_config_map[tracing_provider]["secret_keys"],
  153. provider_config_map[tracing_provider]["other_keys"],
  154. )
  155. new_config = {}
  156. for key in secret_keys:
  157. if key in tracing_config:
  158. new_config[key] = decrypt_token(tenant_id, tracing_config[key])
  159. for key in other_keys:
  160. new_config[key] = tracing_config.get(key, "")
  161. return config_class(**new_config).model_dump()
  162. @classmethod
  163. def obfuscated_decrypt_token(cls, tracing_provider: str, decrypt_tracing_config: dict):
  164. """
  165. Decrypt tracing config
  166. :param tracing_provider: tracing provider
  167. :param decrypt_tracing_config: tracing config
  168. :return:
  169. """
  170. config_class, secret_keys, other_keys = (
  171. provider_config_map[tracing_provider]["config_class"],
  172. provider_config_map[tracing_provider]["secret_keys"],
  173. provider_config_map[tracing_provider]["other_keys"],
  174. )
  175. new_config = {}
  176. for key in secret_keys:
  177. if key in decrypt_tracing_config:
  178. new_config[key] = obfuscated_token(decrypt_tracing_config[key])
  179. for key in other_keys:
  180. new_config[key] = decrypt_tracing_config.get(key, "")
  181. return config_class(**new_config).model_dump()
  182. @classmethod
  183. def get_decrypted_tracing_config(cls, app_id: str, tracing_provider: str):
  184. """
  185. Get decrypted tracing config
  186. :param app_id: app id
  187. :param tracing_provider: tracing provider
  188. :return:
  189. """
  190. trace_config_data: Optional[TraceAppConfig] = (
  191. db.session.query(TraceAppConfig)
  192. .filter(TraceAppConfig.app_id == app_id, TraceAppConfig.tracing_provider == tracing_provider)
  193. .first()
  194. )
  195. if not trace_config_data:
  196. return None
  197. # decrypt_token
  198. app = db.session.query(App).filter(App.id == app_id).first()
  199. if not app:
  200. raise ValueError("App not found")
  201. tenant_id = app.tenant_id
  202. decrypt_tracing_config = cls.decrypt_tracing_config(
  203. tenant_id, tracing_provider, trace_config_data.tracing_config
  204. )
  205. return decrypt_tracing_config
  206. @classmethod
  207. def get_ops_trace_instance(
  208. cls,
  209. app_id: Optional[Union[UUID, str]] = None,
  210. ):
  211. """
  212. Get ops trace through model config
  213. :param app_id: app_id
  214. :return:
  215. """
  216. if isinstance(app_id, UUID):
  217. app_id = str(app_id)
  218. if app_id is None:
  219. return None
  220. app: Optional[App] = db.session.query(App).filter(App.id == app_id).first()
  221. if app is None:
  222. return None
  223. app_ops_trace_config = json.loads(app.tracing) if app.tracing else None
  224. if app_ops_trace_config is None:
  225. return None
  226. if not app_ops_trace_config.get("enabled"):
  227. return None
  228. tracing_provider = app_ops_trace_config.get("tracing_provider")
  229. if tracing_provider is None:
  230. return None
  231. try:
  232. provider_config_map[tracing_provider]
  233. except KeyError:
  234. return None
  235. # decrypt_token
  236. decrypt_trace_config = cls.get_decrypted_tracing_config(app_id, tracing_provider)
  237. if not decrypt_trace_config:
  238. return None
  239. trace_instance, config_class = (
  240. provider_config_map[tracing_provider]["trace_instance"],
  241. provider_config_map[tracing_provider]["config_class"],
  242. )
  243. decrypt_trace_config_key = json.dumps(decrypt_trace_config, sort_keys=True)
  244. tracing_instance = cls.ops_trace_instances_cache.get(decrypt_trace_config_key)
  245. if tracing_instance is None:
  246. # create new tracing_instance and update the cache if it absent
  247. tracing_instance = trace_instance(config_class(**decrypt_trace_config))
  248. cls.ops_trace_instances_cache[decrypt_trace_config_key] = tracing_instance
  249. logging.info(f"new tracing_instance for app_id: {app_id}")
  250. return tracing_instance
  251. @classmethod
  252. def get_app_config_through_message_id(cls, message_id: str):
  253. app_model_config = None
  254. message_data = db.session.query(Message).filter(Message.id == message_id).first()
  255. if not message_data:
  256. return None
  257. conversation_id = message_data.conversation_id
  258. conversation_data = db.session.query(Conversation).filter(Conversation.id == conversation_id).first()
  259. if not conversation_data:
  260. return None
  261. if conversation_data.app_model_config_id:
  262. app_model_config = (
  263. db.session.query(AppModelConfig)
  264. .filter(AppModelConfig.id == conversation_data.app_model_config_id)
  265. .first()
  266. )
  267. elif conversation_data.app_model_config_id is None and conversation_data.override_model_configs:
  268. app_model_config = conversation_data.override_model_configs
  269. return app_model_config
  270. @classmethod
  271. def update_app_tracing_config(cls, app_id: str, enabled: bool, tracing_provider: str):
  272. """
  273. Update app tracing config
  274. :param app_id: app id
  275. :param enabled: enabled
  276. :param tracing_provider: tracing provider
  277. :return:
  278. """
  279. # auth check
  280. if enabled == True:
  281. try:
  282. provider_config_map[tracing_provider]
  283. except KeyError:
  284. raise ValueError(f"Invalid tracing provider: {tracing_provider}")
  285. else:
  286. if tracing_provider is not None:
  287. raise ValueError(f"Invalid tracing provider: {tracing_provider}")
  288. app_config: Optional[App] = db.session.query(App).filter(App.id == app_id).first()
  289. if not app_config:
  290. raise ValueError("App not found")
  291. app_config.tracing = json.dumps(
  292. {
  293. "enabled": enabled,
  294. "tracing_provider": tracing_provider,
  295. }
  296. )
  297. db.session.commit()
  298. @classmethod
  299. def get_app_tracing_config(cls, app_id: str):
  300. """
  301. Get app tracing config
  302. :param app_id: app id
  303. :return:
  304. """
  305. app: Optional[App] = db.session.query(App).filter(App.id == app_id).first()
  306. if not app:
  307. raise ValueError("App not found")
  308. if not app.tracing:
  309. return {"enabled": False, "tracing_provider": None}
  310. app_trace_config = json.loads(app.tracing)
  311. return app_trace_config
  312. @staticmethod
  313. def check_trace_config_is_effective(tracing_config: dict, tracing_provider: str):
  314. """
  315. Check trace config is effective
  316. :param tracing_config: tracing config
  317. :param tracing_provider: tracing provider
  318. :return:
  319. """
  320. config_type, trace_instance = (
  321. provider_config_map[tracing_provider]["config_class"],
  322. provider_config_map[tracing_provider]["trace_instance"],
  323. )
  324. tracing_config = config_type(**tracing_config)
  325. return trace_instance(tracing_config).api_check()
  326. @staticmethod
  327. def get_trace_config_project_key(tracing_config: dict, tracing_provider: str):
  328. """
  329. get trace config is project key
  330. :param tracing_config: tracing config
  331. :param tracing_provider: tracing provider
  332. :return:
  333. """
  334. config_type, trace_instance = (
  335. provider_config_map[tracing_provider]["config_class"],
  336. provider_config_map[tracing_provider]["trace_instance"],
  337. )
  338. tracing_config = config_type(**tracing_config)
  339. return trace_instance(tracing_config).get_project_key()
  340. @staticmethod
  341. def get_trace_config_project_url(tracing_config: dict, tracing_provider: str):
  342. """
  343. get trace config is project key
  344. :param tracing_config: tracing config
  345. :param tracing_provider: tracing provider
  346. :return:
  347. """
  348. config_type, trace_instance = (
  349. provider_config_map[tracing_provider]["config_class"],
  350. provider_config_map[tracing_provider]["trace_instance"],
  351. )
  352. tracing_config = config_type(**tracing_config)
  353. return trace_instance(tracing_config).get_project_url()
  354. class TraceTask:
  355. def __init__(
  356. self,
  357. trace_type: Any,
  358. message_id: Optional[str] = None,
  359. workflow_execution: Optional[WorkflowExecution] = None,
  360. conversation_id: Optional[str] = None,
  361. user_id: Optional[str] = None,
  362. timer: Optional[Any] = None,
  363. **kwargs,
  364. ):
  365. self.trace_type = trace_type
  366. self.message_id = message_id
  367. self.workflow_run_id = workflow_execution.id_ if workflow_execution else None
  368. self.conversation_id = conversation_id
  369. self.user_id = user_id
  370. self.timer = timer
  371. self.file_base_url = os.getenv("FILES_URL", "http://127.0.0.1:5001")
  372. self.app_id = None
  373. self.kwargs = kwargs
  374. def execute(self):
  375. return self.preprocess()
  376. def preprocess(self):
  377. preprocess_map = {
  378. TraceTaskName.CONVERSATION_TRACE: lambda: self.conversation_trace(**self.kwargs),
  379. TraceTaskName.WORKFLOW_TRACE: lambda: self.workflow_trace(
  380. workflow_run_id=self.workflow_run_id, conversation_id=self.conversation_id, user_id=self.user_id
  381. ),
  382. TraceTaskName.MESSAGE_TRACE: lambda: self.message_trace(message_id=self.message_id),
  383. TraceTaskName.MODERATION_TRACE: lambda: self.moderation_trace(
  384. message_id=self.message_id, timer=self.timer, **self.kwargs
  385. ),
  386. TraceTaskName.SUGGESTED_QUESTION_TRACE: lambda: self.suggested_question_trace(
  387. message_id=self.message_id, timer=self.timer, **self.kwargs
  388. ),
  389. TraceTaskName.DATASET_RETRIEVAL_TRACE: lambda: self.dataset_retrieval_trace(
  390. message_id=self.message_id, timer=self.timer, **self.kwargs
  391. ),
  392. TraceTaskName.TOOL_TRACE: lambda: self.tool_trace(
  393. message_id=self.message_id, timer=self.timer, **self.kwargs
  394. ),
  395. TraceTaskName.GENERATE_NAME_TRACE: lambda: self.generate_name_trace(
  396. conversation_id=self.conversation_id, timer=self.timer, **self.kwargs
  397. ),
  398. }
  399. return preprocess_map.get(self.trace_type, lambda: None)()
  400. # process methods for different trace types
  401. def conversation_trace(self, **kwargs):
  402. return kwargs
  403. def workflow_trace(
  404. self,
  405. *,
  406. workflow_run_id: str | None,
  407. conversation_id: str | None,
  408. user_id: str | None,
  409. ):
  410. if not workflow_run_id:
  411. return {}
  412. with Session(db.engine) as session:
  413. workflow_run_stmt = select(WorkflowRun).where(WorkflowRun.id == workflow_run_id)
  414. workflow_run = session.scalars(workflow_run_stmt).first()
  415. if not workflow_run:
  416. raise ValueError("Workflow run not found")
  417. workflow_id = workflow_run.workflow_id
  418. tenant_id = workflow_run.tenant_id
  419. workflow_run_id = workflow_run.id
  420. workflow_run_elapsed_time = workflow_run.elapsed_time
  421. workflow_run_status = workflow_run.status
  422. workflow_run_inputs = workflow_run.inputs_dict
  423. workflow_run_outputs = workflow_run.outputs_dict
  424. workflow_run_version = workflow_run.version
  425. error = workflow_run.error or ""
  426. total_tokens = workflow_run.total_tokens
  427. file_list = workflow_run_inputs.get("sys.file") or []
  428. query = workflow_run_inputs.get("query") or workflow_run_inputs.get("sys.query") or ""
  429. # get workflow_app_log_id
  430. workflow_app_log_data_stmt = select(WorkflowAppLog.id).where(
  431. WorkflowAppLog.tenant_id == tenant_id,
  432. WorkflowAppLog.app_id == workflow_run.app_id,
  433. WorkflowAppLog.workflow_run_id == workflow_run.id,
  434. )
  435. workflow_app_log_id = session.scalar(workflow_app_log_data_stmt)
  436. # get message_id
  437. message_id = None
  438. if conversation_id:
  439. message_data_stmt = select(Message.id).where(
  440. Message.conversation_id == conversation_id,
  441. Message.workflow_run_id == workflow_run_id,
  442. )
  443. message_id = session.scalar(message_data_stmt)
  444. metadata = {
  445. "workflow_id": workflow_id,
  446. "conversation_id": conversation_id,
  447. "workflow_run_id": workflow_run_id,
  448. "tenant_id": tenant_id,
  449. "elapsed_time": workflow_run_elapsed_time,
  450. "status": workflow_run_status,
  451. "version": workflow_run_version,
  452. "total_tokens": total_tokens,
  453. "file_list": file_list,
  454. "triggered_from": workflow_run.triggered_from,
  455. "user_id": user_id,
  456. "app_id": workflow_run.app_id,
  457. }
  458. external_trace_id = self.kwargs.get("external_trace_id")
  459. if external_trace_id:
  460. metadata["external_trace_id"] = external_trace_id
  461. workflow_trace_info = WorkflowTraceInfo(
  462. workflow_data=workflow_run.to_dict(),
  463. conversation_id=conversation_id,
  464. workflow_id=workflow_id,
  465. tenant_id=tenant_id,
  466. workflow_run_id=workflow_run_id,
  467. workflow_run_elapsed_time=workflow_run_elapsed_time,
  468. workflow_run_status=workflow_run_status,
  469. workflow_run_inputs=workflow_run_inputs,
  470. workflow_run_outputs=workflow_run_outputs,
  471. workflow_run_version=workflow_run_version,
  472. error=error,
  473. total_tokens=total_tokens,
  474. file_list=file_list,
  475. query=query,
  476. metadata=metadata,
  477. workflow_app_log_id=workflow_app_log_id,
  478. message_id=message_id,
  479. start_time=workflow_run.created_at,
  480. end_time=workflow_run.finished_at,
  481. )
  482. return workflow_trace_info
  483. def message_trace(self, message_id: str | None):
  484. if not message_id:
  485. return {}
  486. message_data = get_message_data(message_id)
  487. if not message_data:
  488. return {}
  489. conversation_mode_stmt = select(Conversation.mode).where(Conversation.id == message_data.conversation_id)
  490. conversation_mode = db.session.scalars(conversation_mode_stmt).all()
  491. if not conversation_mode or len(conversation_mode) == 0:
  492. return {}
  493. conversation_mode = conversation_mode[0]
  494. created_at = message_data.created_at
  495. inputs = message_data.message
  496. # get message file data
  497. message_file_data = db.session.query(MessageFile).filter_by(message_id=message_id).first()
  498. file_list = []
  499. if message_file_data and message_file_data.url is not None:
  500. file_url = f"{self.file_base_url}/{message_file_data.url}" if message_file_data else ""
  501. file_list.append(file_url)
  502. metadata = {
  503. "conversation_id": message_data.conversation_id,
  504. "ls_provider": message_data.model_provider,
  505. "ls_model_name": message_data.model_id,
  506. "status": message_data.status,
  507. "from_end_user_id": message_data.from_end_user_id,
  508. "from_account_id": message_data.from_account_id,
  509. "agent_based": message_data.agent_based,
  510. "workflow_run_id": message_data.workflow_run_id,
  511. "from_source": message_data.from_source,
  512. "message_id": message_id,
  513. }
  514. message_tokens = message_data.message_tokens
  515. message_trace_info = MessageTraceInfo(
  516. message_id=message_id,
  517. message_data=message_data.to_dict(),
  518. conversation_model=conversation_mode,
  519. message_tokens=message_tokens,
  520. answer_tokens=message_data.answer_tokens,
  521. total_tokens=message_tokens + message_data.answer_tokens,
  522. error=message_data.error or "",
  523. inputs=inputs,
  524. outputs=message_data.answer,
  525. file_list=file_list,
  526. start_time=created_at,
  527. end_time=created_at + timedelta(seconds=message_data.provider_response_latency),
  528. metadata=metadata,
  529. message_file_data=message_file_data,
  530. conversation_mode=conversation_mode,
  531. )
  532. return message_trace_info
  533. def moderation_trace(self, message_id, timer, **kwargs):
  534. moderation_result = kwargs.get("moderation_result")
  535. if not moderation_result:
  536. return {}
  537. inputs = kwargs.get("inputs")
  538. message_data = get_message_data(message_id)
  539. if not message_data:
  540. return {}
  541. metadata = {
  542. "message_id": message_id,
  543. "action": moderation_result.action,
  544. "preset_response": moderation_result.preset_response,
  545. "query": moderation_result.query,
  546. }
  547. # get workflow_app_log_id
  548. workflow_app_log_id = None
  549. if message_data.workflow_run_id:
  550. workflow_app_log_data = (
  551. db.session.query(WorkflowAppLog).filter_by(workflow_run_id=message_data.workflow_run_id).first()
  552. )
  553. workflow_app_log_id = str(workflow_app_log_data.id) if workflow_app_log_data else None
  554. moderation_trace_info = ModerationTraceInfo(
  555. message_id=workflow_app_log_id or message_id,
  556. inputs=inputs,
  557. message_data=message_data.to_dict(),
  558. flagged=moderation_result.flagged,
  559. action=moderation_result.action,
  560. preset_response=moderation_result.preset_response,
  561. query=moderation_result.query,
  562. start_time=timer.get("start"),
  563. end_time=timer.get("end"),
  564. metadata=metadata,
  565. )
  566. return moderation_trace_info
  567. def suggested_question_trace(self, message_id, timer, **kwargs):
  568. suggested_question = kwargs.get("suggested_question", [])
  569. message_data = get_message_data(message_id)
  570. if not message_data:
  571. return {}
  572. metadata = {
  573. "message_id": message_id,
  574. "ls_provider": message_data.model_provider,
  575. "ls_model_name": message_data.model_id,
  576. "status": message_data.status,
  577. "from_end_user_id": message_data.from_end_user_id,
  578. "from_account_id": message_data.from_account_id,
  579. "agent_based": message_data.agent_based,
  580. "workflow_run_id": message_data.workflow_run_id,
  581. "from_source": message_data.from_source,
  582. }
  583. # get workflow_app_log_id
  584. workflow_app_log_id = None
  585. if message_data.workflow_run_id:
  586. workflow_app_log_data = (
  587. db.session.query(WorkflowAppLog).filter_by(workflow_run_id=message_data.workflow_run_id).first()
  588. )
  589. workflow_app_log_id = str(workflow_app_log_data.id) if workflow_app_log_data else None
  590. suggested_question_trace_info = SuggestedQuestionTraceInfo(
  591. message_id=workflow_app_log_id or message_id,
  592. message_data=message_data.to_dict(),
  593. inputs=message_data.message,
  594. outputs=message_data.answer,
  595. start_time=timer.get("start"),
  596. end_time=timer.get("end"),
  597. metadata=metadata,
  598. total_tokens=message_data.message_tokens + message_data.answer_tokens,
  599. status=message_data.status,
  600. error=message_data.error,
  601. from_account_id=message_data.from_account_id,
  602. agent_based=message_data.agent_based,
  603. from_source=message_data.from_source,
  604. model_provider=message_data.model_provider,
  605. model_id=message_data.model_id,
  606. suggested_question=suggested_question,
  607. level=message_data.status,
  608. status_message=message_data.error,
  609. )
  610. return suggested_question_trace_info
  611. def dataset_retrieval_trace(self, message_id, timer, **kwargs):
  612. documents = kwargs.get("documents")
  613. message_data = get_message_data(message_id)
  614. if not message_data:
  615. return {}
  616. metadata = {
  617. "message_id": message_id,
  618. "ls_provider": message_data.model_provider,
  619. "ls_model_name": message_data.model_id,
  620. "status": message_data.status,
  621. "from_end_user_id": message_data.from_end_user_id,
  622. "from_account_id": message_data.from_account_id,
  623. "agent_based": message_data.agent_based,
  624. "workflow_run_id": message_data.workflow_run_id,
  625. "from_source": message_data.from_source,
  626. }
  627. dataset_retrieval_trace_info = DatasetRetrievalTraceInfo(
  628. message_id=message_id,
  629. inputs=message_data.query or message_data.inputs,
  630. documents=[doc.model_dump() for doc in documents] if documents else [],
  631. start_time=timer.get("start"),
  632. end_time=timer.get("end"),
  633. metadata=metadata,
  634. message_data=message_data.to_dict(),
  635. )
  636. return dataset_retrieval_trace_info
  637. def tool_trace(self, message_id, timer, **kwargs):
  638. tool_name = kwargs.get("tool_name", "")
  639. tool_inputs = kwargs.get("tool_inputs", {})
  640. tool_outputs = kwargs.get("tool_outputs", {})
  641. message_data = get_message_data(message_id)
  642. if not message_data:
  643. return {}
  644. tool_config = {}
  645. time_cost = 0
  646. error = None
  647. tool_parameters = {}
  648. created_time = message_data.created_at
  649. end_time = message_data.updated_at
  650. agent_thoughts = message_data.agent_thoughts
  651. for agent_thought in agent_thoughts:
  652. if tool_name in agent_thought.tools:
  653. created_time = agent_thought.created_at
  654. tool_meta_data = agent_thought.tool_meta.get(tool_name, {})
  655. tool_config = tool_meta_data.get("tool_config", {})
  656. time_cost = tool_meta_data.get("time_cost", 0)
  657. end_time = created_time + timedelta(seconds=time_cost)
  658. error = tool_meta_data.get("error", "")
  659. tool_parameters = tool_meta_data.get("tool_parameters", {})
  660. metadata = {
  661. "message_id": message_id,
  662. "tool_name": tool_name,
  663. "tool_inputs": tool_inputs,
  664. "tool_outputs": tool_outputs,
  665. "tool_config": tool_config,
  666. "time_cost": time_cost,
  667. "error": error,
  668. "tool_parameters": tool_parameters,
  669. }
  670. file_url = ""
  671. message_file_data = db.session.query(MessageFile).filter_by(message_id=message_id).first()
  672. if message_file_data:
  673. message_file_id = message_file_data.id if message_file_data else None
  674. type = message_file_data.type
  675. created_by_role = message_file_data.created_by_role
  676. created_user_id = message_file_data.created_by
  677. file_url = f"{self.file_base_url}/{message_file_data.url}"
  678. metadata.update(
  679. {
  680. "message_file_id": message_file_id,
  681. "created_by_role": created_by_role,
  682. "created_user_id": created_user_id,
  683. "type": type,
  684. }
  685. )
  686. tool_trace_info = ToolTraceInfo(
  687. message_id=message_id,
  688. message_data=message_data.to_dict(),
  689. tool_name=tool_name,
  690. start_time=timer.get("start") if timer else created_time,
  691. end_time=timer.get("end") if timer else end_time,
  692. tool_inputs=tool_inputs,
  693. tool_outputs=tool_outputs,
  694. metadata=metadata,
  695. message_file_data=message_file_data,
  696. error=error,
  697. inputs=message_data.message,
  698. outputs=message_data.answer,
  699. tool_config=tool_config,
  700. time_cost=time_cost,
  701. tool_parameters=tool_parameters,
  702. file_url=file_url,
  703. )
  704. return tool_trace_info
  705. def generate_name_trace(self, conversation_id, timer, **kwargs):
  706. generate_conversation_name = kwargs.get("generate_conversation_name")
  707. inputs = kwargs.get("inputs")
  708. tenant_id = kwargs.get("tenant_id")
  709. if not tenant_id:
  710. return {}
  711. start_time = timer.get("start")
  712. end_time = timer.get("end")
  713. metadata = {
  714. "conversation_id": conversation_id,
  715. "tenant_id": tenant_id,
  716. }
  717. generate_name_trace_info = GenerateNameTraceInfo(
  718. conversation_id=conversation_id,
  719. inputs=inputs,
  720. outputs=generate_conversation_name,
  721. start_time=start_time,
  722. end_time=end_time,
  723. metadata=metadata,
  724. tenant_id=tenant_id,
  725. )
  726. return generate_name_trace_info
  727. trace_manager_timer: Optional[threading.Timer] = None
  728. trace_manager_queue: queue.Queue = queue.Queue()
  729. trace_manager_interval = int(os.getenv("TRACE_QUEUE_MANAGER_INTERVAL", 5))
  730. trace_manager_batch_size = int(os.getenv("TRACE_QUEUE_MANAGER_BATCH_SIZE", 100))
  731. class TraceQueueManager:
  732. def __init__(self, app_id=None, user_id=None):
  733. global trace_manager_timer
  734. self.app_id = app_id
  735. self.user_id = user_id
  736. self.trace_instance = OpsTraceManager.get_ops_trace_instance(app_id)
  737. self.flask_app = current_app._get_current_object() # type: ignore
  738. if trace_manager_timer is None:
  739. self.start_timer()
  740. def add_trace_task(self, trace_task: TraceTask):
  741. global trace_manager_timer, trace_manager_queue
  742. try:
  743. if self.trace_instance:
  744. trace_task.app_id = self.app_id
  745. trace_manager_queue.put(trace_task)
  746. except Exception as e:
  747. logging.exception(f"Error adding trace task, trace_type {trace_task.trace_type}")
  748. finally:
  749. self.start_timer()
  750. def collect_tasks(self):
  751. global trace_manager_queue
  752. tasks: list[TraceTask] = []
  753. while len(tasks) < trace_manager_batch_size and not trace_manager_queue.empty():
  754. task = trace_manager_queue.get_nowait()
  755. tasks.append(task)
  756. trace_manager_queue.task_done()
  757. return tasks
  758. def run(self):
  759. try:
  760. tasks = self.collect_tasks()
  761. if tasks:
  762. self.send_to_celery(tasks)
  763. except Exception as e:
  764. logging.exception("Error processing trace tasks")
  765. def start_timer(self):
  766. global trace_manager_timer
  767. if trace_manager_timer is None or not trace_manager_timer.is_alive():
  768. trace_manager_timer = threading.Timer(trace_manager_interval, self.run)
  769. trace_manager_timer.name = f"trace_manager_timer_{time.strftime('%Y-%m-%d %H:%M:%S', time.localtime())}"
  770. trace_manager_timer.daemon = False
  771. trace_manager_timer.start()
  772. def send_to_celery(self, tasks: list[TraceTask]):
  773. with self.flask_app.app_context():
  774. for task in tasks:
  775. if task.app_id is None:
  776. continue
  777. file_id = uuid4().hex
  778. trace_info = task.execute()
  779. task_data = TaskData(
  780. app_id=task.app_id,
  781. trace_info_type=type(trace_info).__name__,
  782. trace_info=trace_info.model_dump() if trace_info else None,
  783. )
  784. file_path = f"{OPS_FILE_PATH}{task.app_id}/{file_id}.json"
  785. storage.save(file_path, task_data.model_dump_json().encode("utf-8"))
  786. file_info = {
  787. "file_id": file_id,
  788. "app_id": task.app_id,
  789. }
  790. process_trace_tasks.delay(file_info)