LangSmith Observability

Traces are a series of steps that your application takes to go from input to output. Each of these individual steps is represented by a run. You can use LangSmith (opens in a new tab) to visualize these execution steps. To use it, enable tracing for your application. This enables you to do the following:

Prerequisites

Before you begin, ensure you have the following:

A LangSmith account: Sign up (for free) or log in at smith.langchain.com (opens in a new tab).
A LangSmith API key: Follow the Create an API key guide.

Enable tracing

To enable tracing for your application, set the following environment variables:

export LANGSMITH_TRACING=true
export LANGSMITH_API_KEY=<your-api-key>

By default, the trace will be logged to the project with the name default. To configure a custom project name, see Log to a project.

For more information, see Trace with LangGraph.

Trace selectively

You may opt to trace specific invocations or parts of your application using LangSmith's tracing_context context manager:

 
# This WILL be traced
with ls.tracing_context(enabled=True):
    agent.invoke({"messages": [{"role": "user", "content": "Send a test email to [email protected]"}]})
 
# This will NOT be traced (if LANGSMITH_TRACING is not set)
agent.invoke({"messages": [{"role": "user", "content": "Send another email"}]})

Log to a project

Statically

You can set a custom project name for your entire application by setting the LANGSMITH_PROJECT environment variable:

export LANGSMITH_PROJECT=my-agent-project

Dynamically

You can set the project name programmatically for specific operations:

 
with ls.tracing_context(project_name="email-agent-test", enabled=True):
    response = agent.invoke({
        "messages": [{"role": "user", "content": "Send a welcome email"}]
    })

Add metadata to traces

You can annotate your traces with custom metadata and tags:

response = agent.invoke(
    {"messages": [{"role": "user", "content": "Send a welcome email"}]},
    config={
        "tags": ["production", "email-assistant", "v1.0"],
        "metadata": {
            "user_id": "user_123",
            "session_id": "session_456",
            "environment": "production"
        }
    }
)

tracing_context also accepts tags and metadata for fine-grained control:

with ls.tracing_context(
    project_name="email-agent-test",
    enabled=True,
    tags=["production", "email-assistant", "v1.0"],
    metadata={"user_id": "user_123", "session_id": "session_456", "environment": "production"}):
    response = agent.invoke(
        {"messages": [{"role": "user", "content": "Send a welcome email"}]}
    )

This custom metadata and tags will be attached to the trace in LangSmith.

To learn more about how to use traces to debug, evaluate, and monitor your agents, see the LangSmith documentation.

Use anonymizers to prevent logging of sensitive data in traces

You may want to mask sensitive data to prevent it from being logged to LangSmith. You can create anonymizers and apply them to your graph using configuration. This example will redact anything matching the Social Security Number format XXX-XX-XXXX from traces sent to LangSmith.

Run a local server overview