sinatra-template_metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c7e73de0572c54c0ef012af529fc6ef3662bfdc
+  data.tar.gz: 2837eade7f9343e1d13d50caa50b4c7ed07cf959
+SHA512:
+  metadata.gz: bde76776ae623c3aed5dd1960bb0702a355d7efde2c637f985b117c9f4bbbcaf62020093d2abf99447454003ac4a423b01ca0bbc2a609d661eacb3629e94b2c3
+  data.tar.gz: 0a21aea3850d0193509d2132420b0c1e73cfadf85cc4ce6392c8813005ad260e419b6162d0873536b102f95233b2389383aed5578b13856c39d1df695dd332b1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-metrics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 sonots
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Sinatra::TemplateMetrics
+
+Instrument sinatra template rendering
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-template_metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-metrics
+
+## Usage
+
+Just require `sinatra/template_metrics` in addition to `sinatra/base` as:
+
+```ruby
+require 'sinatra/base'
+require 'sinatra-template_metrics'
+
+class App < Sinatra::Base
+  get '/' do
+    erb :index, layout: :base
+  end
+end
+```
+
+This will show you the measure time to render erb as:
+
+```
+time:2014-11-02T02:39:50+09:00     template:index  layout:base     elapsed:0.002839445
+```
+
+where `elapsed` is the elapsed time in seconds.
+
+## See also
+
+* [rack-ltsv_logger](https://github.com/sonots/rack-ltsv_logger) (or `enable :logging`) is useful to instrument http request.
+* [mysql2-metrics](https://github.com/sonots/mysql2-metrics) is useful to instrument mysql2 queries. 
+
+## Contributing
+
+1. Fork it ( https://github.com/sonots/sinatra-metrics/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/example/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "sinatra"
+gem "unicorn"
+gem "foreman"
+gem "sinatra-template_metrics", path: '../'
+gem 'pry'
+gem 'pry-nav'

data/example/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: ../
+  specs:
+    sinatra-template_metrics (0.0.1)
+      sinatra
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    dotenv (0.11.1)
+      dotenv-deployment (~> 0.0.2)
+    dotenv-deployment (0.0.2)
+    foreman (0.75.0)
+      dotenv (~> 0.11.1)
+      thor (~> 0.19.1)
+    kgio (2.9.2)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    raindrops (0.13.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.6.0)
+    thor (0.19.1)
+    tilt (1.4.1)
+    unicorn (4.8.3)
+      kgio (~> 2.6)
+      rack
+      raindrops (~> 0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  foreman
+  pry
+  pry-nav
+  sinatra
+  sinatra-template_metrics!
+  unicorn

data/example/Procfile

@@ -0,0 +1 @@
+unicorn: bundle exec unicorn -c unicorn_config.rb -p 8080

data/example/app.rb

@@ -0,0 +1,8 @@
+require 'sinatra/base'
+require 'sinatra/template_metrics'
+
+class App < Sinatra::Base
+  get '/' do
+    erb :index, layout: :base
+  end
+end

data/example/config.ru

@@ -0,0 +1,3 @@
+require_relative './app.rb'
+
+run App

data/example/unicorn_config.rb

@@ -0,0 +1,2 @@
+worker_processes 1
+preload_app true

data/example/views/base.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<% title ||= 'test' %>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <link rel="stylesheet" href="/stylesheets/bootstrap.min.css">
+    <link rel="stylesheet" href="/stylesheets/bootflat.min.css">
+    <link rel="stylesheet" href="/stylesheets/isucon-bank.css">
+    <title><%= title %></title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/example/views/index.erb

@@ -0,0 +1,7 @@
+<div class="page-header">
+  <h1>Yay!</h1>
+</div>
+
+<div class="container">
+  hello world
+</div>

data/lib/sinatra-template_metrics.rb

@@ -0,0 +1 @@
+require 'sinatra/template_metrics'

data/lib/sinatra/template_metrics.rb

@@ -0,0 +1,60 @@
+require 'sinatra/template_metrics/ltsv_formatter'
+require 'logger'
+
+module Sinatra
+  class TemplateMetrics
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.logger
+      @logger ||= Logger.new(STDOUT).tap {|log|
+        log.formatter = ::Sinatra::Metrics::LtsvFormatter.new
+      }
+    end
+
+    def self.add_tracer(method)
+      klass = ::Sinatra::Templates
+      unless klass.method_defined?("#{method}_without_metrics")
+        klass.__send__(:alias_method, "#{method}_without_metrics", method)
+        klass.__send__(:define_method, "#{method}_with_metrics") do |template, options = {}, locals = {}, &block|
+        ::Sinatra::TemplateMetrics.measure_time(template, options[:layout]) do
+          send("#{method}_without_metrics", template, options, locals, &block)
+        end
+        end
+        klass.__send__(:alias_method, method, "#{method}_with_metrics")
+      end
+    end
+
+    def self.measure_time(template, layout, &block)
+      start = Time.now
+      ret = yield
+      elapsed = Time.now - start
+      logger = Sinatra::TemplateMetrics.logger
+      logger.info({ template: template, layout: layout, elapsed: elapsed.to_f })
+      ret
+    end
+  end
+end
+
+# open class
+module Sinatra
+  module Templates
+    # add_tracer :render was not good because it is called for layout also
+    ::Sinatra::TemplateMetrics.add_tracer :erb
+    ::Sinatra::TemplateMetrics.add_tracer :erubis
+    ::Sinatra::TemplateMetrics.add_tracer :haml
+    ::Sinatra::TemplateMetrics.add_tracer :sass
+    ::Sinatra::TemplateMetrics.add_tracer :scss
+    ::Sinatra::TemplateMetrics.add_tracer :less
+    ::Sinatra::TemplateMetrics.add_tracer :stylus
+    ::Sinatra::TemplateMetrics.add_tracer :less
+    ::Sinatra::TemplateMetrics.add_tracer :builder
+    ::Sinatra::TemplateMetrics.add_tracer :liquid
+    ::Sinatra::TemplateMetrics.add_tracer :markdown
+    ::Sinatra::TemplateMetrics.add_tracer :textile
+    ::Sinatra::TemplateMetrics.add_tracer :rdoc
+    ::Sinatra::TemplateMetrics.add_tracer :slim
+  end
+end
+

data/lib/sinatra/template_metrics/ltsv_formatter.rb

@@ -0,0 +1,15 @@
+module Sinatra
+  class Metrics
+    class LtsvFormatter
+      def call(severity, datetime, progname, msg)
+        "time:#{datetime.iso8601}\t#{format_msg(msg)}\n"
+      end
+
+      private
+
+      def format_msg(msg)
+        msg.map {|k, v| "#{k}:#{v}" }.join("\t")
+      end
+    end
+  end
+end

data/sinatra-template_metrics.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-template_metrics"
+  spec.version       = "0.0.1"
+  spec.authors       = ["sonots"]
+  spec.email         = ["sonots@gmail.com"]
+  spec.summary       = %q{Instrument sinatra template rendering}
+  spec.description   = %q{Instrument sinatra template rendering}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "sinatra"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-template_metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sonots
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Instrument sinatra template rendering
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/Gemfile.lock
+- example/Procfile
+- example/app.rb
+- example/config.ru
+- example/unicorn_config.rb
+- example/views/base.erb
+- example/views/index.erb
+- lib/sinatra-template_metrics.rb
+- lib/sinatra/template_metrics.rb
+- lib/sinatra/template_metrics/ltsv_formatter.rb
+- sinatra-template_metrics.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Instrument sinatra template rendering
+test_files: []