LangSmith 可观测性(Observability)
跟踪(Traces)是应用程序从输入到输出所经历的一系列步骤。这些单独步骤中的每一步都由一个运行(run)表示。你可以使用 LangSmith 来可视化这些执行步骤。要使用它,请为你的应用程序启用跟踪。这使你能够执行以下操作:
前置准备
在开始之前,请确保你具备以下条件:
- LangSmith 账户:在 smith.langchain.com 免费注册或登录。
- LangSmith API 密钥:按照创建 API 密钥指南进行操作。
启用跟踪
要为应用程序启用跟踪,请设置以下环境变量:
bash
export LANGSMITH_TRACING=true
export LANGSMITH_API_KEY=<your-api-key>默认情况下,跟踪将记录到名为 default 的项目中。要配置自定义项目名称,请参阅记录到项目。
有关更多信息,请参阅使用 LangGraph 进行跟踪。
选择性跟踪
你可以使用回调或显式 Tracer 选择性地跟踪应用程序的特定调用或部分:
typescript
import { LangChainTracer } from "@langchain/core/tracers/tracer_langchain";
// 这将被跟踪
const tracer = new LangChainTracer();
await agent.invoke(
{
messages: [{role: "user", content: "Send a test email to alice@example.com"}]
},
{ callbacks: [tracer] }
);
// 这将不会被跟踪(如果未设置 LANGSMITH_TRACING)
await agent.invoke(
{
messages: [{role: "user", content: "Send another email"}]
}
);记录到项目
静态配置
你可以通过设置 LANGSMITH_PROJECT 环境变量为整个应用程序设置自定义项目名称:
bash
export LANGSMITH_PROJECT=my-agent-project动态配置
你可以针对特定操作以编程方式设置项目名称:
typescript
import { LangChainTracer } from "@langchain/core/tracers/tracer_langchain";
const tracer = new LangChainTracer({ projectName: "email-agent-test" });
await agent.invoke(
{
messages: [{role: "user", content: "Send a test email to alice@example.com"}]
},
{ callbacks: [tracer] }
);向跟踪添加元数据
你可以使用自定义元数据和标签对跟踪进行注释:
typescript
import { LangChainTracer } from "@langchain/core/tracers/tracer_langchain";
const tracer = new LangChainTracer({ projectName: "email-agent-test" });
await agent.invoke(
{
messages: [{role: "user", content: "Send a test email to alice@example.com"}]
},
{
tags: ["production", "email-assistant", "v1.0"],
metadata: {
userId: "user123",
sessionId: "session456",
environment: "production"
}
},
);这些自定义元数据和标签将附加到 LangSmith 中的跟踪上。
TIP
要了解有关如何使用跟踪来调试、评估和监控智能体的更多信息,请参阅 LangSmith 文档。
使用脱敏器防止在跟踪中记录敏感数据
你可能希望屏蔽敏感数据以防止其记录到 LangSmith。你可以创建脱敏器(anonymizers),并使用配置将其应用于你的图。此示例将从发送到 LangSmith 的跟踪中删除与社会安全号码格式 XXX-XX-XXXX 匹配的任何内容。
typescript
import { StateGraph } from "@langchain/langgraph";
import { LangChainTracer } from "@langchain/core/tracers/tracer_langchain";
import { StateAnnotation } from "./state.js";
import { createAnonymizer } from "langsmith/anonymizer";
import { Client } from "langsmith";
const anonymizer = createAnonymizer([
// 匹配 SSN
{ pattern: /\b\d{3}-?\d{2}-?\d{4}\b/, replace: "<ssn>" }
]);
const langsmithClient = new Client({ anonymizer });
const tracer = new LangChainTracer({
client: langsmithClient,
});
export const graph = new StateGraph(StateAnnotation)
.compile()
.withConfig({ callbacks: [tracer] });