eyeloupe

项目介绍：Eyeloupe

Eyeloupe 是一个优雅的 Rails 调试助手，借助 AI 技术，帮助开发者更好地查看和管理 Rails 应用的请求和异常。目前项目不再处于活跃开发中，正在寻找新的贡献者。

项目特点

Eyeloupe 提供了一种简洁优雅的方式来查看应用的进出请求和异常，并借助 AI 来协助开发者解决问题。它特别是为 Rails 框架而设计的调试工具，灵感来源于 Laravel 的 Telescope，目标是为从 Laravel 转向 Rails 的开发者提供一个类似的调试工具。

安装指南

1. 在应用程序的 Gemfile 中添加以下行：

   gem "eyeloupe"

2. 执行以下命令以安装 Eyeloupe：

   $ bundle

3. 安装 Eyeloupe 迁移文件到项目中：

   $ rails eyeloupe:install:migrations

4. 运行数据库迁移：

   $ rails db:migrate

5. 在 config/routes.rb 文件中添加以下路由来访问 Eyeloupe 控制台：

   mount Eyeloupe::Engine => "/eyeloupe"

配置

在 initializers/eyeloupe.rb 文件中，可以进行如下配置：

• excluded_paths：配置不需要 Eyeloupe 捕获的路径。
• capture：布尔类型，决定是否启用 Eyeloupe 捕获。
• openai_access_key：设置 OpenAI API 的访问密钥。
• openai_model：指定 OpenAI API 使用的模型。
• database：可选配置，指定 Eyeloupe 使用的数据库。

数据库配置

默认情况下，Eyeloupe 使用和应用程序相同的数据库。如果希望在生产环境中使用单独的数据库，可以在 config/database.yml 中添加新的数据库配置。

异常处理

要启用对异常的处理，需要在环境配置文件中禁用 Rails 默认的异常处理，比如在 config/environments/development.rb 中设置：

config.consider_all_requests_local = false

使用方法

Eyeloupe 最适合在开发环境中使用来进行应用调试，而不推荐在生产环境使用。开启自动刷新功能，每 3 秒页面会自动更新显示最新数据。

当您在配置中定义了 OpenAI 访问密钥后，异常详细信息页面中将出现一个新的区块，通过 OpenAI 提供解决异常的建议。

常见问题

• 请求时间为何不同于 rack-mini-profiler？ Eyeloupe 并非面向性能优化工具，显示的请求时间与 Rails 日志中相同。若需详细的加载时间信息，可将 rack-mini-profiler 与 Eyeloupe 一起使用。

• 这是 Rails 版的 Laravel Telescope 吗？ 是的，Eyeloupe 的灵感来源于 Laravel Telescope，为习惯使用 Laravel 的人提供类似的工具补充。

贡献

Eyeloupe 鼓励社区创新和贡献。如果有改进建议，欢迎通过拉取请求提交代码。通过以下步骤参与贡献：

1. Fork 项目
2. 创建新的功能分支 (git checkout -b feature/amazing_feature)
3. 提交代码 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing_feature)
5. 创建一个 Pull Request

许可证

Eyeloupe 根据 MIT 许可证开放源代码发布。