peek / peek-rblineprof

Peek into how much each line of your Rails application takes throughout a request.

Peek::Rblineprof

Peek into how much time each line of your Rails application takes throughout a request.

Things this peek view provides:

• Total time it takes to render individual lines within your codebase
• Total network time spent waiting per line

You can also drill down to only certain parts of your codebase like:

• app, everything within Rails.root/(app|lib)
• views, everything within Rails.root/app/view
• gems, everything within Rails.root/vendor/gems
• all, everything within Rails.root
• stdlib

Installation

Add this line to your application's Gemfile:

gem 'peek-rblineprof'

And then execute:

$ bundle

Or install it yourself as:

$ gem install peek-rblineprof

Usage

Add the following to your config/initializers/peek.rb:

Peek.into Peek::Views::Rblineprof

You'll then need to add the following CSS and CoffeeScript:

CSS:

//= require peek
//= require peek/views/rblineprof

CoffeeScript:

#= require peek
#= require peek/views/rblineprof

Integration with pygments.rb

By default peek-rblineprof renders the code of each file in plain text with no syntax highlighting for performance reasons. If you'd like to have your code highlighted as it does on GitHub.com, just include the pygments.rb gem:

gem 'pygments.rb', :require => false

peek-rblineprof will now highlight each file for you, but there's one more thing...

To use the default theme that peek-rblineprof provides just add the following to your peek specific or application stylesheet:

//= require peek/views/rblineprof/pygments

That's it! Now your code will look ✨

Contributors

• @tmm1 for rblineprof
• @dewski for this

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

peek-rblineprof's Issues

Error on startup

When adding and trying to fire up a rails app I get:

/Users/ccunningham/.rvm/gems/ruby-1.9.3-p385/gems/peek-rblineprof-0.1.0/lib/peek/views/rblineprof.rb:5:in `module:Views': uninitialized constant Peek::Views::View (NameError)

Indeed it's trying to subclass a View but I'm not entirely sure what class it's trying to subclass in there...

Error on startup

rails s
=> Booting Thin
=> Rails 4.0.0 application starting in development on http://0.0.0.0:3000
=> Run `rails server -h` for more startup options
=> Ctrl-C to shutdown server
Exiting
/Users/nico/Rails/new_yousty/yousty/config/initializers/peek.rb:1:in `<top (required)>': undefined method `into' for Peek:Module (NoMethodError)

Feature request: close or hide button

A simple (x) close button for hiding the overlays would be great. Right now they stay on top and I have no way to close them except doing a refresh of the page. When using pjax they also sometimes stay open on the next request or showing double ... old and new request windows will show on top of each other ...

Incorrect line profiling in views

First of all, thanks for the effort in this gem.

Take a look at the following SS:

I'll try to describe what I think the incorrect behavior is (please look at the number on SS):

• There's no ruby on (1) (doctype), (2) (meta viewport) and (3) (link rel manifest), so I don't get why there's profiling there
• On (4), there's ruby but there's no profiling;
• On (5) and (6), there's ruby but it's a comment, unlikely it's taking all that time;
• On (7), it shows it took 186 ms to render the csrf_meta_tag, which is unlikely; it also shows it took 0 ms to render the previous line (the stylesheet include), which was the culprit (as I show below).

So, to test, I removed the csrf_tag, and it showed that huge time in the next line (not the previous one) ... If I keep removing them, you'll see that huge time assigned to a line that has no ruby on it:

I wondered if everything was just offset by one line but it's irregular, as you can check if you analyze line by line.

In controllers profilling this does not seem to happen.

Output/display error when Pygments isn't present

If pygments.rb isn't present then the output isn't readable/correct; it appears to be partially rendering the file content into the page as actual markup, triggering JavaScript events, malformed Ajax calls, and the like. You can see in the image below that the top-level <html> tags aren't displaying as part of the escaped layout in the right panel.

I wasn't seeing an interesting backtrace, but the error was consistent on every request. I wound up just adding pygments to get highlighted output. If you'd like help gathering more useful debugging data, let me know and I'll play around without pygments enabled again.

Allow to specify custom classes for the 'code' element

It would be great to be able to set custom classes for the 'code' element.

For instance, in our case, we'd like to set the white class to define the highlighting theme.

Modal never displays

I believe I have correctly installed peek-rblineprof into my Rails app (it's a rails 3.2 app) and I also installed pygments and the other related gems since other issues mentioned that that can prevent the gem from working.

The JS and CSS are in my app, but the peek element never ends up in the DOM and nothing ever appears.

I have verified that the initializer is indeed loading, but I'm not really sure what I should do to troubleshoot further. Any ideas?