Skip to content

Commit

Permalink
[Python] Check if mid-trace (#769)
Browse files Browse the repository at this point in the history
for "tracing is enabled". 

This isn't relevant for `@traceable` only tracing, but comes into play
if you're crossing over to langchain.

Also fix a bug in `trace` context manager where it would be persisting
the run tree inferred by headers beyond its desired lifespan
  • Loading branch information
hinthornw committed Jun 6, 2024
1 parent 679585c commit aa8e174
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 10 deletions.
8 changes: 4 additions & 4 deletions python/langsmith/run_helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,7 @@ def trace(
f"{sorted(kwargs.keys())}.",
DeprecationWarning,
)
old_ctx = get_tracing_context()
outer_tags = _TAGS.get()
outer_metadata = _METADATA.get()
outer_project = _PROJECT_NAME.get() or utils.get_tracer_project()
Expand Down Expand Up @@ -739,6 +740,7 @@ def trace(
new_run.post()
_PARENT_RUN_TREE.set(new_run)
_PROJECT_NAME.set(project_name_)

try:
yield new_run
except (Exception, KeyboardInterrupt, BaseException) as e:
Expand All @@ -751,10 +753,8 @@ def trace(
new_run.patch()
raise e
finally:
_PARENT_RUN_TREE.set(parent_run_)
_PROJECT_NAME.set(outer_project)
_TAGS.set(outer_tags)
_METADATA.set(outer_metadata)
# Reset the old context
_set_tracing_context(old_ctx)
new_run.patch()


Expand Down
10 changes: 9 additions & 1 deletion python/langsmith/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,19 @@ class LangSmithConnectionError(LangSmithError):

def tracing_is_enabled() -> bool:
"""Return True if tracing is enabled."""
from langsmith.run_helpers import get_tracing_context
from langsmith.run_helpers import get_current_run_tree, get_tracing_context

tc = get_tracing_context()
# You can manually override the environment using context vars.
# Check that first.
# Doing this before checking the run tree lets us
# disable a branch within a trace.
if tc["enabled"] is not None:
return tc["enabled"]
# Next check if we're mid-trace
if get_current_run_tree():
return True
# Finally, check the global environment
var_result = get_env_var("TRACING_V2", default=get_env_var("TRACING", default=""))
return var_result == "true"

Expand Down
2 changes: 1 addition & 1 deletion python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "langsmith"
version = "0.1.74"
version = "0.1.75"
description = "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform."
authors = ["LangChain <support@langchain.dev>"]
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion python/tests/unit_tests/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ def test_create_run_mutate() -> None:
trace_id=id_,
dotted_order=run_dict["dotted_order"],
)
for _ in range(7):
for _ in range(10):
time.sleep(0.1) # Give the background thread time to stop
payloads = [
json.loads(call[2]["data"])
Expand Down
39 changes: 36 additions & 3 deletions python/tests/unit_tests/test_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@
from datetime import datetime
from enum import Enum
from typing import Any, NamedTuple, Optional
from unittest.mock import patch
from unittest.mock import MagicMock, patch

import attr
import dataclasses_json
import pytest
from pydantic import BaseModel

import langsmith.utils as ls_utils
from langsmith import Client, traceable
from langsmith.run_helpers import tracing_context


Expand Down Expand Up @@ -87,7 +88,9 @@ def test_correct_get_tracer_project(self):


def test_tracing_enabled():
with patch.dict("os.environ", {"LANGCHAIN_TRACING_V2": "false"}):
with patch.dict(
"os.environ", {"LANGCHAIN_TRACING_V2": "false", "LANGSMITH_TRACING": "false"}
):
assert not ls_utils.tracing_is_enabled()
with tracing_context(enabled=True):
assert ls_utils.tracing_is_enabled()
Expand All @@ -97,9 +100,39 @@ def test_tracing_enabled():
assert not ls_utils.tracing_is_enabled()
assert not ls_utils.tracing_is_enabled()

@traceable
def child_function():
assert ls_utils.tracing_is_enabled()
return 1

@traceable
def untraced_child_function():
assert not ls_utils.tracing_is_enabled()
return 1

@traceable
def parent_function():
with patch.dict(
"os.environ",
{"LANGCHAIN_TRACING_V2": "false", "LANGSMITH_TRACING": "false"},
):
assert ls_utils.tracing_is_enabled()
child_function()
with tracing_context(enabled=False):
assert not ls_utils.tracing_is_enabled()
return untraced_child_function()

with patch.dict(
"os.environ", {"LANGCHAIN_TRACING_V2": "true", "LANGSMITH_TRACING": "true"}
):
mock_client = MagicMock(spec=Client)
parent_function(langsmith_extra={"client": mock_client})


def test_tracing_disabled():
with patch.dict("os.environ", {"LANGCHAIN_TRACING_V2": "true"}):
with patch.dict(
"os.environ", {"LANGCHAIN_TRACING_V2": "true", "LANGSMITH_TRACING": "true"}
):
assert ls_utils.tracing_is_enabled()
with tracing_context(enabled=False):
assert not ls_utils.tracing_is_enabled()
Expand Down

0 comments on commit aa8e174

Please sign in to comment.