redis_stream_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea9895c1c5c8f4b5694ef368b53ff70d1472017f859a24bfe7680067eb5b2964
+  data.tar.gz: 67fc064a242db94edd55baf60df633b852a1cc7ba7377626eb5cafc45c515830
+SHA512:
+  metadata.gz: 9af9e64b0008d920b21d2fa7f34a1fc85179bf959010f4bc01dc2fab221a19fbbebfc5af9827eefcaa61fe52f5328a7b2a79f61a2f91bf5c15450de0c877775f
+  data.tar.gz: 636e1dc374ca3877513da738bbde9153ce3f38f7b35ff0fda9c87c72e8f7523b51b152e9a8318d2ac3f0715b25e90abaf7662d581798722e506e403382a33554

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redis_stream_logger.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    redis_stream_logger (0.1.0)
+      redis (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    redis (4.2.5)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  redis_stream_logger!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mike Harris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# RedisStreamLogger
+
+This gem creates a [log device](https://github.com/ruby/logger/blob/bf6d5aa37ee954afc49a407e67fb96064a52af62/lib/logger/log_device.rb) to send your logs to a Redis stream.
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_stream_logger'
+```
+
+## Usage
+
+To use in a Rails application add something like this to your config:
+
+```rb
+redis_log = RedisStreamLogger::LogDevice.new do |config|
+  config.connection = Redis.new
+end
+config.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).
+
+### Configuration
+
+* buffer_size: Max number of items to hold in queue before attempting to write a batch. Defaults to 100
+* send_interval: Number of seconds to wait before sending the buffer, despite buffer_size. Defaults to 10
+* connection: Redis connection to use for logger
+* batch_size: Number of of log items to send to Redis at a time. Defaults to buffer_size
+* stream_name: Stream to publish messages to
+* max_len: Maximum size of stream. Ideally you will have a log consumer set up that calls xtrim after persisting your logs somewhere.
+  If that's more than you need, and just want a simple way to cap the log size set max_len to some sufficiently large number to keep your logs around long enough to be useful.
+* log_set_key: Loggers will store the name of their stream into this key for discoverability
+
+## 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.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/mlh758/redis_stream_logger).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_stream_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis_stream_logger.rb

@@ -0,0 +1,7 @@
+require "redis_stream_logger/version"
+require "redis_stream_logger/log_device"
+
+module RedisStreamLogger
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/redis_stream_logger/config.rb

@@ -0,0 +1,31 @@
+module RedisStreamLogger
+  #
+  # Config provides configuration options for the log device.
+  # buffer_size: Max number of items to hold in queue before attempting to write a batch
+  # defaults to 100
+  # send_interval: Number of seconds to wait before sending the buffer, despite buffer_size
+  # defaults to 10
+  # connection: Redis connection to use for logger
+  # batch_size: Number of of log items to send to Redis at a time
+  # defaults to buffer_size
+  # stream_name: Stream to publish messages to
+  # max_len: Maximum size of stream. Ideally you will have a log
+  # consumer set up that calls xtrim after persisting your logs somewhere.
+  # If that's more than you need, and just want a simple way to cap the log size
+  # set max_len to some sufficiently large number to keep your logs around long
+  # enough to be useful.
+  #
+  class Config
+    attr_accessor :buffer_size, :send_interval, :connection, :batch_size, :stream_name, :max_len, :log_set_key
+
+    def initialize
+      @buffer_size = 100
+      @send_interval = 10
+      @connection = nil
+      @batch_size = @buffer_size
+      @stream_name = nil
+      @max_len = nil
+      @log_set_key = "log-streams"
+    end
+  end
+end

data/lib/redis_stream_logger/log_device.rb

@@ -0,0 +1,136 @@
+require 'logger'
+require "redis_stream_logger/config"
+module RedisStreamLogger
+  class LogDevice
+      attr_reader :config
+      #
+      # Creates a new LogDevice that can be used as a sink for Ruby Logger
+      #
+      # @param [Redis] conn connection to Redis
+      # @param [String] stream name of key to write to
+      #
+      def initialize(conn = nil, stream: 'rails-log')
+          @config = Config.new
+          @closed = false
+          yield @config if block_given?
+          @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 }
+      end
+
+      def write(msg)
+          @q.push msg
+      end
+
+      def reopen(log = nil)
+          # no op
+      end
+
+      def close
+          return if @closed
+          @q.push :exit
+          @ticker.exit
+          @writer.join
+          @config.connection.close
+          @closed = true
+      end
+
+      private
+
+      def send_options
+        return {} if @config.max_len.nil?
+
+        { maxlen: @config.max_len, approximate: true }
+      end
+
+      #
+      # Writes a batch of log lines to the Redis stream
+      #
+      # @param [Array<String>] messages to write to the stream
+      #
+      #
+      def write_batch(messages)
+        redis = @config.connection
+        opt = send_options
+        messages.each_slice(@config.batch_size) do
+          attempt = 0
+          begin
+            redis.pipelined do
+              messages.each do |msg|
+                redis.xadd(@config.stream_name, {m: msg}, **opt)
+              end
+            end
+          rescue StandardError => exception
+            attempt += 1
+            retry if attempt <= 3
+            @error_logger.warn "unable to write redis logs: #{exception}"
+            messages.each { |m| @error_logger.info(m) }
+          end
+        end
+      end
+
+      #
+      # Pushes a message into the queue at the given interval
+      # to wake the writer thread up to ensure it sends partial
+      # buffers if no new logs come in.
+      #
+      # @param [Integer] interval to wake the writer up on
+      #
+      def ticker(interval)
+          loop do
+              sleep(interval)
+              @q.push(:nudge)
+          end
+      end
+
+      def control_msg?(msg)
+          msg == :nudge || msg == :exit
+      end
+
+      #
+      # Stores the name of the logger in the configured set so other tools can 
+      # locate the list of available log streams
+      #
+      #
+      def store_logger_name
+        @config.connection.sadd(@config.log_set_key, @config.stream_name)
+      rescue StandardError => exception
+        @error_logger.warn "unable to store name of log: #{exception}"
+      end
+
+      #
+      # Used in a thread to pull log messages from a queue and store them in batches into a redis
+      # stream.
+      #
+      # @param [Integer] buffer_max maximum number of log entries to buffer before sending
+      # @param [Integer] interval maximum amount of time to wait before sending a partial buffer
+      #
+      #
+      def writer(buffer_max, interval)
+          last_sent = Time.now
+          buffered = []
+          store_logger_name
+          loop do
+              msg = @q.pop
+              buffered.push(msg) unless control_msg?(msg)
+              now = Time.new
+              if buffered.count >= buffer_max || (now - last_sent) > interval || msg == :exit
+                  write_batch(buffered)
+                  return if msg == :exit
+                  last_sent = Time.now
+                  buffered = []
+              end
+          end
+      end
+  end
+end

data/lib/redis_stream_logger/version.rb

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

data/redis_stream_logger.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/redis_stream_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_stream_logger"
+  spec.version       = RedisStreamLogger::VERSION
+  spec.authors       = ["Mike Harris"]
+  spec.email         = ["mike.harris@cerner.com"]
+
+  spec.summary       = "Provides a log device to send logs to a Redis stream"
+  spec.homepage      = "https://github.com/mlh758/redis_stream_logger"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'redis', '~> 4.0'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: redis_stream_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Harris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- mike.harris@cerner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis_stream_logger.rb
+- lib/redis_stream_logger/config.rb
+- lib/redis_stream_logger/log_device.rb
+- lib/redis_stream_logger/version.rb
+- redis_stream_logger.gemspec
+homepage: https://github.com/mlh758/redis_stream_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mlh758/redis_stream_logger
+  source_code_uri: https://github.com/mlh758/redis_stream_logger
+  changelog_uri: https://github.com/mlh758/redis_stream_logger
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Provides a log device to send logs to a Redis stream
+test_files: []