A Rack profiler for web applications.
Ruby CSS HTML Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs
examples
lib/rack
spec
.editorconfig
.gitignore
.rspec
.rubocop.yml
.rubocop_todo.yml
.travis.yml
.yardopts
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
Guardfile
LICENSE
README.md
Rakefile
rack-webprofiler.gemspec

README.md

Rack WebProfiler

A Rack profiler for web application.

Version         Travis CI       Gitter

Installation

Add this line to your application's Gemfile:

gem "rack-webprofiler"

And then execute:

$ bundle

Or install it yourself as:

$ gem install rack-webprofiler

Usage

home = lambda { |_env|
  [200, { "Content-Type" => "text/html" }, ["<html><body>Hello world!</body></html>"]]
}

builder = Rack::Builder.new do
  use Rack::WebProfiler

  map('/') { run home }
end

run builder

Configuration

You can specify the temporary directory. It is used to save the SQlite database.

use Rack::WebProfiler, tmp_dir: File.expand_path("/tmp", __FILE__)

# OR

use Rack::WebProfiler.config do |c|
  c.tmp_dir = File.expand_path("/tmp", __FILE__)
end

Examples

See the examples.

Documentation

See the documentation.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

You can use bin/start-dev to run the example and test the library.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nicolas-brousse/rack-webprofiler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Contributors

License

The gem is available as open source under the terms of the MIT License.

Alternatives & comments

This project is in part inspired by the Symfony WebProfiler Bundle.