eyeloupe

Proyecto ya no está bajo desarrollo activo: busca nuevos contribuyentes

Eyeeloupe

El elegante asistente de depuración de Rails. Ai alimentada.
Informe de error · Función de solicitud

EyeLoupe es el elegante asistente de depuración de Rails. Le ayuda a depurar su aplicación Rails proporcionando una interfaz simple y elegante para ver sus solicitudes y excepciones entrantes/salientes, impulsadas por AI.

Instalación

Agregue esta línea al archivo gem de su aplicación:

 gem "eyeloupe"

Y luego ejecutar:

$ bundle

Instale migraciones de EyeLoupe en su proyecto:

$ rails eyeloupe:install:migrations

Y ejecutar las migraciones:

$ rails db:migrate

Para acceder al panel de EyeLoupe, debe agregar la siguiente ruta a su archivo config/routes.rb :

 mount Eyeloupe :: Engine => "/eyeloupe" 

Configuración

Este es un ejemplo de la configuración que puede agregar a su archivo initializers/eyeloupe.rb :

 Eyeloupe . configure do | config |
  config . excluded_paths = %w[ assets favicon.ico service-worker.js manifest.json ]
  config . capture = Rails . env . development?
  config . openai_access_key = "your-openai-access-key"
  config . openai_model = "gpt-4"
  config . database = 'eyeloupe'
end

• excluded_paths es una variedad de rutas que desea excluir de la captura de EyeLoupe. EyeLoupe agrega estas rutas excluidas a las predeterminadas: %w[mini-profiler eyeloupe active_storage]
• capture es un booleano para habilitar/deshabilitar la captura de laelope. Por defecto, está configurado en true .
• openai_access_key es la clave de acceso para usar la API de OpenAI. Puedes conseguir uno aquí.
• openai_model es el modelo a usar para la API de OpenAI. Puede encontrar la lista de modelos disponibles aquí.
• database es una base de datos opcional que Eyeeloupe usará (base de datos).

Base de datos

Por defecto, EyeLoupe usa la misma base de datos que su aplicación. Si desea utilizar una base de datos diferente para mantener limpio su entorno de producción, puede agregar una nueva configuración de la base de datos en su archivo config/database.yml :

 development :
  primary :
    << : *default
    database : db/development.sqlite3
  eyeloupe :
    << : *default
    database : db/eyeloupe.sqlite3
    migrations_paths : <%= Gem.loaded_specs['eyeloupe'].full_gem_path + '/db/migrate' %>
    schema_dump : false

Usando esto puede omitir el eyeloupe:install:migrations , pero no olvide ejecutar rails db:migrate RAILS_ENV=eyeloupe para configurar la base de datos.

Manejo de excepciones

Para poder manejar excepciones, asegúrese de deshabilitar el manejo de excepciones de rieles predeterminados en su archivo de configuración de entorno (por ejemplo, config/environments/development.rb ):

 config . consider_all_requests_local = false 

Uso

EyeLoupe se desarrolla exclusivamente para el marco Rails.

Puede usarlo en su entorno de desarrollo para depurar su aplicación, pero no se recomienda usarla en producción.

Autoinfresión

Al activar Auto-Fresh, cada 3 segundos la página se actualizará para mostrarle los últimos datos.

Eliminar todos los datos

Puede eliminar todos los datos almacenados por EyeLoupe haciendo clic en el botón de basura.

Asistente de IA

Cuando defina una tecla de acceso OpenAI en la configuración, puede ver una nueva sección en la página Detalles de excepción. Esta sección está impulsada por la API de OpenAI y puede darle una solución para resolver su excepción. Envía todo el contenido del archivo que contiene la excepción de tener la mejor respuesta a su problema.

Mejora

Cuando su actualización de EyeLoupe a la última versión, asegúrese de ejecutar los siguientes comandos:

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

Q/A

¿Por qué el tiempo de solicitud no es el mismo en Rack-Mini-Profiler?

EyeLoupe no es una herramienta orientada al rendimiento, el tiempo de solicitud es el mismo que puede ver en el registro de rieles. Si desea más detalles sobre su tiempo de carga, puede usar RACK-MINI-Profiler junto con EyeLoupe.

¿Es este el telescopio Laravel para los rieles?

Sí, EyeLoupe está inspirado en Laravel Telescope. Muchas personas que vienen de Laravel les falta el telescopio o buscan algo similar, por lo que EyeLoupe está aquí para llenar este vacío.

Que contribuye

Las contribuciones son lo que hace que la comunidad de código abierto sea un lugar tan increíble para aprender, inspirar y crear. Cualquier contribución que haga es muy apreciada .

Si tiene una sugerencia que lo mejore, desembolse el repositorio y cree una solicitud de extracción. También puede simplemente abrir un problema con la etiqueta "Mejora". ¡No olvides darle una estrella al proyecto! ¡Gracias de nuevo!

1. Bifurca el proyecto
2. Cree su rama de características ( git checkout -b feature/amazing_feature )
3. Comprometer sus cambios ( git commit -m 'Add some amazing feature' )
4. Push to the Branch ( git push origin feature/amazing_feature )
5. Abra una solicitud de extracción

Licencia

La gema está disponible como código abierto bajo los términos de la licencia MIT.

Contacto

Enlace del proyecto: https://github.com/alxlion/eyeLoupe