redis-stream 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e636f1c98003bb96c0ca288b66e7ec9e8a32232a2eb1a06c3c5291df97bed4b
-  data.tar.gz: d9e9533cc0175ceb705d4f9d9964f5fb5f94c517df3bd3cd5614c12dc2962c76
+  metadata.gz: fbe96b36fe4773c01e41855ee855e5f9439173c5d49a29d2437a13387f6ee3e4
+  data.tar.gz: 8ed325cf47a32f25336bea011abcd1de73e4ab05807168a453d0b7408cf74ada
 SHA512:
-  metadata.gz: b900b2614e55c5a470cf1b54f0751475c4186a9a1272bd1d0acefb0a9827139ed34d4e857494396333a2ff4c0f4556050df7400316f236502a4261f2916aab05
-  data.tar.gz: cf969f706a177b0636f0100909987fc52fee799b502accae266a697524068d77ce9d12919b9bc80dda6acaa055d6ef9532a85b183fcfa0c0333ff55f0d89a507
+  metadata.gz: 312cf26889a74940ad75bab25350d8edd3c2edccca57229c141f2cd3c57c744b45909a9a9aa8318d0925d0f1fe2cd597d8fa4e18bac0353644464ccd72985d45
+  data.tar.gz: 0cd8e58a47892aca5f3cdb70a04372d8b92b72c24509404213e55d3978ac436a9b89c78b67bcd6078212b8f5996a148fb4ac6b6307ad5e21d41523fd86c62340

data/Gemfile.lock

@@ -1,22 +1,35 @@
 PATH
   remote: .
   specs:
-    redis-stream (0.3.0)
+    redis-stream (0.4.0)
       moneta (~> 1.2)
       multi_json (~> 1.14)
       redis (= 4.1.3)
+      zipkin-tracer (~> 0.43)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    concurrent-ruby (1.1.5)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
     minitest (5.13.0)
     moneta (1.2.1)
     multi_json (1.14.1)
+    multipart-post (2.1.1)
+    rack (2.1.2)
     rake (10.5.0)
     redis (4.1.3)
+    sucker_punch (2.1.2)
+      concurrent-ruby (~> 1.0)
+    zipkin-tracer (0.43.0)
+      faraday (~> 0.13)
+      rack (>= 1.0)
+      sucker_punch (~> 2.0)
 
 PLATFORMS
   java
+  ruby
 
 DEPENDENCIES
   bundler (~> 2.0)

data/README.md

