lmnr 0.4.4__tar.gz → 0.4.5__tar.gz

{lmnr-0.4.4 → lmnr-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lmnr
-Version: 0.4.4
+Version: 0.4.5
 Summary: Python SDK for Laminar AI
 License: Apache-2.0
 Author: lmnr.ai
@@ -89,6 +89,44 @@ def poem_writer(topic="turbulence"):
 print(poem_writer(topic="laminar flow"))
 ```
 
+### Manual instrumentation
+
+Our manual instrumentation is a very thin wrapper around OpenTelemetry's
+`trace.start_span`. Our wrapper sets the span into the active context.
+You don't have to explicitly pass the spans around, it is enough to
+just call `L.start_span`, and OpenTelemetry will handle the context management
+
+```python
+from lmnr import observe, Laminar as L
+L.initialize(project_api_key="<LMNR_PROJECT_API_KEY>")
+
+def poem_writer(topic="turbulence"):
+    
+    span = L.start_span("poem_writer", topic) # start a span
+
+    prompt = f"write a poem about {topic}"
+
+    # OpenAI calls are still automatically instrumented with OpenLLMetry
+    response = client.chat.completions.create(
+        model="gpt-4o",
+        messages=[
+            {"role": "system", "content": "You are a helpful assistant."},
+            {"role": "user", "content": prompt},
+        ],
+    )
+    poem = response.choices[0].message.content
+    # while within the span, you can attach laminar events to it
+    L.event("event_name", "event_value")
+
+    L.set_span_output(span, poem) # set an output
+    
+    # IMPORTANT: don't forget to end all the spans (usually in `finally` blocks)
+    # Otherwise, the trace may not be sent/displayed correctly
+    span.end()
+
+    return poem
+```
+
 
 ## Sending events
 

{lmnr-0.4.4 → lmnr-0.4.5}/README.md

@@ -68,6 +68,44 @@ def poem_writer(topic="turbulence"):
 print(poem_writer(topic="laminar flow"))
 ```
 
+### Manual instrumentation
+
+Our manual instrumentation is a very thin wrapper around OpenTelemetry's
+`trace.start_span`. Our wrapper sets the span into the active context.
+You don't have to explicitly pass the spans around, it is enough to
+just call `L.start_span`, and OpenTelemetry will handle the context management
+
+```python
+from lmnr import observe, Laminar as L
+L.initialize(project_api_key="<LMNR_PROJECT_API_KEY>")
+
+def poem_writer(topic="turbulence"):
+    
+    span = L.start_span("poem_writer", topic) # start a span
+
+    prompt = f"write a poem about {topic}"
+
+    # OpenAI calls are still automatically instrumented with OpenLLMetry
+    response = client.chat.completions.create(
+        model="gpt-4o",
+        messages=[
+            {"role": "system", "content": "You are a helpful assistant."},
+            {"role": "user", "content": prompt},
+        ],
+    )
+    poem = response.choices[0].message.content
+    # while within the span, you can attach laminar events to it
+    L.event("event_name", "event_value")
+
+    L.set_span_output(span, poem) # set an output
+    
+    # IMPORTANT: don't forget to end all the spans (usually in `finally` blocks)
+    # Otherwise, the trace may not be sent/displayed correctly
+    span.end()
+
+    return poem
+```
+
 
 ## Sending events
 

{lmnr-0.4.4 → lmnr-0.4.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lmnr"
-version = "0.4.4"
+version = "0.4.5"
 description = "Python SDK for Laminar AI"
 authors = [
   { name = "lmnr.ai", email = "founders@lmnr.ai" }
@@ -11,7 +11,7 @@ license = "Apache-2.0"
 
 [tool.poetry]
 name = "lmnr"
-version = "0.4.4"
+version = "0.4.5"
 description = "Python SDK for Laminar AI"
 authors = ["lmnr.ai"]
 readme = "README.md"

{lmnr-0.4.4 → lmnr-0.4.5}/src/lmnr/sdk/laminar.py

@@ -11,7 +11,7 @@ from traceloop.sdk import Traceloop
 from traceloop.sdk.tracing import get_tracer
 
 from pydantic.alias_generators import to_snake
-from typing import Any, Optional, Tuple, Union
+from typing import Any, Optional, Union
 
 import copy
 import datetime
@@ -289,7 +289,7 @@ class Laminar:
         cls,
         name: str,
         input: Any = None,
-    ) -> Tuple[Span, object]:
+    ) -> Span:
         """Start a new span with the given name. Useful for manual
         instrumentation.
 
@@ -304,33 +304,34 @@ class Laminar:
                     that must be passed to `end_span` to end the span.
 
         """
-        with get_tracer() as tracer:
-            span = tracer.start_span(name)
-            ctx = set_span_in_context(span)
-            token = context.attach(ctx)
-            span.set_attribute(SpanAttributes.TRACELOOP_ENTITY_NAME, name)
-            if input is not None:
-                span.set_attribute(
-                    SpanAttributes.TRACELOOP_ENTITY_INPUT, json.dumps({"input": input})
-                )
-            return (span, token)
+        tracer = get_tracer().__enter__()
+        span = tracer.start_span(name)
+        # apparently, detaching from this context is not mandatory.
+        # According to traceloop, and the github issue in opentelemetry,
+        # the context is collected by the garbage collector.
+        # https://github.com/open-telemetry/opentelemetry-python/issues/2606#issuecomment-2106320379
+        context.attach(set_span_in_context(span))
+
+        if input is not None:
+            span.set_attribute(
+                SpanAttributes.TRACELOOP_ENTITY_INPUT, json.dumps({"input": input})
+            )
+
+        return span
 
     @classmethod
-    def end_span(cls, span: Span, token: object, output: Any = None):
-        """End the span started with `start_span`
+    def set_span_output(cls, span: Span, output: Any = None):
+        """Set the output of the span. Useful for manual instrumentation.
 
         Args:
-            span (Span): span returned by `start_span`
-            token (object): context token returned by `start_span`
+            span (Span): the span to set the output for
             output (Any, optional): output of the span. Will be sent as an
                 attribute, so must be json serializable. Defaults to None.
         """
         if output is not None:
             span.set_attribute(
-                SpanAttributes.TRACELOOP_ENTITY_OUTPUT, json.dumps({"output": output})
+                SpanAttributes.TRACELOOP_ENTITY_OUTPUT, json.dumps({output})
             )
-        span.end()
-        context.detach(token)
 
     @classmethod
     def set_session(