langfuse.utils.base_callback_handler

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