Rack::Bug Code Climate

• Repositorio: http://github.com/brynary/rack-bug

Descripción

Rack::Bug añade una barra de herramientas de diagnóstico a las aplicaciones Rack. Cuando está habilitada, inyecta un div flotante que permite explorar el registro, las consultas a la base de datos, los tiempos de renderizado de plantillas, etc.

Características

• Seguridad basada en contraseña
• Seguridad basada en IP
• La instrumentación/reporte de Rack::Bug está dividido en paneles.
  • Paneles en la configuración por defecto:
    • Información de Rails
    • Temporizador
    • Variables de Solicitud
    • SQL
    • Active Record
    • Caché
    • Plantillas
    • Registro
    • Memoria
  • Otros paneles incluidos:
    • Redis
    • Sphinx
  • La API para agregar tus propios paneles es simple y potente

Inicio rápido con Rails

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

En config/environments/development.rb, añade:

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

Añade el bookmarklet a tu navegador:

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

Uso con aplicaciones Rack que no son Rails

Simplemente usa 'use Rack::Bug' como cualquier otro middleware. Consulta la aplicación SampleApp en la carpeta spec/fixtures para un ejemplo de aplicación Sinatra.

Si deseas usar el panel de registro, define la constante LOGGER como un Logger de Ruby o ActiveSupport::BufferedLogger

Configuración de paneles personalizados

Especifica el conjunto de paneles que deseas, en el orden en que quieres que aparezcan:

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
  ]

Ejecutar Rack::Bug en staging o producción

Hemos encontrado que Rack::Bug es lo suficientemente rápido como para ejecutarse en producción para esfuerzos específicos de resolución de problemas.

Configuración

Añade la configuración del middleware a un inicializador o a los archivos de entorno apropiados, teniendo en cuenta el resto de esta sección.

Seguridad

Restringe el acceso a direcciones IP específicas:

require "ipaddr"

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

Restringe el acceso mediante una contraseña:

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

Autores

• Mantenido por Bryan Helmkamp
• Contribuciones de Luke Melia, Joey Aghion, Tim Connor y más.

Agradecimientos

La inspiración para Rack::Bug proviene principalmente de la barra de herramientas de depuración de Django. Ideas adicionales de Rails footnotes, el middleware ShowException de Rack, Oink y Rack::Cache

Gracias a Weplay.com por apoyar el desarrollo de Rack::Bug

Desarrollo

Para el desarrollo, necesitarás instalar las siguientes gemas: rspec, rack-test, webrat, sinatra

Licencia

Consulta MIT-LICENSE.txt en este directorio.