determinator 2.4.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63baaf3ee379eef31694ec105e48407970d0e53e6906af8e9a1746cfac5ca5e4
-  data.tar.gz: 88b70dc55dedc32c98dc1eb3619fd420471127c812a7cdda7086c13349d3bdca
+  metadata.gz: 02425b2fa13369e05f3f9013a7b42c24f50b4a0b21e96368dd28624b7172486d
+  data.tar.gz: b1076e122637aa6f0cdf02d06b0ecc61d5783cd383ae39312c514b0826f23391
 SHA512:
-  metadata.gz: 1ea1835cd7e0953c5d6747bbcbddfc43804cd33ffc3ed136c72ede003c2a24c9357c7746081370404b9851788a0b64b9d45a633657365524ed77cf6a5a69bf67
-  data.tar.gz: 2db13fd8793c724554c2ba4766e3e769eb5d9e4042481b153a205337c5b0cfaad1bd6a691b552ee9a25109f9b8bb7b6dc6837570e909bf5d60fab1f4fe056e86
+  metadata.gz: 737f32c5b7d5d1fa849d6433d90e8abaf9bef29b9774fcc174835dcd2f265d7668c6d53c9a2ac90f20cc166c95affba58cd95cc8df591d32e07321ca624e509e
+  data.tar.gz: 5f285ca73316e74fb13649bcef594e39f94a68579b38417a1be55f7aaa4e5e0770e8a2ed243b1e306d88f4d3b5a4f40e425af294f4c4bc3c8938af8917b9f668

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 2.4.2
+
+Feature:
+- Add endpoint information to tracking request
+
+Bug fix:
+- Make tracking request "start" attribute an actual time
+
+# 2.4.1
+
+Bug fix:
+- Update "fake" retrievers to match behaviour introduced in `v2.3.1` when a feature is missing
+
 # 2.4.0
 
 Feature:

data/README.md

@@ -289,12 +289,17 @@ end
 require 'determinator/tracking'
 
 Determinator::Tracking.on_request do |r|
-  Rails.logger.info("tag=determinator_request type=#{r.type} request_time=#{r.time} error=#{r.error?} response_status=#{r.attributes[:status]} sidekiq_queue=#{r.attributes[:queue]}")
+  Rails.logger.info("tag=determinator_request endpoint=#{r.endpoint} type=#{r.type} request_time=#{r.time} error=#{r.error?} response_status=#{r.attributes[:status]} sidekiq_queue=#{r.attributes[:queue]}")
   r.determinations.each do |d|
     Rails.logger.info("tag=determination id=#{d.id} guid=#{d.guid} flag=#{d.feature_id} result=#{d.determination}")
   end
 end
 
+# The library sets the "endpoint" with information about the request or sidekiq job. If you
+# have environment variables that further identify the service, e.g. ENV['APP_NAME'],
+# you can configure the tracker to prepend it to the endpoint:
+Determinator::Tracking.endpoint_env_vars = ['APP_NAME']
+
 # If using an APM, you can provide trace information on the request by providing a get_context hook: e.g.
 
 Determinator::Tracking.get_context do
