redis_stream_logger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea9895c1c5c8f4b5694ef368b53ff70d1472017f859a24bfe7680067eb5b2964
-  data.tar.gz: 67fc064a242db94edd55baf60df633b852a1cc7ba7377626eb5cafc45c515830
+  metadata.gz: 39514125c61948167aa8d2f5c6720daaff2e5a2014a982db9e28db08cfa17ced
+  data.tar.gz: 0d08dbcf9a91e83401cd2549a5ba0b4a08147e445e3b1df1dd90043aaf21f587
 SHA512:
-  metadata.gz: 9af9e64b0008d920b21d2fa7f34a1fc85179bf959010f4bc01dc2fab221a19fbbebfc5af9827eefcaa61fe52f5328a7b2a79f61a2f91bf5c15450de0c877775f
-  data.tar.gz: 636e1dc374ca3877513da738bbde9153ce3f38f7b35ff0fda9c87c72e8f7523b51b152e9a8318d2ac3f0715b25e90abaf7662d581798722e506e403382a33554
+  metadata.gz: 70de80ef89b06c7bd677ac15b96b9404fc312d49e98eb52d72738225119c7de0e3e276c7ad400fd13438a18ae3c71e5e8c629e8fe74fa917caefb23884e63bf4
+  data.tar.gz: 176fa6ae2845a05af6b2dd217777c3aa242b510f174589d860e8a6b1d2d9cb081d43638c44efa1adc201811dc263b677d7a2335506d6a859c8631bd7a083656e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis_stream_logger (0.1.0)
+    redis_stream_logger (0.2.0)
       redis (~> 4.0)
 
 GEM

data/README.md

@@ -5,6 +5,9 @@ This gem creates a [log device](https://github.com/ruby/logger/blob/bf6d5aa37ee9
 The log device will buffer requests internally until either a time interval or buffer size is hit and then it will send all the log entries as a pipeline to minimize network
 traffic.
 
+There is a basic viewer for this logger (or any Redis stream if you're feeling brave) [here](https://github.com/mlh758/stream_log_viewer). It supports tailing
+a stream or searching logs with basic text matching.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,17 +18,41 @@ gem 'redis_stream_logger'
 
 ## Usage
 
-To use in a Rails application add something like this to your config:
+To use in an application add something like this:
 
 ```rb
 redis_log = RedisStreamLogger::LogDevice.new do |config|
   config.connection = Redis.new
 end
-config.logger = Logger.new(redis_log)
+logger = Logger.new(redis_log)
 ```
 
 It is _highly_ recommended that you set timeouts on your Redis connection. See the [Redis docs](https://github.com/redis/redis-rb/#timeouts).
 
+If you are using a forking Rails server like Passenger this gets a lot weirder because currently the logger uses threads
+to handle IO and avoid blocking the main app. For Rails and Passenger it will look something like this:
+
+```rb
+# config.ru
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    next unless forked
+    Rails.logger.close
+    redis_log = RedisStreamLogger::LogDevice.new do |config|
+      config.connection = Redis.new
+      config.stream_name = 'app-logs'
+    end
+    logger = Logger.new(redis_log)
+    logger.level = Rails.application.config.log_level
+    Rails.logger = logger
+    Rails.application.config.logger = logger
+    Rails.application.config.action_controller.logger = logger
+  end
+end
+```
+
+I'm currently looking for a way to use one of the async libraries to improve things.
+
 ### Configuration
 
 * buffer_size: Max number of items to hold in queue before attempting to write a batch. Defaults to 100
@@ -39,7 +66,7 @@ It is _highly_ recommended that you set timeouts on your Redis connection. See t
 
 ## Path to 1.0
 
-1. Custom formatter: Right now it just takes the string from the logger and writes it to Redis. Ideally, the timestamp, log level, and tags would be written as separate keys.
+The use of threads caused unexpected headaches in applications that rely on forking like Passenger. I'm hoping this library can drop the reliance on threads.
 
 ## Development
 

data/lib/redis_stream_logger.rb

@@ -1,5 +1,6 @@
 require "redis_stream_logger/version"
 require "redis_stream_logger/log_device"
+require 'redis_stream_logger/railtie' if defined?(Rails::Railtie)
 
 module RedisStreamLogger
   class Error < StandardError; end

data/lib/redis_stream_logger/log_device.rb

@@ -12,20 +12,15 @@ module RedisStreamLogger
       def initialize(conn = nil, stream: 'rails-log')
           @config = Config.new
           @closed = false
-          yield @config if block_given?
+          # Just in case a whole new config is passed in like in the Railtie
+          new_conf = yield @config if block_given?
+          @config = new_conf if new_conf.is_a?(Config)
           @config.connection ||= conn
           @config.stream_name ||= stream
           raise ArgumentError, 'must provide connection' if @config.connection.nil?
 
           @q = Queue.new
-          @error_logger = ::Logger.new(STDERR)
-          @ticker = Thread.new do
-              ticker(@config.send_interval)
-          end
-          @writer = Thread.new do
-              writer(@config.buffer_size, @config.send_interval)
-          end
-          at_exit { close }
+          start
       end
 
       def write(msg)
@@ -33,7 +28,9 @@ module RedisStreamLogger
       end
 
       def reopen(log = nil)
-          # no op
+          close
+          @config.connection._client.connect
+          start
       end
 
       def close
@@ -47,6 +44,18 @@ module RedisStreamLogger
 
       private
 
+      def start
+        @closed = false
+        @error_logger = ::Logger.new(STDERR)
+        @ticker = Thread.new do
+            ticker(@config.send_interval)
+        end
+        @writer = Thread.new do
+            writer(@config.buffer_size, @config.send_interval)
+        end
+        at_exit { close }
+      end
+
       def send_options
         return {} if @config.max_len.nil?
 

data/lib/redis_stream_logger/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails/railtie'
+
+module RedisStreamLogger
+  # I based this heavily on the LogstashLogger implementation but we'll only
+  # accept our own config class here
+  def self.setup(app)
+    return unless app.config.redis_stream_logger.present?
+    conf = app.config.redis_stream_logger
+    raise ArgumentError, 'unexpected config class' unless conf.is_a?(Config)
+
+    logdev = RedisStreamLogger::LogDevice.new do |_c|
+      conf
+    end
+
+    logger = Logger.new(logdev)
+    logger.level = app.config.log_level
+    app.config.logger = logger
+  end
+end
+
+class Railtie < ::Rails::Railtie
+  config.redis_stream_logger = nil
+  initializer :redis_stream_logger, before: :initialize_logger do |app|
+    RedisStreamLogger.setup(app)
+  end
+end

data/lib/redis_stream_logger/version.rb

@@ -1,3 +1,3 @@
 module RedisStreamLogger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_stream_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -44,6 +44,7 @@ files:
 - lib/redis_stream_logger.rb
 - lib/redis_stream_logger/config.rb
 - lib/redis_stream_logger/log_device.rb
+- lib/redis_stream_logger/railtie.rb
 - lib/redis_stream_logger/version.rb
 - redis_stream_logger.gemspec
 homepage: https://github.com/mlh758/redis_stream_logger