langfuse_trace.py 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  1. import json
  2. import logging
  3. import os
  4. from datetime import datetime, timedelta
  5. from typing import Optional
  6. from langfuse import Langfuse
  7. from core.ops.base_trace_instance import BaseTraceInstance
  8. from core.ops.entities.config_entity import LangfuseConfig
  9. from core.ops.entities.trace_entity import (
  10. BaseTraceInfo,
  11. DatasetRetrievalTraceInfo,
  12. GenerateNameTraceInfo,
  13. MessageTraceInfo,
  14. ModerationTraceInfo,
  15. SuggestedQuestionTraceInfo,
  16. ToolTraceInfo,
  17. TraceTaskName,
  18. WorkflowTraceInfo,
  19. )
  20. from core.ops.langfuse_trace.entities.langfuse_trace_entity import (
  21. GenerationUsage,
  22. LangfuseGeneration,
  23. LangfuseSpan,
  24. LangfuseTrace,
  25. LevelEnum,
  26. UnitEnum,
  27. )
  28. from core.ops.utils import filter_none_values
  29. from extensions.ext_database import db
  30. from models.model import EndUser
  31. from models.workflow import WorkflowNodeExecution
  32. logger = logging.getLogger(__name__)
  33. class LangFuseDataTrace(BaseTraceInstance):
  34. def __init__(
  35. self,
  36. langfuse_config: LangfuseConfig,
  37. ):
  38. super().__init__(langfuse_config)
  39. self.langfuse_client = Langfuse(
  40. public_key=langfuse_config.public_key,
  41. secret_key=langfuse_config.secret_key,
  42. host=langfuse_config.host,
  43. )
  44. self.file_base_url = os.getenv("FILES_URL", "http://127.0.0.1:5001")
  45. def trace(self, trace_info: BaseTraceInfo):
  46. if isinstance(trace_info, WorkflowTraceInfo):
  47. self.workflow_trace(trace_info)
  48. if isinstance(trace_info, MessageTraceInfo):
  49. self.message_trace(trace_info)
  50. if isinstance(trace_info, ModerationTraceInfo):
  51. self.moderation_trace(trace_info)
  52. if isinstance(trace_info, SuggestedQuestionTraceInfo):
  53. self.suggested_question_trace(trace_info)
  54. if isinstance(trace_info, DatasetRetrievalTraceInfo):
  55. self.dataset_retrieval_trace(trace_info)
  56. if isinstance(trace_info, ToolTraceInfo):
  57. self.tool_trace(trace_info)
  58. if isinstance(trace_info, GenerateNameTraceInfo):
  59. self.generate_name_trace(trace_info)
  60. def workflow_trace(self, trace_info: WorkflowTraceInfo):
  61. trace_id = trace_info.workflow_app_log_id or trace_info.workflow_run_id
  62. user_id = trace_info.metadata.get("user_id")
  63. if trace_info.message_id:
  64. trace_id = trace_info.message_id
  65. name = TraceTaskName.MESSAGE_TRACE.value
  66. trace_data = LangfuseTrace(
  67. id=trace_id,
  68. user_id=user_id,
  69. name=name,
  70. input=trace_info.workflow_run_inputs,
  71. output=trace_info.workflow_run_outputs,
  72. metadata=trace_info.metadata,
  73. session_id=trace_info.conversation_id,
  74. tags=["message", "workflow"],
  75. created_at=trace_info.start_time,
  76. updated_at=trace_info.end_time,
  77. )
  78. self.add_trace(langfuse_trace_data=trace_data)
  79. workflow_span_data = LangfuseSpan(
  80. id=(trace_info.workflow_app_log_id or trace_info.workflow_run_id),
  81. name=TraceTaskName.WORKFLOW_TRACE.value,
  82. input=trace_info.workflow_run_inputs,
  83. output=trace_info.workflow_run_outputs,
  84. trace_id=trace_id,
  85. start_time=trace_info.start_time,
  86. end_time=trace_info.end_time,
  87. metadata=trace_info.metadata,
  88. level=LevelEnum.DEFAULT if trace_info.error == "" else LevelEnum.ERROR,
  89. status_message=trace_info.error or "",
  90. )
  91. self.add_span(langfuse_span_data=workflow_span_data)
  92. else:
  93. trace_data = LangfuseTrace(
  94. id=trace_id,
  95. user_id=user_id,
  96. name=TraceTaskName.WORKFLOW_TRACE.value,
  97. input=trace_info.workflow_run_inputs,
  98. output=trace_info.workflow_run_outputs,
  99. metadata=trace_info.metadata,
  100. session_id=trace_info.conversation_id,
  101. tags=["workflow"],
  102. )
  103. self.add_trace(langfuse_trace_data=trace_data)
  104. # through workflow_run_id get all_nodes_execution
  105. workflow_nodes_executions = (
  106. db.session.query(
  107. WorkflowNodeExecution.id,
  108. WorkflowNodeExecution.tenant_id,
  109. WorkflowNodeExecution.app_id,
  110. WorkflowNodeExecution.title,
  111. WorkflowNodeExecution.node_type,
  112. WorkflowNodeExecution.status,
  113. WorkflowNodeExecution.inputs,
  114. WorkflowNodeExecution.outputs,
  115. WorkflowNodeExecution.created_at,
  116. WorkflowNodeExecution.elapsed_time,
  117. WorkflowNodeExecution.process_data,
  118. WorkflowNodeExecution.execution_metadata,
  119. )
  120. .filter(WorkflowNodeExecution.workflow_run_id == trace_info.workflow_run_id)
  121. .all()
  122. )
  123. for node_execution in workflow_nodes_executions:
  124. node_execution_id = node_execution.id
  125. tenant_id = node_execution.tenant_id
  126. app_id = node_execution.app_id
  127. node_name = node_execution.title
  128. node_type = node_execution.node_type
  129. status = node_execution.status
  130. if node_type == "llm":
  131. inputs = (
  132. json.loads(node_execution.process_data).get("prompts", {}) if node_execution.process_data else {}
  133. )
  134. else:
  135. inputs = json.loads(node_execution.inputs) if node_execution.inputs else {}
  136. outputs = json.loads(node_execution.outputs) if node_execution.outputs else {}
  137. created_at = node_execution.created_at or datetime.now()
  138. elapsed_time = node_execution.elapsed_time
  139. finished_at = created_at + timedelta(seconds=elapsed_time)
  140. metadata = json.loads(node_execution.execution_metadata) if node_execution.execution_metadata else {}
  141. metadata.update(
  142. {
  143. "workflow_run_id": trace_info.workflow_run_id,
  144. "node_execution_id": node_execution_id,
  145. "tenant_id": tenant_id,
  146. "app_id": app_id,
  147. "node_name": node_name,
  148. "node_type": node_type,
  149. "status": status,
  150. }
  151. )
  152. process_data = json.loads(node_execution.process_data) if node_execution.process_data else {}
  153. model_provider = process_data.get("model_provider", None)
  154. model_name = process_data.get("model_name", None)
  155. if model_provider is not None and model_name is not None:
  156. metadata.update(
  157. {
  158. "model_provider": model_provider,
  159. "model_name": model_name,
  160. }
  161. )
  162. # add span
  163. if trace_info.message_id:
  164. span_data = LangfuseSpan(
  165. id=node_execution_id,
  166. name=node_type,
  167. input=inputs,
  168. output=outputs,
  169. trace_id=trace_id,
  170. start_time=created_at,
  171. end_time=finished_at,
  172. metadata=metadata,
  173. level=(LevelEnum.DEFAULT if status == "succeeded" else LevelEnum.ERROR),
  174. status_message=trace_info.error or "",
  175. parent_observation_id=(trace_info.workflow_app_log_id or trace_info.workflow_run_id),
  176. )
  177. else:
  178. span_data = LangfuseSpan(
  179. id=node_execution_id,
  180. name=node_type,
  181. input=inputs,
  182. output=outputs,
  183. trace_id=trace_id,
  184. start_time=created_at,
  185. end_time=finished_at,
  186. metadata=metadata,
  187. level=(LevelEnum.DEFAULT if status == "succeeded" else LevelEnum.ERROR),
  188. status_message=trace_info.error or "",
  189. )
  190. self.add_span(langfuse_span_data=span_data)
  191. if process_data and process_data.get("model_mode") == "chat":
  192. total_token = metadata.get("total_tokens", 0)
  193. # add generation
  194. generation_usage = GenerationUsage(
  195. total=total_token,
  196. )
  197. node_generation_data = LangfuseGeneration(
  198. name="llm",
  199. trace_id=trace_id,
  200. model=process_data.get("model_name"),
  201. parent_observation_id=node_execution_id,
  202. start_time=created_at,
  203. end_time=finished_at,
  204. input=inputs,
  205. output=outputs,
  206. metadata=metadata,
  207. level=(LevelEnum.DEFAULT if status == "succeeded" else LevelEnum.ERROR),
  208. status_message=trace_info.error or "",
  209. usage=generation_usage,
  210. )
  211. self.add_generation(langfuse_generation_data=node_generation_data)
  212. def message_trace(self, trace_info: MessageTraceInfo, **kwargs):
  213. # get message file data
  214. file_list = trace_info.file_list
  215. metadata = trace_info.metadata
  216. message_data = trace_info.message_data
  217. message_id = message_data.id
  218. user_id = message_data.from_account_id
  219. if message_data.from_end_user_id:
  220. end_user_data: EndUser = (
  221. db.session.query(EndUser).filter(EndUser.id == message_data.from_end_user_id).first()
  222. )
  223. if end_user_data is not None:
  224. user_id = end_user_data.session_id
  225. metadata["user_id"] = user_id
  226. trace_data = LangfuseTrace(
  227. id=message_id,
  228. user_id=user_id,
  229. name=TraceTaskName.MESSAGE_TRACE.value,
  230. input={
  231. "message": trace_info.inputs,
  232. "files": file_list,
  233. "message_tokens": trace_info.message_tokens,
  234. "answer_tokens": trace_info.answer_tokens,
  235. "total_tokens": trace_info.total_tokens,
  236. "error": trace_info.error,
  237. "provider_response_latency": message_data.provider_response_latency,
  238. "created_at": trace_info.start_time,
  239. },
  240. output=trace_info.outputs,
  241. metadata=metadata,
  242. session_id=message_data.conversation_id,
  243. tags=["message", str(trace_info.conversation_mode)],
  244. version=None,
  245. release=None,
  246. public=None,
  247. )
  248. self.add_trace(langfuse_trace_data=trace_data)
  249. # start add span
  250. generation_usage = GenerationUsage(
  251. input=trace_info.message_tokens,
  252. output=trace_info.answer_tokens,
  253. total=trace_info.total_tokens,
  254. unit=UnitEnum.TOKENS,
  255. totalCost=message_data.total_price,
  256. )
  257. langfuse_generation_data = LangfuseGeneration(
  258. name="llm",
  259. trace_id=message_id,
  260. start_time=trace_info.start_time,
  261. end_time=trace_info.end_time,
  262. model=message_data.model_id,
  263. input=trace_info.inputs,
  264. output=message_data.answer,
  265. metadata=metadata,
  266. level=(LevelEnum.DEFAULT if message_data.status != "error" else LevelEnum.ERROR),
  267. status_message=message_data.error or "",
  268. usage=generation_usage,
  269. )
  270. self.add_generation(langfuse_generation_data)
  271. def moderation_trace(self, trace_info: ModerationTraceInfo):
  272. span_data = LangfuseSpan(
  273. name=TraceTaskName.MODERATION_TRACE.value,
  274. input=trace_info.inputs,
  275. output={
  276. "action": trace_info.action,
  277. "flagged": trace_info.flagged,
  278. "preset_response": trace_info.preset_response,
  279. "inputs": trace_info.inputs,
  280. },
  281. trace_id=trace_info.message_id,
  282. start_time=trace_info.start_time or trace_info.message_data.created_at,
  283. end_time=trace_info.end_time or trace_info.message_data.created_at,
  284. metadata=trace_info.metadata,
  285. )
  286. self.add_span(langfuse_span_data=span_data)
  287. def suggested_question_trace(self, trace_info: SuggestedQuestionTraceInfo):
  288. message_data = trace_info.message_data
  289. generation_usage = GenerationUsage(
  290. total=len(str(trace_info.suggested_question)),
  291. input=len(trace_info.inputs),
  292. output=len(trace_info.suggested_question),
  293. unit=UnitEnum.CHARACTERS,
  294. )
  295. generation_data = LangfuseGeneration(
  296. name=TraceTaskName.SUGGESTED_QUESTION_TRACE.value,
  297. input=trace_info.inputs,
  298. output=str(trace_info.suggested_question),
  299. trace_id=trace_info.message_id,
  300. start_time=trace_info.start_time,
  301. end_time=trace_info.end_time,
  302. metadata=trace_info.metadata,
  303. level=(LevelEnum.DEFAULT if message_data.status != "error" else LevelEnum.ERROR),
  304. status_message=message_data.error or "",
  305. usage=generation_usage,
  306. )
  307. self.add_generation(langfuse_generation_data=generation_data)
  308. def dataset_retrieval_trace(self, trace_info: DatasetRetrievalTraceInfo):
  309. dataset_retrieval_span_data = LangfuseSpan(
  310. name=TraceTaskName.DATASET_RETRIEVAL_TRACE.value,
  311. input=trace_info.inputs,
  312. output={"documents": trace_info.documents},
  313. trace_id=trace_info.message_id,
  314. start_time=trace_info.start_time or trace_info.message_data.created_at,
  315. end_time=trace_info.end_time or trace_info.message_data.updated_at,
  316. metadata=trace_info.metadata,
  317. )
  318. self.add_span(langfuse_span_data=dataset_retrieval_span_data)
  319. def tool_trace(self, trace_info: ToolTraceInfo):
  320. tool_span_data = LangfuseSpan(
  321. name=trace_info.tool_name,
  322. input=trace_info.tool_inputs,
  323. output=trace_info.tool_outputs,
  324. trace_id=trace_info.message_id,
  325. start_time=trace_info.start_time,
  326. end_time=trace_info.end_time,
  327. metadata=trace_info.metadata,
  328. level=(LevelEnum.DEFAULT if trace_info.error == "" or trace_info.error is None else LevelEnum.ERROR),
  329. status_message=trace_info.error,
  330. )
  331. self.add_span(langfuse_span_data=tool_span_data)
  332. def generate_name_trace(self, trace_info: GenerateNameTraceInfo):
  333. name_generation_trace_data = LangfuseTrace(
  334. name=TraceTaskName.GENERATE_NAME_TRACE.value,
  335. input=trace_info.inputs,
  336. output=trace_info.outputs,
  337. user_id=trace_info.tenant_id,
  338. metadata=trace_info.metadata,
  339. session_id=trace_info.conversation_id,
  340. )
  341. self.add_trace(langfuse_trace_data=name_generation_trace_data)
  342. name_generation_span_data = LangfuseSpan(
  343. name=TraceTaskName.GENERATE_NAME_TRACE.value,
  344. input=trace_info.inputs,
  345. output=trace_info.outputs,
  346. trace_id=trace_info.conversation_id,
  347. start_time=trace_info.start_time,
  348. end_time=trace_info.end_time,
  349. metadata=trace_info.metadata,
  350. )
  351. self.add_span(langfuse_span_data=name_generation_span_data)
  352. def add_trace(self, langfuse_trace_data: Optional[LangfuseTrace] = None):
  353. format_trace_data = filter_none_values(langfuse_trace_data.model_dump()) if langfuse_trace_data else {}
  354. try:
  355. self.langfuse_client.trace(**format_trace_data)
  356. logger.debug("LangFuse Trace created successfully")
  357. except Exception as e:
  358. raise ValueError(f"LangFuse Failed to create trace: {str(e)}")
  359. def add_span(self, langfuse_span_data: Optional[LangfuseSpan] = None):
  360. format_span_data = filter_none_values(langfuse_span_data.model_dump()) if langfuse_span_data else {}
  361. try:
  362. self.langfuse_client.span(**format_span_data)
  363. logger.debug("LangFuse Span created successfully")
  364. except Exception as e:
  365. raise ValueError(f"LangFuse Failed to create span: {str(e)}")
  366. def update_span(self, span, langfuse_span_data: Optional[LangfuseSpan] = None):
  367. format_span_data = filter_none_values(langfuse_span_data.model_dump()) if langfuse_span_data else {}
  368. span.end(**format_span_data)
  369. def add_generation(self, langfuse_generation_data: Optional[LangfuseGeneration] = None):
  370. format_generation_data = (
  371. filter_none_values(langfuse_generation_data.model_dump()) if langfuse_generation_data else {}
  372. )
  373. try:
  374. self.langfuse_client.generation(**format_generation_data)
  375. logger.debug("LangFuse Generation created successfully")
  376. except Exception as e:
  377. raise ValueError(f"LangFuse Failed to create generation: {str(e)}")
  378. def update_generation(self, generation, langfuse_generation_data: Optional[LangfuseGeneration] = None):
  379. format_generation_data = (
  380. filter_none_values(langfuse_generation_data.model_dump()) if langfuse_generation_data else {}
  381. )
  382. generation.end(**format_generation_data)
  383. def api_check(self):
  384. try:
  385. return self.langfuse_client.auth_check()
  386. except Exception as e:
  387. logger.debug(f"LangFuse API check failed: {str(e)}")
  388. raise ValueError(f"LangFuse API check failed: {str(e)}")
  389. def get_project_key(self):
  390. try:
  391. projects = self.langfuse_client.client.projects.get()
  392. return projects.data[0].id
  393. except Exception as e:
  394. logger.debug(f"LangFuse get project key failed: {str(e)}")
  395. raise ValueError(f"LangFuse get project key failed: {str(e)}")