racecar 0.3.0.beta1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21f3ecc4525a97eace384c5702c7f37939920292
-  data.tar.gz: 6bf40c5f643a9f0eb8fe6a962793a04e020becd4
+  metadata.gz: c0651e97f7403aacaf9494cb2cc2833b7b6040a5
+  data.tar.gz: d5849ff77aec0112c92d56937cb4ab30d926dc16
 SHA512:
-  metadata.gz: 17a690c3206dc413c8795b36d2a8d01afbab74bbcd48a2c0e1d64bb8a662ae2d41516a4446d140967d5266e1bc5755b4e0814f269fc6c6f6dc1892eac7e05ed1
-  data.tar.gz: c811af7f6f5aa7cdd3953e1e954964ad6903e7740600e9ae16e5b8b2ef27234116b48c60fa6851d9166b157a07f1e44b851c310fd1a784a9717728d8218f43fc
+  metadata.gz: 5781c4b863eefed5f336c5cfd5f7832ed8d6c248f5064eb7a1729222676c0ed88663dc7db1ca9f7d1adda5dc470317fdd78ea3c15246ab4d4eb23d6480f57977
+  data.tar.gz: bcb8e7d8b5d1aed13c68d7257381d0d710979dde5dbcc34ba9e7649ce53e3e11031deaa410fc9b046f5914690eec41d114ff7ee38a16ee554f96f4259b983524

data/Procfile

@@ -0,0 +1,2 @@
+batch: bundle exec racecar --require examples/batch_consumer BatchConsumer
+cat: bundle exec racecar --require examples/cat_consumer CatConsumer

data/README.md

@@ -13,7 +13,8 @@ Using [ruby-kafka](https://github.com/zendesk/ruby-kafka) directly can be a chal
     3. [Configuration](#configuration)
     4. [Testing consumers](#testing-consumers)
     5. [Deploying consumers](#deploying-consumers)
-    6. [Operations](#operations)
+    6. [Logging](#logging)
+    7. [Operations](#operations)
 3. [Development](#development)
 4. [Contributing](#contributing)
 5. [Copyright and license](#copyright-and-license)
@@ -255,6 +256,13 @@ If you've ever used Heroku you'll recognize the format – indeed, deploying to
 With Foreman, you can easily run these processes locally by executing `foreman run`; in production you'll want to _export_ to another process management format such as Upstart or Runit. [capistrano-foreman](https://github.com/hyperoslo/capistrano-foreman) allows you to do this with Capistrano.
 
 
+### Logging
+
+By default, Racecar will log to `STDOUT`. If you're using Rails, your application code will use whatever logger you've configured there.
+
+In order to make Racecar log its own operations to a log file, set the `logfile` configuration variable or pass `--log filename.log` to the `racecar` command.
+
+
 ### Operations
 
 In order to gracefully shut down a Racecar consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit and Kubernetes send this signal when shutting down a process, so using those systems will make things easier.

data/lib/racecar/cli.rb

@@ -1,4 +1,5 @@
 require "optparse"
+require "logger"
 require "racecar/rails_config_file_loader"
 
 module Racecar
@@ -11,9 +12,13 @@ module Racecar
           require lib
         end
 
+        opts.on("-l", "--log LOGFILE", "Log to the specified file") do |logfile|
+          Racecar.config.logfile = logfile
+        end
+
         opts.on_tail("--version", "Show Racecar version") do
           require "racecar/version"
-          puts "Racecar #{Racecar::VERSION}"
+          $stderr.puts "Racecar #{Racecar::VERSION}"
           exit
         end
       end
@@ -22,7 +27,7 @@ module Racecar
 
       consumer_name = args.first or raise Racecar::Error, "no consumer specified"
 
-      puts "=> Starting Racecar consumer #{consumer_name}..."
+      $stderr.puts "=> Starting Racecar consumer #{consumer_name}..."
 
       RailsConfigFileLoader.load!
 
@@ -34,14 +39,19 @@ module Racecar
 
       Racecar.config.validate!
 
-      puts "=> Wrooooom!"
-      puts "=> Ctrl-C to shutdown consumer"
+      if Racecar.config.logfile
+        $stderr.puts "=> Logging to #{Racecar.config.logfile}"
+        Racecar.logger = Logger.new(Racecar.config.logfile)
+      end
+
+      $stderr.puts "=> Wrooooom!"
+      $stderr.puts "=> Ctrl-C to shutdown consumer"
 
       processor = consumer_class.new
 
       Racecar.run(processor)
 
-      puts "=> Shut down"
+      $stderr.puts "=> Shut down"
     end
   end
 end

data/lib/racecar/config.rb

@@ -21,7 +21,7 @@ module Racecar
       max_wait_time
 
       error_handler
-      log_to_stdout
+      logfile
 
       ssl_ca_cert
       ssl_ca_cert_file_path
@@ -43,7 +43,6 @@ module Racecar
     DEFAULT_CONFIG = {
       brokers: ["localhost:9092"],
       client_id: "racecar",
-      group_id_prefix: nil,
 
       subscriptions: [],
 
@@ -72,9 +71,6 @@ module Racecar
 
       # Default is to do nothing on exceptions.
       error_handler: proc {},
-
-      # Default is to only log to the logger.
-      log_to_stdout: false,
     }
 
     attr_accessor(*ALLOWED_KEYS)

data/lib/racecar/ctl.rb

@@ -60,7 +60,7 @@ module Racecar
 
       kafka.deliver_message(message.value, key: message.key, topic: message.topic)
 
-      puts "=> Delivered message to Kafka cluster"
+      $stderr.puts "=> Delivered message to Kafka cluster"
     end
   end
 end

data/lib/racecar/rails_config_file_loader.rb

@@ -6,21 +6,20 @@ module Racecar
       begin
         require "rails"
 
-        puts "=> Detected Rails, booting application..."
+        $stderr.puts "=> Detected Rails, booting application..."
 
         require "./config/environment"
 
         Racecar.config.load_file(config_file, Rails.env)
 
-        if Racecar.config.log_to_stdout
-          # Write to STDOUT as well as to the log file.
+        # In development, write Rails logs to STDOUT. This mirrors what e.g.
+        # Unicorn does.
+        if Rails.env.development?
           console = ActiveSupport::Logger.new($stdout)
           console.formatter = Rails.logger.formatter
           console.level = Rails.logger.level
           Rails.logger.extend(ActiveSupport::Logger.broadcast(console))
         end
-
-        Racecar.logger = Rails.logger
       rescue LoadError
         # Not a Rails application.
       end

data/lib/racecar/version.rb

@@ -1,3 +1,3 @@
 module Racecar
-  VERSION = "0.3.0.beta1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: racecar
 version: !ruby/object:Gem::Version
-  version: 0.3.0.beta1
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Schierbeck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
@@ -81,6 +81,7 @@ files:
 - ".rspec"
 - Gemfile
 - LICENSE.txt
+- Procfile
 - README.md
 - Rakefile
 - bin/console
@@ -118,9 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1