OpenLIT 项目使用教程

OpenLIT 项目使用教程

openlitOpenLIT is an open-source GenAI and LLM observability platform native to OpenTelemetry with traces and metrics in a single application 🔥 🖥 . Open source GenAI and LLM Application Performance Monitoring (APM) & Observability tool项目地址:https://gitcode.com/gh_mirrors/ope/openlit

1. 项目的目录结构及介绍

OpenLIT 项目的目录结构如下：

openlit/
├── sdk/
│   └── python/
├── src/
├── .gitignore
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── docker-compose.yml

目录介绍

• sdk/python/: 包含 Python SDK 相关文件。
• src/: 项目源代码目录。
• .gitignore: Git 忽略文件配置。
• CODEOWNERS: 代码所有者配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明文件。
• SECURITY.md: 安全相关说明文件。
• docker-compose.yml: Docker 配置文件，用于启动项目。

2. 项目的启动文件介绍

OpenLIT 项目的启动文件主要是 docker-compose.yml 文件。该文件定义了如何通过 Docker 启动 OpenLIT 项目。

docker-compose.yml 文件内容

version: '3'
services:
  openlit:
    image: openlit/openlit:latest
    ports:
      - "8080:8080"
    volumes:
      - ./src:/app/src
    environment:
      - OPENLIT_ENV=production

启动步骤

1. 克隆项目仓库：

   git clone git@github.com:openlit/openlit.git
   

2. 进入项目目录：

   cd openlit
   

3. 启动 Docker 容器：

   docker-compose up -d
   

3. 项目的配置文件介绍

OpenLIT 项目的配置文件主要是 docker-compose.yml 和 src/config.py。

docker-compose.yml

如上所述，docker-compose.yml 文件定义了 Docker 容器的配置，包括镜像、端口映射、卷挂载和环境变量。

src/config.py

src/config.py 文件包含了项目的配置信息，如数据库连接、日志级别等。

# src/config.py
import os

class Config:
    DEBUG = os.getenv('DEBUG', False)
    DATABASE_URI = os.getenv('DATABASE_URI', 'sqlite:///openlit.db')
    LOG_LEVEL = os.getenv('LOG_LEVEL', 'INFO')

配置项介绍

• DEBUG: 是否开启调试模式。
• DATABASE_URI: 数据库连接字符串。
• LOG_LEVEL: 日志级别。

通过这些配置文件，可以灵活地调整 OpenLIT 项目的运行环境和行为。

openlitOpenLIT is an open-source GenAI and LLM observability platform native to OpenTelemetry with traces and metrics in a single application 🔥 🖥 . Open source GenAI and LLM Application Performance Monitoring (APM) & Observability tool项目地址:https://gitcode.com/gh_mirrors/ope/openlit