eyeloupe

Eyeloupe: An Elegant Debug Assistant for Rails

Overview

Eyeloupe is a premium Rails debugging tool that integrates elegant design with cutting-edge AI technology. The project, aimed at helping developers pinpoint and solve issues in their Rails applications, provides a refined interface for monitoring incoming and outgoing requests, as well as tracking exceptions. It's particularly beneficial with its AI-powered capabilities to offer potential solutions for exceptions, leveraging the OpenAI API for enhanced problem-solving assistance.

Installation

To incorporate Eyeloupe into your Rails application, simply add the following line to your Gemfile:

gem "eyeloupe"

After updating your bundle, you'll need to install the corresponding migrations with:

$ rails eyeloupe:install:migrations

Following this, ensure that the migrations are up-to-date with:

$ rails db:migrate

To access Eyeloupe's features, add a specific route to your config/routes.rb file:

mount Eyeloupe::Engine => "/eyeloupe"

Configuration

Eyeloupe is configurable through an initializer file initializers/eyeloupe.rb. Key configuration options include:

• excluded_paths: Paths that should not be captured by Eyeloupe, such as static assets.
• capture: Enables capturing in specific environments, typically set to true in development.
• openai_access_key: An essential key for connecting to the OpenAI API.
• openai_model: Specifies the machine learning model to utilize, such as "gpt-4".
• database: Opt to store Eyeloupe's data in a separate database, if desired.

Database

By default, Eyeloupe shares the application's primary database. However, it offers flexibility by allowing developers to specify a separate database in config/database.yml, ensuring cleaner environments and distinct data management.

Exception Handling

For Eyeloupe to effectively handle exceptions, developers must disable Rails' default exception handling within the environment configuration, like so:

config.consider_all_requests_local = false

Usage

Eyeloupe is tailored for exclusive use within the Rails framework. It's aimed primarily at development environments, providing auto-refresh capabilities and comprehensive data deletion options. Important features include:

• Auto-refresh: Updates the console every three seconds for the freshest data.
• Data Deletion: Effortlessly clear stored data with a simple user interface action.

AI Assistant

Thanks to the integrated AI Assistant, when exceptions occur, developers are presented with AI-driven insights and solutions. By defining an OpenAI access key in the configuration, Eyeloupe's AI can provide context-specific recommendations by analyzing exception files thoroughly.

Upgrades

Keeping Eyeloupe up-to-date is straightforward. After upgrading, remember to reinstall migrations and execute them:

$ rails eyeloupe:install:migrations
$ rails db:migrate

Inspirations and Comparisons

Eyeloupe draws parallels with Laravel Telescope, targeting Rails developers who have transitioned from Laravel, offering a familiar yet customized debugging experience.

Contribution and Community

Eyeloupe greatly values the contributions of the open-source community. Developers eager to enhance the tool are warmly invited to fork the repository, implement features, and submit pull requests. Community-driven suggestions and enhancements are always appreciated.

Licensing

Eyeloupe is distributed under the MIT License, ensuring it's freely available for open-source use.

Engagement

For more information, community discussions, or to report issues, the Eyeloupe GitHub repository is a comprehensive hub for all things related to the tool. Explore, contribute, and elevate your Rails debugging experience with Eyeloupe.

Visit the GitHub Repository to embark on your debugging journey with Eyeloupe today!