@@ -310,9 +315,7 @@ Determinator::Tracking.get_context do
 end
 ```
 
-NOTE: this is implemented by keeping the list of requests in a per-request thread-local variable, which means that determinations will only be tracked on the main thread.
-
-If your application is spinning out worker threads, you should make the determinations in the main thread if possible; or collect them from your worker threads and track them in the main thread with
+NOTE: determinations will only be recorded on the threads where Determinator::Tracking is initialised via the middleware. If offloading work away from these thread (for example, by spinning up new threads within a Rack request or a Sidekiq worker), make the determinations before, and pass them through to the new threads; or, if it's not possible, collect them manually and track them in the request's thread with
 ```
 Determinator::Tracking.track(id, guid, feature, determination)
 ```

data/lib/determinator/retrieve/in_memory_retriever.rb

@@ -10,7 +10,7 @@ module Determinator
 
       # @param name [string,symbol] The name of the feature to retrieve
       def retrieve(name)
-        @features[name.to_s]
+        @features.fetch(name.to_s, MissingResponse.new)
       end
 
       # @param feature [Determinator::Feature] The feature to store

data/lib/determinator/retrieve/null_retriever.rb

@@ -10,6 +10,7 @@ module Determinator
       # The Control class will assume a nil return from this method
       # means the feature doesn't exist, so in turn will return `false`.
       def retrieve(_)
+        MissingResponse.new
       end
     end
   end

data/lib/determinator/tracking.rb

@@ -4,6 +4,8 @@ require 'determinator/tracking/context'
 module Determinator
   module Tracking
     class << self
+      attr_reader :endpoint_env_vars
+
       def instance
         Thread.current[:determinator_tracker]
       end
@@ -12,9 +14,9 @@ module Determinator
         Thread.current[:determinator_tracker] = Tracker.new(type)
       end
 
-      def finish!(error:, **attributes)
+      def finish!(endpoint:, error:, **attributes)
         return false unless started?
-        request = instance.finish!(error: error, **attributes)
+        request = instance.finish!(endpoint: endpoint, error: error, **attributes)
         clear!
         report(request)
         request
@@ -57,6 +59,16 @@ module Determinator
         @on_request = nil
         @get_context = nil
       end
+
+      def endpoint_env_vars=(vars)
+        @endpoint_env_vars = Array(vars)
+      end
+
+      def collect_endpoint_info(parts)
+        endpoint = Array(Determinator::Tracking.endpoint_env_vars).map{ |v| ENV[v] }
+        endpoint += Array(parts)
+        endpoint.reject{ |p| p.nil? || p == ''}.join(' ')
+      end
     end
   end
 end

data/lib/determinator/tracking/rack/middleware.rb

@@ -16,7 +16,24 @@ module Determinator
           error = true
           raise
         ensure
-          Determinator::Tracking.finish!(status: status, error: !!error)
+          Determinator::Tracking.finish!(
+            status: status,
+            error: !!error,
+            endpoint: extract_endpoint(env)
+          )
+        end
+
+        private
+
+        def extract_endpoint(env)
+          parts = if params = env['action_dispatch.request.path_parameters']
+            [[params[:controller], params[:action]].join('#')]
+          else
+            [env['REQUEST_METHOD'], env['PATH_INFO'] || env['REQUEST_URI']]
+          end
+          Determinator::Tracking.collect_endpoint_info(parts)
+        rescue
+          env['PATH_INFO']
         end
       end
     end

data/lib/determinator/tracking/request.rb

@@ -1,14 +1,16 @@
 module Determinator
   module Tracking
     class Request
-      attr_reader :type, :time, :error, :attributes, :determinations, :context
+      attr_reader :start, :type, :endpoint, :time, :error, :attributes, :determinations, :context
 
-      def initialize(type:, time:, error:, attributes:, determinations:, context: nil)
+      def initialize(start:, type:, endpoint:, time:, error:, attributes:, determinations:, context: nil)
+        @start = start
         @type = type
         @time = time
         @error = error
         @attributes = attributes
         @determinations = determinations
+        @endpoint = endpoint
         @context = context
       end
 

data/lib/determinator/tracking/sidekiq/middleware.rb

@@ -18,7 +18,11 @@ module Determinator
             error = true
             raise
           ensure
-            Determinator::Tracking.finish!(queue: queue, error: !!error)
+            Determinator::Tracking.finish!(
+              endpoint: Determinator::Tracking.collect_endpoint_info(worker.class.name),
+              queue: queue,
+              error: !!error
+            )
           end
         end
       end

data/lib/determinator/tracking/tracker.rb

@@ -9,7 +9,8 @@ module Determinator
       def initialize(type)
         @determinations = []
         @type = type
-        @start = now
+        @monotonic_start = now
+        @start = Time.now
       end
 
       def track(id, guid, feature, determination)
@@ -21,11 +22,13 @@ module Determinator
         )
       end
 
-      def finish!(error:, **attributes)
-        request_time = now - @start
+      def finish!(endpoint:, error:, **attributes)
+        request_time = now - @monotonic_start
         Determinator::Tracking::Request.new(
+          start: @start,
           type: type,
           time: request_time,
+          endpoint: endpoint,
           error: error,
           attributes: attributes,
           determinations: determinations,

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '2.4.0'
+  VERSION = '2.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.2
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday