phobos 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31d36810a7dbe760625a6f08d618d37780c1f584
-  data.tar.gz: ffbca77c17a57c8bc86d6497e4e4f6fccb3efdd4
+  metadata.gz: 4fc3d3e6b285b1bc4cbb2a0dad3c67137ee9be99
+  data.tar.gz: d093c46556e62aa25ebb8e1dd1c40e5681033909
 SHA512:
-  metadata.gz: a6f98e9ce96d3c0671db8c7c63cb833b3189f3541706258dc2e4757d2ca714dfc675973c23dd2edb344c5f888c987674a24341d98345de0dc0c6d76de4138db6
-  data.tar.gz: 7c98f56c03f8d479bb7067bde18e6ba9290184b08eadad0a680c42c6cf001db71e9c42a86357ffd9909bbf27b3364f95e2211fcd05c56eec5a88364101411aad
+  metadata.gz: 5a6f68d45bd827a5b59df81a504fca1b4128706dd4755c1d56e2c9fb53f45a0d7eeb23bab6d149cc41a752da87a141dda01f0e97d4d36c71aed1b0739c473ef7
+  data.tar.gz: e0eaf75e328b57c3ce05fae5e128bd3ee88246376ce66e41a10b2a1006ec6f2b056052931185226dd993f8abc152f5aec99cadd3df47c82784080d6b231b059f

data/.gitignore

@@ -9,6 +9,6 @@
 spec/examples.txt
 /tmp/
 .DS_Store
-config/phobos.yml
+config/*.yml
 log/*.log
 .byebug_history

data/CHANGELOG.md

@@ -4,11 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.2.0 (2016-10-10)
+
+- [enhancement] Log file can be disabled #20
+- [enhancement] Add a new extra (time_elapsed) for notifications "listener.process_message" and "listener.process_batch" #24
+- [enhancement] Add option to configure ruby-kafka logger #23
+
 ## 1.1.0 (2016-09-02)
+
 - [enhancement] - Removed Hashie as a dependency #12
 - [feature] Allow configuring consumers min_bytes & max_wait_time #15
 - [feature] Allow configuring producers max_queue_size, delivery_threshold & delivery_interval #16
 - [feature] Allow configuring force_encoding for message payload #18
 
 ## 1.0.0 (2016-08-08)
+
 - Published on Github with full fledged consumers and producers

data/README.md

@@ -346,6 +346,7 @@ end
     * partition
     * offset_lag
     * highwater_mark_offset
+    * time_elapsed
   * `listener.process_message` is sent after process a message. It includes the following payload:
     * listener_id
     * group_id
@@ -354,6 +355,7 @@ end
     * partition
     * offset
     * retry_count
+    * time_elapsed
   * `listener.retry_handler_error` is sent after waited for `handler#consume` retry. It includes the following payload:
     * listener_id
     * group_id

data/config/phobos.yml.example

@@ -1,6 +1,10 @@
 logger:
+  # Optional log file, set to false or remove to disable it
   file: log/phobos.log
   level: info
+  # Comment the block to disable ruby-kafka logs
+  ruby_kafka:
+    level: error
 
 kafka:
   # identifier for this application

data/examples/publishing_messages_without_consumer.rb

@@ -4,6 +4,7 @@
 # what happens when you produce more messages than the producer can handle.
 #
 require 'bundler/setup'
+require 'json'
 require 'phobos'
 
 TOPIC = 'test-partitions'

data/lib/phobos/instrumentation.rb

@@ -3,8 +3,8 @@ module Phobos
     NAMESPACE = 'phobos'
 
     def instrument(event, extra = {})
-      ActiveSupport::Notifications.instrument("#{NAMESPACE}.#{event}", extra) do
-        yield if block_given?
+      ActiveSupport::Notifications.instrument("#{NAMESPACE}.#{event}", extra) do |extra|
+        yield(extra) if block_given?
       end
     end
 

data/lib/phobos/listener.rb

@@ -46,8 +46,9 @@ module Phobos
             highwater_mark_offset: batch.highwater_mark_offset
           }.merge(listener_metadata)
 
-          instrument('listener.process_batch', batch_metadata) do
-            process_batch(batch)
+          instrument('listener.process_batch', batch_metadata) do |batch_metadata|
+            time_elapsed = measure { process_batch(batch) }
+            batch_metadata.merge!(time_elapsed: time_elapsed)
             Phobos.logger.info { Hash(message: 'Committed offset').merge(batch_metadata) }
           end
 
@@ -111,8 +112,9 @@ module Phobos
         )
 
         begin
-          instrument('listener.process_message', metadata) do
-            process_message(message, metadata)
+          instrument('listener.process_message', metadata) do |metadata|
+            time_elapsed = measure { process_message(message, metadata) }
+            metadata.merge!(time_elapsed: time_elapsed)
           end
         rescue => e
           retry_count = metadata[:retry_count]
@@ -156,6 +158,12 @@ module Phobos
       @encoding ? value.force_encoding(@encoding) : value
     end
 
+    def measure
+      start = Time.now.utc
+      yield if block_given?
+      (Time.now.utc - start).round(3)
+    end
+
     def compact(hash)
       hash.delete_if { |_, v| v.nil? }
     end

data/lib/phobos/version.rb

@@ -1,3 +1,3 @@
 module Phobos
-  VERSION = "1.1.0"
+  VERSION = '1.2.0'
 end

data/lib/phobos.rb

@@ -37,7 +37,7 @@ module Phobos
     end
 
     def create_kafka_client
-      Kafka.new(config.kafka.to_hash)
+      Kafka.new(config.kafka.to_hash.merge(logger: @ruby_kafka_logger))
     end
 
     def create_exponential_backoff
@@ -47,17 +47,30 @@ module Phobos
     end
 
     def configure_logger
+      log_file = config.logger.file
+      ruby_kafka = config.logger.ruby_kafka
       date_pattern = '%Y-%m-%dT%H:%M:%S:%L%zZ'
-      FileUtils.mkdir_p(File.dirname(config.logger.file))
+      log_layout = Logging.layouts.pattern(date_pattern: date_pattern)
+      appenders = [Logging.appenders.stdout(layout: log_layout)]
 
-      Logging.backtrace true
+      Logging.backtrace(true)
       Logging.logger.root.level = silence_log ? :fatal : config.logger.level
 
+      if log_file
+        FileUtils.mkdir_p(File.dirname(log_file))
+        appenders << Logging.appenders.file(log_file, layout: log_layout)
+      end
+
+      @ruby_kafka_logger = nil
+
+      if ruby_kafka
+        @ruby_kafka_logger = Logging.logger['RubyKafka']
+        @ruby_kafka_logger.appenders = appenders
+        @ruby_kafka_logger.level = silence_log ? :fatal : ruby_kafka.level
+      end
+
       @logger = Logging.logger[self]
-      @logger.appenders = [
-        Logging.appenders.stdout(layout: Logging.layouts.pattern(date_pattern: date_pattern)),
-        Logging.appenders.file(config.logger.file, layout: Logging.layouts.json(date_pattern: date_pattern))
-      ]
+      @logger.appenders = appenders
     end
   end
 end

data/phobos.gemspec

@@ -49,6 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec_junit_formatter', '0.2.2'
   spec.add_development_dependency 'simplecov', '~> 0.12.0'
   spec.add_development_dependency 'coveralls', '~> 0.8.15'
+  spec.add_development_dependency 'timecop'
 
   spec.add_dependency 'ruby-kafka', '>= 0.3.14'
   spec.add_dependency 'concurrent-ruby', '>= 1.0.2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.15
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
   requirement: !ruby/object:Gem::Requirement