journalist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7db826c70d439a2ee0ad1e9f9f67dfd8b6209471
+  data.tar.gz: ce108b771e21a517521b19efec110a6a1b81a935
+SHA512:
+  metadata.gz: f49a58bff0124333d6a4fa06b5a3dcfa888aa5d94e493de4d8544dd750d3d8590090923e707932278fb701e704b7ded55c48e4cd8e3645abc0a689bc29b46c12
+  data.tar.gz: 3000484d221a0bbe164902f6290cfc3bf8900f55e938f14691e2be5a67773ee139a5988ec2ccb29d3337d29049c2c4218a14dfed6554d1710e2e48c856697ca2

data/.consolerc

@@ -0,0 +1,10 @@
+def start
+  Journalist.start
+  stress_gc
+end
+
+def stress_gc
+  100_000.times { "foo" }
+end
+
+puts "Fixtures loaded"

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in journalist.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andre Medeiros
+
+MIT License
+
+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.md

@@ -0,0 +1,47 @@
+# Journalist
+
+A gem that allows you to look into a running Ruby process.
+
+## Motivation
+
+We lack the tools to have real time visibility in Ruby processes. After seeing [VisualVM](http://visualvm.java.net/) at Baruco, I've realised that a tool like that for CRuby would be amazing. Thus, Journalist was born.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'journalist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install journalist
+
+## Usage
+
+To start profiling, type:
+
+    Journalist.start
+
+There are a lot of limitations right now, such as this only working for one process at any given time.
+
+## TODO
+
+- [ ] Finish call/return tracepoints
+- [ ] Implement allocation tracepoints
+- [ ] Implement msgpack serialization
+- [ ] Implement command and stream sockets
+- [ ] Build GUI
+
+## Contributing
+
+1. Fork it ( https://github.com/journalistrb/journalist/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new("journalist") do |ext|
+  ext.lib_dir = "lib/journalist"
+end

data/ext/journalist/calls.c

@@ -0,0 +1,70 @@
+#include "calls.h"
+
+static struct {
+  VALUE c_call;
+  VALUE c_return;
+} calls_tp_hook;
+
+// TODO: For now, a very basic counter. What we really want to do is keep around
+// the trace argument, and keep track of what's going on at all times (maybe
+// even benchmark how long calls take and only output the info on return.)
+static int stack_size = 0;
+
+const char c_call_fmt[] = "c_call: "
+  "class %s method: %s class_method %d stack_depth %d "
+  "path %s line %d\n";
+
+static void
+journalist_on_call_c_call(VALUE tpval, void *data) {
+  rb_trace_arg_t *tparg = rb_tracearg_from_tracepoint(tpval);
+
+  VALUE self      = rb_tracearg_self(tparg);
+  VALUE method_id = rb_tracearg_method_id(tparg);
+  VALUE path      = rb_tracearg_path(tparg);
+  VALUE lineno    = rb_tracearg_lineno(tparg);
+
+  bool instance   = TYPE(self) == T_CLASS || TYPE(self) == T_MODULE;
+
+  char buffer[4096];
+  sprintf(buffer,
+    c_call_fmt,
+    rb_obj_classname(self),
+    rb_id2name(SYM2ID(method_id)),
+    instance,
+    stack_size,
+    RSTRING_PTR(path),
+    NUM2INT(lineno)
+  );
+
+  rb_journalist_socket_send(buffer);
+  stack_size++;
+}
+
+static void
+journalist_on_call_c_return(VALUE tpval, void *data) {
+  if(stack_size == 0) return;
+
+  rb_journalist_socket_send("c_return\n");
+  stack_size--;
+}
+
+void
+rb_journalist_calls_init() {
+  calls_tp_hook.c_call   = rb_tracepoint_new(0, RUBY_EVENT_C_CALL,   journalist_on_call_c_call,   0);
+  calls_tp_hook.c_return = rb_tracepoint_new(0, RUBY_EVENT_C_RETURN, journalist_on_call_c_return, 0);
+
+  rb_gc_register_address(&calls_tp_hook.c_call);
+  rb_gc_register_address(&calls_tp_hook.c_return);
+}
+
+void
+rb_journalist_calls_start() {
+  rb_tracepoint_enable(calls_tp_hook.c_call);
+  rb_tracepoint_enable(calls_tp_hook.c_return);
+}
+
+void
+rb_journalist_calls_stop() {
+  rb_tracepoint_disable(calls_tp_hook.c_call);
+  rb_tracepoint_disable(calls_tp_hook.c_return);
+}

data/ext/journalist/calls.h

@@ -0,0 +1,10 @@
+#ifndef CALLS_H
+#define CALLS_H 1
+
+#include "journalist.h"
+
+void rb_journalist_calls_init();
+void rb_journalist_calls_start();
+void rb_journalist_calls_stop();
+
+#endif /* CALLS_H */

data/ext/journalist/extconf.rb

@@ -0,0 +1,5 @@
+require "mkmf"
+
+$CFLAGS << " -Wall -Werror -Wno-unused-parameter "
+
+create_makefile("journalist/journalist")

data/ext/journalist/garbage_collection.c

@@ -0,0 +1,139 @@
+#include "garbage_collection.h"
+
+static struct {
+  VALUE start;
+  VALUE end_mark;
+  VALUE end_sweep;
+} gc_tp_hook;
+
+static struct {
+  VALUE gc;
+} cookie;
+
+static VALUE sym_count,
+  sym_heap_used,
+  sym_heap_length,
+  sym_heap_increment,
+  sym_heap_live_slot,
+  sym_heap_free_slot,
+  sym_heap_final_slot,
+  sym_heap_swept_slot,
+  sym_total_allocated_object,
+  sym_total_freed_object,
+  sym_malloc_increase,
+  sym_malloc_limit,
+  sym_minor_gc_count,
+  sym_major_gc_count,
+  sym_remembered_shady_object,
+  sym_remembered_shady_object_limit,
+  sym_old_object,
+  sym_old_object_limit,
+  sym_oldmalloc_increase,
+  sym_oldmalloc_limit;
+
+const char gc_end_sweep_fmt[] = "gc_end_sweep: "
+  "count %d heap_used %d heap_length %d heap_live_slot %d heap_free_slot %d "
+  "heap_final_slot %d heap_swept_slot %d total_allocated_object %d "
+  "total_freed_object %d malloc_increase %d malloc_limit %d "
+  "minor_gc_count %d major_gc_count %d remembered_shady_object %d "
+  "remembered_shady_object_limit %d old_object %d old_object_limit %d "
+  "oldmalloc_increase %d oldmalloc_limit %d\n";
+
+static void
+journalist_on_gc_start(VALUE tpval, void *data) {
+  rb_journalist_socket_send("gc_start\n");
+}
+
+static void
+journalist_on_gc_end_mark(VALUE tpval, void *data) {
+  rb_journalist_socket_send("gc_mark\n");
+}
+
+static void
+journalist_on_gc_end_sweep(VALUE tpval, void *data) {
+  char buffer[4096];
+  rb_gc_stat(cookie.gc);
+
+#define STAT(name) NUM2INT(rb_hash_aref(cookie.gc, sym_##name))
+  sprintf(buffer,
+    gc_end_sweep_fmt,
+    STAT(count),
+    STAT(heap_used),
+    STAT(heap_length),
+    STAT(heap_live_slot),
+    STAT(heap_free_slot),
+    STAT(heap_final_slot),
+    STAT(heap_swept_slot),
+    STAT(total_allocated_object),
+    STAT(total_freed_object),
+    STAT(malloc_increase),
+    STAT(malloc_limit),
+    STAT(minor_gc_count),
+    STAT(major_gc_count),
+    STAT(remembered_shady_object),
+    STAT(remembered_shady_object_limit),
+    STAT(old_object),
+    STAT(old_object_limit),
+    STAT(oldmalloc_increase),
+    STAT(oldmalloc_limit)
+  );
+#undef STAT
+
+  rb_journalist_socket_send(buffer);
+}
+
+void
+rb_journalist_gc_init() {
+  // Initialize symbols
+#define S(name) sym_##name = ID2SYM(rb_intern_const(#name));
+  S(count);
+  S(heap_used);
+  S(heap_length);
+  S(heap_increment);
+  S(heap_live_slot);
+  S(heap_free_slot);
+  S(heap_final_slot);
+  S(heap_swept_slot);
+  S(total_allocated_object);
+  S(total_freed_object);
+  S(malloc_increase);
+  S(malloc_limit);
+  S(minor_gc_count);
+  S(major_gc_count);
+  S(remembered_shady_object);
+  S(remembered_shady_object_limit);
+  S(old_object);
+  S(old_object_limit);
+  S(oldmalloc_increase);
+  S(oldmalloc_limit);
+#undef S
+
+  // Grab the latest info on GC. We need to do this so that Ruby does all the
+  // allocations it needs for this object outside of GC, so that we don't
+  // blow up the interpreter. Also, mark it so that GC doesn't reap it on a run.
+  cookie.gc = rb_hash_new();
+  rb_gc_register_mark_object(cookie.gc);
+  rb_gc_stat(cookie.gc);
+
+  gc_tp_hook.start     = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_GC_START,     journalist_on_gc_start,     0);
+  gc_tp_hook.end_mark  = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_GC_END_MARK,  journalist_on_gc_end_mark,  0);
+  gc_tp_hook.end_sweep = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_GC_END_SWEEP, journalist_on_gc_end_sweep, 0);
+
+  rb_gc_register_address(&gc_tp_hook.start);
+  rb_gc_register_address(&gc_tp_hook.end_mark);
+  rb_gc_register_address(&gc_tp_hook.end_sweep);
+}
+
+void
+rb_journalist_gc_start() {
+  rb_tracepoint_enable(gc_tp_hook.start);
+  rb_tracepoint_enable(gc_tp_hook.end_mark);
+  rb_tracepoint_enable(gc_tp_hook.end_sweep);
+}
+
+void
+rb_journalist_gc_stop() {
+  rb_tracepoint_disable(gc_tp_hook.start);
+  rb_tracepoint_disable(gc_tp_hook.end_mark);
+  rb_tracepoint_disable(gc_tp_hook.end_sweep);
+}

