x_runtime 0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://ruby.taobao.org"
+gem 'rack'
+gem 'rake'
+gem 'jeweler'
+gem 'active_support'
+gem 'redis', '~>3.0.1'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://ruby.taobao.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (3.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  jeweler
+  rack
+  rake
+  redis (~> 3.0.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 崔峥
+
+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.markdown

@@ -0,0 +1,76 @@
+# x_runtime
+
+XRuntime是一个Rack的middleware,配合Redis用来分析Http Server每个URI请求时长.    
+由于使用到Redis的**lua script**,所以需要你的Redis服务支持.
+
+版本要求:
+* redis-server版本>2.6.x
+* redis(ruby gem)>3.0.1
+
+在Redis中，对每一个URI记录了以下信息:
+* 请求总数
+* 总共请求时间
+* 最近一次请求时间
+* 平均请求时间
+
+## Portal
+
+可以访问Http Server的这个URL来实时查看当前记录的请求:[/xruntime](/xruntime)    
+这个页面是按照每个URI数次执行后的平均时间来排序的。
+
+## Usage
+
+引入这个middleware需要两个参数:
+
+1. threshold,表示处理时间超过多少毫秒的请求才会被记录
+2. redis对象
+
+可以指定XRuntime使用的Redis的key前缀或者叫命名空间:    
+`XRuntime::NameSpace = "RuntimeEx::Threshold"`
+
+### Sinatra
+
+    use Rack::XRuntime, 100, Redis.connect(:url => "redis://localhost:6380/")
+
+### Rails3
+
+    # config/environment.rb
+    config.middleware.insert_after Rack::Runtime, Rack::XRuntime, 100, Redis.connect(:url => "redis://localhost:6380/")
+
+### Test
+
+请先修改test/server.rb和test/client.rb中的Redis参数,我的地址是localhost:6380,这个请改为你的地址。
+
+* 先启动服务 `ruby test/server.rb`
+* 再产生测试数据 `ruby test/client.rb`
+	
+执行完毕后可以打开浏览器访问[/xruntime](http://localhost:4567/xruntime),看是否已经准确的记录了一些数据
+
+## Redis Lua Script
+
+redis-server的版本要大于2.6.0才会支持lua script,    
+可以使用__script__系列命令来测试服务端是否支持
+
+启动__redis-cli__
+
+    redis 127.0.0.1:6380> SCRIPT LOAD "local key = KEYS[1];local path = tonumber(ARGV[1]);redis.call('set',key, path)"
+    "dab89791b5a512390f69e1f59eb1753f671b6649"
+    redis 127.0.0.1:6380> evalsha dab89791b5a512390f69e1f59eb1753f671b6649 1 hahaha 123456789
+    redis 127.0.0.1:6380> get hahaha
+    "123456789"
+
+## Contributing to x_runtime
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 崔峥. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "x_runtime"
+  gem.homepage = "http://github.com/charlescui/x_runtime"
+  gem.license = "MIT"
+  gem.summary = %Q{XRuntime是一个Rack的middleware,配合Redis用来分析Http Server每个URI请求时长}
+  gem.description = %Q{由于使用到Redis的lua script,所以需要你的Redis服务支持,redis-server版本>2.6.x,redis(ruby gem)>3.0.1.}
+  gem.email = "zheng.cuizh@gmail.com"
+  gem.authors = ["崔峥"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "x_runtime #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/x_runtime/array.rb

@@ -0,0 +1,15 @@
+class Array
+  def to_hash
+    _hashify.call(self)
+  end
+  
+  def _hashify
+    lambda { |array|
+      hash = Hash.new
+      array.each_slice(2) do |field, value|
+        hash[field] = value
+      end
+      hash
+    }
+  end
+end

data/lib/x_runtime/data_set.rb

@@ -0,0 +1,46 @@
+module XRuntime
+  class DataSet
+    
+    def initialize(key, script)
+      raise ArgumentError, "Script must not nil and be valid!" unless script
+      @key = key
+      @key_counter = "#{@key}::Counter"
+      @key_amount = "#{@key}::Amount"
+      @key_average = "#{@key}::Average"
+      @script = script
+    end
+    
+    # {key => {:score => score, :count => count, :average => average}}
+    def latest(opts = {})
+      opts.delete_if{|k,v| v == nil}
+      opts = {:limit => 100, :offset => 0}.update(opts)
+      data = {}
+      key_average = @script.redis
+      .zrevrangebyscore(@key_average, '+inf', '-inf', :limit => [opts[:offset], opts[:limit]], :withscores => true)
+      .inject({}){|hash, array|hash[array[0]] = array[1]; hash}
+
+      if key_average.size > 0
+        key_count = {}
+        keys = key_average.keys
+        @script.redis.hmget(@key_counter, *key_average.keys).each_with_index{|count, idx| key_count[keys[idx]] = count}
+
+        key_average.keys.each do |key|
+          data[key] = {
+            :latest => @script.redis.zscore(@key, key),
+            :count => key_count[key],
+            :average => key_average[key]
+          }
+        end
+      end
+      data
+    end
+    
+    def size
+      @script.redis.zcard(@key)
+    end
+    
+    def add(member, score)
+      @script.evalsha([@key], [member, score])
+    end
+  end#end of DataSet
+end

data/lib/x_runtime/middleware.rb

@@ -0,0 +1,56 @@
+module XRuntime
+  class Middleware
+    # threshold => ms
+    def initialize(app, threshold, redis)
+      @app = app
+      @threshold = threshold.to_f
+      @redis = redis
+    end
+    
+    def ds
+      @@ds ||= DataSet.new(redis_key, script)
+    end
+    
+    def script
+      @@script ||= Script.new(@redis)
+    end
+
+    def call(env)
+      status, headers, body = nil
+    
+      if env['REQUEST_PATH'] == "/xruntime"
+        status, headers, body = call_portal(env)
+      else
+        status, headers, body = call_app(env)
+      end
+
+      [status, headers, body]
+    end
+  
+    def call_app(env)
+      start_time = Time.now
+      status, headers, body = @app.call(env)
+      request_time = (Time.now - start_time).to_f*1000
+
+      if request_time >= @threshold
+        logredis(request_time, env['REQUEST_URI']) rescue nil
+      end
+    
+      [status, headers, body]
+    end
+  
+    def call_portal(env)
+      @req = Rack::Request.new(env)
+      [200, {}, [Template.new(ds, :limit => (@req.params["limit"] ? @req.params["limit"].to_i : 20), :offset => @req.params["offset"].to_i).render]]
+    end
+    
+    def logredis(cost,uri)
+      ds.add(uri, cost)
+    end
+  
+    def redis_key
+      @key ||= "#{XRuntime::NameSpace}::#{@threshold}"
+    end
+  
+  end#end of Middleware
+end

data/lib/x_runtime/redis.lua

@@ -0,0 +1,17 @@
+local path = ARGV[1];
+local score = tonumber(ARGV[2])
+local key = KEYS[1]
+local key_counter = string.format("%s::Counter",key)
+local key_amount = string.format("%s::Amount",key)
+local key_average = string.format("%s::Average",key)
+
+-- 记录最新一次请求的耗时
+redis.call('zadd',key,score,path)
+-- 记录某个path的请求次数
+redis.call('hincrby',key_counter,path,1)
+-- 记录某个path的请求总时长
+redis.call('hincrbyfloat',key_amount,path,score)
+-- 记录某个path的平均时长
+local average = tonumber(redis.call('hget',key_amount,path))/tonumber(redis.call('hget',key_counter,path))
+redis.call('zadd',key_average,average,path)
+return average

data/lib/x_runtime/script.rb

@@ -0,0 +1,23 @@
+module XRuntime
+  class Script
+    attr_accessor :redis
+    
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def content
+      @script ||= IO.read(::File.join(::File.dirname(__FILE__),'redis.lua'))
+    end
+    
+    def sha
+      # 加载脚本 redis-server会将该脚本缓存起来
+      @sha ||= @redis.script(:load, content)
+    end
+    
+    def evalsha(keys, argv)
+      @redis.evalsha(sha, :keys => keys, :argv => argv)
+    end
+    
+  end
+end

data/lib/x_runtime/template.erb

@@ -0,0 +1,43 @@
+<html>
+  <head>
+  	<title>XRuntime</title>
+  </head>
+  <body>
+  	<table>
+    <tr>
+      <td>#</td>
+  		<td>Last</td>
+  		<td>URI</td>
+  		<td>Count</td>
+  		<td>Average</td>
+	  </tr>
+    <% num = 0 %>
+  		<% @data.each do |member, hash| %>
+        <% num +=1 %>
+      		<tr>
+            <td><%= num %></td>
+      			<td><%= hash[:latest] %>ms</td>
+      			<td><a href=<%= member %>><%= member %></a></td>
+      			<td><%= hash[:count]%></td>
+      			<td><%= hash[:average]%></td>
+      		</tr>
+  		<% end %>
+    <% num = nil %>
+  	</table>
+    <br/>
+    <br/>
+    <div>
+    <% if @offset - @limit < 0 %>
+      Prev
+    <% else %>
+      <a href="/xruntime?offset=<%=[@offset - @limit, 0].max%>&limit=<%=@limit%>">Prev</a>
+    <% end %>
+    &nbsp-&nbsp-&nbsp
+    <% if @offset + @limit >= @ds.size %>
+      Next
+    <% else %>
+      <a href="/xruntime?offset=<%=[@offset + @limit, @ds.size].min%>&limit=<%=@limit%>">Next</a>
+    <% end %>
+    </div>
+  </body>
+</html>

data/lib/x_runtime/template.rb

@@ -0,0 +1,24 @@
+module XRuntime
+  class Template
+    def initialize(ds, opts={})
+      opts.delete_if{|k,v| v == nil}
+      opts = {:limit => 100, :offset => 0}.update(opts)
+      @ds = ds
+      @offset = opts[:offset]
+      @limit = opts[:limit]
+      @data = @ds.latest(:limit => opts[:limit], :offset => opts[:offset])
+    end
+    
+    def render
+      Template.erb.result(binding)
+    end
+    
+    def self.erb
+      @erb ||= ERB.new(self.html)
+    end
+    
+    def self.html
+      @html ||= IO.read(File.join(File.dirname(__FILE__),'template.erb'))
+    end
+  end#end of Template
+end

data/lib/x_runtime/utils.rb

@@ -0,0 +1,4 @@
+module XRuntime
+  module Utils
+  end
+end

data/lib/x_runtime.rb

@@ -0,0 +1,23 @@
+require "pp"
+require "rack"
+require "redis"
+require "digest"
+require "fileutils"
+
+require_relative "x_runtime/array"
+
+$:.unshift(File.dirname(__FILE__))
+
+module XRuntime
+  NameSpace = "RuntimeEx::Threshold"
+end
+
+XRuntime.autoload :Middleware, "x_runtime/middleware"
+XRuntime.autoload :DataSet,    "x_runtime/data_set"
+XRuntime.autoload :Script,     "x_runtime/script"
+XRuntime.autoload :Template,   "x_runtime/template"
+XRuntime.autoload :Utils,      "x_runtime/utils"
+
+module Rack
+  XRuntime = XRuntime::Middleware
+end

data/test/client.rb

@@ -0,0 +1,12 @@
+def alpha
+  # @@alpha ||= ('a'..'z').to_a | ('A'..'Z').to_a | ('0'..'9').to_a
+  @@alpha ||= ('a'..'z').to_a
+end
+
+def rand_url(size=1)
+  "http://localhost:4567/#{(1..size).to_a.inject(''){|s,t|s+=alpha[rand(alpha.size-1)].to_s}}"
+end
+
+100.times do
+  `curl "#{rand_url}" >/dev/null 2>&1`
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'x_runtime'
+
+class Test::Unit::TestCase
+end

data/test/server.rb

@@ -0,0 +1,12 @@
+require "sinatra"
+require_relative "../lib/x_runtime"
+
+# redis-server version must > 2.6.0 for lua script.
+# use XRuntime::Middleware, 10, Redis.connect(:url => "redis://localhost:6380/")
+use Rack::XRuntime, 10, Redis.connect(:url => "redis://localhost:6380/")
+
+get /.*/ do
+  # sleep(1)
+  sleep(0.01*rand(10))
+  "Hello, I'am x_runtime"
+end

data/test/test_x_runtime.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestXRuntime < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: x_runtime
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- 崔峥
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+description: 由于使用到Redis的lua script,所以需要你的Redis服务支持,redis-server版本>2.6.x,redis(ruby
+  gem)>3.0.1.
+email: zheng.cuizh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/x_runtime.rb
+- lib/x_runtime/array.rb
+- lib/x_runtime/data_set.rb
+- lib/x_runtime/middleware.rb
+- lib/x_runtime/redis.lua
+- lib/x_runtime/script.rb
+- lib/x_runtime/template.erb
+- lib/x_runtime/template.rb
+- lib/x_runtime/utils.rb
+- test/client.rb
+- test/helper.rb
+- test/server.rb
+- test/test_x_runtime.rb
+homepage: http://github.com/charlescui/x_runtime
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1659196055007791068
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: XRuntime是一个Rack的middleware,配合Redis用来分析Http Server每个URI请求时长
+test_files: []