union_station_hooks_core 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfc9815e53e9b9fdd1ec5ec8406c75dbe63cfad1
-  data.tar.gz: 9ff6e5d34e4c703e4a1a3d98272dea5e49b07cfc
+  metadata.gz: d2c7222363bb2d98083dbcf04c0c3a575ab9b405
+  data.tar.gz: 61b97992862e5bc29763daa99aaf3be502c8fc22
 SHA512:
-  metadata.gz: 95656628e3239ee71c71b21bf5d093150934f68dcd3cee2642d224c90f1b670304248b173b9b1d60503cd5df6ea75316a7c6a36118ccdb18870aa3624f92050c
-  data.tar.gz: a3fa7113d2d569c3c1c3a23dcb1efd2853bfaee3434f116b3c128a9b8e143a7f667a6018d90cdd38bcd4fba685587f8f6a4c6f641a6a416e6b4337b3cc1bad52
+  metadata.gz: fa91aa10d298de35a1758d070b97f636eccf2cf7f12336a71be780d73884c37c5b2274bd0f5c20235439140f1fb42e8680026158a411a484189f1c71840ae6dc
+  data.tar.gz: 7e0b6d7f8833218eecafdf833e80119cf4d9948c32a31a030448bc23f79f46096116a3f10fb0eb388515cbb59acb56e360b580f42be808ce304c8a5f13b4d2b3

data/lib/union_station_hooks_core.rb

@@ -1,5 +1,5 @@
 #  Union Station - https://www.unionstationapp.com/
-#  Copyright (c) 2015 Phusion Holding B.V.
+#  Copyright (c) 2015-2016 Phusion Holding B.V.
 #
 #  "Union Station" and "Passenger" are trademarks of Phusion Holding B.V.
 #
@@ -189,7 +189,7 @@ module UnionStationHooks
       if defined?(PhusionPassenger)
         PhusionPassenger::App.options['analytics']
       else
-        true
+        false
       end
     end
 
@@ -330,6 +330,12 @@ module UnionStationHooks
       nil
     end
 
+    def get_delta_monotonic
+      # When `initialize!` is called, the definition in
+      # `api.rb` will override this implementation.
+      nil
+    end
+
   private
 
     def finalize_and_validate_config

data/lib/union_station_hooks_core/api.rb

@@ -70,12 +70,10 @@ module UnionStationHooks
 
       # Workaround for Ruby < 2.1 support where there is no function for querying
       # the monotonic time.
-      delta_monotonic = rack_env['PASSENGER_DELTA_MONOTONIC']
-      if delta_monotonic
-        delta_monotonic = delta_monotonic.to_i
-      end
+      delta_monotonic_env = rack_env['PASSENGER_DELTA_MONOTONIC']
+      set_delta_monotonic(delta_monotonic_env.to_i) if delta_monotonic_env
 
-      reporter = RequestReporter.new(context, txn_id, app_group_name, key, delta_monotonic)
+      reporter = RequestReporter.new(context, txn_id, app_group_name, key)
       return if reporter.null?
 
       rack_env['union_station_hooks'] = reporter
@@ -122,7 +120,7 @@ module UnionStationHooks
     #
     # This method should be used for logging exceptions outside the
     # request-response cycle, e.g. exceptions in threads. If you want to
-    # log a request that occurred during a request, use
+    # log an exception that occurred during a request, use
     # {RequestReporter#log_exception} instead. That method will also log
     # any related request-specific information, while this method does not.
     #
@@ -149,14 +147,15 @@ module UnionStationHooks
     # Returns an opaque object (a {TimePoint}) that represents a collection
     # of metrics about the current time.
     #
-    # Various API methods expect you to provide timing information. They
-    # accept standard Ruby `Time` objects, but it is generally better to
-    # pass `TimePoint` objects. Unlike the standard Ruby `Time` object,
-    # which only contains the wall clock time (the real time), `TimePoint`
-    # may contain additional timing information such as CPU time, time
-    # spent in userspace and kernel space, time spent context switching,
-    # etc. The exact information contained in the object is operating
-    # system specific, hence why the object is meant to be opaque.
+    # This TimePoint samples monotonic time (with a fallback to wall clock
+    # time) as well as CPU time, time spent in userspace and kernel space,
+    # time spent context switching, etc. The exact information contained
+    # in the object is operating system specific, hence the object is opaque.
+    #
+    # You should use it for the various API methods that require timing
+    # information. Those methods also accept standard Ruby `Time` objects,
+    # but we strongly recommended against doing this, because wall clock
+    # time can jump forwards and backwards, which may create issues.
     #
     # See {RequestReporter#log_controller_action} for an example of
     # an API method which expects timing information.