data/ext/journalist/garbage_collection.h

@@ -0,0 +1,10 @@
+#ifndef GARBAGE_COLLECTION_H
+#define GARBAGE_COLLECTION_H 1
+
+#include "journalist.h"
+
+void rb_journalist_gc_init();
+void rb_journalist_gc_start();
+void rb_journalist_gc_stop();
+
+#endif /* GARBAGE_COLLECTION_H */

data/ext/journalist/journalist.c

@@ -0,0 +1,38 @@
+#include "journalist.h"
+
+VALUE rb_mJournalist;
+
+static void
+rb_journalist_init() {
+  rb_journalist_socket_init();
+
+  rb_journalist_gc_init();
+  rb_journalist_calls_init();
+}
+
+static VALUE
+journalist_start(VALUE klass) {
+  rb_journalist_gc_start();
+  rb_journalist_calls_start();
+
+  return Qtrue;
+}
+
+static VALUE
+journalist_stop(VALUE klass) {
+  rb_journalist_gc_stop();
+  rb_journalist_calls_stop();
+
+  return Qtrue;
+}
+
+void
+Init_journalist(void)
+{
+  rb_mJournalist = rb_define_module("Journalist");
+
+  rb_define_singleton_method(rb_mJournalist, "start", journalist_start, 0);
+  rb_define_singleton_method(rb_mJournalist, "stop",  journalist_stop,  0);
+
+  rb_journalist_init();
+}

data/ext/journalist/journalist.h

@@ -0,0 +1,13 @@
+#ifndef JOURNALIST_H
+#define JOURNALIST_H 1
+
+#include <stdbool.h>
+
+#include "ruby.h"
+#include "ruby/debug.h"
+
+#include "calls.h"
+#include "garbage_collection.h"
+#include "socket.h"
+
+#endif /* JOURNALIST_H */

data/ext/journalist/socket.c

@@ -0,0 +1,15 @@
+#include "socket.h"
+
+FILE *journalist_file;
+static char journalist_file_path[] = "/tmp/journalist";
+
+void
+rb_journalist_socket_init() {
+  journalist_file = fopen(journalist_file_path, "w");
+}
+
+void
+rb_journalist_socket_send(char *message) {
+  fwrite(message, sizeof(char), strlen(message), journalist_file);
+  fflush(journalist_file);
+}

data/ext/journalist/socket.h

@@ -0,0 +1,14 @@
+#ifndef ASDASDASD
+#define ASDASDASD 1
+
+#include <stdio.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+void rb_journalist_socket_init();
+void rb_journalist_socket_send(char *message);
+
+#endif /* ASDASDASD */

data/journalist.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'journalist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "journalist"
+  spec.version       = Journalist::VERSION
+  spec.authors       = ["Andre Medeiros"]
+  spec.email         = ["me@andremedeiros.info"]
+  spec.extensions    = ["ext/journalist/extconf.rb"]
+  spec.summary       = %q{Easily look into a running Ruby process.}
+  spec.description   = <<-DESC.gsub(/^\s|\t|\n/, '').lstrip
+    Journalist is a gem that intends to make it really easy to get visibility
+    into any running Ruby processes with metrics like GC stats, performance and
+    allocations.
+  DESC
+  spec.homepage      = "https://github.com/journalistrb/journalist"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler"
+end

data/lib/journalist.rb

@@ -0,0 +1,6 @@
+require "journalist/version"
+require "journalist/journalist"
+
+module Journalist
+  # Your code goes here...
+end

data/lib/journalist/version.rb

@@ -0,0 +1,3 @@
+module Journalist
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: journalist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andre Medeiros
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Journalist is a gem that intends to make it really easy to get visibility   into
+  any running Ruby processes with metrics like GC stats, performance and   allocations.
+email:
+- me@andremedeiros.info
+executables: []
+extensions:
+- ext/journalist/extconf.rb
+extra_rdoc_files: []
+files:
+- ".consolerc"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/journalist/calls.c
+- ext/journalist/calls.h
+- ext/journalist/extconf.rb
+- ext/journalist/garbage_collection.c
+- ext/journalist/garbage_collection.h
+- ext/journalist/journalist.c
+- ext/journalist/journalist.h
+- ext/journalist/socket.c
+- ext/journalist/socket.h
+- journalist.gemspec
+- lib/journalist.rb
+- lib/journalist/version.rb
+homepage: https://github.com/journalistrb/journalist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Easily look into a running Ruby process.
+test_files: []