eyeloupe

Projet NOR plus sous le développement actif - à la recherche de nouveaux contributeurs

Oiseau

L'assistant de débogage élégant Rails. Ai alimenté.
RAPPORT BUG · Fonction de demande

Eyeloupe est l'élégant assistant de débogage des Rails. Il vous aide à déboguer votre application Rails en fournissant une interface simple et élégante pour afficher vos demandes et exceptions entrantes / sortantes, alimentées par l'IA.

Installation

Ajoutez cette ligne à Gemfile de votre application:

 gem "eyeloupe"

Puis exécuter:

$ bundle

Installez les migrations de l'Eyeloup dans votre projet:

$ rails eyeloupe:install:migrations

Et exécuter les migrations:

$ rails db:migrate

Pour accéder au tableau de bord Eyeloupe, vous devez ajouter l'itinéraire suivant à votre fichier config/routes.rb :

 mount Eyeloupe :: Engine => "/eyeloupe" 

Configuration

Ceci est un exemple de la configuration que vous pouvez ajouter à votre fichier 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 est un tableau de chemins que vous souhaitez exclure de la capture de l'eyeloup. Eyeloupe ajoute ces chemins exclus aux paramètres par défaut: %w[mini-profiler eyeloupe active_storage]
• capture est un booléen pour activer / désactiver la capture de l'eyeloup. Par défaut, il est défini sur true .
• openai_access_key est la clé d'accès pour utiliser l'API OpenAI. Vous pouvez en obtenir un ici.
• openai_model est le modèle à utiliser pour l'API OpenAI. Vous pouvez trouver la liste des modèles disponibles ici.
• database est un eyeloup de configuration de base de données facultatif utilisera (base de données).

Base de données

Par défaut, Eyeloup utilise la même base de données que votre application. Si vous souhaitez utiliser une base de données différente pour garder votre environnement de production propre, vous pouvez ajouter une nouvelle configuration de base de données dans votre fichier 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

En utilisant cela, vous pouvez ignorer l' eyeloupe:install:migrations , mais n'oubliez pas d'exécuter rails db:migrate RAILS_ENV=eyeloupe pour configurer la base de données.

Gestion des exceptions

Pour pouvoir gérer les exceptions, assurez-vous de désactiver la gestion des exceptions des rails par défaut dans votre fichier de configuration d'environnement (par exemple, config/environments/development.rb ):

 config . consider_all_requests_local = false 

Usage

Eyeloupe est exclusivement développé pour le cadre des rails.

Vous pouvez l'utiliser dans votre environnement de développement pour déboguer votre application, mais il n'est pas recommandé de l'utiliser en production.

Rafraîchissement automatique

En activant l'auto-frais, toutes les 3 secondes , la page sera actualisée pour vous montrer les dernières données.

Supprimer toutes les données

Vous pouvez supprimer toutes les données stockées par eyeloup en cliquant sur le bouton poubelle.

Assistant d'IA

Lorsque vous définissez une clé d'accès Openai dans la configuration, vous pouvez voir une nouvelle section dans la page Détails d'exception. Cette section est alimentée par l'API OpenAI et il est capable de vous donner une solution pour résoudre votre exception. Il envoie l'intégralité du contenu du fichier contenant l'exception pour avoir la meilleure réponse à votre problème.

Mise à niveau

Lorsque votre eyeloup de mise à niveau vers la dernière version, assurez-vous d'exécuter les commandes suivantes:

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

Q / A

Pourquoi l'heure de la demande n'est pas la même sur le rack-mini-profil?

Eyeloupe n'est pas un outil axé sur les performances, le temps de demande est le même que vous pouvez afficher dans le journal des rails. Si vous voulez plus de détails sur votre temps de chargement, vous pouvez utiliser Rack-Mini-Profiler avec Eyeloup.

Est-ce le télescope Laravel pour les rails?

Oui, Eyeloup est inspiré du télescope Laravel. Beaucoup de gens venant de Laravel manquent un télescope ou recherchent quelque chose de similaire, donc Eyeloup est là pour combler cette lacune.

Contributif

Les contributions sont ce qui fait de la communauté open source un endroit incroyable pour apprendre, inspirer et créer. Toutes les contributions que vous faites sont grandement appréciées .

Si vous avez une suggestion qui améliorerait cela, veuillez débarquer le dépôt et créer une demande de traction. Vous pouvez également ouvrir simplement un problème avec la balise "amélioration". N'oubliez pas de donner une étoile au projet! Merci encore!

1. Fourk le projet
2. Créez votre succursale de fonctionnalité ( git checkout -b feature/amazing_feature )
3. Commissez vos modifications ( git commit -m 'Add some amazing feature' )
4. Push to the Branch ( git push origin feature/amazing_feature )
5. Ouvrir une demande de traction

Licence

Le GEM est disponible en open source en vertu des termes de la licence du MIT.

Contact

Lien du projet: https://github.com/alxlion/eyeloup