langfuse_trace.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429
  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. # add span
  153. if trace_info.message_id:
  154. span_data = LangfuseSpan(
  155. id=node_execution_id,
  156. name=node_type,
  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 or "",
  165. parent_observation_id=(trace_info.workflow_app_log_id or trace_info.workflow_run_id),
  166. )
  167. else:
  168. span_data = LangfuseSpan(
  169. id=node_execution_id,
  170. name=node_type,
  171. input=inputs,
  172. output=outputs,
  173. trace_id=trace_id,
  174. start_time=created_at,
  175. end_time=finished_at,
  176. metadata=metadata,
  177. level=(LevelEnum.DEFAULT if status == "succeeded" else LevelEnum.ERROR),
  178. status_message=trace_info.error or "",
  179. )
  180. self.add_span(langfuse_span_data=span_data)
  181. process_data = json.loads(node_execution.process_data) if node_execution.process_data else {}
  182. if process_data and process_data.get("model_mode") == "chat":
  183. total_token = metadata.get("total_tokens", 0)
  184. # add generation
  185. generation_usage = GenerationUsage(
  186. total=total_token,
  187. )
  188. node_generation_data = LangfuseGeneration(
  189. name="llm",
  190. trace_id=trace_id,
  191. model=process_data.get("model_name"),
  192. parent_observation_id=node_execution_id,
  193. start_time=created_at,
  194. end_time=finished_at,
  195. input=inputs,
  196. output=outputs,
  197. metadata=metadata,
  198. level=(LevelEnum.DEFAULT if status == "succeeded" else LevelEnum.ERROR),
  199. status_message=trace_info.error or "",
  200. usage=generation_usage,
  201. )
  202. self.add_generation(langfuse_generation_data=node_generation_data)
  203. def message_trace(self, trace_info: MessageTraceInfo, **kwargs):
  204. # get message file data
  205. file_list = trace_info.file_list
  206. metadata = trace_info.metadata
  207. message_data = trace_info.message_data
  208. message_id = message_data.id
  209. user_id = message_data.from_account_id
  210. if message_data.from_end_user_id:
  211. end_user_data: EndUser = (
  212. db.session.query(EndUser).filter(EndUser.id == message_data.from_end_user_id).first()
  213. )
  214. if end_user_data is not None:
  215. user_id = end_user_data.session_id
  216. metadata["user_id"] = user_id
  217. trace_data = LangfuseTrace(
  218. id=message_id,
  219. user_id=user_id,
  220. name=TraceTaskName.MESSAGE_TRACE.value,
  221. input={
  222. "message": trace_info.inputs,
  223. "files": file_list,
  224. "message_tokens": trace_info.message_tokens,
  225. "answer_tokens": trace_info.answer_tokens,
  226. "total_tokens": trace_info.total_tokens,
  227. "error": trace_info.error,
  228. "provider_response_latency": message_data.provider_response_latency,
  229. "created_at": trace_info.start_time,
  230. },
  231. output=trace_info.outputs,
  232. metadata=metadata,
  233. session_id=message_data.conversation_id,
  234. tags=["message", str(trace_info.conversation_mode)],
  235. version=None,
  236. release=None,
  237. public=None,
  238. )
  239. self.add_trace(langfuse_trace_data=trace_data)
  240. # start add span
  241. generation_usage = GenerationUsage(
  242. input=trace_info.message_tokens,
  243. output=trace_info.answer_tokens,
  244. total=trace_info.total_tokens,
  245. unit=UnitEnum.TOKENS,
  246. totalCost=message_data.total_price,
  247. )
  248. langfuse_generation_data = LangfuseGeneration(
  249. name="llm",
  250. trace_id=message_id,
  251. start_time=trace_info.start_time,
  252. end_time=trace_info.end_time,
  253. model=message_data.model_id,
  254. input=trace_info.inputs,
  255. output=message_data.answer,
  256. metadata=metadata,
  257. level=(LevelEnum.DEFAULT if message_data.status != "error" else LevelEnum.ERROR),
  258. status_message=message_data.error or "",
  259. usage=generation_usage,
  260. )
  261. self.add_generation(langfuse_generation_data)
  262. def moderation_trace(self, trace_info: ModerationTraceInfo):
  263. span_data = LangfuseSpan(
  264. name=TraceTaskName.MODERATION_TRACE.value,
  265. input=trace_info.inputs,
  266. output={
  267. "action": trace_info.action,
  268. "flagged": trace_info.flagged,
  269. "preset_response": trace_info.preset_response,
  270. "inputs": trace_info.inputs,
  271. },
  272. trace_id=trace_info.message_id,
  273. start_time=trace_info.start_time or trace_info.message_data.created_at,
  274. end_time=trace_info.end_time or trace_info.message_data.created_at,
  275. metadata=trace_info.metadata,
  276. )
  277. self.add_span(langfuse_span_data=span_data)
  278. def suggested_question_trace(self, trace_info: SuggestedQuestionTraceInfo):
  279. message_data = trace_info.message_data
  280. generation_usage = GenerationUsage(
  281. total=len(str(trace_info.suggested_question)),
  282. input=len(trace_info.inputs),
  283. output=len(trace_info.suggested_question),
  284. unit=UnitEnum.CHARACTERS,
  285. )
  286. generation_data = LangfuseGeneration(
  287. name=TraceTaskName.SUGGESTED_QUESTION_TRACE.value,
  288. input=trace_info.inputs,
  289. output=str(trace_info.suggested_question),
  290. trace_id=trace_info.message_id,
  291. start_time=trace_info.start_time,
  292. end_time=trace_info.end_time,
  293. metadata=trace_info.metadata,
  294. level=(LevelEnum.DEFAULT if message_data.status != "error" else LevelEnum.ERROR),
  295. status_message=message_data.error or "",
  296. usage=generation_usage,
  297. )
  298. self.add_generation(langfuse_generation_data=generation_data)
  299. def dataset_retrieval_trace(self, trace_info: DatasetRetrievalTraceInfo):
  300. dataset_retrieval_span_data = LangfuseSpan(
  301. name=TraceTaskName.DATASET_RETRIEVAL_TRACE.value,
  302. input=trace_info.inputs,
  303. output={"documents": trace_info.documents},
  304. trace_id=trace_info.message_id,
  305. start_time=trace_info.start_time or trace_info.message_data.created_at,
  306. end_time=trace_info.end_time or trace_info.message_data.updated_at,
  307. metadata=trace_info.metadata,
  308. )
  309. self.add_span(langfuse_span_data=dataset_retrieval_span_data)
  310. def tool_trace(self, trace_info: ToolTraceInfo):
  311. tool_span_data = LangfuseSpan(
  312. name=trace_info.tool_name,
  313. input=trace_info.tool_inputs,
  314. output=trace_info.tool_outputs,
  315. trace_id=trace_info.message_id,
  316. start_time=trace_info.start_time,
  317. end_time=trace_info.end_time,
  318. metadata=trace_info.metadata,
  319. level=(LevelEnum.DEFAULT if trace_info.error == "" or trace_info.error is None else LevelEnum.ERROR),
  320. status_message=trace_info.error,
  321. )
  322. self.add_span(langfuse_span_data=tool_span_data)
  323. def generate_name_trace(self, trace_info: GenerateNameTraceInfo):
  324. name_generation_trace_data = LangfuseTrace(
  325. name=TraceTaskName.GENERATE_NAME_TRACE.value,
  326. input=trace_info.inputs,
  327. output=trace_info.outputs,
  328. user_id=trace_info.tenant_id,
  329. metadata=trace_info.metadata,
  330. session_id=trace_info.conversation_id,
  331. )
  332. self.add_trace(langfuse_trace_data=name_generation_trace_data)
  333. name_generation_span_data = LangfuseSpan(
  334. name=TraceTaskName.GENERATE_NAME_TRACE.value,
  335. input=trace_info.inputs,
  336. output=trace_info.outputs,
  337. trace_id=trace_info.conversation_id,
  338. start_time=trace_info.start_time,
  339. end_time=trace_info.end_time,
  340. metadata=trace_info.metadata,
  341. )
  342. self.add_span(langfuse_span_data=name_generation_span_data)
  343. def add_trace(self, langfuse_trace_data: Optional[LangfuseTrace] = None):
  344. format_trace_data = filter_none_values(langfuse_trace_data.model_dump()) if langfuse_trace_data else {}
  345. try:
  346. self.langfuse_client.trace(**format_trace_data)
  347. logger.debug("LangFuse Trace created successfully")
  348. except Exception as e:
  349. raise ValueError(f"LangFuse Failed to create trace: {str(e)}")
  350. def add_span(self, langfuse_span_data: Optional[LangfuseSpan] = None):
  351. format_span_data = filter_none_values(langfuse_span_data.model_dump()) if langfuse_span_data else {}
  352. try:
  353. self.langfuse_client.span(**format_span_data)
  354. logger.debug("LangFuse Span created successfully")
  355. except Exception as e:
  356. raise ValueError(f"LangFuse Failed to create span: {str(e)}")
  357. def update_span(self, span, langfuse_span_data: Optional[LangfuseSpan] = None):
  358. format_span_data = filter_none_values(langfuse_span_data.model_dump()) if langfuse_span_data else {}
  359. span.end(**format_span_data)
  360. def add_generation(self, langfuse_generation_data: Optional[LangfuseGeneration] = None):
  361. format_generation_data = (
  362. filter_none_values(langfuse_generation_data.model_dump()) if langfuse_generation_data else {}
  363. )
  364. try:
  365. self.langfuse_client.generation(**format_generation_data)
  366. logger.debug("LangFuse Generation created successfully")
  367. except Exception as e:
  368. raise ValueError(f"LangFuse Failed to create generation: {str(e)}")
  369. def update_generation(self, generation, 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. generation.end(**format_generation_data)
  374. def api_check(self):
  375. try:
  376. return self.langfuse_client.auth_check()
  377. except Exception as e:
  378. logger.debug(f"LangFuse API check failed: {str(e)}")
  379. raise ValueError(f"LangFuse API check failed: {str(e)}")
  380. def get_project_key(self):
  381. try:
  382. projects = self.langfuse_client.client.projects.get()
  383. return projects.data[0].id
  384. except Exception as e:
  385. logger.debug(f"LangFuse get project key failed: {str(e)}")
  386. raise ValueError(f"LangFuse get project key failed: {str(e)}")