sqreen 1.20.1-java → 1.22.0-java

data/lib/sqreen/ecosystem/module_api/tracing/messaging_data.rb

@@ -0,0 +1,35 @@
+require 'sqreen/ecosystem/util/call_writers_from_init'
+
+module Sqreen
+  module Ecosystem
+    module ModuleApi
+      module Tracing
+        # The data the tracing module needs in order to populate
+        # +Sqreen::Ecosystem::Tracing::Signals::TracingConsumer::Payload+ and
+        # +Sqreen::Ecosystem::Tracing::Signals::TracingProducer::Payload+.
+        #
+        # Signals are not produced by the data producers (transport)
+        # because of superior orders, as the only current use of this
+        # data is to generate signals.
+        module MessagingData
+          include Util::CallWritersFromInit
+
+          # @return [Symbol]
+          attr_accessor :message_type
+
+          # @return [String]
+          attr_accessor :host
+
+          # @return [String]
+          attr_accessor :ip
+
+          # @return [String]
+          attr_accessor :topic
+
+          # @return [String]
+          attr_accessor :tracing_identifier
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/module_api/tracing/producer_data.rb

@@ -0,0 +1,13 @@
+require 'sqreen/ecosystem/module_api/tracing/messaging_data'
+
+module Sqreen
+  module Ecosystem
+    module ModuleApi
+      module Tracing
+        class ProducerData
+          include MessagingData
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/module_api/tracing/server_data.rb

@@ -0,0 +1,27 @@
+require 'sqreen/ecosystem/util/call_writers_from_init'
+
+module Sqreen
+  module Ecosystem
+    module ModuleApi
+      module Tracing
+        # The data the tracing module needs in order to populate
+        # +Sqreen::Ecosystem::Tracing::Signals::TracingServer::Payload+
+        module ServerData
+          include Util::CallWritersFromInit
+
+          # @return [Symbol]
+          attr_accessor :transport
+
+          # @return [String]
+          attr_accessor :client_ip
+
+          # @return [Array<String>]
+          attr_accessor :previous_hops
+
+          # @return [String]
+          attr_accessor :tracing_identifier
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/module_api/tracing_id_generation.rb

@@ -0,0 +1,16 @@
+module Sqreen
+  module Ecosystem
+    module ModuleApi
+      module TracingIdGeneration
+        # for injection
+        attr_writer :tracing_id_producer
+
+        private
+
+        def create_tracing_id
+          @tracing_id_producer.call
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/module_api/transaction_storage.rb

@@ -0,0 +1,71 @@
+require 'sqreen/ecosystem/transaction_storage'
+require 'sqreen/ecosystem/loggable'
+
+module Sqreen
+  module Ecosystem
+    module ModuleApi
+      module TransactionStorage
+        class TxLocalVariables
+          class << self
+            class << self
+              include Sqreen::Ecosystem::Loggable
+
+              private
+
+              def attr_reader(attr, _opts = {})
+                define_method attr do
+                  tx_storage = Ecosystem::TransactionStorage.fetch_thread_local
+                  return unless tx_storage
+                  tx_storage[attr]
+                end
+              end
+
+              def attr_accessor(attr, opts = {})
+                # reader
+                attr_reader attr, opts
+
+                # writer (2 variants)
+                do_assign = proc do |value|
+                  tx_storage = Ecosystem::TransactionStorage.fetch_thread_local
+                  unless tx_storage
+                    logger.debug do
+                      "Assignment of tx local attribute #{attr} to #{value} has no effect"
+                    end
+                    return
+                  end
+
+                  tx_storage[attr] = value
+                end
+
+                if opts.fetch(:allow_overwrite, false)
+                  define "#{attr}=", &do_assign
+                else
+                  define_method "#{attr}=" do |value|
+                    cur = public_send(attr)
+                    unless cur.nil?
+                      raise "Cannot override value of #{attr} from #{cur} with #{value}"
+                    end
+
+                    do_assign.call(value)
+                  end
+                end
+              end
+            end # TxLocalVariables.singleton_class.singleton_class
+
+            # usage:
+            # attr_reader :xxx
+
+            # in the future, we'll possibly need to expose the full
+            # TransactionStorage to the modules, at least if we don't
+            # opt for a more structured fashion of data exchange between
+            # the modules.
+          end # TxLocalVariables.singleton_class
+        end # TxLocalVariables
+
+        def tx_local_vars
+          TxLocalVariables
+        end
+      end # TransactionStorage module
+    end
+  end
+end

data/lib/sqreen/ecosystem/module_registry.rb

