promoted-ruby-client 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ba0e172809a6aa76284b4b88980fa45dea5b2bf28cdda4fbe8e672b7510a83
-  data.tar.gz: e28586ed23f7db16b959bb9819072e502fc7af3805e68938f2bbf421fdc9e4d8
+  metadata.gz: 38925e54b884c3e36db632faa2481cd99621846848c21c80def989e1539a87d7
+  data.tar.gz: 6c0b3caedbef47b9ed6a5c5c1c9e58368031521c6f36181ae1a4938bd9f796fd
 SHA512:
-  metadata.gz: 4e6b42f73ff30726aa81af1c08b97a0cd0e0307685dec1f90dcce5d0d61d4009c3a2e6179af77a600038531101db187a83dc52f46a7c0ad4a99f7c6c2530b43e
-  data.tar.gz: f3d304f0a2aad7acc15229750f97b021da4c0bfe8deae40c6ac1110bc7c1621ab0db19635464ba835e4e9a9ec07b9cfa0c231a9163fa0e1dcffeeebfdc1e51fc
+  metadata.gz: eae233ce5d572a6e581a57572292edf212205ab15764ff41db98116506c548b0746a94be236d44dda1bb43d758005a25bef8bbcfb8816295f4de9f30efb75481
+  data.tar.gz: 5085fa33d2e4d040d134a69cc8af872b4c209bda2ddee1be1f51f3d7c3b948ac8300152a790fbcdadaa5dbb75902b94727d1b20575398d563b5aa6757cfc3ea4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.6)
+    promoted-ruby-client (0.1.7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -28,10 +28,10 @@ This client will suffice for building log requests. To send actually send traffi
 
 ```rb
 client = Promoted::Ruby::Client::PromotedClient.new({
-  :metrics_endpoint = "https://<get this from Promoted>",
-  :delivery_endpoint = "https://<get this from Promoted>",
-  :metrics_api_key = "<get this from Promoted>",
-  :delivery_api_key = "<get this from Promoted>"
+  :metrics_endpoint => "https://<get this from Promoted>",
+  :delivery_endpoint => "https://<get this from Promoted>",
+  :metrics_api_key => "<get this from Promoted>",
+  :delivery_api_key => "<get this from Promoted>"
 })
 ```
 

data/dev.md

@@ -4,5 +4,5 @@
 2. Get credentials for deployment from 1password.
 3. Modify `promoted-ruby-client.gemspec`'s push block.
 4. Run `gem build promoted-ruby-client.gemspec` to generate `gem`.
-5. Run (using new output) `gem push promoted-ruby-client-0.1.6.gem`
+5. Run (using new output) `gem push promoted-ruby-client-0.1.7.gem`
 6. Update README with new version.

data/lib/promoted/ruby/client.rb

@@ -19,7 +19,9 @@ module Promoted
         class Error < StandardError; end
 
         attr_reader :perform_checks, :default_only_log, :delivery_timeout_millis, :metrics_timeout_millis, :should_apply_treatment_func,
-                    :default_request_headers, :http_client
+                    :default_request_headers, :http_client, :logger, :shadow_traffic_delivery_percent, :async_shadow_traffic
+                    
+        attr_accessor :request_logging_on
         
         ##            
         # A common compact method implementation.
@@ -39,7 +41,8 @@ module Promoted
             @perform_checks = params[:perform_checks]
           end
 
-          @logger = params[:logger] # Example:  Logger.new(STDERR, :progname => "promotedai")
+          @logger               = params[:logger] # Example:  Logger.new(STDERR, :progname => "promotedai")
+          @request_logging_on   = params[:request_logging_on] || false
 
           @default_request_headers = params[:default_request_headers] || {}
           @metrics_api_key = params[:metrics_api_key] || ''
@@ -66,21 +69,31 @@ module Promoted
           @http_client = FaradayHTTPClient.new
           @validator = Promoted::Ruby::Client::Validator.new
 
-          # Thread pool to process delivery of shadow traffic. Will silently drop excess requests beyond the queue
-          # size, and silently eat errors on the background threads.
-          @pool = Concurrent::ThreadPoolExecutor.new(
-            min_threads: 0,
-            max_threads: 10,
-            max_queue: 100,
-            fallback_policy: :discard
-          )
+          @async_shadow_traffic = true
+          if params[:async_shadow_traffic] != nil
+            @async_shadow_traffic = params[:async_shadow_traffic] || false
+          end
+
+          @pool = nil
+          if @async_shadow_traffic
+            # Thread pool to process delivery of shadow traffic. Will silently drop excess requests beyond the queue
+            # size, and silently eat errors on the background threads.
+            @pool = Concurrent::ThreadPoolExecutor.new(
+              min_threads: 0,
+              max_threads: 10,
+              max_queue: 100,
+              fallback_policy: :discard
+            )
+          end
         end
         
         ##
         # Politely shut down a Promoted client.
         def close
-          @pool.shutdown
-          @pool.wait_for_termination
+          if @pool
+            @pool.shutdown
+            @pool.wait_for_termination
+          end
         end
 
         ##
@@ -211,20 +224,38 @@ module Promoted
         private
 
         def send_request payload, endpoint, timeout_millis, api_key, headers={}, send_async=false
+          resp = nil
+
           headers["x-api-key"] = api_key
           use_headers = @default_request_headers.merge headers
           
-          if send_async
+          if @request_logging_on && @logger
+            @logger.info("promotedai") {
+              "Sending #{payload.to_json} to #{endpoint}"
+            }
+          end
+
+          if send_async && @pool
             @pool.post do
-              @http_client.send(endpoint, timeout_millis, payload, use_headers)
+              start_time = Time.now.to_i
+              begin
+                resp = @http_client.send(endpoint, timeout_millis, payload, use_headers)
+              rescue Faraday::Error => err
+                @logger.warn("Deliver call failed with #{err}") if @logger
+                return
+              end
+              ellapsed_time = Time.now.to_i - start_time
+              @logger.info("Deliver call completed in #{ellapsed_time} ms") if @logger
             end
           else
             begin
-              @http_client.send(endpoint, timeout_millis, payload, use_headers)
+              resp = @http_client.send(endpoint, timeout_millis, payload, use_headers)
             rescue Faraday::Error => err
               raise EndpointError.new(err)
             end
           end
+
+          return resp
         end
 
 
@@ -290,4 +321,5 @@ require "promoted/ruby/client/request_builder"
 require "promoted/ruby/client/sampler"
 require "promoted/ruby/client/util"
 require "promoted/ruby/client/validator"
-require 'securerandom'
+require 'securerandom'
+require 'time'

data/lib/promoted/ruby/client/version.rb

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "0.1.6"
+      VERSION = "0.1.7"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler