Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Tracing & Callbacks

LangChainRust provides a callback system for observability, tracing, and monitoring with handlers for console, file, LangSmith, and OpenTelemetry.

Callback System

ComponentDescription
CallbackHandlerTrait with lifecycle hooks (LLM, chain, tool, retriever)
CallbackManagerManages multiple handlers, dispatches events
RunTreeStructured run tracking with parent-child relationships
RunTypeLlm, Chain, Tool, Retriever, Embedding, Prompt, Parser

Callback Handlers

HandlerStructOutput
ConsoleStdOutHandlerPrints to stdout
FileFileCallbackHandlerWrites to file (Plain/JSON/JSONLines)
LangSmithLangSmithHandlerSends to LangSmith platform
OpenTelemetryOtelHandlerEmits OTel spans with GenAI SemConv

Setup

#![allow(unused)]
fn main() {
use langchainrust::{
    CallbackManager, StdOutHandler, FileCallbackHandler,
    LangSmithHandler, LogFormat,
};
use std::sync::Arc;

let manager = CallbackManager::new()
    .add_handler(Arc::new(StdOutHandler::new()))
    .add_handler(Arc::new(FileCallbackHandler::new("./traces.jsonl")?
        .with_format(LogFormat::JsonLines)))
    .add_handler(Arc::new(LangSmithHandler::from_env()?));
}

LangSmith Configuration

Environment variables:

VariableDescriptionDefault
LANGSMITH_API_KEYAPI key (starts with ls_)Required
LANGSMITH_TRACINGEnable tracingtrue
LANGSMITH_PROJECTProject namedefault
LANGSMITH_ENDPOINTAPI endpointLangSmith official
LANGSMITH_WORKSPACE_IDWorkspace IDFor org accounts

OpenTelemetry (GenAI SemConv)

#![allow(unused)]
fn main() {
// Feature: opentelemetry
use langchainrust::OtelHandler;

let handler = OtelHandler::from_global("langchainrust");
// Sets GenAI Semantic Convention attributes:
// gen_ai.system, gen_ai.request.model, gen_ai.response.model,
// gen_ai.response.finish_reason, gen_ai.client.token.usage.*,
// gen_ai.request.max_tokens, gen_ai.request.temperature,
// gen_ai.operation.name, gen_ai.tool.name
}

Tracing Subsystem

#![allow(unused)]
fn main() {
use langchainrust::{Tracer, SpanKind, SpanGuard, InMemoryTracingBackend};

let backend = Arc::new(InMemoryTracingBackend::new());
let tracer = Tracer::new(backend.clone());

let mut span = tracer.start("llm_call", SpanKind::Llm);
span.with_tokens(SpanTokenUsage { prompt_tokens: 10, completion_tokens: 20, total_tokens: 30 });
span.end(); // RAII: ends on drop if not called

// Inspect traces
let spans = backend.spans();
}

RunTree

#![allow(unused)]
fn main() {
use langchainrust::{RunTree, RunType};

let run = RunTree::new("my_chain", RunType::Chain, serde_json::json!({"input": "hello"}))
    .with_tag("production")
    .with_project("my-project");

let child = run.create_child("llm_step", RunType::Llm, serde_json::json!({"prompt": "..."}));
}