gc_tracer 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f51c53293509fec6925050bd2a7777d21a7e5c5f
-  data.tar.gz: ee101027412970ae77e73377e06218da4b00033a
+  metadata.gz: fc71d8de7bf981a27b8cb3859ed6134fd275d2ec
+  data.tar.gz: 25ab4eee36db92b7280d2a270556e7b3ea699af9
 SHA512:
-  metadata.gz: 506e6d6ed2206e9e03ba8081434eac2a33472c1cb0c911d9a917db0a571c7890e43ca6ea3ebb572467dae54c02e31cc817e0f0c611d64c070417e4679dcc1628
-  data.tar.gz: 803962c62b75c2f97994705e12452e3e2682e1de434d165f3d531615e6bf997ba5d306b3ad64d763cf1b7d89e3b049ea03dd6828e82caeaad0ff8c4c56dd1787
+  metadata.gz: f85092b780785d3a414b1343e5542516446f507485c7d3304a4e2ffa81c3101010ed4cf11bd5bb4693b72e066be8e66f45787b0eb3502ff72c68f816bb4f8c6a
+  data.tar.gz: 95e5f65dcd28c70365241b3b5e7c622b243307265b4ed86767881c6a99a2da981eba3dfe7e9e2635233c767372ee7ead5ad6fe0877c5ec8300dcf451342b3649

data/README.md

@@ -50,6 +50,10 @@ ensure
 end
 ```
 
+If `ENV['GC_TRACER_LOGFILE']` is given, then this value and `pid` (concatenated with '-') is used as filename.
+
+If filename is not given, then all of logs puts onto `stderr`.
+
 ### Setup
 
 In the stored file (filename), you can get tab separated values of:
@@ -57,6 +61,7 @@ In the stored file (filename), you can get tab separated values of:
 * `GC.stat()`
 * `GC.latest_gc_info()`
 * `getrusage()` (if supported by system)
+* Custom fields (described bloew)
 
 at each events, there are one of:
 
@@ -152,6 +157,29 @@ This method is useful to trace where the GC events occur in your
 application.
 
 
+## Rack middleware
+
+You can insert Rack middleware to record and view GC Tracer log.
+
+```ruby
+require 'rack'
+require 'sinatra'
+require 'rack/gc_tracer'
+
+use Rack::GCTracerMiddleware, view_page_path: '/gc_tracer'
+
+get '/' do
+  'foo'
+end
+```
+
+You can pass two options.
+
+* logging_filename: File name of GC Tracer log
+* view_page_path: You can view GC tracer log with this path *if logging_filename is given*. You should not use this option on production.
+
+And also you can pass all options (except filename) of `GC::Tracer.start_logging`.
+
 ## Contributing
 
 1. Fork it ( http://github.com/ko1/gc_tracer/fork )

data/ext/gc_tracer/gc_logging.c

@@ -138,6 +138,12 @@ out_terminate(FILE *out)
     fprintf(out, "\n");
 }
 
+static void
+out_flush(FILE *out)
+{
+    fflush(out);
+}
+
 static void
 out_sizet(FILE *out, size_t size)
 {
@@ -683,6 +689,20 @@ gc_tracer_stop_logging(VALUE self)
     return self;
 }
 
+static VALUE
+gc_tracer_flush_logging(VALUE self)
+{
+    struct gc_logging *logging = &trace_logging;
+
+    if (logging->enabled) {
+	out_flush(logging->out);
+    }
+    else {
+	rb_raise(rb_eRuntimeError, "GC tracer is not enabled.");
+    }
+    return self;
+}
+
 static VALUE
 gc_tracer_custom_event_logging(VALUE self, VALUE event_str)
 {
@@ -703,6 +723,7 @@ Init_gc_tracer_logging(VALUE mod)
 {
     rb_define_module_function(mod, "start_logging_", gc_tracer_start_logging, 0);
     rb_define_module_function(mod, "stop_logging", gc_tracer_stop_logging, 0);
+    rb_define_module_function(mod, "flush_logging", gc_tracer_flush_logging, 0);
 
     /* setup */
     rb_define_module_function(mod, "setup_logging_out", gc_tracer_setup_logging_out, 1);

data/lib/gc_tracer.rb

@@ -3,6 +3,14 @@ require 'gc_tracer/gc_tracer'
 
 module GC
   module Tracer
+    def self.env_logging_filename
+      if fn = ENV['GC_TRACER_LOGFILE']
+        "#{fn}-#{Process.pid}"
+      else
+        nil
+      end
+    end
+
     def self.start_logging(filename_opt = nil,
                            filename: nil,
                            # event filter
@@ -17,7 +25,7 @@ module GC
                          )
       # setup
       raise "do not specify two fienames" if filename && filename_opt
-      setup_logging_out(filename_opt || filename)
+      setup_logging_out(filename_opt || filename || env_logging_filename)
       setup_logging_events(*events)
 
       self.setup_logging_gc_stat = gc_stat

data/lib/gc_tracer/version.rb

@@ -1,3 +1,3 @@
 module GC::Tracer
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/lib/rack/gc_tracer.rb

@@ -0,0 +1,28 @@
+#
+# Rack middleware
+#
+
+require 'gc_tracer'
+
+module Rack
+  class GCTracerMiddleware
+    def initialize app, view_page_path: nil, logging_filename: nil, **kw
+      @app = app
+      @view_page_path = view_page_path
+      @logging_filename = logging_filename || GC::Tracer.env_logging_filename
+      @has_view_page = @logging_filename && @view_page_path
+      GC::Tracer.start_logging @logging_filename, custom_fields: %i(accesses), **kw
+    end
+
+    def call env
+      if @has_view_page && env["PATH_INFO"] == @has_view_page
+        GC::Tracer.flush_logging
+        [200, {"Content-Type" => "text/plain"}, [open(@logging_filename).read]]
+      else
+        GC::Tracer.custom_field_increment(0)
+        @app.call(env)
+      end
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gc_tracer
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ files:
 - lib/gc_tracer/allocation_trace.rb
 - lib/gc_tracer/version.rb
 - lib/gc_tracer/viewer.html.erb
+- lib/rack/gc_tracer.rb
 - public/jquery-2.1.0.min.js
 - spec/gc_tracer_spec.rb
 - spec/spec_helper.rb