Rack::Bug Code Climate

リポジトリ: http://github.com/brynary/rack-bug

説明

Rack::BugはRackアプリケーションに診断ツールバーを追加します。有効にすると、ログ、データベースクエリ、テンプレートレンダリング時間などの探索を可能にする浮動divを挿入します。

機能

パスワードベースのセキュリティ
IPベースのセキュリティ
Rack::Bugの計測/レポートはパネルに分割されています。
- デフォルト設定のパネル:
  - Rails Info
  - Timer
  - Request Variables
  - SQL
  - Active Record
  - Cache
  - Templates
  - Log
  - Memory
- その他のバンドルパネル:
  - Redis
  - Sphinx
- 独自パネルを追加するためのAPIはシンプルかつ強力です

Railsクイックスタート

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

config/environments/development.rb に以下を追加します:

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

ブックマークレットをブラウザに追加します:

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

非Rails Rackアプリでの使用

他のミドルウェアと同様に 'use Rack::Bug' として使用します。Sinatraアプリの例については spec/fixtures フォルダ内の SampleApp を参照してください。

ロガーパネルを使用する場合は、ruby Logger または ActiveSupport::BufferedLogger である LOGGER 定数を定義してください。

カスタムパネルの設定

表示させたいパネルのセットを、表示順に指定します:

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
  ]

ステージング環境または本番環境でのRack::Bugの実行

特定のトラブルシューティング目的において、Rack::Bugは本番環境でも十分に高速であることがわかりました。

設定

このセクションの残りの部分を考慮して、ミドルウェアの設定をイニシャライザまたは適切な環境ファイルに追加します。

セキュリティ

特定のIPアドレスへのアクセスを制限:

require "ipaddr"

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

パスワードを使用してアクセスを制限:

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

著者

メンテナ: Bryan Helmkamp
コントリビューター: Luke Melia, Joey Aghion, Tim Connor 他

謝辞

Rack::Bugの着想は主にDjangoデバッグツールバーから得ました。追加のアイデアはRails footnotes、RackのShowExceptionミドルウェア、Oink、Rack::Cacheから得ました。

Rack::Bugの開発を支援してくれたWeplay.comに感謝します。

開発

開発には、以下のgemをインストールする必要があります: rspec, rack-test, webrat, sinatra

ライセンス

このディレクトリ内のMIT-LICENSE.txtを参照してください。

rack-bug

人気