Rack::Bug Code Climate

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

Beschreibung

Rack::Bug fügt Rack-Anwendungen eine Diagnose-Symbolleiste hinzu. Wenn aktiviert, fügt es ein schwebendes Div ein, das Einsicht in Logging, Datenbankabfragen, Rendering-Zeiten von Templates usw. ermöglicht.

Funktionen

• Passwortbasierte Sicherheit
• IP-basierte Sicherheit
• Rack::Bug Instrumentierung/Berichterstattung ist in Panels unterteilt.
  • Panels in der Standardkonfiguration:
    • Rails Info
    • Timer
    • Request-Variablen
    • SQL
    • Active Record
    • Cache
    • Templates
    • Log
    • Memory
  • Andere integrierte Panels:
    • Redis
    • Sphinx
  • Die API zum Hinzufügen eigener Panels ist einfach und leistungsstark

Rails-Schnellstart

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

In config/environments/development.rb fügen Sie hinzu:

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

Fügen Sie das Bookmarklet zu Ihrem Browser hinzu:

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

Verwendung mit Nicht-Rails-Rack-Anwendungen

Verwenden Sie einfach use Rack::Bug wie jede andere Middleware. Siehe die SampleApp im Verzeichnis spec/fixtures für eine Beispiel-Sinatra-Anwendung.

Wenn Sie das Logger-Panel verwenden möchten, definieren Sie die Konstante LOGGER, die ein Ruby Logger oder ActiveSupport::BufferedLogger ist.

Konfigurieren benutzerdefinierter Panels

Geben Sie die gewünschten Panels in der Reihenfolge an, in der sie erscheinen sollen:

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
  ]

Ausführen von Rack::Bug im Staging oder in der Produktion

Wir haben festgestellt, dass Rack::Bug schnell genug ist, um für spezifische Fehlerbehebungsmaßnahmen in der Produktion ausgeführt zu werden.

Konfiguration

Fügen Sie die Middleware-Konfiguration zu einem Initializer oder den entsprechenden Umgebungsdateien hinzu, unter Berücksichtigung des restlichen Abschnitts.

Sicherheit

Beschränken Sie den Zugriff auf bestimmte IP-Adressen:

require "ipaddr"

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

Beschränken Sie den Zugriff mithilfe eines Passworts:

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

Autoren

• Gepflegt von Bryan Helmkamp
• Beiträge von Luke Melia, Joey Aghion, Tim Connor und weiteren

Danksagungen

Die Inspiration für Rack::Bug stammt hauptsächlich von der Django Debug Toolbar. Weitere Ideen stammen von Rails Footnotes, Rack's ShowException Middleware, Oink und Rack::Cache

Dank an Weplay.com für die Unterstützung der Entwicklung von Rack::Bug

Entwicklung

Für die Entwicklung müssen Sie die folgenden Gems installieren: rspec, rack-test, webrat, sinatra

Lizenz

Siehe MIT-LICENSE.txt in diesem Verzeichnis.