Merge pull request #375 from splitio/development

[7.3.0] Development into master

Author: sanzmauro

.rubocop.yml

@@ -3,23 +3,34 @@ Documentation:
 
 Metrics/AbcSize:
   Max: 26
+  Exclude:
+    - lib/splitclient-rb/telemetry/memory/memory_synchronizer.rb
 
 Metrics/MethodLength:
   Max: 20
+  Exclude:
+    - lib/splitclient-rb/telemetry/memory/memory_synchronizer.rb
 
 Metrics/ClassLength:
   Max: 150
+  Exclude:
+    - lib/splitclient-rb/telemetry/memory/memory_synchronizer.rb
 
 Metrics/CyclomaticComplexity:
   Max: 8
 
+Metrics/ParameterLists:
+  Exclude:
+    - lib/splitclient-rb/engine/sync_manager.rb
+
 Metrics/LineLength:
   Max: 130
   Exclude:
     - spec/sse/**/*
     - spec/integrations/**/*
     - spec/engine/sync_manager_spec.rb
     - spec/engine/auth_api_client_spec.rb
+    - spec/telemetry/synchronizer_spec.rb
 
 Style/BracesAroundHashParameters:
   Exclude:
@@ -50,3 +61,4 @@ AllCops:
     - lib/splitclient-rb/engine/metrics/**/*
     - lib/splitclient-rb/engine/models/**/*
     - lib/splitclient-rb/engine/parser/**/*
+    - spec/telemetry/synchronizer_spec.rb

CHANGES.txt

@@ -1,5 +1,9 @@
 CHANGES
 
+7.3.0 (Jul 12, 2021)
+- Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
+- Fixed high cpu usage when api key is wrong.
+
 7.2.3 (Feb 24, 2021)
 - Fixed missing segment fetch after an SPLIT_UPDATE.
 - Updated streaming logic to support multiregion.

README.md

@@ -63,7 +63,7 @@ Split has built and maintains SDKs for:
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
 * Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
