lumberjack_redis_device 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0bbc9ce42f70e40c813a3d446f7a185d876d5a1475179b9fb58286d0648f7293
+  data.tar.gz: 790abe1f48c28198df3584184ac336a87ea399102f1f6b381786e16de40b114f
+SHA512:
+  metadata.gz: 2bde67b21c182c709faa85c6ee49b1b39afa063a61eee3563d3e02aaeaad4a98a07951eee02595d7296b155b3824db184272b9def616ff3238d3fa42c1010914
+  data.tar.gz: 9150565938e10b012aeec942cc81d244280abfa01c91c117144ce8cd0c17749ef98736d4a68656369fc1a3dbc20bfc4393fd3fd6cd5ec8299ab434b016bab6c2

data/CHANGE_LOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial release

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Brian Durand
+
+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,22 @@
+# Lumberjack Redis Device
+
+[![Build Status](https://travis-ci.org/bdurand/lumberjack_redis_device.svg?branch=master)](https://travis-ci.org/bdurand/lumberjack_redis_device)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7785eba72f9a92b686b2/maintainability)](https://codeclimate.com/github/bdurand/lumberjack_redis_device/maintainability)
+
+This is a simple reference implementation of a device for the [lumberjack](https://github.com/bdurand/lumberjack) to send logs to a data store.
+
+Log data will be stored in a Redis list. This will likely not scale to handle permanent or large log storage, but it can be useful as a temporary store in log shipment, or as a debug tool for seeing only recent log entries.
+
+The number of entries in the list can be capped with the `:limit` paramter on the constructor. An expiration time can also be set on the redis key as well with the `:ttl` parameter.
+
+```ruby
+# create a device to save to the app.log key in redis
+# with a limit of 1000 entries that expires one hour after the last write.
+device = Lumberjack::RedisDevice.new("app.log", redis: Redis.new, limit: 1000, ttl: 3600)
+```
+
+The log entries can then be read out again with the `read` method. The result will be an array of `Lumberjack::LogEntry` objects in the reverse order that they were written in (i.e. newest first).
+
+```ruby
+entries = device.read
+```

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/lumberjack_redis_device.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'lumberjack'
+require 'multi_json'
+require 'redis'
+
+module Lumberjack
+  # This Lumberjack device logs output to a redis list. The redis list will automatically truncate
+  # to a given size to prevent running out of memory on the server. This is not inteneded to be a
+  # scalable logging solution, but it can be useful as an additional logging tool to expose recent logs.
+  class RedisDevice < Device
+
+    attr_reader :name, :ttl, :limit
+
+    # Create a device. The name will be used as the key for the log entris in redis.
+    #
+    # The redis object can either be a `Redis` instance or a block that yields a `Redis`
+    # instance.
+    #
+    # You can also specify a time to live in seconds (ttl) and set the limit for the size of the list.
+    def initialize(name:, redis:, limit: 10_000, ttl: nil)
+      @name = name
+      @redis = redis
+      @ttl = ttl.to_i
+      @limit = limit
+    end
+
+    # Write an entry to the list in redis
+    def write(entry)
+      data = entry_as_json(entry)
+      json = MultiJson.dump(data)
+      redis.multi do |transaction|
+        transaction.lpush(name, json)
+        transaction.ltrim(name, 0, limit - 1)
+        transaction.expire(name, ttl) if ttl && ttl > 0
+      end
+    end
+
+    # Read a set number of entries from the list. The result will be an array of
+    # Lumberjack::LogEntry objects.
+    def read(count = limit)
+      docs = redis.lrange(name, 0, count - 1)
+      docs.collect { |json| entry_from_json(json) }
+    end
+
+    def datetime_format
+      @time_formatter.format if @time_formatter
+    end
+
+    def datetime_format=(format)
+      @time_formatter = Lumberjack::Formatter::DateTimeFormatter.new(format)
+    end
+
+    def redis
+      if @redis.is_a?(Proc)
+        @redis.call
+      else
+        @redis
+      end
+    end
+
+    private
+
+    def entry_as_json(entry)
+      data = {}
+      set_attribute(data, "timestamp", entry.time.to_f) unless entry.time.nil?
+      set_attribute(data, "time", entry.time)
+      set_attribute(data, "severity", entry.severity_label)
+      set_attribute(data, "progname", entry.progname)
+      set_attribute(data, "pid", entry.pid)
+      set_attribute(data, "message", entry.message)
+      set_attribute(data, "tags", entry.tags)
+
+      unless @tags_key.nil?
+        tags ||= {}
+        set_attribute(data, @tags_key, tags)
+      end
+
+      data = @formatter.format(data) if @formatter
+      data
+    end
+
+    def entry_from_json(json)
+      data = MultiJson.load(json)
+      time = Time.at(data["timestamp"]) if data["timestamp"]
+      severity = data["severity"]
+      progname = data["progname"]
+      pid = data["pid"]
+      message = data["message"]
+      tags = data["tags"]
+      LogEntry.new(time, severity, message, progname, pid, tags)
+    end
+
+    def set_attribute(data, key, value)
+      return if value.nil?
+
+      if (value.is_a?(Time) || value.is_a?(DateTime)) && @time_formatter
+        value = @time_formatter.call(value)
+      end
+
+      if key.is_a?(Array)
+        unless key.empty?
+          if key.size == 1
+            data[key.first] = value
+          else
+            data[key.first] ||= {}
+            set_attribute(data[key.first], key[1, key.size], value)
+          end
+        end
+      elsif key.respond_to?(:call)
+        hash = key.call(value)
+        if hash.is_a?(Hash)
+          data.merge!(Lumberjack::Tags.stringify_keys(hash))
+        end
+      else
+        data[key] = value unless key.nil?
+      end
+    end
+
+    def default_formatter
+      formatter = Formatter.new.clear
+      object_formatter = Lumberjack::Formatter::ObjectFormatter.new
+      formatter.add(String, object_formatter)
+      formatter.add(Object, object_formatter)
+      formatter.add(Enumerable, Formatter::StructuredFormatter.new(formatter))
+      formatter.add(Exception, Formatter::InspectFormatter.new)
+    end
+
+  end
+end

data/lumberjack_redis_device.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |spec|
+  spec.name = 'lumberjack_redis_device'
+  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors = ['Brian Durand']
+  spec.email = ['bbdurand@gmail.com']
+
+  spec.summary = "A logging device for the lumberjack gem that writes log entries as JSON documentspec."
+  spec.homepage = "https://github.com/bdurand/lumberjack_redis_device"
+  spec.license = "MIT"
+
+  # 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.
+  ignore_files = %w(
+    .gitignore
+    .travis.yml
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    gemfiles/
+    spec/
+  )
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject{ |f| ignore_files.any?{ |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "lumberjack", ">=1.1"
+  spec.add_dependency "multi_json"
+  spec.add_dependency "redis"
+
+  spec.add_development_dependency("rspec", ["~> 3.0"])
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fakeredis"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: lumberjack_redis_device
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lumberjack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: fakeredis
+  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'
+description: 
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGE_LOG.md
+- MIT_LICENSE
+- README.md
+- VERSION
+- lib/lumberjack_redis_device.rb
+- lumberjack_redis_device.gemspec
+homepage: https://github.com/bdurand/lumberjack_redis_device
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A logging device for the lumberjack gem that writes log entries as JSON documentspec.
+test_files: []