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

ops_trace_manager.py 35KB

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