space_observatory 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c33aabad489c6d4e3fe00a0d270daaf7694450aa
-  data.tar.gz: 2c22ce59b2d4d6c2aba4310d931261eae95f4d03
+  metadata.gz: cbfdd79f8b24c39b374ca7bd7f23540ea545e602
+  data.tar.gz: 05c51b5ed6e113c65617c1bb74d0120ddcdcc542
 SHA512:
-  metadata.gz: 5056147bf38a148f8a28c6a35af85f6a691b4073507291224ec8d45630cf1a9556da97e5788453fb2164369554e2a9bcfd8151016b018e76580af2909d3974e6
-  data.tar.gz: df671b5081f41a0418ccf499860cb7c16b7732a36de3b6a013ab5f04df857e3a61907515eccc4e47a9202f14eb76e4fca33e85c1faa335c6ad7d319c7ec3fa40
+  metadata.gz: d48ce0353e37319ee548bda34aa224e75edbeb69c18b41838676cff0635c8c88f5db33f7a3eee2c00dd4e11f4b6dca280f9f735dd88dc0d15fece64ec5ac213f
+  data.tar.gz: cdb858c3109a0405c8e498419f13c9dbbe8901598f5f13efd6fb51fb96fd12a1191ddc9381a81b6f1bb984f280e28f07e166eca208cfeb95044a8b4440640ae5

data/Gemfile

@@ -23,5 +23,6 @@
 
 source 'https://rubygems.org'
 
+gem 'rack', git: 'git@github.com:rack/rack.git'
 # Specify your gem's dependencies in space_observatory.gemspec
 gemspec

data/README.md

@@ -7,13 +7,38 @@ This is an easy add-on for you to observe your ObjectSpace.
 - Pure ruby.  NO C extensions.
 - Drop-in design that requires NO modifications to your program.
 - Minimal overhead.  Does all jobs except data collection in a separate process.
+- Native support Rails, Sinatra, and non-Web daemons.
 
 ## Installation
 
 As usual.
 
+**NOTE** however that as of this writing, WEBrick do not support websockets (necessary for this lib).  You need a websockets-aware rack handler like Puma, Passanger, whatever.
+
 ## Usage
 
+### on Rails
+
+```ruby
+gem 'space_observatory', require: 'space_observatory/railtie'
+```
+
+And you are done.
+
+### Pure Rack / Sinatra / Padrino etc
+
+```ruby
+gem 'space_observatory', require: 'space_observatory/rack_middleware'
+```
+
+Also in your `config.ru` file add:
+
+```ruby
+use SpaceObservatory::RackMiddleware
+```
+
+### Versatile use case including non-Web daemons
+
 ```bash
 bundle exec with-space-observatory.rb --port=1234 -- ruby bin/rails server --port=5678
 ```

data/lib/space_observatory.rb

@@ -24,5 +24,5 @@
 require_relative "space_observatory/version"
 
 module SpaceObservatory
-  # Your code goes here...
+  require_relative 'space_observatory/railtie' if defined? ::Rails
 end

data/lib/space_observatory/base_station.rb

@@ -22,13 +22,13 @@
 # SOFTWARE.
 
 require 'rubygems'
-require 'open3'
-require 'sync'
+require 'bundler/setup'
 require 'rack'
 require 'slop'
 require_relative '../space_observatory'
+require_relative 'rack_middleware'
 
-class SpaceObservatory::BaseStation
+class SpaceObservatory::BaseStation < SpaceObservatory::RackMiddleware
   # Fork a base station process
   # @param  [Array]  argv     The ::ARGV
   # @return [IO, IO, Integer, Array]  child's socket, pid, and argv.
@@ -44,7 +44,6 @@ class SpaceObservatory::BaseStation
   def self.construct
     obj = new ARGV, STDIN, STDOUT
     if obj.need_rackup?
-      obj.start_collector
       obj.rackup
     else
       obj.banner
@@ -74,17 +73,18 @@ class SpaceObservatory::BaseStation
     @stdout.sync = true # we need line IO
     @opts, @argw = self.class.parse argv
     @argw.shift if @argw.first == '--'
-    @started     = Time.at 0
-    @finished    = Time.at 0
-    @jsons       = Array.new
-    @rwlock      = Sync.new
-    @expires     = @opts['ttl'] || 60 # 300 # 3600
+
+    super nil, '/', @opts['ttl'] || 60 # 300 # 3600
   end
 
   def rackup
     Rack::Handler::WEBrick.run self, Port: @opts['port']
   end
 
+  def need_rackup?
+    not @opts['h'] and not @argw.empty?
+  end
+
   def banner
     @stdout.puts "space_observatory norun"
     @stdout.puts @opts.help if @opts['h']
@@ -92,13 +92,28 @@ class SpaceObservatory::BaseStation
     @stdout.close_write
   end
 
+  private
+
   def start_collector
+    retun unless need_rackup?
+
+    Thread.start do
+      loop do
+        env = @queue.deq # block here
+        @mutex.synchronize do
+          next if Time.now - @started < @expires
+          @stdout.puts "space_observatory probe"
+        end
+      end
+    end
+
     Thread.start do
       # needs handshale
       @stdout.puts "space_observatory ok"
       @stdin.gets # wait execve(2)
       @stdout.puts "space_observatory setup"
-      @stdout.puts "space_observatory probe"
+
+      tmp = Tempfile.new ''
       while line = @stdin.gets
         case line
         when "space_observatory projectile_eof\n"
@@ -107,57 +122,20 @@ class SpaceObservatory::BaseStation
           return
         when "space_observatory begin_objspace\n"
           @started = Time.now
-          @rwlock.lock Sync::EX
-          @jsons   = Array.new
+          @mutex.lock
+          tmp.truncate 0
         when "space_observatory end_objspace\n"
