From 16c59118eba6be45373d28332ed3728ca641d6c0 Mon Sep 17 00:00:00 2001 From: Jacob Lee Date: Fri, 28 Jun 2024 18:28:49 -0700 Subject: [PATCH] docs[patch]: Adds short tracing how-tos and conceptual guide (#23657) CC @agola11 --- docs/docs/concepts.mdx | 10 ++++++++++ docs/docs/how_to/index.mdx | 13 ++++++++++++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/docs/concepts.mdx b/docs/docs/concepts.mdx index 5f627f3fa6b..ac7e5412278 100644 --- a/docs/docs/concepts.mdx +++ b/docs/docs/concepts.mdx @@ -1101,3 +1101,13 @@ This process is vital for building reliable applications. - It allows you to track results over time and automatically run your evaluators on a schedule or as part of CI/Code To learn more, check out [this LangSmith guide](https://docs.smith.langchain.com/concepts/evaluation). + +### Tracing + + +A trace is essentially a series of steps that your application takes to go from input to output. +Traces contain individual steps called `runs`. These can be individual calls from a model, retriever, +tool, or sub-chains. +Tracing gives you observability inside your chains and agents, and is vital in diagnosing issues. + +For a deeper dive, check out [this LangSmith conceptual guide](https://docs.smith.langchain.com/concepts/tracing). diff --git a/docs/docs/how_to/index.mdx b/docs/docs/how_to/index.mdx index 9765e894726..4543d82ba6b 100644 --- a/docs/docs/how_to/index.mdx +++ b/docs/docs/how_to/index.mdx @@ -317,7 +317,8 @@ LangSmith allows you to closely trace, monitor and evaluate your LLM application It seamlessly integrates with LangChain and LangGraph, and you can use it to inspect and debug individual steps of your chains and agents as you build. LangSmith documentation is hosted on a separate site. -You can peruse [LangSmith how-to guides here](https://docs.smith.langchain.com/how_to_guides/). +You can peruse [LangSmith how-to guides here](https://docs.smith.langchain.com/how_to_guides/), but we'll highlight a few sections that are particularly +relevant to LangChain below: ### Evaluation @@ -326,3 +327,13 @@ Evaluating performance is a vital part of building LLM-powered applications. LangSmith helps with every step of the process from creating a dataset to defining metrics to running evaluators. To learn more, check out the [LangSmith evaluation how-to guides](https://docs.smith.langchain.com/how_to_guides#evaluation). + +### Tracing + + +Tracing gives you observability inside your chains and agents, and is vital in diagnosing issues. + +- [How to: trace with LangChain](https://docs.smith.langchain.com/how_to_guides/tracing/trace_with_langchain) +- [How to: add metadata and tags to traces](https://docs.smith.langchain.com/how_to_guides/tracing/trace_with_langchain#add-metadata-and-tags-to-traces) + +You can see general tracing-related how-tos [in this section of the LangSmith docs](https://docs.smith.langchain.com/how_to_guides/tracing).