langfuse_trace.py 17 KB

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