x_runtime 1.0.0 → 1.0.1

data/README.markdown

@@ -103,6 +103,28 @@ XRuntime.p.log("/index") do
 end
 ```
 
+### Probe探针
+
+探针的用途:
+* 在服务端请求最开始的地方打点比如`before_filter require_user`
+* 在服务端业务有性能陷阱的地方打点
+* 在Nginx或者Apache日志中输出记录，在日志中可以看到每个请求的路径，及其对应的业务路径中每个探针点之间的请求时长
+
+这样做的好处是:   
+探针会产生大量的数据，并且这些数据需要记录下来以供分析，如果需要Rails或者Sinatra来处理这些数据会降低自身业务的性能，   
+不如将这些数据放在请求头中，当Nginx或者Apache这些前段服务器记录日志的时候将其写入日志中，在我们分析日志的时候就能发现某些API的某些加过探针的运算消耗。    
+
+在Rails或者Sinatra中可以通过如下方法使用探针:`XRuntime::Utils.probe(headers)`    
+
+Nginx日志格式:
+```
+log_format timing '$remote_addr - $remote_user [$time_local] "$status" $request "$http_user_agent" '
+                          'upstream_response_time $upstream_response_time '
+                          'msec $msec request_time $request_time probe $upstream_http_xx_runtime';
+```
+
+最主要的是这个`probe $upstream_http_xx_runtime`
+
 ### Test
 
 请先修改test/server.rb和test/client.rb中的Redis参数,我的地址是localhost:6380,这个请改为你的地址。

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/x_runtime/lua/add.lua

@@ -1,9 +1,9 @@
 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)
+local key_counter = key.."::Counter"
+local key_amount = key.."::Amount"
+local key_average = key.."::Average"
 
 -- 记录最新一次请求的耗时
 redis.call('zadd',key,score,path)

data/lib/x_runtime/lua/del.lua

@@ -1,8 +1,8 @@
 local path = ARGV[1];
 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)
+local key_counter = key.."::Counter"
+local key_amount = key.."::Amount"
+local key_average = key.."::Average"
 
 -- 删除最新一次请求的耗时
 redis.call('zrem',key,path)

data/lib/x_runtime/utils.rb

@@ -17,6 +17,26 @@ module XRuntime
           hash
         }
       end
+      
+      PROBELATESTFLAG = "XX-Runtime-Latest"
+      PROBEFLAG = "XX-Runtime"
+      # Rails : XRuntime::Utils.probe(headers)
+      # Sinatra : XRuntime::Utils.probe(headers)
+      
+      # for Nginx log:
+      # log_format timing '$remote_addr - $remote_user [$time_local] "$status" $request "$http_user_agent" '
+      #                           'upstream_response_time $upstream_response_time '
+      #                           'msec $msec request_time $request_time probe $upstream_http_xx_runtime';
+      def probe(headers={})
+        headers[PROBEFLAG] = "0" unless headers[PROBEFLAG]
+        
+        if headers[PROBELATESTFLAG]
+          last_probe = headers[PROBELATESTFLAG].to_f
+          headers[PROBEFLAG] += ",#{"%06f"%(Time.now.to_f - last_probe)}"
+        end
+        
+        headers[PROBELATESTFLAG] = Time.now.to_f.to_s
+      end
     end
   end
 end

data/test/server.ru

@@ -9,6 +9,15 @@ class Server < Sinatra::Base
   # use XRuntime::Middleware, 10, Redis.connect(:url => "redis://localhost:6380/")
   # XRuntime::Middleware is same as Rack::XRuntime
   use Rack::XRuntime, Redis.connect(:url => "redis://localhost:6379/"), :threshold => 30.0, :cache => 50, :expire => 60
+  
+  get '/probe' do
+    XRuntime::Utils.probe(headers)
+    sleep rand(0.9)
+    XRuntime::Utils.probe(headers)
+    sleep rand(0.9)
+    XRuntime::Utils.probe(headers)
+    headers.inspect
+  end
 
   get /.*/ do
     XRuntime.p.log("/index") do

data/x_runtime.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "x_runtime"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["\u{5d14}\u{5ce5}"]
-  s.date = "2012-08-28"
+  s.date = "2012-08-31"
   s.description = "\u{7531}\u{4e8e}\u{4f7f}\u{7528}\u{5230}Redis\u{7684}lua script,\u{6240}\u{4ee5}\u{9700}\u{8981}\u{4f60}\u{7684}Redis\u{670d}\u{52a1}\u{652f}\u{6301},redis-server\u{7248}\u{672c}>2.6.x,redis(ruby gem)>3.0.1."
   s.email = "zheng.cuizh@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: x_runtime
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2012-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -151,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 194114813501611628
+      hash: -3268609457104962014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: