langfuse.utils.base_callback_handler

  1from typing import Optional, Union, List, Any
  2import httpx
  3import logging
  4import os
  5import warnings
  6
  7from langfuse.client import Langfuse, StatefulTraceClient, StatefulSpanClient, StateType
  8
  9
 10class LangfuseBaseCallbackHandler:
 11    log = logging.getLogger("langfuse")
 12
 13    def __init__(
 14        self,
 15        *,
 16        public_key: Optional[str] = None,
 17        secret_key: Optional[str] = None,
 18        host: Optional[str] = None,
 19        debug: bool = False,
 20        stateful_client: Optional[
 21            Union[StatefulTraceClient, StatefulSpanClient]
 22        ] = None,
 23        update_stateful_client: bool = False,
 24        version: Optional[str] = None,
 25        session_id: Optional[str] = None,
 26        user_id: Optional[str] = None,
 27        trace_name: Optional[str] = None,
 28        release: Optional[str] = None,
 29        metadata: Optional[Any] = None,
 30        tags: Optional[List[str]] = None,
 31        threads: Optional[int] = None,
 32        flush_at: Optional[int] = None,
 33        flush_interval: Optional[int] = None,
 34        max_retries: Optional[int] = None,
 35        timeout: Optional[int] = None,
 36        enabled: Optional[bool] = None,
 37        httpx_client: Optional[httpx.Client] = None,
 38        sdk_integration: str,
 39        sample_rate: Optional[float] = None,
 40    ) -> None:
 41        self.version = version
 42        self.session_id = session_id
 43        self.user_id = user_id
 44        self.trace_name = trace_name
 45        self.release = release
 46        self.metadata = metadata
 47        self.tags = tags
 48
 49        self.root_span = None
 50        self.update_stateful_client = update_stateful_client
 51        self.langfuse = None
 52
 53        prio_public_key = public_key or os.environ.get("LANGFUSE_PUBLIC_KEY")
 54        prio_secret_key = secret_key or os.environ.get("LANGFUSE_SECRET_KEY")
 55        prio_host = host or os.environ.get(
 56            "LANGFUSE_HOST", "https://cloud.langfuse.com"
 57        )
 58
 59        prio_sample_rate = (
 60            sample_rate
 61            if sample_rate is not None
 62            else float(os.environ.get("LANGFUSE_SAMPLE_RATE", 1.0))
 63        )
 64
 65        if stateful_client and isinstance(stateful_client, StatefulTraceClient):
 66            self.trace = stateful_client
 67            self._task_manager = stateful_client.task_manager
 68
 69            return
 70
 71        elif stateful_client and isinstance(stateful_client, StatefulSpanClient):
 72            self.root_span = stateful_client
 73            self.trace = StatefulTraceClient(
 74                stateful_client.client,
 75                stateful_client.trace_id,
 76                StateType.TRACE,
 77                stateful_client.trace_id,
 78                stateful_client.task_manager,
 79            )
 80            self._task_manager = stateful_client.task_manager
 81
 82            return
 83
 84        args = {
 85            "public_key": prio_public_key,
 86            "secret_key": prio_secret_key,
 87            "host": prio_host,
 88            "debug": debug,
 89        }
 90
 91        if release is not None:
 92            args["release"] = release
 93        if threads is not None:
 94            args["threads"] = threads
 95        if flush_at is not None:
 96            args["flush_at"] = flush_at
 97        if flush_interval is not None:
 98            args["flush_interval"] = flush_interval
 99        if max_retries is not None:
100            args["max_retries"] = max_retries
101        if timeout is not None:
102            args["timeout"] = timeout
103        if enabled is not None:
104            args["enabled"] = enabled
105        if httpx_client is not None:
106            args["httpx_client"] = httpx_client
107        if prio_sample_rate is not None:
108            args["sample_rate"] = prio_sample_rate
109
110        args["sdk_integration"] = sdk_integration
111
112        self.langfuse = Langfuse(**args)
113        self.trace: Optional[StatefulTraceClient] = None
114        self._task_manager = self.langfuse.task_manager
115
116    def get_trace_id(self):
117        """This method is deprecated and will be removed in a future version as it is not concurrency-safe.
118        Please refer to the [documentation](https://langfuse.com/docs/integrations/langchain/get-started#interoperability) on how to use interop with the Langfuse SDK to get the id of a trace.
119
120        Returns:
121            The ID of the current/last trace or None if no trace is available.
122        """
123        warnings.warn(
124            "get_trace_id is deprecated, create a trace for this handler instead. See interop documentation of this integration for more information.",
125            DeprecationWarning,
126        )
127        return self.trace.id if self.trace else None
128
129    def get_trace_url(self):
130        """This method is deprecated and will be removed in a future version as it is not concurrency-safe.
131        Please refer to the [documentation](https://langfuse.com/docs/tracing/url) for more information.
132
133        Returns:
134            The URL of the current/last trace or None if no trace is available.
135        """
136        warnings.warn(
137            "get_trace_url is deprecated, create a trace for this handler instead. See interop documentation of this integration for more information.",
138            DeprecationWarning,
139        )
140        return self.trace.get_trace_url() if self.trace else None
141
142    def flush(self):
143        if self.trace is not None:
144            self.trace.task_manager.flush()
145        elif self.root_span is not None:
146            self.root_span.task_manager.flush()
147        else:
148            self.log.debug("There was no trace yet, hence no flushing possible.")
149
150    def auth_check(self):
151        if self.langfuse is not None:
152            return self.langfuse.auth_check()
153        elif self.trace is not None:
154            projects = self.trace.client.projects.get()
155            if len(projects.data) == 0:
156                raise Exception("No projects found for the keys.")
157            return True
158        elif self.root_span is not None:
159            projects = self.root_span.client.projects.get()
160            if len(projects) == 0:
161                raise Exception("No projects found for the keys.")
162            return True
163
164        return False