<div align="center">
  <h1>
    <img src="https://github.com/Scale3-Labs/langtrace/assets/105607645/6825158c-39bb-4270-b1f9-446c36c066ee" alt="Langtrace" width="400"/>
    <br/>
    <a href="https://www.langtrace.ai">Langtrace</a>
  </h1>
  <h3>Open Source Observability for LLM Applications</h3>

  [![License](https://img.shields.io/badge/License-AGPL--3.0-blue?style=flat-square)](LICENSE)
  [![Development Status](https://img.shields.io/badge/Status-Active-success?style=flat-square)](https://github.com/Scale3-Labs/langtrace)
  [![Pull Requests](https://img.shields.io/github/issues-pr/Scale3-Labs/langtrace?style=flat-square)](https://github.com/Scale3-Labs/langtrace/pulls)
  [![NPM SDK](https://img.shields.io/npm/v/%40langtrase%2Ftypescript-sdk?style=flat-square&logo=npm&label=typescript-sdk&color=green)](https://github.com/Scale3-Labs/langtrace-typescript-sdk)
  [![NPM Downloads](https://img.shields.io/npm/dm/%40langtrase%2Ftypescript-sdk?style=flat-square&logo=npm)](https://www.npmjs.com/package/@langtrase/typescript-sdk)
  [![PyPI SDK](https://img.shields.io/pypi/v/langtrace-python-sdk?style=flat-square&logo=python&label=python-sdk&color=green)](https://github.com/Scale3-Labs/langtrace-python-sdk)
  [![PyPI Downloads](https://static.pepy.tech/badge/langtrace-python-sdk/month)](https://pepy.tech/project/langtrace-python-sdk)
  [![Total PyPI Downloads](https://static.pepy.tech/badge/langtrace-python-sdk)](https://static.pepy.tech/badge/langtrace-python-sdk)
  [![Deploy](https://railway.app/button.svg)](https://railway.app/template/8dNq1c?referralCode=MA2S9H)
  [![Deploy to Northflank](https://assets.northflank.com/deploy_to_northflank_smm_36700fb050.svg)](https://northflank.com/stacks/deploy-langtrace)
</div>

---

## 📚 Table of Contents
- [✨ Features](#-features)
- [🚀 Quick Start](#-quick-start)
- [🔗 Integrations](#-supported-integrations)
- [🌐 Getting Started](#-getting-started)
- [🏠 Self Hosting](#-langtrace-self-hosted)
- [📐 Architecture](#-langtrace-system-architecture)
- [🤝 Contributing](#-contributions)
- [🔒 Security](#-security)
- [❓ FAQ](#-frequently-asked-questions)
- [👥 Contributors](#-contributors)
- [📜 License](#-license)

Langtrace is an open source observability software which lets you capture, debug and analyze traces and metrics from all your applications that leverages LLM APIs, Vector Databases and LLM based Frameworks.

![image](/public/langtrace-tracing-ss.png)

## ✨ Features

- 📊 **Open Telemetry Support**: Built on OTEL standards for comprehensive tracing
- 🔄 **Real-time Monitoring**: Track LLM API calls, vector operations, and framework usage
- 🎯 **Performance Insights**: Analyze latency, costs, and usage patterns
- 🔍 **Debug Tools**: Trace and debug your LLM application workflows
- 📈 **Analytics**: Get detailed metrics and visualizations
- 🏠 **Self-hosting Option**: Deploy on your own infrastructure

## 🚀 Quick Start

```bash
# For TypeScript/JavaScript
npm i @langtrase/typescript-sdk

# For Python
pip install langtrace-python-sdk
```

Initialize in your code:
```typescript
// TypeScript
import * as Langtrace from '@langtrase/typescript-sdk'
Langtrace.init({ api_key: '<your_api_key>' }) // Get your API key at langtrace.ai
```
```python
# Python
from langtrace_python_sdk import langtrace
langtrace.init(api_key='<your_api_key>') # Get your API key at langtrace.ai
```

For detailed setup instructions, see [Getting Started](#-getting-started).

## 📊 Open Telemetry Support

The traces generated by Langtrace adhere to [Open Telemetry Standards(OTEL)](https://opentelemetry.io/docs/concepts/signals/traces/). We are developing [semantic conventions](https://opentelemetry.io/docs/concepts/semantic-conventions/) for the traces generated by this project. You can checkout the current definitions in [this repository](https://github.com/Scale3-Labs/langtrace-trace-attributes/tree/main/schemas). Note: This is an ongoing development and we encourage you to get involved and welcome your feedback.

---

## 📦 SDK Repositories

- [Langtrace Typescript SDK](https://github.com/Scale3-Labs/langtrace-typescript-sdk)
- [Langtrace Python SDK](https://github.com/Scale3-Labs/langtrace-python-sdk)
- [Semantic Span Attributes](https://github.com/Scale3-Labs/langtrace-trace-attributes)

---

## 🚀 Getting Started

### Langtrace Cloud ☁️

To use the managed SaaS version of Langtrace, follow the steps below:

1. Sign up by going to [this link](https://langtrace.ai).
2. Create a new Project after signing up. Projects are containers for storing traces and metrics generated by your application. If you have only one application, creating 1 project will do.
3. Generate an API key by going inside the project.
4. In your application, install the Langtrace SDK and initialize it with the API key you generated in the step 3.
5. The code for installing and setting up the SDK is shown below:

###  If your application is built using typescript/javascript

```typescript
npm i @langtrase/typescript-sdk
```

```typescript
import * as Langtrace from '@langtrase/typescript-sdk' // Must precede any llm module imports
Langtrace.init({ api_key: <your_api_key> })
```

OR

```typescript
import * as Langtrace from "@langtrase/typescript-sdk"; // Must precede any llm module imports
LangTrace.init(); // LANGTRACE_API_KEY as an ENVIRONMENT variable
```

### If your application is built using python

```python
pip install langtrace-python-sdk
```

```python
from langtrace_python_sdk import langtrace
langtrace.init(api_key=<your_api_key>)
```

OR

```python
from langtrace_python_sdk import langtrace
langtrace.init() # LANGTRACE_API_KEY as an ENVIRONMENT variable
```

### 🏠 Langtrace self hosted

To run the Langtrace locally, you have to run three services:

- Next.js app
- Postgres database
- Clickhouse database

> [!IMPORTANT]
> Checkout our [documentation](https://docs.langtrace.ai/hosting/overview) for various deployment options and configurations.

Requirements:

- Docker
- Docker Compose

#### The .env file

Feel free to modify the `.env` file to suit your needs.

#### Starting the servers

```bash
docker compose up
```

The application will be available at `http://localhost:3000`.

#### Take down the setup

To delete containers and volumes

```bash
docker compose down -v
```

`-v` flag is used to delete volumes

## Telemetry

Langtrace does NOT collect any Telemetry if you are self hosting the OSS client. None of your data leaves your servers.

---

## 🔗 Supported Integrations

Langtrace automatically captures traces from the following vendors and frameworks:

### LLM Providers
| Provider | TypeScript SDK | Python SDK |
|----------|:-------------:|:----------:|
| OpenAI | ✅ | ✅ |
| Anthropic | ✅ | ✅ |
| Azure OpenAI | ✅ | ✅ |
| Cohere | ✅ | ✅ |
| DeepSeek | ✅ | ✅ |
| xAI | ✅ | ✅ |
| Groq | ✅ | ✅ |
| Perplexity | ✅ | ✅ |
| Gemini | ✅ | ✅ |
| AWS Bedrock | ✅ | ✅ |
| Mistral | ❌ | ✅ |

### LLM Frameworks
| Framework | TypeScript SDK | Python SDK |
|-----------|:-------------:|:----------:|
| Langchain | ❌ | ✅ |
| LlamaIndex | ✅ | ✅ |
| Langgraph | ❌ | ✅ |
| LiteLLM | ❌ | ✅ |
| DSPy | ❌ | ✅ |
| CrewAI | ❌ | ✅ |
| Ollama | ❌ | ✅ |
| VertexAI | ✅ | ✅ |
| Vercel AI | ✅ | ❌ |
| GuardrailsAI | ❌ | ✅ |
| Arch | ❌ | ✅ |
| Graphlit | ❌ | ✅ |
| Agno | ❌ | ✅ |
| Phidata | ❌ | ✅ |
| Cleanlab | ❌ | ✅ |

### Vector Databases
| Database | TypeScript SDK | Python SDK |
|----------|:-------------:|:----------:|
| Pinecone | ✅ | ✅ |
| ChromaDB | ✅ | ✅ |
| QDrant | ✅ | ✅ |
| Weaviate | ✅ | ✅ |
| PGVector | ✅ | ✅ (SQLAlchemy) |
| MongoDB | ❌ | ✅ |
| Milvus | ❌ | ✅ |

---

## 📐 Langtrace System Architecture

![image](https://github.com/Scale3-Labs/langtrace/assets/105607645/eae180dd-ebf7-4792-b076-23f75d3734a8)

---

## 💡 Feature Requests and Issues

- To request for features, head over [here to start a discussion](https://github.com/Scale3-Labs/langtrace/discussions/categories/feature-requests).
- To raise an issue, head over [here and create an issue](https://github.com/Scale3-Labs/langtrace/issues).

---

## 🤝 Contributions

We welcome contributions to this project. To get started, fork this repository and start developing. To get involved, join our Slack workspace.

---

## 🌟 Langtrace Star History

## [![Langtrace Star History Chart](https://api.star-history.com/svg?repos=Scale3-Labs/langtrace&type=Timeline)](https://star-history.com/#Scale3-Labs/langtrace&Timeline)

---

## 🔒Security

To report security vulnerabilities, email us at <security@scale3labs.com>. You can read more on security [here](https://github.com/Scale3-Labs/langtrace/blob/development/SECURITY.md).

---

## 📜 License

- Langtrace application(this repository) is [licensed](https://github.com/Scale3-Labs/langtrace/blob/development/LICENSE) under the AGPL 3.0 License. You can read about this license [here](https://www.gnu.org/licenses/agpl-3.0.en.html).
- Langtrace SDKs are licensed under the Apache 2.0 License. You can read about this license [here](https://www.apache.org/licenses/LICENSE-2.0).

## 👥 Contributors

<div align="center">
  <table>
    <tr>
      <td align="center"><a href="https://github.com/karthikscale3"><img src="https://github.com/karthikscale3.png" width="100px;" alt="karthikscale3"/><br /><sub><b>karthikscale3</b></sub></a></td>
      <td align="center"><a href="https://github.com/dylanzuber-scale3"><img src="https://github.com/dylanzuber-scale3.png" width="100px;" alt="dylanzuber-scale3"/><br /><sub><b>dylanzuber-scale3</b></sub></a></td>
      <td align="center"><a href="https://github.com/darshit-s3"><img src="https://github.com/darshit-s3.png" width="100px;" alt="darshit-s3"/><br /><sub><b>darshit-s3</b></sub></a></td>
      <td align="center"><a href="https://github.com/rohit-kadhe"><img src="https://github.com/rohit-kadhe.png" width="100px;" alt="rohit-kadhe"/><br /><sub><b>rohit-kadhe</b></sub></a></td>
    </tr>
    <tr>
      <td align="center"><a href="https://github.com/yemiadej"><img src="https://github.com/yemiadej.png" width="100px;" alt="yemiadej"/><br /><sub><b>yemiadej</b></sub></a></td>
      <td align="center"><a href="https://github.com/alizenhom"><img src="https://github.com/alizenhom.png" width="100px;" alt="alizenhom"/><br /><sub><b>alizenhom</b></sub></a></td>
      <td align="center"><a href="https://github.com/obinnascale3"><img src="https://github.com/obinnascale3.png" width="100px;" alt="obinnascale3"/><br /><sub><b>obinnascale3</b></sub></a></td>
      <td align="center"><a href="https://github.com/Cruppelt"><img src="https://github.com/Cruppelt.png" width="100px;" alt="Cruppelt"/><br /><sub><b>Cruppelt</b></sub></a></td>
    </tr>
    <tr>
      <td align="center"><a href="https://github.com/Dnaynu"><img src="https://github.com/Dnaynu.png" width="100px;" alt="Dnaynu"/><br /><sub><b>Dnaynu</b></sub></a></td>
      <td align="center"><a href="https://github.com/jatin9823"><img src="https://github.com/jatin9823.png" width="100px;" alt="jatin9823"/><br /><sub><b>jatin9823</b></sub></a></td>
      <td align="center"><a href="https://github.com/MayuriS24"><img src="https://github.com/MayuriS24.png" width="100px;" alt="MayuriS24"/><br /><sub><b>MayuriS24</b></sub></a></td>
      <td align="center"><a href="https://github.com/NishantRana07"><img src="https://github.com/NishantRana07.png" width="100px;" alt="NishantRana07"/><br /><sub><b>NishantRana07</b></sub></a></td>
    </tr>
    <tr>
      <td align="center"><a href="https://github.com/obinnaokafor"><img src="https://github.com/obinnaokafor.png" width="100px;" alt="obinnaokafor"/><br /><sub><b>obinnaokafor</b></sub></a></td>
      <td align="center"><a href="https://github.com/heysagnik"><img src="https://github.com/heysagnik.png" width="100px;" alt="heysagnik"/><br /><sub><b>heysagnik</b></sub></a></td>
      <td align="center"><a href="https://github.com/dabiras3"><img src="https://github.com/dabiras3.png" width="100px;" alt="dabiras3"/><br /><sub><b>dabiras3</b></sub></a></td>
    </tr>
  </table>
</div>

---

## ❓Frequently Asked Questions

**1. Can I self host and run Langtrace in my own cloud?**
Yes, you can absolutely do that. Follow the self hosting setup instructions in our [documentation](https://docs.langtrace.ai/hosting/overview).

**2. What is the pricing for Langtrace cloud?**
Currently, we are not charging anything for Langtrace cloud and we are primarily looking for feedback so we can continue to improve the project. We will inform our users when we decide to monetize it.

**3. What is the tech stack of Langtrace?**
Langtrace uses NextJS for the frontend and APIs. It uses PostgresDB as a metadata store and Clickhouse DB for storing spans, metrics, logs and traces.

**4. Can I contribute to this project?**
Absolutely! We love developers and welcome contributions. Get involved early by joining our [Discord Community](https://discord.langtrace.ai/).

**5. What skillset is required to contribute to this project?**
Programming Languages: Typescript and Python.
Framework knowledge: NextJS.
Database: Postgres and Prisma ORM.
Nice to haves: Opentelemetry instrumentation framework, experience with distributed tracing.
