skylight 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 727271788a0fddacdf3b7e53451c413023d74a0d
-  data.tar.gz: 0b911dd320834be2608b7cd294e5aacf395188b7
+  metadata.gz: 21e17f0c6b492a15fe9be1823c16121ffa55ffbb
+  data.tar.gz: 000df33e16f6d5cd9c8e007e96f20d0a7fac89cb
 SHA512:
-  metadata.gz: 425fe8a9ece2086b79e08cadcd7687c1d808ce65e2772c6b3d457c7f5b79c57fe9284d78f9964a7a161e95f67d0e87d2cf4dc89370488d6d7ad7906abec53357
-  data.tar.gz: bbbe029afd5bfaa9c203ad7103ac818bdebbc95a78b94435ed43344b5a00feb74e7992d75bc8fdca27e1fe63dadb784fcd64ef63abbb41130092c4511988f5ea
+  metadata.gz: 5bc55e53b477093f2239a954aa2892a14b34cf7a49d85d48c83c77a04348b09be58f6529fd6ce0e58a09dc9662f801ba890388390498ddf7045dfd83cb8250aa
+  data.tar.gz: 8635a462ded00edf9e8cdf8c05919a64201a7f9d7e5b39a4cb107b89454635602cd1ef2a655fe3b2a989c403f90d782423d01cbbed6af202c2c84e72dbfe241a

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.3.8 (April 3, 2014)
+
+* Update vendored highline to 1.6.21
+* Send more information with exceptions for easier debugging
+* Instrument and report internal agent metrics for easier debugging
+* Fix bug with tracking request counts per endpoint
+
+## 0.3.7 (March 31, 2014)
+
+* Use a default event category if none passed to Skylight.instrument
+* Fix bugs around disabling the agent
+* Fix native extension compilation bugs
+
 ## 0.3.6 (March 27, 2014)
 
 * Shorter token validation timeout

data/ext/libskylight.yml

@@ -1,6 +1,6 @@
 ---
-version: "74fb9b3"
+version: "f2a0e15"
 checksums:
-  linux-x86_64: "98b04f7d73c1894cc79621a135b4598a679c421f5ff3eecc652f84ba07258d9c"
-  linux-x86: "1d4bbd58e319237b18752607d087ce0c895fe99c58482e994abe62a9f07d41dd"
+  linux-x86_64: "a99d5542893418b0a5b6b53a599b2c2a07dc8186491181f6dbe0ccfab03dbed4"
+  linux-x86: "a4db4dfbaaa1181e74e6756f4d56ba00fdf4b88e54476294086e7e27bf0c3cdc"
 

data/ext/skylight_native.c

@@ -428,46 +428,6 @@ static VALUE trace_serialize(VALUE self) {
   return rb_string;
 }
 
-static VALUE trace_span_add_annotation(VALUE self, VALUE rb_span_id, VALUE parent, VALUE rb_key, VALUE value) {
-  uint32_t *parent_id = NULL;
-  RustSlice rs_key;
-  RustSlice *key = NULL;
-  uint32_t new_id, parent_int;
-
-  My_Struct(trace, RustTrace, freedTrace);
-
-  CHECK_TYPE(rb_span_id, T_FIXNUM);
-  uint32_t span_id = FIX2UINT(rb_span_id);
-
-  if (parent != Qnil) {
-    CHECK_TYPE(parent, T_FIXNUM);
-    parent_int = FIX2UINT(parent);
-    parent_id = &parent_int;
-  }
-
-  if (rb_key != Qnil) {
-    CHECK_TYPE(rb_key, T_STRING);
-
-    rs_key = STR2SLICE(rb_key);
-    key = &rs_key;
-  }
-
-  if (TYPE(value) == T_FIXNUM) {
-    CHECK_FFI(skylight_trace_add_annotation_int(trace, span_id, parent_id, key, NUM2LL(value)), "Could not add int annotation");
-  } else if (TYPE(value) == T_FLOAT) {
-    CHECK_FFI(skylight_trace_add_annotation_double(trace, span_id, parent_id, key, NUM2DBL(value)), "Could not add double annotation");
-  } else if (TYPE(value) == T_STRING) {
-    CHECK_FFI(skylight_trace_add_annotation_string(trace, span_id, parent_id, key, STR2SLICE(value)), "Could not add string annotation");
-  } else if (TYPE(value) == T_SYMBOL && value == ID2SYM(rb_intern("nested"))) {
-    CHECK_FFI(skylight_trace_add_annotation_nested(trace, span_id, parent_id, key, &new_id), "Could not add nested annotation");
-    return ULL2NUM(new_id);
-  } else {
-    rb_raise(rb_eArgError, "You must pass an integer, string or :nested to native_span_add_annotation");
-  }
-
-  return Qnil;
-}
-
 /**
  * class Skylight::Batch
  */
