UNPKG

@lobehub/chat

Version:

Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.

75 lines (49 loc) 3.2 kB
--- title: Observability and Tracing for LobeChat description: >- Enhance your LobeChat applications with open-source observability and tracing using Langfuse. Automatically capture detailed traces and metrics for every request to optimize and debug your chats. tags: - Observability - Tracing - Langfuse --- # Monitor your LobeChat application with Langfuse ## What is Langfuse? [Langfuse](https://langfuse.com/) an **open-source LLM Observability platform**. By enabling the Langfuse integration, you can trace your application data to develop, monitor, and improve the use of LobeChat, including: - Application [traces](https://langfuse.com/docs/tracing) - Usage patterns - Cost data by user and model - [Evaluations](https://langfuse.com/docs/scores/overview) ## Get Started <Steps> ### Set up Langfuse Get your Langfuse API key by signing up for [Langfuse Cloud](https://cloud.langfuse.com) or [self-hosting](https://langfuse.com/docs/deployment/self-host) Langfuse. ### Set up LobeChat There are multiple ways to [self-host LobeChat](https://lobehub.com/docs/self-hosting/start). For this example, we will use the Docker Desktop deployment. <Tabs items={["Environment Variables", "Example in Docker Desktop"]}> <Tab> Before deploying LobeChat, set the following four environment variables with the Langfuse API keys you created in the previous step. ```sh ENABLE_LANGFUSE = '1' LANGFUSE_SECRET_KEY = 'sk-lf...' LANGFUSE_PUBLIC_KEY = 'pk-lf...' LANGFUSE_HOST = 'https://cloud.langfuse.com' ``` </Tab> <Tab> Before running the Docker container, set the environment variables in the Docker Desktop with the Langfuse API keys you created in the previous step. <Image alt={'Environment Variables in Docker Desktop'} src={'https://langfuse.com/images/docs/lobechat-docker-desktop-env.png'} /> </Tab> </Tabs> ### Activate Analytics in Settings Once you have LobeChat running, navigate to the **About** tab in the **Settings** and activate analytics. This is necessary for traces to be sent to Langfuse. <Image alt={'LobeChat Settings'} src={'https://langfuse.com/images/docs/lobechat-settings.png'} /> ### See Chat Traces in Langfuse After setting your LLM model key, you can start interacting with your LobeChat application. <Image alt={'LobeChat Conversation'} src={'https://langfuse.com/images/docs/lobechat-converstation.png'} /> All conversations in the chat are automatically traced and sent to Langfuse. You can view the traces in the [Traces section](https://langfuse.com/docs/tracing) in the Langfuse UI. <Image alt={'LobeChat Example Trace'} src={'https://langfuse.com/images/docs/lobechat-example-trace.png'} /> *[Example trace in the Langfuse UI](https://cloud.langfuse.com/project/cloramnkj0002jz088vzn1ja4/traces/63e9246d-3f22-4e45-936d-b0c4ccf55a1e?timestamp=2024-11-26T17%3A00%3A02.028Z\&observation=7ea75a0c-d9d1-425c-9b88-27561c63b413)* </Steps> ## Feedback If you have any feedback or requests, please create a GitHub [Issue](https://langfuse.com/issue) or share your work with the Langfuse community on [Discord](https://discord.langfuse.com/).