openlit 0.0.2__tar.gz → 0.0.3__tar.gz

{openlit-0.0.2 → openlit-0.0.3}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: openlit
-Version: 0.0.2
+Version: 0.0.3
 Summary: OpenTelemetry-native Auto instrumentation library for monitoring LLM Applications, facilitating the integration of observability into your GenAI-driven projects
-Home-page: https://github.com/open-lit/openlit/tree/main/openlit/python
+Home-page: https://github.com/openlit/openlit/tree/main/openlit/python
 Keywords: OpenTelemetry,otel,otlp,llm,tracing,openai,anthropic,claude,cohere,llm monitoring,observability,monitoring,gpt,Generative AI,chatGPT
 Author: OpenLIT
 Requires-Python: >=3.7.1,<4.0.0
@@ -18,10 +18,25 @@ Requires-Dist: opentelemetry-instrumentation (>=0.45b0,<0.46)
 Requires-Dist: opentelemetry-sdk (>=1.24.0,<2.0.0)
 Requires-Dist: requests (>=2.26.0,<3.0.0)
 Requires-Dist: tiktoken (>=0.1.1,<0.2.0)
-Project-URL: Repository, https://github.com/open-lit/openlit/tree/main/openlit/python
+Project-URL: Repository, https://github.com/openlit/openlit/tree/main/openlit/python
 Description-Content-Type: text/markdown
 