-* .NET [Github](https://github.com/splitio/.net-core-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)

lib/splitclient-rb.rb

@@ -23,12 +23,8 @@
 require 'splitclient-rb/cache/repositories/events/redis_repository'
 require 'splitclient-rb/cache/repositories/impressions/memory_repository'
 require 'splitclient-rb/cache/repositories/impressions/redis_repository'
-require 'splitclient-rb/cache/repositories/metrics_repository'
-require 'splitclient-rb/cache/repositories/metrics/memory_repository'
-require 'splitclient-rb/cache/repositories/metrics/redis_repository'
 require 'splitclient-rb/cache/senders/impressions_formatter'
 require 'splitclient-rb/cache/senders/impressions_sender'
-require 'splitclient-rb/cache/senders/metrics_sender'
 require 'splitclient-rb/cache/senders/events_sender'
 require 'splitclient-rb/cache/senders/impressions_count_sender'
 require 'splitclient-rb/cache/senders/localhost_repo_cleaner'
@@ -51,10 +47,10 @@
 require 'splitclient-rb/engine/api/faraday_adapter/patched_net_http_persistent'
 require 'splitclient-rb/engine/api/client'
 require 'splitclient-rb/engine/api/impressions'
-require 'splitclient-rb/engine/api/metrics'
 require 'splitclient-rb/engine/api/segments'
 require 'splitclient-rb/engine/api/splits'
 require 'splitclient-rb/engine/api/events'
+require 'splitclient-rb/engine/api/telemetry_api'
 require 'splitclient-rb/engine/common/impressions_counter'
 require 'splitclient-rb/engine/common/impressions_manager'
 require 'splitclient-rb/engine/parser/condition'
@@ -84,7 +80,6 @@
 require 'splitclient-rb/engine/matchers/equal_to_matcher'
 require 'splitclient-rb/engine/matchers/matches_string_matcher'
 require 'splitclient-rb/engine/evaluator/splitter'
-require 'splitclient-rb/engine/metrics/metrics'
 require 'splitclient-rb/engine/metrics/binary_search_latency_tracker'
 require 'splitclient-rb/engine/models/split'
 require 'splitclient-rb/engine/models/label'
@@ -95,9 +90,6 @@
 require 'splitclient-rb/engine/synchronizer'
 require 'splitclient-rb/utilitites'
 
-# redis metrics fixer
-require 'splitclient-rb/redis_metrics_fixer'
-
 # SSE 
 require 'splitclient-rb/sse/event_source/back_off'
 require 'splitclient-rb/sse/event_source/client'
@@ -110,6 +102,29 @@
 require 'splitclient-rb/sse/notification_processor'
 require 'splitclient-rb/sse/sse_handler'
 
+# Telemetry
+require 'splitclient-rb/telemetry/domain/constants'
+require 'splitclient-rb/telemetry/domain/structs'
+require 'splitclient-rb/telemetry/storages/memory'
+require 'splitclient-rb/telemetry/evaluation_consumer'
+require 'splitclient-rb/telemetry/evaluation_producer'
+require 'splitclient-rb/telemetry/init_consumer'
+require 'splitclient-rb/telemetry/init_producer'
+require 'splitclient-rb/telemetry/runtime_consumer'
+require 'splitclient-rb/telemetry/runtime_producer'
+require 'splitclient-rb/telemetry/sync_task'
+require 'splitclient-rb/telemetry/synchronizer'
+require 'splitclient-rb/telemetry/memory/memory_evaluation_consumer'
+require 'splitclient-rb/telemetry/memory/memory_evaluation_producer'
+require 'splitclient-rb/telemetry/memory/memory_init_consumer'
+require 'splitclient-rb/telemetry/memory/memory_init_producer'
+require 'splitclient-rb/telemetry/memory/memory_runtime_consumer'
+require 'splitclient-rb/telemetry/memory/memory_runtime_producer'
+require 'splitclient-rb/telemetry/memory/memory_synchronizer'
+require 'splitclient-rb/telemetry/redis/redis_evaluation_producer'
+require 'splitclient-rb/telemetry/redis/redis_init_producer'
+require 'splitclient-rb/telemetry/redis/redis_synchronizer'
+
 # C extension
 require 'murmurhash/murmurhash_mri'
 

lib/splitclient-rb/cache/adapters/redis_adapter.rb

@@ -17,6 +17,10 @@ def initialize(redis_url)
           @redis = Redis.new(connection)
         end
 
+        def hincrby(key, field, increment)
+          @redis.hincrby(key, field, increment)
+        end
+
         # Map
         def initialize_map(key)
           # No need to initialize hash/map in Redis

lib/splitclient-rb/cache/fetchers/segment_fetcher.rb

@@ -4,13 +4,13 @@ module Fetchers
       class SegmentFetcher
         attr_reader :segments_repository
 
-        def initialize(segments_repository, api_key, metrics, config, sdk_blocker = nil)
+        def initialize(segments_repository, api_key, config, sdk_blocker, telemetry_runtime_producer)
           @segments_repository = segments_repository
           @api_key = api_key
-          @metrics = metrics
           @config = config
           @sdk_blocker = sdk_blocker
           @semaphore = Mutex.new
+          @telemetry_runtime_producer = telemetry_runtime_producer
         end
 
         def call
@@ -27,19 +27,19 @@ def call
           end
         end
 
-        def fetch_segments_if_not_exists(names)
+        def fetch_segments_if_not_exists(names, cache_control_headers = false)
           names.each do |name|
             change_number = @segments_repository.get_change_number(name)
 
-            fetch_segment(name) if change_number == -1
+            fetch_segment(name, cache_control_headers) if change_number == -1
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
         end
 
-        def fetch_segment(name)
+        def fetch_segment(name, cache_control_headers = false)
           @semaphore.synchronize do
-            segments_api.fetch_segments_by_names([name])
+            segments_api.fetch_segments_by_names([name], cache_control_headers)
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
@@ -50,6 +50,7 @@ def fetch_segments
             segments_api.fetch_segments_by_names(@segments_repository.used_segment_names)
 
             @sdk_blocker.segments_ready!
+            @sdk_blocker.sdk_internal_ready
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
@@ -66,7 +67,10 @@ def segments_thread
             @config.logger.info('Starting segments fetcher service') if @config.debug_enabled
 
             loop do
-              next unless @sdk_blocker.splits_repository.ready?
+              unless @sdk_blocker.splits_repository.ready?
+                sleep 0.2
+                next
+              end
 
               fetch_segments
               @config.logger.debug("Segment names: #{@segments_repository.used_segment_names.to_a}") if @config.debug_enabled
@@ -76,10 +80,10 @@ def segments_thread
               sleep(sleep_for)
             end
           end
-        end        
+        end
 
         def segments_api
-          @segments_api ||= SplitIoClient::Api::Segments.new(@api_key, @metrics, @segments_repository, @config)
+          @segments_api ||= SplitIoClient::Api::Segments.new(@api_key, @segments_repository, @config, @telemetry_runtime_producer)
         end
       end
     end

lib/splitclient-rb/cache/fetchers/split_fetcher.rb

@@ -4,13 +4,13 @@ module Fetchers
       class SplitFetcher
         attr_reader :splits_repository
 
-        def initialize(splits_repository, api_key, metrics, config, sdk_blocker = nil)
+        def initialize(splits_repository, api_key, config, sdk_blocker, telemetry_runtime_producer)
           @splits_repository = splits_repository
           @api_key = api_key
-          @metrics = metrics
           @config = config
           @sdk_blocker = sdk_blocker
           @semaphore = Mutex.new
+          @telemetry_runtime_producer = telemetry_runtime_producer
         end
 
         def call
@@ -27,9 +27,9 @@ def call
           end
         end
 
-        def fetch_splits
+        def fetch_splits(cache_control_headers = false)
           @semaphore.synchronize do
-            data = splits_since(@splits_repository.get_change_number)
+            data = splits_since(@splits_repository.get_change_number, cache_control_headers)
 
             data[:splits] && data[:splits].each do |split|
               add_split_unless_archived(split)
@@ -46,6 +46,7 @@ def fetch_splits
           end
         rescue StandardError => error
           @config.log_found_exception(__method__.to_s, error)
+          []
         end
 
         def stop_splits_thread
@@ -67,8 +68,8 @@ def splits_thread
           end
         end
 
-        def splits_since(since)
-          splits_api.since(since)
+        def splits_since(since, cache_control_headers = false)
+          splits_api.since(since, cache_control_headers)
         end
 
         def add_split_unless_archived(split)
@@ -94,7 +95,7 @@ def store_split(split)
         end
 
         def splits_api
-          @splits_api ||= SplitIoClient::Api::Splits.new(@api_key, @metrics, @config)
+          @splits_api ||= SplitIoClient::Api::Splits.new(@api_key, @config, @telemetry_runtime_producer)
         end
       end
     end

lib/splitclient-rb/cache/repositories/events/memory_repository.rb

@@ -5,10 +5,11 @@ module Events
         class MemoryRepository < EventsRepository
           EVENTS_MAX_SIZE_BYTES = 5242880
 
-          def initialize(config)
+          def initialize(config, telemetry_runtime_producer)
             @config = config
             @adapter = @config.events_adapter
             @size = 0
+            @telemetry_runtime_producer = telemetry_runtime_producer
           end
 
           def add(key, traffic_type, event_type, time, value, properties, event_size)
@@ -17,8 +18,10 @@ def add(key, traffic_type, event_type, time, value, properties, event_size)
 
             post_events if @size >= EVENTS_MAX_SIZE_BYTES || @adapter.length == @config.events_queue_size
 
-            rescue StandardError => error
-              @config.log_found_exception(__method__.to_s, error)
+            @telemetry_runtime_producer.record_events_stats(Telemetry::Domain::Constants::EVENTS_QUEUED, 1)
+          rescue StandardError => error
+            @config.log_found_exception(__method__.to_s, error)
+            @telemetry_runtime_producer.record_events_stats(Telemetry::Domain::Constants::EVENTS_DROPPED, 1)
           end
 
           def clear

lib/splitclient-rb/cache/repositories/events_repository.rb

@@ -6,16 +6,17 @@ class EventsRepository < Repository
         extend Forwardable
         def_delegators :@repository, :add, :clear, :batch
 
-        def initialize(config, api_key)
+        def initialize(config, api_key, telemetry_runtime_producer)
           super(config)
           @repository = case @config.events_adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
-            Repositories::Events::MemoryRepository.new(@config)
+            Repositories::Events::MemoryRepository.new(@config, telemetry_runtime_producer)
           when 'SplitIoClient::Cache::Adapters::RedisAdapter'
             Repositories::Events::RedisRepository.new(@config)
           end
 
           @api_key = api_key
+          @telemetry_runtime_producer = telemetry_runtime_producer
         end
 
         def post_events
@@ -48,7 +49,7 @@ def event(key, traffic_type, event_type, time, value, properties)
         private
 
         def events_api
-          @events_api ||= SplitIoClient::Api::Events.new(@api_key, @config)
+          @events_api ||= SplitIoClient::Api::Events.new(@api_key, @config, @telemetry_runtime_producer)
         end
       end
     end

lib/splitclient-rb/cache/repositories/impressions/memory_repository.rb

@@ -11,15 +11,23 @@ def initialize(config)
           end
 
           def add_bulk(impressions)
+            return 0 if impressions.nil?
+
+            count = 0
             impressions.each do |impression|
               @adapter.add_to_queue(impression)
+              count += 1
             end
+
+            0
           rescue ThreadError # queue is full
             if random_sampler.rand(1..1000) <= 2 # log only 0.2 % of the time
               @config.logger.warn("Dropping impressions. Current size is \
                 #{@config.impressions_queue_size}. " \
                 'Consider increasing impressions_queue_size')
             end
+
+            impressions.length - count
           end
 
           def batch