@@ -564,7 +524,6 @@ void Init_skylight_native() {
   rb_define_method(rb_cTrace, "native_stop_span", trace_stop_span, 2);
   rb_define_method(rb_cTrace, "native_span_set_title", trace_span_set_title, 2);
   rb_define_method(rb_cTrace, "native_span_set_description", trace_span_set_description, 2);
-  rb_define_method(rb_cTrace, "native_span_add_annotation", trace_span_add_annotation, 4);
 
   rb_cBatch = rb_define_class_under(rb_mSkylight, "Batch", rb_cObject);
   rb_define_singleton_method(rb_cBatch, "native_new", batch_new, 2);

data/lib/skylight.rb

@@ -81,9 +81,17 @@ module Skylight
   autoload :Subscriber,   'skylight/subscriber'
   autoload :Worker,       'skylight/worker'
 
+  module Metrics
+    autoload :Meter,           'skylight/metrics/meter'
+    autoload :EWMA,            'skylight/metrics/ewma'
+    autoload :ProcessMemGauge, 'skylight/metrics/process_mem_gauge'
+    autoload :ProcessCpuGauge, 'skylight/metrics/process_cpu_gauge'
+  end
+
   module Util
     require 'skylight/util/clock'
 
+    autoload :Conversions,   'skylight/util/conversions'
     autoload :Gzip,          'skylight/util/gzip'
     autoload :HTTP,          'skylight/util/http'
     autoload :Inflector,     'skylight/util/inflector'

data/lib/skylight/config.rb

@@ -19,50 +19,53 @@ module Skylight
 
     # Map environment variable keys with Skylight configuration keys
     ENV_TO_KEY = {
-      'ROOT'                => :'root',
-      'LOG_FILE'            => :'log_file',
-      'LOG_LEVEL'           => :'log_level',
-      'APPLICATION'         => :'application',
-      'AUTHENTICATION'      => :'authentication',
-      'HOSTNAME'            => :'hostname',
-      'SKIP_VALIDATION'     => :'skip_validation',
-      'AGENT_INTERVAL'      => :'agent.interval',
-      'AGENT_KEEPALIVE'     => :'agent.keepalive',
-      'AGENT_SAMPLE_SIZE'   => :'agent.sample',
-      'AGENT_SOCKFILE_PATH' => :'agent.sockfile_path',
-      'AGENT_STRATEGY'      => :'agent.strategy',
-      'AGENT_MAX_MEMORY'    => :'agent.max_memory',
-      'REPORT_HOST'         => :'report.host',
-      'REPORT_PORT'         => :'report.port',
-      'REPORT_SSL'          => :'report.ssl',
-      'REPORT_DEFLATE'      => :'report.deflate',
-      'ACCOUNTS_HOST'       => :'accounts.host',
-      'ACCOUNTS_PORT'       => :'accounts.port',
-      'ACCOUNTS_SSL'        => :'accounts.ssl',
-      'ACCOUNTS_DEFLATE'    => :'accounts.deflate',
-      'ME_AUTHENTICATION'   => :'me.authentication',
-      'ME_CREDENTIALS_PATH' => :'me.credentials_path',
-      'TEST_CONSTANT_FLUSH' => :'test.constant_flush',
-      'TEST_IGNORE_TOKEN'   => :'test.ignore_token' }
+      'ROOT'                    => :'root',
+      'LOG_FILE'                => :'log_file',
+      'LOG_LEVEL'               => :'log_level',
+      'APPLICATION'             => :'application',
+      'AUTHENTICATION'          => :'authentication',
+      'HOSTNAME'                => :'hostname',
+      'SKIP_VALIDATION'         => :'skip_validation',
+      'AGENT_INTERVAL'          => :'agent.interval',
+      'AGENT_KEEPALIVE'         => :'agent.keepalive',
+      'AGENT_SAMPLE_SIZE'       => :'agent.sample',
+      'AGENT_SOCKFILE_PATH'     => :'agent.sockfile_path',
+      'AGENT_STRATEGY'          => :'agent.strategy',
+      'AGENT_MAX_MEMORY'        => :'agent.max_memory',
+      'REPORT_HOST'             => :'report.host',
+      'REPORT_PORT'             => :'report.port',
+      'REPORT_SSL'              => :'report.ssl',
+      'REPORT_DEFLATE'          => :'report.deflate',
+      'ACCOUNTS_HOST'           => :'accounts.host',
+      'ACCOUNTS_PORT'           => :'accounts.port',
+      'ACCOUNTS_SSL'            => :'accounts.ssl',
+      'ACCOUNTS_DEFLATE'        => :'accounts.deflate',
+      'ME_AUTHENTICATION'       => :'me.authentication',
+      'ME_CREDENTIALS_PATH'     => :'me.credentials_path',
+      'METRICS_REPORT_INTERVAL' => :'metrics.report_interval',
+      'TEST_CONSTANT_FLUSH'     => :'test.constant_flush',
+      'TEST_IGNORE_TOKEN'       => :'test.ignore_token' }
 
     # Default values for Skylight configuration keys
     DEFAULTS = {
-      :'log_file'            => '-'.freeze,
-      :'log_level'           => 'INFO'.freeze,
-      :'hostname'            => default_hostname,
-      :'agent.keepalive'     => 60,
-      :'agent.interval'      => 5,
-      :'agent.sample'        => 200,
-      :'agent.max_memory'    => 256, # MB
-      :'report.host'         => 'agent.skylight.io'.freeze,
-      :'report.port'         => 443,
-      :'report.ssl'          => true,
-      :'report.deflate'      => true,
-      :'accounts.host'       => 'www.skylight.io'.freeze,
-      :'accounts.port'       => 443,
-      :'accounts.ssl'        => true,
-      :'accounts.deflate'    => false,
-      :'me.credentials_path' => '~/.skylight' }.freeze
+      :'log_file'                => '-'.freeze,
+      :'log_level'               => 'INFO'.freeze,
+      :'hostname'                => default_hostname,
+      :'agent.keepalive'         => 60,
+      :'agent.interval'          => 5,
+      :'agent.sample'            => 200,
+      :'agent.max_memory'        => 256, # MB
+      :'report.host'             => 'agent.skylight.io'.freeze,
+      :'report.port'             => 443,
+      :'report.ssl'              => true,
+      :'report.deflate'          => true,
+      :'accounts.host'           => 'www.skylight.io'.freeze,
+      :'accounts.port'           => 443,
+      :'accounts.ssl'            => true,
+      :'accounts.deflate'        => false,
+      :'me.credentials_path'     => '~/.skylight',
+      :'metrics.report_interval' => 60
+    }.freeze
 
     REQUIRED = {
       :'authentication' => "authentication token",

data/lib/skylight/metrics/ewma.rb

@@ -0,0 +1,69 @@
+module Skylight
+  module Metrics
+
+    # An exponentially-weighted moving average. Not thread-safe
+    class EWMA
+      include Util::Conversions
+
+      INTERVAL = 5
+
+      # Some common EWMA
+      attr_reader :interval
+
+      def initialize(alpha, interval)
+        @rate = 0.0
+        @alpha = alpha
+        @interval = secs_to_nanos(interval).to_f
+        @uncounted = 0
+        @initialized = false
+      end
+
+      def self.alpha(minutes, interval = INTERVAL)
+        1 - Math.exp(-interval / 60.0 / minutes)
+      end
+
+      # Some common EWMA
+
+      M1  = alpha(1)
+      M5  = alpha(5)
+      M15 = alpha(15)
+
+      def self.one_minute_ewma
+        EWMA.new M1, INTERVAL
+      end
+
+      def self.five_minute_ewma
+        EWMA.new M5, INTERVAL
+      end
+
+      def self.fifteen_minute_ewma
+        EWMA.new M15, INTERVAL
+      end
+
+      def update(count)
+        @uncounted += count
+      end
+
+      def tick
+        # Compute the rate this interval (aka the num of occurences this tick)
+        instant_rate = @uncounted / @interval
+
+        # Reset the count
+        @uncounted = 0
+
+        if @initialized
+          @rate += (@alpha * (instant_rate - @rate))
+        else
+          @rate = instant_rate
+          @initialized = true
+        end
+      end
+
+      # Get the rate in the requested interval (where the interval is specified
+      # in number of seconds
+      def rate(interval = 1)
+        @rate * secs_to_nanos(interval)
+      end
+    end
+  end
+end

data/lib/skylight/metrics/meter.rb

@@ -0,0 +1,58 @@
+require 'thread'
+
+module Skylight
+  module Metrics
+    class Meter
+      def initialize(ewma = EWMA.one_minute_ewma, clock = Util::Clock.default)
+        @ewma = ewma
+        @lock = Mutex.new
+        @clock = clock
+        @start_time = @clock.tick
+        @last_tick = @start_time
+      end
+
+      def mark(n = 1)
+        @lock.synchronize do
+          tick_if_necessary
+          @ewma.update(n)
+        end
+      end
+
+      def rate
+        @lock.synchronize do
+          tick_if_necessary
+          @ewma.rate(1)
+        end
+      end
+
+      def call
+        rate
+      end
+
+    private
+
+      def tick_if_necessary
+        old_tick = @last_tick
+        new_tick = @clock.tick
+
+        # How far behind are we
+        age = new_tick - old_tick
+
+        if age >= @ewma.interval
+          new_tick = new_tick - age % @ewma.interval
+
+          # Update the last seen tick
+          @last_tick = new_tick
+
+          # Number of missing ticks
+          required_ticks = age / @ewma.interval
+
+          while required_ticks > 0
+            @ewma.tick
+            required_ticks -= 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skylight/metrics/process_cpu_gauge.rb

@@ -0,0 +1,65 @@
+module Skylight
+  module Metrics
+    class ProcessCpuGauge
+
+      def initialize(cache_for = 5, clock = Util::Clock.default)
+        @value = nil
+        @cache_for = cache_for
+        @last_check_at = 0
+        @clock = clock
+
+        @last_totaltime = nil
+        @last_usagetime = nil
+        @last_utime = nil
+        @last_stime = nil
+      end
+
+      def call(now = @clock.absolute_secs)
+        if !@value || should_check?(now)
+          @value = check
+          @last_check_at = now
+        end
+
+        @value
+      end
+
+    private
+
+      def check
+        ret = nil
+
+        statfile = "/proc/stat"
+        pidstatfile = "/proc/#{Process.pid}/stat"
+
+        if File.exist?(statfile) && File.exist?(pidstatfile)
+          cpustats = File.readlines(statfile).grep(/^cpu /).first.split(' ')
+          usagetime = cpustats[1..3].reduce(0){|sum, i| sum + i.to_i }
+          totaltime = usagetime + cpustats[4].to_i
+
+          pidstats = File.read(pidstatfile).split(' ')
+          utime, stime = pidstats[13].to_i, pidstats[14].to_i
+
+          if @last_totaltime && @last_usagetime && @last_utime && @last_stime
+            elapsed = totaltime - @last_totaltime
+            ret = [(usagetime - @last_usagetime).to_f / elapsed,
+                   (utime - @last_utime).to_f / elapsed,
+                   (stime - @last_stime).to_f / elapsed]
+          end
+
+          @last_totaltime = totaltime
+          @last_usagetime = usagetime
+          @last_utime = utime
+          @last_stime = stime
+        end
+
+        ret
+      rescue Errno::ENOENT
+        nil
+      end
+
+      def should_check?(now)
+        now >= @last_check_at + @cache_for
+      end
+    end
+  end
+end

data/lib/skylight/metrics/process_mem_gauge.rb

@@ -0,0 +1,34 @@
+module Skylight
+  module Metrics
+    class ProcessMemGauge
+
+      def initialize(cache_for = 30, clock = Util::Clock.default)
+        @value = nil
+        @cache_for = cache_for
+        @last_check_at = 0
+        @clock = clock
+      end
+
+      def call(now = @clock.absolute_secs)
+        if !@value || should_check?(now)
+          @value = check
+          @last_check_at = now
+        end
+
+        @value
+      end
+
+    private
+
+      def check
+        `ps -o rss= -p #{Process.pid}`.to_i / 1024
+      rescue Errno::ENOENT, Errno::EINTR
+        0
+      end
+
+      def should_check?(now)
+        now >= @last_check_at + @cache_for
+      end
+    end
+  end
+end

data/lib/skylight/util/clock.rb

@@ -2,22 +2,28 @@ module Skylight
   module Util
     class Clock
 
-      def absolute_secs
-        Time.now.to_i
-      end
-
       if Skylight.native?
-        def nanos
+        def tick
           native_hrtime
         end
       else
-        # Implement nanos to work when native extension is not present
-        def nanos
+        def tick
           now = Time.now
           now.to_i * 1_000_000_000 + now.usec * 1_000
         end
       end
 
+      # TODO: rename to secs
+      def absolute_secs
+        Time.now.to_i
+      end
+
+      # TODO: remove
+      def nanos
+        tick
+      end
+
+      # TODO: remove
       def secs
         nanos / 1_000_000_000
       end