@@ -0,0 +1,48 @@
+require 'sqreen/ecosystem/loggable'
+
+module Sqreen
+  module Ecosystem
+    class ModuleRegistry
+      include Sqreen::Ecosystem::Loggable
+
+      def initialize
+        @mods = []
+      end
+
+      def register(mod)
+        @mods << mod
+      end
+
+      def init_all
+        logger.info { "Initializing #{@mods.size} ecosystem modules" }
+        each_module do |mod|
+          unless mod.respond_to? :setup
+            logger.debug { "Module with type #{mod.class} requires no initialization" }
+            next
+          end
+
+          logger.debug { "Initializing module with type #{mod.class}" }
+          mod.setup
+        end
+      end
+
+      def destroy_all
+        # not implemented
+      end
+
+      # @param [Class] type
+      def each_module(type = nil, &block)
+        selected_mods = type ? (@mods.select { |mod| mod.is_a?(type) }) : @mods
+        if block_given?
+          selected_mods.each(&block)
+        else
+          selected_mods.each
+        end
+      end
+
+      def module_subset(type)
+        each_module(type).to_a
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/tracing/modules/client.rb

@@ -0,0 +1,35 @@
+require 'sqreen/ecosystem/tracing/modules/determine_ip'
+require 'sqreen/ecosystem/tracing/signals/tracing_client'
+require 'sqreen/ecosystem/loggable'
+require 'sqreen/ecosystem/module_api'
+require 'sqreen/ecosystem/module_api/tracing'
+require 'sqreen/ecosystem/module_api/tracing/client_data'
+
+module Sqreen
+  module Ecosystem
+    module Tracing
+      module Modules
+        class Client
+          include ModuleApi::Tracing
+          include ModuleApi::TracingIdGeneration
+          include ModuleApi::Loggable
+
+          consumes    ModuleApi::Tracing::ClientData
+          fixed_scope 'client'
+
+          def receive(data)
+            signal = Tracing::Signals::TracingClient.new
+            signal.payload = Tracing::Signals::TracingClient::Payload.new(
+              transport: data.transport,
+              host: data.host || '',
+              ip: data.ip,
+              tracing_identifier: data.tracing_identifier || create_tracing_id
+            )
+
+            submit_signal signal
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/tracing/modules/consumer.rb

@@ -0,0 +1,35 @@
+require 'sqreen/ecosystem/tracing/modules/determine_ip'
+require 'sqreen/ecosystem/tracing/signals/tracing_consumer'
+require 'sqreen/ecosystem/module_api'
+require 'sqreen/ecosystem/module_api/tracing/consumer_data'
+
+module Sqreen
+  module Ecosystem
+    module Tracing
+      module Modules
+        class Consumer
+          include ModuleApi::Tracing
+          include ModuleApi::TracingIdGeneration
+          include ModuleApi::Loggable
+
+          consumes    ModuleApi::Tracing::ConsumerData
+          fixed_scope 'consumer'
+
+          # @param [ModuleApi::Tracing::ConsumerData] data
+          def receive(data)
+            signal = Tracing::Signals::TracingConsumer.new
+            signal.payload = Tracing::Signals::TracingConsumer::Payload.new(
+              message_type: data.message_type,
+              host: data.host || '',
+              ip: data.ip,
+              topic: data.topic,
+              tracing_identifier: data.tracing_identifier || create_tracing_id
+            )
+
+            submit_signal signal
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/tracing/modules/determine_ip.rb

@@ -0,0 +1,28 @@
+require 'sqreen/ecosystem/module_api'
+
+module Sqreen
+  module Ecosystem
+    module Tracing
+      module Modules
+        module DetermineIp
+          class << self
+            include ModuleApi::Loggable
+
+            def [](data)
+              return data.ip if data.ip
+
+              return nil unless data.host && !data.host.empty?
+
+              begin
+                IPSocket.getaddress data.host
+              rescue SocketError => e
+                logger.info { "Error resolving #{data.host}: #{e.message}" }
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/tracing/modules/producer.rb

@@ -0,0 +1,35 @@
+require 'sqreen/ecosystem/tracing/modules/determine_ip'
+require 'sqreen/ecosystem/tracing/signals/tracing_producer'
+require 'sqreen/ecosystem/module_api'
+require 'sqreen/ecosystem/module_api/tracing/producer_data'
+
+module Sqreen
+  module Ecosystem
+    module Tracing
+      module Modules
+        class Producer
+          include ModuleApi::Tracing
+          include ModuleApi::TracingIdGeneration
+          include ModuleApi::Loggable
+
+          consumes    ModuleApi::Tracing::ProducerData
+          fixed_scope 'producer'
+
+          # @param [ModuleApi::Tracing::ProducerData] data
+          def receive(data)
+            signal = Tracing::Signals::TracingProducer.new
+            signal.payload = Tracing::Signals::TracingProducer::Payload.new(
+              message_type: data.message_type,
+              host: data.host || '',
+              ip: data.ip,
+              topic: data.topic,
+              tracing_identifier: data.tracing_identifier || create_tracing_id
+            )
+
+            submit_signal signal
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/tracing/modules/server.rb

