langfuse_trace.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  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("prompts", {})
  116. else:
  117. inputs = json.loads(node_execution.inputs) if node_execution.inputs else {}
  118. outputs = (
  119. json.loads(node_execution.outputs) if node_execution.outputs else {}
  120. )
  121. created_at = node_execution.created_at if node_execution.created_at else datetime.now()
  122. elapsed_time = node_execution.elapsed_time
  123. finished_at = created_at + timedelta(seconds=elapsed_time)
  124. metadata = json.loads(node_execution.execution_metadata) if node_execution.execution_metadata else {}
  125. metadata.update(
  126. {
  127. "workflow_run_id": trace_info.workflow_run_id,
  128. "node_execution_id": node_execution_id,
  129. "tenant_id": tenant_id,
  130. "app_id": app_id,
  131. "node_name": node_name,
  132. "node_type": node_type,
  133. "status": status,
  134. }
  135. )
  136. # add span
  137. if trace_info.message_id:
  138. span_data = LangfuseSpan(
  139. name=f"{node_name}_{node_execution_id}",
  140. input=inputs,
  141. output=outputs,
  142. trace_id=trace_id,
  143. start_time=created_at,
  144. end_time=finished_at,
  145. metadata=metadata,
  146. level=LevelEnum.DEFAULT if status == 'succeeded' else LevelEnum.ERROR,
  147. status_message=trace_info.error if trace_info.error else "",
  148. parent_observation_id=trace_info.workflow_app_log_id if trace_info.workflow_app_log_id else trace_info.workflow_run_id,
  149. )
  150. else:
  151. span_data = LangfuseSpan(
  152. name=f"{node_name}_{node_execution_id}",
  153. input=inputs,
  154. output=outputs,
  155. trace_id=trace_id,
  156. start_time=created_at,
  157. end_time=finished_at,
  158. metadata=metadata,
  159. level=LevelEnum.DEFAULT if status == 'succeeded' else LevelEnum.ERROR,
  160. status_message=trace_info.error if trace_info.error else "",
  161. )
  162. self.add_span(langfuse_span_data=span_data)
  163. def message_trace(
  164. self, trace_info: MessageTraceInfo, **kwargs
  165. ):
  166. # get message file data
  167. file_list = trace_info.file_list
  168. metadata = trace_info.metadata
  169. message_data = trace_info.message_data
  170. message_id = message_data.id
  171. user_id = message_data.from_account_id
  172. if message_data.from_end_user_id:
  173. end_user_data: EndUser = db.session.query(EndUser).filter(
  174. EndUser.id == message_data.from_end_user_id
  175. ).first().session_id
  176. user_id = end_user_data.session_id
  177. trace_data = LangfuseTrace(
  178. id=message_id,
  179. user_id=user_id,
  180. name=f"message_{message_id}",
  181. input={
  182. "message": trace_info.inputs,
  183. "files": file_list,
  184. "message_tokens": trace_info.message_tokens,
  185. "answer_tokens": trace_info.answer_tokens,
  186. "total_tokens": trace_info.total_tokens,
  187. "error": trace_info.error,
  188. "provider_response_latency": message_data.provider_response_latency,
  189. "created_at": trace_info.start_time,
  190. },
  191. output=trace_info.outputs,
  192. metadata=metadata,
  193. session_id=message_data.conversation_id,
  194. tags=["message", str(trace_info.conversation_mode)],
  195. version=None,
  196. release=None,
  197. public=None,
  198. )
  199. self.add_trace(langfuse_trace_data=trace_data)
  200. # start add span
  201. generation_usage = GenerationUsage(
  202. totalTokens=trace_info.total_tokens,
  203. input=trace_info.message_tokens,
  204. output=trace_info.answer_tokens,
  205. total=trace_info.total_tokens,
  206. unit=UnitEnum.TOKENS,
  207. )
  208. langfuse_generation_data = LangfuseGeneration(
  209. name=f"generation_{message_id}",
  210. trace_id=message_id,
  211. start_time=trace_info.start_time,
  212. end_time=trace_info.end_time,
  213. model=message_data.model_id,
  214. input=trace_info.inputs,
  215. output=message_data.answer,
  216. metadata=metadata,
  217. level=LevelEnum.DEFAULT if message_data.status != 'error' else LevelEnum.ERROR,
  218. status_message=message_data.error if message_data.error else "",
  219. usage=generation_usage,
  220. )
  221. self.add_generation(langfuse_generation_data)
  222. def moderation_trace(self, trace_info: ModerationTraceInfo):
  223. span_data = LangfuseSpan(
  224. name="moderation",
  225. input=trace_info.inputs,
  226. output={
  227. "action": trace_info.action,
  228. "flagged": trace_info.flagged,
  229. "preset_response": trace_info.preset_response,
  230. "inputs": trace_info.inputs,
  231. },
  232. trace_id=trace_info.message_id,
  233. start_time=trace_info.start_time or trace_info.message_data.created_at,
  234. end_time=trace_info.end_time or trace_info.message_data.created_at,
  235. metadata=trace_info.metadata,
  236. )
  237. self.add_span(langfuse_span_data=span_data)
  238. def suggested_question_trace(self, trace_info: SuggestedQuestionTraceInfo):
  239. message_data = trace_info.message_data
  240. generation_usage = GenerationUsage(
  241. totalTokens=len(str(trace_info.suggested_question)),
  242. input=len(trace_info.inputs),
  243. output=len(trace_info.suggested_question),
  244. total=len(trace_info.suggested_question),
  245. unit=UnitEnum.CHARACTERS,
  246. )
  247. generation_data = LangfuseGeneration(
  248. name="suggested_question",
  249. input=trace_info.inputs,
  250. output=str(trace_info.suggested_question),
  251. trace_id=trace_info.message_id,
  252. start_time=trace_info.start_time,
  253. end_time=trace_info.end_time,
  254. metadata=trace_info.metadata,
  255. level=LevelEnum.DEFAULT if message_data.status != 'error' else LevelEnum.ERROR,
  256. status_message=message_data.error if message_data.error else "",
  257. usage=generation_usage,
  258. )
  259. self.add_generation(langfuse_generation_data=generation_data)
  260. def dataset_retrieval_trace(self, trace_info: DatasetRetrievalTraceInfo):
  261. dataset_retrieval_span_data = LangfuseSpan(
  262. name="dataset_retrieval",
  263. input=trace_info.inputs,
  264. output={"documents": trace_info.documents},
  265. trace_id=trace_info.message_id,
  266. start_time=trace_info.start_time or trace_info.message_data.created_at,
  267. end_time=trace_info.end_time or trace_info.message_data.updated_at,
  268. metadata=trace_info.metadata,
  269. )
  270. self.add_span(langfuse_span_data=dataset_retrieval_span_data)
  271. def tool_trace(self, trace_info: ToolTraceInfo):
  272. tool_span_data = LangfuseSpan(
  273. name=trace_info.tool_name,
  274. input=trace_info.tool_inputs,
  275. output=trace_info.tool_outputs,
  276. trace_id=trace_info.message_id,
  277. start_time=trace_info.start_time,
  278. end_time=trace_info.end_time,
  279. metadata=trace_info.metadata,
  280. level=LevelEnum.DEFAULT if trace_info.error == "" else LevelEnum.ERROR,
  281. status_message=trace_info.error,
  282. )
  283. self.add_span(langfuse_span_data=tool_span_data)
  284. def generate_name_trace(self, trace_info: GenerateNameTraceInfo):
  285. name_generation_trace_data = LangfuseTrace(
  286. name="generate_name",
  287. input=trace_info.inputs,
  288. output=trace_info.outputs,
  289. user_id=trace_info.tenant_id,
  290. metadata=trace_info.metadata,
  291. session_id=trace_info.conversation_id,
  292. )
  293. self.add_trace(langfuse_trace_data=name_generation_trace_data)
  294. name_generation_span_data = LangfuseSpan(
  295. name="generate_name",
  296. input=trace_info.inputs,
  297. output=trace_info.outputs,
  298. trace_id=trace_info.conversation_id,
  299. start_time=trace_info.start_time,
  300. end_time=trace_info.end_time,
  301. metadata=trace_info.metadata,
  302. )
  303. self.add_span(langfuse_span_data=name_generation_span_data)
  304. def add_trace(self, langfuse_trace_data: Optional[LangfuseTrace] = None):
  305. format_trace_data = (
  306. filter_none_values(langfuse_trace_data.model_dump()) if langfuse_trace_data else {}
  307. )
  308. try:
  309. self.langfuse_client.trace(**format_trace_data)
  310. logger.debug("LangFuse Trace created successfully")
  311. except Exception as e:
  312. raise ValueError(f"LangFuse Failed to create trace: {str(e)}")
  313. def add_span(self, langfuse_span_data: Optional[LangfuseSpan] = None):
  314. format_span_data = (
  315. filter_none_values(langfuse_span_data.model_dump()) if langfuse_span_data else {}
  316. )
  317. try:
  318. self.langfuse_client.span(**format_span_data)
  319. logger.debug("LangFuse Span created successfully")
  320. except Exception as e:
  321. raise ValueError(f"LangFuse Failed to create span: {str(e)}")
  322. def update_span(self, span, langfuse_span_data: Optional[LangfuseSpan] = None):
  323. format_span_data = (
  324. filter_none_values(langfuse_span_data.model_dump()) if langfuse_span_data else {}
  325. )
  326. span.end(**format_span_data)
  327. def add_generation(
  328. self, langfuse_generation_data: Optional[LangfuseGeneration] = None
  329. ):
  330. format_generation_data = (
  331. filter_none_values(langfuse_generation_data.model_dump())
  332. if langfuse_generation_data
  333. else {}
  334. )
  335. try:
  336. self.langfuse_client.generation(**format_generation_data)
  337. logger.debug("LangFuse Generation created successfully")
  338. except Exception as e:
  339. raise ValueError(f"LangFuse Failed to create generation: {str(e)}")
  340. def update_generation(
  341. self, generation, langfuse_generation_data: Optional[LangfuseGeneration] = None
  342. ):
  343. format_generation_data = (
  344. filter_none_values(langfuse_generation_data.model_dump())
  345. if langfuse_generation_data
  346. else {}
  347. )
  348. generation.end(**format_generation_data)
  349. def api_check(self):
  350. try:
  351. return self.langfuse_client.auth_check()
  352. except Exception as e:
  353. logger.debug(f"LangFuse API check failed: {str(e)}")
  354. raise ValueError(f"LangFuse API check failed: {str(e)}")