@@ -165,19 +164,28 @@ module UnionStationHooks
     # information is supposed to be obtained by calling
     # `UnionStationHooks.now`.
     #
-    # In all API methods that expect a `TimePoint`, you can also pass a
-    # normal Ruby `Time` object instead. But if you do that, the logged
-    # timing information will be less detailed. Only do this if you cannot
-    # obtain a `TimePoint` object for some reason.
-    #
     # @return [TimePoint]
     def now
+      monotime_usec = Utils.monotime_usec_now
       pt = Utils.process_times
-      TimePoint.new(Time.now, pt.utime, pt.stime)
+      TimePoint.new(monotime_usec, pt.utime, pt.stime)
+    end
+
+    # Returns a best-estimate delta (usec) between the wallclock and
+    # the monotonic clock (updated every request), such that:
+    # time_monotic_usec = time_wallclock_usec - delta
+    def get_delta_monotonic
+      @mono_mutex.synchronize { @delta_monotonic }
     end
 
   private
 
+    # Although the de-facto state seems to be that reading/writing instance variables
+    # is MT-safe, it's not guaranteed so better safe than sorry here.
+    def set_delta_monotonic(val)
+      @mono_mutex.synchronize { @delta_monotonic = val }
+    end
+
     def create_context
       require_lib('context')
       @@context = Context.new(config[:ust_router_address],
@@ -222,6 +230,8 @@ module UnionStationHooks
         UnionStationHooks::Log.debugging = true
       end
       require_simple_json
+      @mono_mutex = Mutex.new
+      @delta_monotonic = 0
       @@initialized = true
     end
   end

data/lib/union_station_hooks_core/context.rb

@@ -173,7 +173,7 @@ module UnionStationHooks
       end
     end
 
-    def continue_transaction(txn_id, group_name, category, key, delta_monotonic = 0)
+    def continue_transaction(txn_id, group_name, category, key)
       if !@server_address
         return Transaction.new(nil, nil)
       elsif !txn_id || txn_id.empty?
@@ -209,7 +209,7 @@ module UnionStationHooks
               Utils.encoded_timestamp,
               key,
               true)
-            return Transaction.new(@connection, txn_id, delta_monotonic)
+            return Transaction.new(@connection, txn_id)
           rescue SystemCallError, IOError
             @connection.disconnect
             UnionStationHooks::Log.warn(

data/lib/union_station_hooks_core/request_reporter.rb

@@ -102,7 +102,7 @@ module UnionStationHooks
     # in the {RequestReporter class description}.
     #
     # @api private
-    def initialize(context, txn_id, app_group_name, key, delta_monotonic)
+    def initialize(context, txn_id, app_group_name, key)
       raise ArgumentError, 'Transaction ID must be given' if txn_id.nil?
       raise ArgumentError, 'App group name must be given' if app_group_name.nil?
       raise ArgumentError, 'Union Station key must be given' if key.nil?
@@ -110,7 +110,6 @@ module UnionStationHooks
       @txn_id = txn_id
       @app_group_name = app_group_name
       @key = key
-      @delta_monotonic = delta_monotonic
       @transaction = continue_transaction
       @next_view_rendering_number = 1
       @next_user_activity_number = 1
@@ -139,7 +138,7 @@ module UnionStationHooks
 
     def continue_transaction
       @context.continue_transaction(@txn_id, @app_group_name,
-        :requests, @key, @delta_monotonic)
+        :requests, @key)
     end
 
     # Called when one of the methods return early upon detecting null

data/lib/union_station_hooks_core/simple_json.rb

@@ -29,6 +29,8 @@ require 'strscan'
 require 'forwardable'
 
 module UnionStationHooks
+
+# @private
 module SimpleJSON
 
 # Usage:
@@ -38,7 +40,6 @@ module SimpleJSON
 #
 # Run tests by executing this file directly. Pipe standard input to the script to have it
 # parsed as JSON and to display the result in Ruby.
-#
 class JSON
   def self.parse(data) new(data).parse end
 

data/lib/union_station_hooks_core/spec_helper.rb

@@ -116,6 +116,8 @@ module UnionStationHooks
 
     def initialize_ush_api
       UnionStationHooks.require_lib('api')
+      UnionStationHooks.instance_variable_set(:@mono_mutex, Mutex.new)
+      UnionStationHooks.instance_variable_set(:@delta_monotonic, 0)
     end
 
     def initialize_debugging

data/lib/union_station_hooks_core/time_point.rb

