From 7728a848d019b7a001f50c5c7e24be3798f319bb Mon Sep 17 00:00:00 2001 From: Harrison Chase Date: Sun, 29 Jan 2023 20:49:35 -0800 Subject: [PATCH] Harrison/tracing docs (#806) Co-authored-by: Ankush Gola <9536492+agola11@users.noreply.github.com> --- docs/index.rst | 1 + docs/tracing.md | 6 +++++- docs/tracing/agent_with_tracing.ipynb | 12 ++++++++++-- docs/tracing/hosted_installation.md | 2 +- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index c1e7ce30..ec1a46af 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -177,5 +177,6 @@ Additional collection of resources we think may be useful as you develop your ap ./glossary.md ./gallery.rst ./deployments.md + ./tracing.md Discord Production Support diff --git a/docs/tracing.md b/docs/tracing.md index 40247f92..3214140e 100644 --- a/docs/tracing.md +++ b/docs/tracing.md @@ -1,7 +1,11 @@ -# LangChain Tracing Instructions +# Tracing + +By enabling tracing in your LangChain runs, you’ll be able to more effectively visualize, step through, and debug your chains and agents. First, you should install tracing and set up your environment properly. You can use either a locally hosted version of this (uses Docker) or a cloud hosted version (in closed alpha). +If you're interested in using the hosted platform, please fill out the form [here](https://forms.gle/tRCEMSeopZf6TE3b6). + - [Locally Hosted Setup](./tracing/local_installation.md) - [Cloud Hosted Setup](./tracing/hosted_installation.md) diff --git a/docs/tracing/agent_with_tracing.ipynb b/docs/tracing/agent_with_tracing.ipynb index beee1fb9..ebc0ee5a 100644 --- a/docs/tracing/agent_with_tracing.ipynb +++ b/docs/tracing/agent_with_tracing.ipynb @@ -1,5 +1,13 @@ { "cells": [ + { + "cell_type": "markdown", + "id": "5371a9bb", + "metadata": {}, + "source": [ + "# Tracing Walkthrough" + ] + }, { "cell_type": "code", "execution_count": 1, @@ -19,7 +27,7 @@ "# os.environ[\"LANGCHAIN_SESSION\"] = \"my_session\" \n", "\n", "## Better to set this environment variable in the terminal\n", - "# Uncomment this if using hosted version. Replace \"my_api_key\" with your actual API Key.\n", + "## Uncomment this if using hosted version. Replace \"my_api_key\" with your actual API Key.\n", "\n", "# os.environ[\"LANGCHAIN_API_KEY\"] = \"my_api_key\" \n", "\n", @@ -78,7 +86,7 @@ { "cell_type": "code", "execution_count": null, - "id": "0bf0304c", + "id": "25addd7f", "metadata": {}, "outputs": [], "source": [] diff --git a/docs/tracing/hosted_installation.md b/docs/tracing/hosted_installation.md index 74926cc7..e00e72ed 100644 --- a/docs/tracing/hosted_installation.md +++ b/docs/tracing/hosted_installation.md @@ -1,6 +1,6 @@ # Cloud Hosted Setup -We offer a hosted version of tracing at https://langchainplus.vercel.app/. You can use this to view traces from your run without having to run the server locally. +We offer a hosted version of tracing at [langchainplus.vercel.app](https://langchainplus.vercel.app/). You can use this to view traces from your run without having to run the server locally. Note: we are currently only offering this to a limited number of users. The hosted platform is VERY alpha, in active development, and data might be dropped at any time. Don't depend on data being persisted in the system long term and don't log traces that may contain sensitive information. If you're interested in using the hosted platform, please fill out the form [here](https://forms.gle/tRCEMSeopZf6TE3b6).