-          @rwlock.unlock Sync::EX
+          cook tmp
+          @mutex.unlock
           @finished = Time.now
           STDERR.printf "took %fsec\n", (@finished - @started).to_f
         when /\A{/o
           # This is the output of ObjectSpace.dump_all
-          @jsons.push line
+          tmp.write line
         else
 		raise "TBW: #{line}"
         end
       end
     end
   end
-
-  def need_rackup?
-    not @opts['h'] and not @argw.empty?
-  end
-
-  def call env
-    # TODO: more "proper" JSON
-    enum = Enumerator.new do |y|
-      @rwlock.synchronize Sync::EX do
-        if Time.now - @started >= @expires
-          @stdout.puts "space_observatory probe"
-          IO.select [@stdin], [], [], 10
-          @started = Time.now # prevent further probe
-        end
-      end
-      Thread.pass
-      @rwlock.synchronize Sync::SH do
-        id = @finished.to_i
-        y.yield <<-"]"
-          {
-            "jsonrpc" : "2.0",
-            "id" : #{id},
-            "result" : [
-        ]
-        @jsons.each_with_index do |i, j|
-          y.yield "," unless j.zero?
-          y.yield i
-        end
-        y.yield "]\n}\n"
-      end
-    end
-
-    return [
-      200,
-      { 'Content-Type' => 'application/json' },
-      enum
-    ]
-  end
 end

data/lib/space_observatory/rack_middleware.rb

@@ -0,0 +1,119 @@
+#! /your/favourite/path/to/ruby
+# -*- coding: utf-8; mode: ruby; ruby-indent-level: 2 -*-
+#
+# Copyright (c) 2014 Urabe, Shyouhei
+#
+# 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.
+
+require 'objspace'
+require 'thread'
+require 'tempfile'
+require 'open3'
+require 'rubygems'
+require 'bundler/setup'
+require_relative '../space_observatory'
+
+class SpaceObservatory::RackMiddleware
+
+  def initialize app, path = '/space', expires = 60 # 300 # 3600
+    @app      = app
+    @path     = path
+    @expires  = expires
+    @mutex    = Mutex.new
+    @queue    = Queue.new
+    @latest   = nil
+    @started  = Time.at 0
+    @finished = Time.at 0
+    @thread   = start_collector
+  end
+
+  def call env
+    return @app.call env if @app and env['PATH_INFO'] != @path
+
+    @queue.enq env
+    hdr = {
+      'Connection'   => 'close',
+      'Content-Type' => 'application/json',
+      'rack.hijack'  => lambda do |fp|
+        Thread.start do
+          begin
+            Thread.pass until @latest
+            @mutex.synchronize do
+              @latest.rewind
+              IO.copy_stream @latest, fp
+            end
+          rescue Errno::ENOTCONN
+          ensure
+            fp.close
+          end
+        end
+      end
+    }
+    return [ 200, hdr, nil ]
+  end
+
+  private
+  
+  def start_collector
+    Thread.start do
+      loop do
+        env = @queue.deq # block here
+        @mutex.synchronize do
+          next if Time.now - @started < @expires
+
+          @started = Time.now # prevent further probe
+          env['rack.errors'] << "Collection happen at #@started\n"
+          tmp1 = ObjectSpace.dump_all output: :file
+          cook tmp1
+          tmp1.close
+          @finished = Time.now
+          env['rack.errors'] << "Collection done in #{@finished - @started} secs.\n"
+        end
+      end
+    end
+  end
+
+  def cook io
+    @latest ||= Tempfile.new ''
+    @latest.rewind
+    @latest.truncate 0
+    @latest.print <<-"end".gsub(/^\s+(\S)/, '\\1').gsub(/[\r\n]/, "\r\n")
+      HTTP/1.1 200 OK
+      Content-Type: application/json
+      Connection: close
+
+    end
+    @latest.puts <<-"]".gsub(/^\s+/, '')
+      {
+        "jsonrpc" : "2.0",
+        "id" : #{@started.to_i},
+        "result" : [
+    ]
+    # This subprocessing is CHAPER than gsub-ing ourselves because
+    # gsub creates TONS of garbage string objects, which would be
+    # counted in the next ObjectSpace.dump_all call.
+    #
+    # Also note that this can totally be avoided if
+    # ObjectSpace.dump_all have generated valid JSON from the outset.
+    Open3.pipeline_r "cat #{io.path}", 'sed s/$/,/' do |r,|
+      IO.copy_stream r, @latest
+    end
+    @latest.print "]\n}\n"
+  end
+end

data/lib/space_observatory/railtie.rb

@@ -0,0 +1,31 @@
+#! /your/favourite/path/to/ruby
+# -*- coding: utf-8; mode: ruby; ruby-indent-level: 2 -*-
+#
+# Copyright (c) 2014 Urabe, Shyouhei
+#
+# 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.
+
+require 'rubygems'
+require_relative 'rack_middleware'
+
+class SpaceObservatory::Railtie < ::Rails::Railtie
+  initializer "space_observatory.install_middleware" do |app|
+    app.config.middleware.insert_before "ActionDispatch::Static", "SpaceObservatory::RackMiddleware"
+  end
+end

data/lib/space_observatory/version.rb

@@ -21,5 +21,5 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 module SpaceObservatory
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: space_observatory
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Urabe, Shyouhei
 autorequire: 
 bindir: exec
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -168,6 +168,8 @@ files:
 - exec/with-space-observatory.rb
 - lib/space_observatory.rb
 - lib/space_observatory/base_station.rb
+- lib/space_observatory/rack_middleware.rb
+- lib/space_observatory/railtie.rb
 - lib/space_observatory/version.rb
 - space_observatory.gemspec
 homepage: https://github.com/shyouhei/space_observatory