@@ -26,28 +26,14 @@ module UnionStationHooks
   # See {UnionStationHooks.now} for more information.
   class TimePoint
     # @api private
-    attr_reader :time, :utime, :stime
+    attr_reader :monotime, :utime, :stime
 
     # @api private
-    def initialize(time, utime, stime)
-      @time = time
+    def initialize(monotime, utime, stime)
+      @monotime = monotime
       @utime = utime
       @stime = stime
     end
 
-    # @api private
-    def usec_timestamp
-      @time.to_i * 1_000_000 + @time.usec
-    end
-
-    # @api private
-    def usec
-      @time.usec
-    end
-
-    # @api private
-    def to_i
-      @time.to_i
-    end
   end
 end

data/lib/union_station_hooks_core/transaction.rb

@@ -31,10 +31,9 @@ module UnionStationHooks
   class Transaction
     attr_reader :txn_id
 
-    def initialize(connection, txn_id, delta_monotonic = 0)
+    def initialize(connection, txn_id)
       @connection = connection
       @txn_id = txn_id
-      @delta_monotonic = delta_monotonic
       if connection
         raise ArgumentError, 'Transaction ID required' if txn_id.nil?
         connection.ref
@@ -84,37 +83,35 @@ module UnionStationHooks
     end
 
     def log_activity_begin(name, time = UnionStationHooks.now, extra_info = nil)
-      monotime = Utils.encoded_monotime_now(@delta_monotonic)
       if extra_info
         extra_info_base64 = Utils.base64(extra_info)
       else
         extra_info_base64 = nil
       end
       if time.is_a?(TimePoint)
-        message "BEGIN: #{name} (#{monotime}," \
+        message "BEGIN: #{name} (#{time.monotime.to_s(36)}," \
           "#{time.utime.to_s(36)},#{time.stime.to_s(36)}) " \
           "#{extra_info_base64}"
       else
-        message "BEGIN: #{name} (#{monotime})" \
+        message "BEGIN: #{name} (#{Utils.monotime_usec_from_time(time).to_s(36)})" \
           " #{extra_info_base64}"
       end
     end
 
     def log_activity_end(name, time = UnionStationHooks.now, has_error = false)
-      monotime = Utils.encoded_monotime_now(@delta_monotonic)
       if time.is_a?(TimePoint)
         if has_error
-          message "FAIL: #{name} (#{monotime}," \
+          message "FAIL: #{name} (#{time.monotime.to_s(36)}," \
             "#{time.utime.to_s(36)},#{time.stime.to_s(36)})"
         else
-          message "END: #{name} (#{monotime}," \
+          message "END: #{name} (#{time.monotime.to_s(36)}," \
             "#{time.utime.to_s(36)},#{time.stime.to_s(36)})"
         end
       else
         if has_error
-          message "FAIL: #{name} (#{monotime})"
+          message "FAIL: #{name} (#{Utils.monotime_usec_from_time(time).to_s(36)})"
         else
-          message "END: #{name} (#{monotime})"
+          message "END: #{name} (#{Utils.monotime_usec_from_time(time).to_s(36)})"
         end
       end
     end

data/lib/union_station_hooks_core/utils.rb

@@ -90,20 +90,22 @@ module UnionStationHooks
     end
 
     if Process.const_defined?(:CLOCK_MONOTONIC)
-      def encoded_monotime_now(delta_monotonic)
-        time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        timestamp = (time * 1_000_000).to_i
-        timestamp.to_s(36)
+      def monotime_usec_now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC, :microsecond)
       end
     else
-      def encoded_monotime_now(delta_monotonic)
-        time = Time.now
-        timestamp = time.to_i * 1_000_000 + time.usec - delta_monotonic
-        timestamp.to_s(36)
+      # Workaround for approximating the monotonic clock
+      def monotime_usec_now
+        monotime_usec_from_time
       end
     end
 
-    def encoded_timestamp(time = Time.now)
+    def monotime_usec_from_time(time = Time.now)
+      timestamp = time.to_i * 1_000_000 + time.usec - UnionStationHooks.get_delta_monotonic
+    end
+
+    def encoded_timestamp
+      time = Time.now
       timestamp = time.to_i * 1_000_000 + time.usec
       timestamp.to_s(36)
     end

data/lib/union_station_hooks_core/version_data.rb

@@ -39,6 +39,6 @@
 {
   :major  => 2,
   :minor  => 1,
-  :tiny   => 1,
-  :string => '2.1.1'
+  :tiny   => 2,
+  :string => '2.1.2'
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: union_station_hooks_core
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Hongli Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies: []
 description: Union Station Ruby hooks core code.
 email: info@phusion.nl