-# OpenLIT: OpenTelemetry-native Observability for LLMs
+<div align="center">
+<img src="https://github.com/openlit/.github/blob/main/profile/assets/wide-logo-no-bg.png?raw=true" alt="OpenLIT Logo" width="30%"><h1>
+OpenTelemetry Auto-Instrumentation for GenAI & LLM Applications</h1>
+
+**[Documentation](https://docs.openlit.io/) | [Quickstart](#-getting-started) | [Python SDK](https://github.com/openlit/openlit/tree/main/sdk/python)**
+
+[![OpenLIT](https://img.shields.io/badge/OpenLIT-orange)](https://github.com/openlit/openlit)
+[![License](https://img.shields.io/github/license/openlit/openlit?label=License&logo=github&color=f80&logoColor=white)](https://github.com/openlit/openlit/blob/main/LICENSE)
+[![Downloads](https://static.pepy.tech/badge/dokumetry/month)](https://pepy.tech/project/dokumetry)
+[![GitHub Last Commit](https://img.shields.io/github/last-commit/openlit/openlit)](https://github.com/openlit/openlit/pulse)
+[![GitHub Contributors](https://img.shields.io/github/contributors/openlit/openlit)](https://github.com/openlit/openlit/graphs/contributors)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=white)](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ)
+[![X](https://img.shields.io/badge/follow-%40OpenLIT-1DA1F2?logo=x&style=social)](https://twitter.com/openlit_io)
+
+</div>
 
 OpenLIT Python SDK is an **OpenTelemetry-native** Auto instrumentation library for monitoring LLM Applications, facilitating the integration of observability into your GenAI-driven projects. Designed with simplicity and efficiency, OpenLIT offers the ability to embed observability into your GenAI-driven projects effortlessly using just **a single line of code**.
 
@@ -63,10 +78,20 @@ This project adheres to the [Semantic Conventions](https://github.com/open-telem
 pip install openlit
 ```
 
-## ⚡ Quick Integration
+## 🚀 Getting Started
+
+## Step 1: Install OpenLIT SDK
+
+```bash
+pip install openlit
+```
+
+### Step 2: Instrument your Application
+Integrating the OpenLIT into LLM applications is straightforward. Start monitoring for your LLM Application with just **one line of code**: 
 
 ```python
 import openlit
+
 openlit.init()
 ```
 
@@ -74,6 +99,42 @@ By default, OpenLIT directs traces and metrics straight to your console. To forw
 
 To send telemetry to OpenTelemetry backends requiring authentication, set the `otlp_headers` parameter with its desired value. Alternatively, you can configure the endpoint by setting the `OTEL_EXPORTER_OTLP_HEADERS` environment variable as recommended in the OpenTelemetry documentation.
 
+#### Example
+
+Here is how you can send telemetry from OpenLIT to Grafana Cloud
+
+```python
+openlit.init(
+  otlp_endpoint="https://otlp-gateway-prod-us-east-0.grafana.net/otlp", 
+  otlp_headers="Authorization=Basic%20<base64 encoded Instance ID and API Token>"
+)
+```
+
+Alternatively, You can also choose to set these values using `OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_EXPORTER_OTLP_HEADERS` environment variables
+
+```python
+openlit.init()
+```
+
+```env
+export OTEL_EXPORTER_OTLP_ENDPOINT = "https://otlp-gateway-prod-us-east-0.grafana.net/otlp"
+export OTEL_EXPORTER_OTLP_HEADERS = "Authorization=Basic%20<base64 encoded Instance ID and API Token>"
+```
+
+### Step 3: Visualize and Optimize!
+With the LLM Observability data now being collected and sent to your chosen OpenTelemetry backend, the next step is to visualize and analyze this data to glean insights into your application's performance, behavior, and identify areas of improvement. Here is how you would use the data in Grafana, follow these detailed instructions to explore your LLM application's Telemetry data.
+
+   - Select the **Explore** option from Grafana's sidebar.
+   - At the top, ensure the correct Tempo data source is selected from the dropdown menu.
+   - Use the **Query** field to specify any particular traces you are interested in, or leave it empty to browse through all the available traces.
+   - You can adjust the time range to focus on specific periods of interest.
+   - Hit **Run Query** to fetch your trace data. You'll see a visual representation of your traces along with detailed information on particular spans when clicked.
+
+#### Next Steps
+
+- **Create Dashboards:** Beyond just exploring traces, consider creating dashboards in Grafana to monitor key performance indicators (KPIs) and metrics over time. Dashboards can be customized with various panels to display graphs, logs, and single stats that are most relevant to your application's performance and usage patterns.
+- **Set Alerts:** Grafana also allows you to set up alerts based on specific thresholds. This feature can be invaluable in proactively managing your application's health by notifying you of potential issues before they impact users.
+- **Iterate and Optimize:** Use the insights gained from your observability data to make informed decisions on optimizing your LLM application. This might involve refining model parameters, adjusting scaling strategies, or identifying and resolving bottlenecks.
 
 
 ### Configuration
@@ -107,7 +168,7 @@ Your input helps us grow and improve, and we're here to support you every step o
 
 Connect with the OpenLIT community and maintainers for support, discussions, and updates:
 
-- 🌟 If you like it, Leave a star on our [GitHub](https://github.com/open-lit/openlit/)
+- 🌟 If you like it, Leave a star on our [GitHub](https://github.com/openlit/openlit/)
 - 🌍 Join our [Slack](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ) Community for live interactions and questions.
-- 🐞 Report bugs on our [GitHub Issues](https://github.com/open-lit/openlit/issues) to help us improve OpenLIT.
+- 🐞 Report bugs on our [GitHub Issues](https://github.com/openlit/openlit/issues) to help us improve OpenLIT.
 - 𝕏 Follow us on [X](https://twitter.com/openlit) for the latest updates and news.

{openlit-0.0.2 → openlit-0.0.3}/README.md

@@ -1,4 +1,19 @@
-# OpenLIT: OpenTelemetry-native Observability for LLMs
+<div align="center">
+<img src="https://github.com/openlit/.github/blob/main/profile/assets/wide-logo-no-bg.png?raw=true" alt="OpenLIT Logo" width="30%"><h1>
+OpenTelemetry Auto-Instrumentation for GenAI & LLM Applications</h1>
+
+**[Documentation](https://docs.openlit.io/) | [Quickstart](#-getting-started) | [Python SDK](https://github.com/openlit/openlit/tree/main/sdk/python)**
+
+[![OpenLIT](https://img.shields.io/badge/OpenLIT-orange)](https://github.com/openlit/openlit)
+[![License](https://img.shields.io/github/license/openlit/openlit?label=License&logo=github&color=f80&logoColor=white)](https://github.com/openlit/openlit/blob/main/LICENSE)
+[![Downloads](https://static.pepy.tech/badge/dokumetry/month)](https://pepy.tech/project/dokumetry)
+[![GitHub Last Commit](https://img.shields.io/github/last-commit/openlit/openlit)](https://github.com/openlit/openlit/pulse)
+[![GitHub Contributors](https://img.shields.io/github/contributors/openlit/openlit)](https://github.com/openlit/openlit/graphs/contributors)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=white)](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ)
+[![X](https://img.shields.io/badge/follow-%40OpenLIT-1DA1F2?logo=x&style=social)](https://twitter.com/openlit_io)
+
+</div>
 
 OpenLIT Python SDK is an **OpenTelemetry-native** Auto instrumentation library for monitoring LLM Applications, facilitating the integration of observability into your GenAI-driven projects. Designed with simplicity and efficiency, OpenLIT offers the ability to embed observability into your GenAI-driven projects effortlessly using just **a single line of code**.
 
@@ -40,10 +55,20 @@ This project adheres to the [Semantic Conventions](https://github.com/open-telem
 pip install openlit
 ```
 
-## ⚡ Quick Integration
+## 🚀 Getting Started
+
+## Step 1: Install OpenLIT SDK
+
+```bash
+pip install openlit
+```
+
+### Step 2: Instrument your Application
+Integrating the OpenLIT into LLM applications is straightforward. Start monitoring for your LLM Application with just **one line of code**: 
 
 ```python
 import openlit
+
 openlit.init()
 ```
 
@@ -51,6 +76,42 @@ By default, OpenLIT directs traces and metrics straight to your console. To forw
 
 To send telemetry to OpenTelemetry backends requiring authentication, set the `otlp_headers` parameter with its desired value. Alternatively, you can configure the endpoint by setting the `OTEL_EXPORTER_OTLP_HEADERS` environment variable as recommended in the OpenTelemetry documentation.
 
+#### Example
+
+Here is how you can send telemetry from OpenLIT to Grafana Cloud
+
+```python
+openlit.init(
+  otlp_endpoint="https://otlp-gateway-prod-us-east-0.grafana.net/otlp", 
+  otlp_headers="Authorization=Basic%20<base64 encoded Instance ID and API Token>"
+)
+```
+
+Alternatively, You can also choose to set these values using `OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_EXPORTER_OTLP_HEADERS` environment variables
+
+```python
+openlit.init()
+```
+
+```env
+export OTEL_EXPORTER_OTLP_ENDPOINT = "https://otlp-gateway-prod-us-east-0.grafana.net/otlp"
+export OTEL_EXPORTER_OTLP_HEADERS = "Authorization=Basic%20<base64 encoded Instance ID and API Token>"
+```
+
+### Step 3: Visualize and Optimize!
+With the LLM Observability data now being collected and sent to your chosen OpenTelemetry backend, the next step is to visualize and analyze this data to glean insights into your application's performance, behavior, and identify areas of improvement. Here is how you would use the data in Grafana, follow these detailed instructions to explore your LLM application's Telemetry data.
+
+   - Select the **Explore** option from Grafana's sidebar.
+   - At the top, ensure the correct Tempo data source is selected from the dropdown menu.
+   - Use the **Query** field to specify any particular traces you are interested in, or leave it empty to browse through all the available traces.
+   - You can adjust the time range to focus on specific periods of interest.
+   - Hit **Run Query** to fetch your trace data. You'll see a visual representation of your traces along with detailed information on particular spans when clicked.
+
+#### Next Steps
+
+- **Create Dashboards:** Beyond just exploring traces, consider creating dashboards in Grafana to monitor key performance indicators (KPIs) and metrics over time. Dashboards can be customized with various panels to display graphs, logs, and single stats that are most relevant to your application's performance and usage patterns.
+- **Set Alerts:** Grafana also allows you to set up alerts based on specific thresholds. This feature can be invaluable in proactively managing your application's health by notifying you of potential issues before they impact users.
+- **Iterate and Optimize:** Use the insights gained from your observability data to make informed decisions on optimizing your LLM application. This might involve refining model parameters, adjusting scaling strategies, or identifying and resolving bottlenecks.
 
 
 ### Configuration
@@ -84,7 +145,7 @@ Your input helps us grow and improve, and we're here to support you every step o
 
 Connect with the OpenLIT community and maintainers for support, discussions, and updates:
 
-- 🌟 If you like it, Leave a star on our [GitHub](https://github.com/open-lit/openlit/)
+- 🌟 If you like it, Leave a star on our [GitHub](https://github.com/openlit/openlit/)
 - 🌍 Join our [Slack](https://join.slack.com/t/openlit/shared_invite/zt-2etnfttwg-TjP_7BZXfYg84oAukY8QRQ) Community for live interactions and questions.
-- 🐞 Report bugs on our [GitHub Issues](https://github.com/open-lit/openlit/issues) to help us improve OpenLIT.
+- 🐞 Report bugs on our [GitHub Issues](https://github.com/openlit/openlit/issues) to help us improve OpenLIT.
 - 𝕏 Follow us on [X](https://twitter.com/openlit) for the latest updates and news.

{openlit-0.0.2 → openlit-0.0.3}/pyproject.toml

@@ -1,11 +1,11 @@
 [tool.poetry]
 name = "openlit"
-version = "0.0.2"
+version = "0.0.3"
 description = "OpenTelemetry-native Auto instrumentation library for monitoring LLM Applications, facilitating the integration of observability into your GenAI-driven projects"
 authors = ["OpenLIT"]
-repository = "https://github.com/open-lit/openlit/tree/main/openlit/python"
+repository = "https://github.com/openlit/openlit/tree/main/openlit/python"
 readme = "README.md"
-homepage = "https://github.com/open-lit/openlit/tree/main/openlit/python"
+homepage = "https://github.com/openlit/openlit/tree/main/openlit/python"
 keywords = ["OpenTelemetry", "otel", "otlp","llm", "tracing", "openai", "anthropic", "claude", "cohere", "llm monitoring", "observability", "monitoring", "gpt", "Generative AI", "chatGPT"]
 
 [tool.poetry.dependencies]

{openlit-0.0.2 → openlit-0.0.3}/src/openlit/__helpers.py

@@ -124,7 +124,7 @@ def get_audio_model_cost(model, pricing_info, prompt):
 
 def fetch_pricing_info():
     """Fetches pricing information from a specified URL."""
-    pricing_url = "https://raw.githubusercontent.com/dokulabs/doku/main/assets/pricing.json"
+    pricing_url = "https://raw.githubusercontent.com/openlit/openlit/main/assets/pricing.json"
     try:
          # Set a timeout of 10 seconds for both the connection and the read
         response = requests.get(pricing_url, timeout=20)