@@ -27,8 +27,39 @@ Load the stream library
 require 'redis/stream'
 ```
 Available objects
-### Redis::Stream::Client
 ### Redis::Stream::Config
+Simple way to read and manage a config file. It looks for a config.yml file in the current and './config' directory.
+#### _name_
+name defaults to config.yml
+```ruby 
+    include Redis::Stream
+    puts Config.name
+    Config.name = "test.yml"
+``` 
+#### _path_
+path to the config file
+```ruby 
+    include Redis::Stream
+    puts Config.path
+    Config.path = "./configDEV"
+```
+#### _[key]_
+reads and writes the key or key/value from/to the config file
+```ruby 
+    include Redis::Stream
+    puts Config[:cache]
+    Config[:cache] = "./cache"
+```
+
+#### include?(key)
+check if key exists in the config file
+#### file_exists?()
+check if the config file exists 
+#### _init_
+This function is called implicitly. You do not need to call it
+
+
+### Redis::Stream::Client
 ### Redis::Stream::Inspect
 ### Redis::Stream::Type
 ### Redis::Stream::DataCache

data/lib/redis/stream/client.rb

@@ -6,23 +6,30 @@ require "thread"
 require "redis/stream/inspect"
 require "redis/stream/config"
 require "redis/stream/data_cache"
+require "redis/stream/tracer/zipkin_tracer"
 
 class Redis
   module Stream
     class Client
       include Redis::Stream::Inspect
 
-      attr_reader :logger, :name, :group, :consumer_id, :cache, :redis, :non_blocking
+      attr_reader :logger, :name, :group, :stream, :consumer_id, :cache, :redis, :non_blocking
 
       # Initialize: setup rstream
       # @param [String] stream_name        name of the rstream
-      # @param [String] group         name of the rstream group
+      # @param [String] group_name         name of the rstream group
+      # @param [String] name               name of the Stream Client
       # @param [Object] options       options can contain redis[host, port, db] and logger keys
       #
       # Example: Redis::Stream::Client.new("resolver", "stream", {"logger" => Logger.new(STDOUT)})
       # if group is nil or not supplied then no rstream group will be setup
       def initialize(stream_name, group_name = nil, name = rand(36 ** 7).to_s(36), options = {})
-        default_options = {"host" => "127.0.0.1", "port" => 6379, "db" => 0, "config_file_path" => '.', "logger" => Logger.new(STDOUT)}
+        default_options = {"host" => "127.0.0.1",
+                           "port" => 6379,
+                           "db" => 0,
+                           "config_file_path" => '.',
+                           "logger" => Logger.new(STDOUT),
+                           "zipkin_config" => {}}
         options = default_options.merge(options)
 
         Redis::Stream::Config.path = options['config_file_path']
@@ -32,7 +39,7 @@ class Redis
         db = options["db"]
         @logger = options["logger"]
         @cache = options.include?('caching') && options['caching'] ? Redis::Stream::DataCache.new : nil
-
+        @tracer = ZipkinTracer::RedisStreamHandler.new(self, options["zipkin_config"])
         @name = name
         @state = Redis::Stream::State::IDLE
         @stream = stream_name
@@ -60,12 +67,18 @@ class Redis
         @logger.info "#{@consumer_id} - Last ID = #{@last_id}"
       end
 
+      def trace(topic, span = nil, &block)
+        @tracer.trace(topic, span, &block)
+      end
+
+      def trace_error(msg, span, &block)
+        @tracer.trace_error(msg, span, &block)
+      end
+
 
       # add: add a message to the stream
       # @param [Object] data                    Any data you want to transmit
-      # @param [String] to                      Name of the consumer can be "*" or "" or nil for any consumer
-      # @param [String] group                   Name of the consumer group can be "*" or "" or nil for any group
-      # @param [Stream::Type] type    Type of message
+      # @param [Hash{String->String}]           Options
       #
       # no passthrough variable here. The passthrough is available in the start method
       def add(data = {}, options = {})
@@ -87,11 +100,7 @@ class Redis
 
       # sync_add: same as add command but synchronous. Blocks call until a message arrives
       # @param [Object] data                    Any data you want to transmit
-      # @param [String] to                      Name of the consumer can be "*" or "" or nil for any consumer
-      # @param [String] group                   Name of the consumer group can be "*" or "" or nil for any group
-      # @param [Stream::Type] type    Type of message
-      # @param [Integer] time_out               Time out after x seconds
-      # @param [Boolean] passthrough            Receive all messages also the ones intended for other consumers
+      # @param [Hash{String->String}]           Options
       def sync_add(data = {}, options = {})
         raise "Client isn't running" unless @state.eql?(Redis::Stream::State::RUNNING)
 

data/lib/redis/stream/tracer/zipkin_tracer.rb

@@ -0,0 +1,66 @@
+require 'socket'
+require 'zipkin-tracer'
+
+module ZipkinTracer
+  class RedisStreamHandler
+    def initialize(stream, config = nil)
+      @stream = stream
+
+      @config = Config.new(nil, config)
+      @tracer = TracerFactory.new.tracer(@config) rescue nil
+    end
+
+    def trace(topic, span=nil)
+      if @tracer.is_a?(Trace::NullSender)
+        yield nil if block_given?
+      else
+        trace_id = trace_id_from_span(span)
+        TraceContainer.with_trace_id(trace_id) do
+          trace_id = trace_id.next_id unless span.nil?
+          @tracer.with_new_span(trace_id, topic) do |new_span|
+            new_span.kind = Trace::Span::Kind::CLIENT
+            new_span.record("Session")
+            new_span.record_tag('group', @stream.group)
+            new_span.record_tag('stream',@stream.stream)
+            new_span.record_tag('client', @stream.name)
+
+            yield new_span if block_given?
+          end
+        end
+      end
+    end
+
+    def trace_error(msg, span = nil)
+      if @tracer.is_a?(Trace::NullSender)
+        yield nil if block_given?
+      else
+        span.record_tag(Trace::Span::Tag::ERROR, msg)
+        yield span if block_given?
+      end
+    end
+
+    private
+    def trace_id_from_span(span=nil)
+      if span.nil?
+        span_id  = TraceGenerator.new.generate_id
+        trace_id = TraceGenerator.new.generate_id_from_span_id(span_id)
+        parent_span_id = nil
+        sampled = false
+        flags = 0
+        shared = false
+      else
+        span_h = span.to_h
+        span_id  = span_h[:id]
+        trace_id = span_h[:traceId]
+        parent_span_id = span_h[:parent_span_id]
+        sampled = false
+        flags = 0
+        shared = true
+      end
+
+      Trace::TraceId.new(trace_id, parent_span_id, span_id, sampled, flags, shared)
+    end
+
+
+  end
+end

data/lib/redis/stream/version.rb

@@ -1,6 +1,6 @@
 #encoding: UTF-8
 class Redis
   module Stream
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/redis-stream.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "redis", "4.1.3"
   spec.add_dependency "moneta", "~> 1.2"
   spec.add_dependency "multi_json", "~> 1.14"
+  spec.add_dependency "zipkin-tracer", "~> 0.43"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-stream
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mehmet Celik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2020-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: zipkin-tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
 description: Simple stream library using Redis Streams
 email:
 - mehmet@celik.be
@@ -119,6 +133,7 @@ files:
 - lib/redis/stream/group.rb
 - lib/redis/stream/inspect.rb
 - lib/redis/stream/state.rb
+- lib/redis/stream/tracer/zipkin_tracer.rb
 - lib/redis/stream/type.rb
 - lib/redis/stream/version.rb
 - redis-stream.gemspec