@@ -0,0 +1,30 @@
+require 'sqreen/ecosystem/tracing/signals/tracing_server'
+require 'sqreen/ecosystem/module_api/tracing'
+require 'sqreen/ecosystem/module_api/tracing/server_data'
+
+module Sqreen
+  module Ecosystem
+    module Tracing
+      module Modules
+        class Server
+          include ModuleApi::Tracing
+
+          consumes    ModuleApi::Tracing::ServerData
+          fixed_scope 'server'
+
+          # @param [Sqreen::Ecosystem::ModuleApi::Tracing::ServerData] data
+          def receive(data)
+            signal = Tracing::Signals::TracingServer.new
+            signal.payload = Tracing::Signals::TracingServer::Payload.new(
+              transport: data.transport,
+              client_ip: data.client_ip,
+              tracing_identifier: data.tracing_identifier
+            )
+
+            submit_signal signal
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sqreen/ecosystem/tracing/sampler.rb

@@ -0,0 +1,160 @@
+require 'thread' # for Mutex
+require 'singleton'
+require 'sqreen/ecosystem/loggable'
+
+# see https://github.com/sqreen/TechDoc/blob/master/content/specs/spec000024-sampling.md
+
+module Sqreen
+  module Ecosystem
+    module Tracing
+      class Sampler
+        # @param [Array<Hash{String=>Object}>] definition
+        def initialize(definition)
+          @lines = definition.map { |h| Line.new(h) }
+        end
+
+        def should_sample?
+          line = @lines.find(&:triggers?)
+          line ? line.saved_definition : false
+        end
+
+        class Line
+          include Loggable
+
+          attr_reader :saved_definition
+
+          # @param [Hash{String=>Object}] definition
+          def initialize(definition)
+            @saved_definition = definition
+            @primitives = []
+
+            unknown = definition.keys - PRIMITIVES_MAP.keys
+            unless unknown.empty?
+              logger.warn "Unknown primitives: #{unknown}"
+              @primitives << AlwaysFalsePrimitive.instance
+              return
+            end
+
+            PRIMITIVES_MAP.each do |key, prim_class|
+              next unless definition[key]
+              @primitives << prim_class.new(definition[key])
+            end
+            # if @primitives is empty the line will always
+            # return true: [].all?(&:triggers?) is true
+          end
+
+          def triggers?
+            @primitives.all?(&:triggers?)
+          end
+        end
+
+        class AlwaysFalsePrimitive
+          include Singleton
+
+          def triggers?
+            false
+          end
+        end
+
+        class CallsPrimitive
+          def initialize(calls_period)
+            @calls_period = calls_period
+            @count = 0
+            @mutex = Mutex.new
+          end
+
+          def triggers?
+            prev_count = nil
+            @mutex.synchronize do
+              prev_count = @count
+              @count += 1
+            end
+
+            (prev_count % @calls_period).zero?
+          end
+        end
+
+        class RandomPrimitive
+          def initialize(probability)
+            @probability = probability
+          end
+
+          def triggers?
+            @probability >= rand
+          end
+        end
+
+        class MaxDurationMinutesPrimitive
+          def initialize(time_in_minutes)
+            @deadline = Sqreen.time + time_in_minutes * 60
+            @passed = false # no locking needed
+          end
+
+          def triggers?
+            return false if @passed
+            if Sqreen.time > @deadline
+              @passed = true
+              return false
+            end
+            true
+          end
+        end
+
+        class TargetPerMinutePrimitive
+          def initialize(max_calls)
+            @max_calls = max_calls
+            @minute_last_call = cur_minute
+            @calls_accumulated = 0
+            @mutex = Mutex.new
+          end
+
+          def triggers?
+            this_minute = cur_minute
+            calls_cur_minute = @mutex.synchronize do
+              if @minute_last_call == this_minute
+                @calls_accumulated += 1
+              else
+                @minute_last_call = this_minute
+                @calls_accumulated = 1
+              end
+            end
+
+            calls_cur_minute <= @max_calls
+          end
+
+          private
+
+          def cur_minute
+            (Sqreen.time / 60).floor
+          end
+        end
+
+        class MaxCallsPrimitive
+          def initialize(max_calls)
+            @max_calls = max_calls
+            @disabled = false # to avoid lock
+            @mutex = Mutex.new
+            @num_calls = 0
+          end
+
+          def triggers?
+            return false if @disabled
+            num_calls = @mutex.synchronize do
+              @num_calls += 1
+            end
+
+            num_calls <= @max_calls
+          end
+        end
+
+        PRIMITIVES_MAP = {
+          "calls"                => CallsPrimitive,
+          "random"               => RandomPrimitive,
+          "max_duration_minutes" => MaxDurationMinutesPrimitive,
+          "target_per_minute"    => TargetPerMinutePrimitive,
+          "max_calls"            => MaxCallsPrimitive,
+        }.freeze
+      end
+    end
+  end
+end