eyeloupe

Projeto que não está mais em desenvolvimento ativo - procurando novos colaboradores

Eyeloupe

O elegante assistente de depuração do Rails. AI alimentada.
Relatório Bug · Recurso de solicitação

Eyeloupe é o elegante assistente de depuração do Rails. Ajuda você a depurar seu aplicativo Rails, fornecendo uma interface simples e elegante para visualizar suas solicitações e exceções recebidas/enviadas, alimentadas pela IA.

Instalação

Adicione esta linha ao GemFile do seu aplicativo:

 gem "eyeloupe"

E depois execute:

$ bundle

Instale as migrações do Eyeloupe para o seu projeto:

$ rails eyeloupe:install:migrations

E executar as migrações:

$ rails db:migrate

Para acessar o painel do Eyeloupe, você precisa adicionar a seguinte rota ao seu arquivo config/routes.rb :

 mount Eyeloupe :: Engine => "/eyeloupe" 

Configuração

Este é um exemplo da configuração que você pode adicionar aos seus initializers/eyeloupe.rb File:

 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 é uma variedade de caminhos que você deseja excluir da captura do Eyeloupe. O Eyeloupe adiciona esses caminhos excluídos aos padrão: %w[mini-profiler eyeloupe active_storage]
• capture é um booleano para ativar/desativar a captura do Eyeloupe. Por padrão, ele está definido como true .
• openai_access_key é a chave de acesso para usar a API OpenAI. Você pode conseguir um aqui.
• openai_model é o modelo a ser usado para a API OpenAI. Você pode encontrar a lista de modelos disponíveis aqui.
• database é um Eyeloupe Opcional Database Config usará (banco de dados).

Banco de dados

Por padrão, o Eyeloupe usa o mesmo banco de dados que o seu aplicativo. Se você deseja usar um banco de dados diferente para manter seu ambiente de produção limpo, poderá adicionar uma nova configuração de banco de dados no seu arquivo 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 isso, você pode pular o eyeloupe:install:migrations , mas não se esqueça de executar rails db:migrate RAILS_ENV=eyeloupe para configurar o banco de dados.

Manuseio de exceção

Para ser capaz de lidar com exceções, não se esqueça de desativar o manuseio de exceção do Rails padrão em seu arquivo de configuração de ambiente (por exemplo config/environments/development.rb ):

 config . consider_all_requests_local = false 

Uso

O Eyeloupe é desenvolvido exclusivamente para a estrutura do Rails.

Você pode usá -lo em seu ambiente de desenvolvimento para depurar seu aplicativo, mas não é recomendável usá -lo na produção.

Refrescamento automático

Ao ativar o frescura automático, a cada 3 segundos a página será atualizada para mostrar os dados mais recentes.

Exclua todos os dados

Você pode excluir todos os dados armazenados pelo Eyeloupe clicando no botão de lixo.

Assistente de IA

Quando você define uma chave de acesso do OpenAI na configuração, você pode ver uma nova seção na página de detalhes da exceção. Esta seção é alimentada pela API OpenAI e é capaz de fornecer uma solução para resolver sua exceção. Ele envia todo o conteúdo do arquivo que contém a exceção para ter a melhor resposta para o seu problema.

Atualizar

Quando o seu Eyeloupe de atualização para a versão mais recente, não deixe de executar os seguintes comandos:

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

Q/a

Por que o tempo de solicitação não é o mesmo no Rack-Mini-Profiler?

O Eyeloupe não é uma ferramenta orientada para o desempenho, o tempo de solicitação é o mesmo que você pode visualizar no log do Rails. Se você quiser mais detalhes sobre o seu tempo de carregamento, pode usar o Rack-Mini-Profiler junto com o Eyeloupe.

Este é o telescópio de Laravel para trilhos?

Sim, o Eyeloupe é inspirado no telescópio Laravel. Muitas pessoas provenientes de Laravel estão faltando telescópio ou procurando algo semelhante, então o Eyeloupe está aqui para preencher essa lacuna.

Contribuindo

As contribuições são o que torna a comunidade de código aberto um lugar tão incrível para aprender, inspirar e criar. Quaisquer contribuições que você faz são muito apreciadas .

Se você tiver uma sugestão que melhoraria isso, bifór -l e crie uma solicitação de tração. Você também pode simplesmente abrir um problema com a tag "aprimoramento". Não se esqueça de dar uma estrela ao projeto! Obrigado novamente!

1. Bifurcar o projeto
2. Crie seu ramo de recursos ( git checkout -b feature/amazing_feature )
3. Compreenda suas mudanças ( git commit -m 'Add some amazing feature' )
4. Empurre para o ramo ( git push origin feature/amazing_feature )
5. Abra um pedido de tração

Licença

A GEM está disponível como código aberto nos termos da licença do MIT.

Contato

Link do projeto: https://github.com/alxlion/eyeloupe