opik

环境要求

• Python 环境并可使用 pip（README 使用 pip install opik）
• 可选：使用 uv 作为包管理器（uv pip install opik）
• 自托管本地服务器需 Docker Compose，支持 Linux 或 Mac 环境
• 使用 Comet.com 托管版需准备 API Key 与 workspace
• 生产级自托管需 Kubernetes 集群与 Helm 图表

安装与启动步骤

1. 1安装 Python SDK

   用 pip 直接安装 Opik 的 Python SDK，这是接入平台的最快方式。

   pip install opik

   复制

2. 2或用 uv 安装

   如果你使用 uv 管理依赖，可改用 uv 安装同一个包，效果一致，二选一即可。

   uv pip install opik

   复制

3. 3运行配置命令

   执行后按提示输入 Opik 服务器地址（自托管），或输入 API Key 与 workspace（Comet.com）。

   opik configure

   复制

4. 4代码中配置本地模式

   不想交互式配置时，可在 Python 代码里直接让 SDK 指向本地自托管实例。

   import opik
   opik.configure(use_local=True)

   复制

5. 5用 @track 记录调用

   给函数加上 @track 装饰器，每次调用都会写入 Opik，嵌套调用同样会被记录。

   from opik import track
   
   @track
   def my_function(input: str) -> str:
       return input

   复制

6. 6启动自托管服务器

   本地开发或测试时用 Docker Compose 启动 Opik 服务器，Linux/Mac 下执行仓库提供的安装脚本。

   ./opik.sh

   复制

7. 7Kubernetes 部署

   生产或大规模自托管场景改用 Helm 图表部署，具体步骤见官方 Kubernetes 安装指南。

关键配置

如何确认成功

调用被 @track 装饰的函数后，在 Opik 界面或自托管服务器中能看到对应的 trace 记录。

常见问题

注意事项

• Apache-2.0 许可，完整平台可免费自托管。
• README 中的自托管脚本仅说明适用于 Linux 或 Mac 环境。
• Comet.com 托管方式需要 API Key 与 workspace 信息。