eyeloupe

Proyek tidak lagi di bawah pengembangan aktif - mencari kontributor baru

Eyeloupe

Asisten Debug Rails Elegan. Ai bertenaga.
Laporkan Bug · Fitur Permintaan

Eyeloupe adalah asisten debug Rails yang elegan. Ini membantu Anda untuk men -debug aplikasi rel Anda dengan menyediakan antarmuka yang sederhana dan elegan untuk melihat permintaan dan pengecualian Anda yang masuk/keluar, ditenagai oleh AI.

Instalasi

Tambahkan baris ini ke gemfile aplikasi Anda:

 gem "eyeloupe"

Dan kemudian mengeksekusi:

$ bundle

Pasang migrasi eyeloupe ke dalam proyek Anda:

$ rails eyeloupe:install:migrations

Dan menjalankan migrasi:

$ rails db:migrate

Untuk mengakses dasbor eyeloupe, Anda perlu menambahkan rute berikut ke file config/routes.rb Anda:

 mount Eyeloupe :: Engine => "/eyeloupe" 

Konfigurasi

Ini adalah contoh konfigurasi yang dapat Anda tambahkan ke file initializers/eyeloupe.rb Anda:

 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 adalah array jalur yang ingin Anda kecualikan dari eyeloupe capture. Eyeloupe menambahkan jalur yang dikecualikan ini ke yang default: %w[mini-profiler eyeloupe active_storage]
• capture adalah boolean untuk mengaktifkan/menonaktifkan penangkapan eyeloupe. Secara default, itu diatur ke true .
• openai_access_key adalah kunci akses untuk menggunakan API OpenAI. Anda bisa mendapatkannya di sini.
• openai_model adalah model untuk digunakan untuk API OpenAI. Anda dapat menemukan daftar model yang tersedia di sini.
• database adalah eyeloupe konfigurasi basis data opsional yang akan digunakan (database).

Database

Secara default, eyeloupe menggunakan database yang sama dengan aplikasi Anda. Jika Anda ingin menggunakan database yang berbeda untuk menjaga lingkungan produksi Anda tetap bersih, Anda dapat menambahkan konfigurasi database baru di file config/database.yml Anda:

 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

Menggunakan ini Anda dapat melewatkan eyeloupe:install:migrations Langkah, tetapi jangan lupa untuk menjalankan rails db:migrate RAILS_ENV=eyeloupe untuk mengatur database.

Penanganan pengecualian

Untuk dapat menangani pengecualian, pastikan untuk menonaktifkan penanganan pengecualian rel default di file konfigurasi lingkungan Anda (misalnya config/environments/development.rb ):

 config . consider_all_requests_local = false 

Penggunaan

Eyeloupe dikembangkan secara eksklusif untuk kerangka kerja rel.

Anda dapat menggunakannya di lingkungan pengembangan Anda untuk men -debug aplikasi Anda tetapi tidak disarankan untuk menggunakannya dalam produksi.

Auto-Refresh

Dengan mengaktifkan Auto-Fresh, setiap 3 detik halaman akan disegarkan untuk menunjukkan kepada Anda data terbaru.

Hapus semua data

Anda dapat menghapus semua data yang disimpan oleh eyeloupe dengan mengklik tombol sampah.

Asisten ai

Saat Anda mendefinisikan kunci akses OpenAI dalam konfigurasi, Anda dapat melihat bagian baru di halaman Detail Pengecualian. Bagian ini ditenagai oleh API Openai dan dapat memberi Anda solusi untuk menyelesaikan pengecualian Anda. Ini mengirimkan seluruh konten file yang berisi pengecualian untuk memiliki jawaban terbaik untuk masalah Anda.

Meningkatkan

Saat eyeloupe upgrade Anda ke versi terbaru, pastikan untuk menjalankan perintah berikut:

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

Q/a

Mengapa waktu permintaan tidak sama pada rack-mini-profiler?

Eyeloupe bukan alat yang berorientasi pada kinerja, waktu permintaannya sama dengan yang dapat Anda lihat di log rel. Jika Anda ingin detail lebih lanjut tentang waktu pemuatan Anda, Anda dapat menggunakan profiler rack-mini bersama dengan eyeloupe.

Apakah ini teleskop Laravel untuk rel?

Ya, eyeloupe terinspirasi oleh Laravel Telescope. Banyak orang yang datang dari Laravel kehilangan teleskop atau mencari sesuatu yang serupa, jadi eyeloupe ada di sini untuk mengisi celah ini.

Berkontribusi

Kontribusi adalah apa yang membuat komunitas open-source menjadi tempat yang luar biasa untuk belajar, menginspirasi, dan menciptakan. Kontribusi apa pun yang Anda buat sangat dihargai .

Jika Anda memiliki saran yang akan membuat ini lebih baik, silakan garukan repo dan buat permintaan tarik. Anda juga bisa membuka masalah dengan tag "peningkatan". Jangan lupa memberi proyek bintang! Terima kasih lagi!

1. Garpu proyek
2. Buat Cabang Fitur Anda ( git checkout -b feature/amazing_feature )
3. Komit perubahan Anda ( git commit -m 'Add some amazing feature' )
4. Dorong ke Cabang ( git push origin feature/amazing_feature )
5. Buka permintaan tarik

Lisensi

Permata tersedia sebagai open source di bawah ketentuan lisensi MIT.

Kontak

Tautan Proyek: https://github.com/alxlion/eyeloupe