-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from Scale3-Labs/karthik/update-readme
Update Readme
- Loading branch information
Showing
12 changed files
with
173 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,128 @@ | ||
<!-- Readme update --> | ||
# [Langtrace](https://www.langtrace.ai) | ||
|
||
|
||
## Open Source & Open Telemetry(OTEL) Observability for LLM applications. | ||
|
||
![Static Badge](https://img.shields.io/badge/License-AGPL--3.0-blue) ![Static Badge](https://img.shields.io/badge/npm_@langtrase/typescript--sdk-1.2.9-green) ![Static Badge](https://img.shields.io/badge/pip_langtrace--python--sdk-1.2.8-green) ![Static Badge](https://img.shields.io/badge/Development_status-Active-green) | ||
|
||
--- | ||
|
||
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. | ||
|
||
## 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. | ||
|
||
--- | ||
|
||
## Getting Started | ||
|
||
### Langtrace Cloud ☁️ | ||
To use the managed SaaS version of Langtrace, follow the steps below: | ||
1. Sign up by going to [this link](www.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**: | ||
``` | ||
npm i @langtrase/typescript-sdk | ||
``` | ||
|
||
``` | ||
import { init } from '@langtrace-init/init'; | ||
init({ api_key: process.env.LANGTRACE_API_KEY }); | ||
``` | ||
|
||
|
||
If your application is built using **python**: | ||
``` | ||
pip install langtrace-python-sdk | ||
``` | ||
|
||
``` | ||
from langtrace_python_sdk import langtrace | ||
langtrace.init(api_key=process.env.LANGTRACE_API_KEY) | ||
``` | ||
|
||
### Langtrace self hosted | ||
|
||
Langtrace UI is built using [NextJS](https://nextjs.org/). To self-host and use langtrace, you can use our Docker container: | ||
``` | ||
# Clone the repository | ||
git clone git@github.com:Scale3-Labs/langtrace.git | ||
cd langtrace | ||
# ⭐ Don't forget to star this repository ⭐ | ||
# Run the application and the databases locally | ||
docker compose up | ||
``` | ||
|
||
Install the langtrace SDK in your application by following the same instructions under the Langtrace Cloud section above for sending traces to your self hosted setup. | ||
|
||
--- | ||
## 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) | ||
|
||
--- | ||
## Supported integrations | ||
|
||
Langtrace automatically captures traces from the following vendors: | ||
|
||
| Vendor | Type | Typescript SDK | Python SDK | ||
| ------ | ------ | ------ | ------ | | ||
| OpenAI | LLM | :white_check_mark: | :white_check_mark: | | ||
| Anthropic | LLM | :white_check_mark: | :white_check_mark: | | ||
| Azure OpenAI | LLM | :white_check_mark: | :white_check_mark: | | ||
| Langchain | Framework | :x: | :white_check_mark: | | ||
| LlamaIndex | Framework | :white_check_mark: | :white_check_mark: | | ||
| Pinecone | Vector Database | :white_check_mark: | :white_check_mark: | | ||
| ChromaDB | Vector Database | :white_check_mark: | :white_check_mark: | | ||
|
||
--- | ||
## 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. | ||
|
||
--- | ||
## Security | ||
|
||
To report security vulnerabilites, 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). | ||
|
||
--- | ||
## 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 laid out above. | ||
|
||
**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 slack workspace. | ||
|
||
**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. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters