gc_tracer 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 477d54ed3c9678407cf4cdb090080222048716f6
-  data.tar.gz: 1c45e0a9ae7ff7f95c5d670835d784c5bef79328
+  metadata.gz: b9ce36d7506d6380617767354fcf92f131fb8eb2
+  data.tar.gz: cd6eeb8447b71f3e4ceafd623af6bf0e793c45a7
 SHA512:
-  metadata.gz: ff98def642484926e33a0116e12a1bec60cb06daccafd798505ac14f17918662c3ffa0f19d6d87fc28e8974b4077b7482d04969e0bbcbd5c54da4ffa14a67cf3
-  data.tar.gz: f9108f5902479a5d559ed40b16b074036b29f6b65abcc62816046060978aec449307bc424d611637ed1e7ebb1058c5706e09d93e54ac74819b5920f082df8f4f
+  metadata.gz: 28c17973fe087d97552e5b12d0e8e0a3b43e0910e2591ae9144d3e6225bdd008da490777939b7d2cd97582a2fbc7e907b18b4c2517869fa65cad7ffb36fc1b66
+  data.tar.gz: b27a89753bf65de227143b1e5966e131e5c47cc595cd90332f0265fa6c6bd28a35febfc5306fa7b0615dd93ae6c8aeeaa9c61db034eadcdb85beeaa867c64808

data/README.md

@@ -48,6 +48,8 @@ ensure
 end
 ```
 
+### Setup
+
 In the stored file (filename), you can get tab separated values of:
 
 * `GC.stat()`
@@ -100,6 +102,28 @@ and :nano_time (if platform supports clock_gettime()).
 
 See lib/gc_tracer.rb for more details.
 
+### Custom events
+
+You can add custom events by your own. Calling 
+`GC::Tracer.custom_event_logging(event_name)` in your program will puts 
+new statistics line into the logging file.
+
+For example, the following program insert 1000 custom event lines into 
+logging file (stderr for this type).
+
+```ruby
+GC::Tracer.start_logging(events: %i(start), gc_stat: false) do
+  1_000.times{|i|
+    1_000.times{''}
+    GC::Tracer.custom_event_logging("custom_#{i}")
+  }
+end
+```
+
+This method is useful to trace where the GC events occur in your 
+application.
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/ko1/gc_tracer/fork )

data/ext/gc_tracer/gc_logging.c

@@ -289,13 +289,13 @@ out_rusage(struct gc_logging *logging)
 }
 
 static void
-logging_start_i(VALUE tpval, struct gc_logging *logging)
+out_stat(struct gc_logging *logging, const char *event)
 {
 #if HAVE_GETRUSAGE
     logging->filled_rusage = 0;
 #endif
 
-    out_str(logging->out, logging->event);
+    out_str(logging->out, event);
     (logging->config.out_time_func)(logging->out);
 
     if (logging->config.log_gc_stat) out_gc_stat(logging);
@@ -306,6 +306,12 @@ logging_start_i(VALUE tpval, struct gc_logging *logging)
     out_terminate(logging->out);
 }
 
+static void
+logging_start_i(VALUE tpval, struct gc_logging *logging)
+{
+    out_stat(logging, logging->event);
+}
+
 static void
 out_header_each(struct gc_logging *logging, VALUE *syms, int n)
 {
@@ -562,6 +568,21 @@ gc_tracer_stop_logging(VALUE self)
     return self;
 }
 
+static VALUE
+gc_tracer_custom_event_logging(VALUE self, VALUE event_str)
+{
+    struct gc_logging *logging = &trace_logging;
+    const char *str = StringValueCStr(event_str);
+
+    if (logging->enabled) {
+	out_stat(logging, str);
+    }
+    else {
+	rb_raise(rb_eRuntimeError, "GC tracer is not enabled.");
+    }
+    return self;
+}
+
 void
 Init_gc_tracer_logging(VALUE mod)
 {
@@ -576,6 +597,9 @@ Init_gc_tracer_logging(VALUE mod)
     rb_define_module_function(mod, "setup_logging_gc_latest_gc_info=", gc_tracer_setup_logging_gc_latest_gc_info, 1);
     rb_define_module_function(mod, "setup_logging_rusage=", gc_tracer_setup_logging_rusage, 1);
 
+    /* custom event */
+    rb_define_module_function(mod, "custom_event_logging", gc_tracer_custom_event_logging, 1);
+
     /* setup data */
     setup_gc_trace_symbols();
     create_gc_hooks();

data/lib/gc_tracer/version.rb

@@ -1,3 +1,3 @@
 module GC::Tracer
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gc_tracer
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler