Rack::Bug Code Climate

• Repositório: http://github.com/brynary/rack-bug

Descrição

O Rack::Bug adiciona uma barra de ferramentas de diagnóstico a aplicativos Rack. Quando ativado, ele injeta uma div flutuante que permite explorar logs, consultas ao banco de dados, tempos de renderização de templates, etc.

Funcionalidades

• Segurança baseada em senha
• Segurança baseada em IP
• A instrumentação/relatórios do Rack::Bug é dividida em painéis.
  • Painéis na configuração padrão:
    • Informações do Rails
    • Temporizador
    • Variáveis da Requisição
    • SQL
    • Active Record
    • Cache
    • Templates
    • Log
    • Memória
  • Outros painéis incluídos:
    • Redis
    • Sphinx
  • A API para adicionar seus próprios painéis é simples e poderosa

Início rápido no Rails

script/plugin install git://github.com/brynary/rack-bug.git

Em config/environments/development.rb, adicione:

config.middleware.use "Rack::Bug",
  :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"

Adicione o bookmarklet ao seu navegador:

open http://RAILS_APP/__rack_bug__/bookmarklet.html

Usando com aplicativos Rack que não são Rails

Apenas use 'Rack::Bug' como qualquer outro middleware. Consulte o SampleApp na pasta spec/fixtures para um exemplo de aplicativo Sinatra.

Se você deseja usar o painel de log, defina a constante LOGGER como um Logger ruby ou ActiveSupport::BufferedLogger

Configurando painéis personalizados

Especifique o conjunto de painéis desejado, na ordem em que deseja que apareçam:

require "rack/bug"

ActionController::Dispatcher.middleware.use Rack::Bug,
  :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
  :panel_classes => [
    Rack::Bug::TimerPanel,
    Rack::Bug::RequestVariablesPanel,
    Rack::Bug::RedisPanel,
    Rack::Bug::TemplatesPanel,
    Rack::Bug::LogPanel,
    Rack::Bug::MemoryPanel
  ]

Executando o Rack::Bug em staging ou produção

Descobrimos que o Rack::Bug é rápido o suficiente para ser executado em produção para esforços específicos de solução de problemas.

Configuração

Adicione a configuração do middleware a um inicializador ou aos arquivos de ambiente apropriados, levando em consideração o restante desta seção.

Segurança

Restrinja o acesso a endereços IP específicos:

require "ipaddr"

ActionController::Dispatcher.middleware.use "Rack::Bug"
  :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
  :ip_masks   => [IPAddr.new("2.2.2.2/0")]

Restrinja o acesso usando uma senha:

ActionController::Dispatcher.middleware.use "Rack::Bug",
  :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
  :password   => "yourpassword"

Autores

• Mantido por Bryan Helmkamp
• Contribuições de Luke Melia, Joey Aghion, Tim Connor e outros

Agradecimentos

A inspiração para o Rack::Bug veio principalmente da barra de ferramentas de depuração do Django. Ideias adicionais dos footnotes do Rails, middleware ShowException do Rack, Oink e Rack::Cache

Agradecemos à Weplay.com por apoiar o desenvolvimento do Rack::Bug

Desenvolvimento

Para desenvolvimento, você precisará instalar as seguintes gems: rspec, rack-test, webrat, sinatra

Licença

Consulte MIT-LICENSE.txt neste diretório.