fluent_logger_rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a88bc428967e9ee7c2f81f9e747b0cc868f52fe9158587c4c847f1516c43d59
-  data.tar.gz: 175d618a1cc6cd67e7c137b02328040e256c8f8e101e6d8786501227792453fe
+  metadata.gz: 0ce631df4339e61d2d64b000abb2411ae9c392455cafd934ed8f9b02a4bce363
+  data.tar.gz: 8180c87b862c568b132b41f62fd8d007c1d25323254395f4814165767ca5c765
 SHA512:
-  metadata.gz: a1557f1bb328c7525b9c7341898c8cfeebe4646a1b2d0741b09cc7e65ae3e2e1de6654b59d8abd1b50818b9e94c2ddc8c95fd3bb40c9d08daf3d632cdf74f11b
-  data.tar.gz: ad952d449c9c9e53e3ac59da6da928cb1a34fd01fa4d34d9a2fce3d4160a48b3cca22fe75517b8b62144ae21a878e962abc915a21a97446bb9bc9919a79d6687
+  metadata.gz: 40aefe081952b14f73fc8aa695a5ffab2c24659d199c40b688513a44d3b61894bc872aa24d01f3da1fe45b292b668f2b77c464073df9991d5b9c9fd67ff5fe1a
+  data.tar.gz: 45144abd502ce1d3a22c61fce70393628aff562da6ec75bcb4cc55e22cadf05893d2b7c82120bc216b7d964265d2da79c3ee4e1eec58aa6eb29b6a478e1b3b19

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec spec

data/CHANGELOG.md

@@ -8,9 +8,20 @@ Bug Fixes:
 
 Enhancements:
 
-* Add a rake task to walk through your table/columns and easily classify and create a migration from it
-* Add a migration generator
-* Module helper to include in migrations to add data classification smart comment 
+* None
+
+Deprecations:
+* None
+
+## v0.2.0
+
+Bug Fixes:
+
+* None
+
+Enhancements:
+
+* Refactoring interface, major breaking changes on format (#1) 
 
 Deprecations:
 * None

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluent_logger_rails (0.1.0)
+    fluent_logger_rails (0.2.0)
       activesupport (~> 5.0)
 
 GEM
@@ -13,9 +13,9 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     coderay (1.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
-    i18n (1.8.3)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.1)

data/README.md

@@ -0,0 +1,109 @@
+# Fluent Logger Rails
+
+This is a library that wraps the [fluent-logger gem](https://github.com/fluent/fluent-logger-ruby) and provides easy integration with your Rails application. This includes a log formatter that supports [Rails tagged logging](https://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html) so your output JSON format that can be sent to Fluentd (or really any other logging backend).
+
+# Installation
+
+```
+gem install fluent_logger_rails
+```
+
+# How to configure
+
+```ruby
+Rails.application.configure do
+  config.logger = FluentLoggerRails::Logger.new(
+    ::Fluent::Logger::FluentLogger.new(
+      nil,
+      host: 'localhost',
+      port: 24224,
+    ),
+    level: config.log_level
+  )
+  # if you are using tagged logging, you need a formatter that supports it
+  config.logger.formatter = FluentLoggerRails::TaggedHashFormatter.new
+end
+```
+
+## Formatter Configuration
+
+This gem includes a formatter that supports [Rails tagged logging](https://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html).
+
+### Hash aka JSON logger formatter
+
+This is a JSON formatter that supports tagged logging.
+```ruby
+config.logger.formatter = FluentLoggerRails::TaggedHashFormatter.new
+config.logger.formatter.datetime_format = '%Y-%m-%d %H:%M:%S.%3N%z'
+config.logger.formatter.parent_key = 'payload'
+```
+
+### Standard Rails Tagged Logger aka default logger format
+
+The standard Rails tagged logger works as well for standard output.
+```ruby
+ActiveSupport::TaggedLogging.new(config.logger)
+```
+
+# Examples
+
+## Hash formatter with tagged Logging
+```ruby
+Rails.logger.tagged(user.id) do
+  Rails.logger.warn('UserUpdateJob failed')
+end
+
+#
+# Outputs:
+#
+# {
+#   "tags": [1234],
+#   "message": "UserUpdateJob failed", 
+#   "severity": "WARN",
+#   "timestamp": "2019-01-08 14:51:39.701-0800", 
+# }
+```
+
+## Hash formatter with hash tagged Logging
+
+```ruby
+Rails.logger.tagged(user_id: user.id, session_id: user_session.id) do
+  Rails.logger.info(message: 'UserUpdateJob failed', args: args)
+end
+
+#
+# Outputs:
+#
+# {
+#   "user_id": 1234,
+#   "session_id": 883839,
+#   "message": {
+#     "message": "UserUpdateJob failed",
+#     "args": [1,2,3]
+#   }, 
+#   "severity": "INFO",
+#   "timestamp": "2019-01-08 14:51:39.701-0800", 
+# }
+```
+
+## Standard Rails formatter with tagged Logger
+
+```ruby
+Rails.logger.tagged(user.id, user_session.id) do
+  Rails.logger.info('UserUpdateJob failed')
+end
+
+#
+# Outputs:
+#
+# [1234] [883839] UserUpdateJob failed
+```
+
+# How to test this locally
+
+You can setup Fluentd with ruby gems as described on [Fluentd docs](https://docs.fluentd.org/installation/install-by-gem). Once that is running, simply configure your environment with the example above and the logs should appear.
+
+# Related Projects
+
+ - https://github.com/fluent/fluent-logger-ruby
+ - https://github.com/actindi/act-fluent-logger-rails

data/fluent_logger_rails.gemspec

@@ -5,8 +5,11 @@ Gem::Specification.new do |spec|
   spec.name        = 'fluent_logger_rails'
   spec.version     = FluentLoggerRails::VERSION
   spec.date        = '2020-07-14'
-  spec.summary     = "A wrapper for fluent-logger gem to support tagged logging"
-  spec.description = "A simple hello world gem"
+  spec.summary     = "A wrapper for fluent-logger gem with support for tagged logging"
+  spec.description = "This is a library that wraps the [fluent-logger gem](https://github.com/fluent/fluent-logger-ruby) "\
+    "and provides easy integration with your Rails application. This includes log formatters that support "\
+    "[Rails tagged logging](https://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html) for JSON format "\
+    "that can be sent to Fluentd (or really any other logging backend)."
   spec.authors     = ["HackerOne Open Source", "Ben Willis"]
   spec.email       = ["opensource+fluent_logger_rails@hackerone.com", "ben@hackeroen.com"]
   spec.homepage      = "https://github.com/Hacker0x01/fluent_logger_rails"

data/lib/fluent_logger_rails.rb

@@ -1,5 +1,2 @@
 require 'fluent_logger_rails/logger'
-require 'fluent_logger_rails/tagged_logging'
-require 'fluent_logger_rails/hash_formatter'
-require 'fluent_logger_rails/json_formatter'
-require 'fluent_logger_rails/pretty_json_formatter'
+require 'fluent_logger_rails/tagged_hash_formatter'

data/lib/fluent_logger_rails/logger.rb

@@ -16,8 +16,7 @@ module FluentLoggerRails
       message = (block_given? ? yield : progname) if message.blank?
       return true if message.blank?
 
-      message = format_message(severity, Time.now, progname, message)
-      message = { message: message } unless message.is_a? Hash
+      message = format_message(severity, Time.zone.now, progname, message)
 
       @logger.post(@path, message)
       true
@@ -26,5 +25,16 @@ module FluentLoggerRails
     def close
       @logger.close
     end
+
+    delegate :add_tags, :remove_tags, :clear_tags!, to: :formatter
+
+    def tagged(*tags)
+      formatter.tagged(*tags) { yield self }
+    end
+
+    def flush
+      clear_tags!
+      super if defined?(super)
+    end
   end
 end

data/lib/fluent_logger_rails/tagged_hash_formatter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module FluentLoggerRails
+  class TaggedHashFormatter < ::Logger::Formatter
+    # Parent key - ensures that if the log is being merged into a higher level payload this key can
+    # be set in order to not conflict or be overridden.
+    attr_accessor :parent_key
+
+    def initialize
+      super
+      # Override the Logger::Formatter default to a format that does not have a trailing space
+      @datetime_format = "%Y-%m-%dT%H:%M:%S.%6N"
+    end
+
+    def call(severity, timestamp, _progname, msg)
+      payload = {
+        severity: format_severity(severity),
+        timestamp: format_datetime(timestamp),
+        message: msg.is_a?(String) ? msg.strip : msg,
+      }.merge(compact_tags.deep_dup)
+
+      @parent_key ? { @parent_key => payload } : payload
+    end
+
+    def format_severity(severity)
+      if severity.blank?
+        'ANY'
+      elsif severity.is_a? Integer
+        ActiveSupport::Logger::SEV_LABEL[severity]
+      else
+        severity
+      end
+    end
+
+    def tagged(*tags)
+      add_tags(*tags)
+      yield self
+    ensure
+      remove_tags(*tags)
+    end
+
+    def add_tags(*tags)
+      tags = tags.first if tags.length == 1
+
+      if tags.is_a? Array
+        current_tags[:tags] ||= []
+        current_tags[:tags] += tags
+      elsif tags.is_a? String
+        current_tags[:tags] ||= []
+        current_tags[:tags] << tags
+      else
+        current_tags.merge! tags
+      end
+    end
+
+    def remove_tags(*tags)
+      tags = tags.first if tags.length == 1
+
+      if tags.is_a? Array
+        current_tags[:tags] ||= []
+        tags.each { |tag| current_tags[:tags].delete(tag) }
+      elsif tags.is_a? String
+        current_tags[:tags] ||= []
+        current_tags[:tags].delete(tags)
+      else
+        tags.each_key { |key| current_tags.delete(key) }
+      end
+    end
+
+    def clear_tags!
+      current_tags.clear
+    end
+
+    def current_tags
+      # We use our object ID here to avoid conflicting with other instances
+      thread_key = @thread_key ||= "fluent_logger_rails:#{object_id}"
+      Thread.current[thread_key] ||= {}
+    end
+
+    def compact_tags
+      current_tags.delete_if { |_k, v| v.blank? }
+    end
+  end
+end

data/lib/fluent_logger_rails/version.rb

@@ -1,3 +1,3 @@
 module FluentLoggerRails
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent_logger_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - HackerOne Open Source
@@ -67,7 +67,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple hello world gem
+description: This is a library that wraps the [fluent-logger gem](https://github.com/fluent/fluent-logger-ruby)
+  and provides easy integration with your Rails application. This includes log formatters
+  that support [Rails tagged logging](https://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html)
+  for JSON format that can be sent to Fluentd (or really any other logging backend).
 email:
 - opensource+fluent_logger_rails@hackerone.com
 - ben@hackeroen.com
@@ -75,6 +78,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -85,11 +89,8 @@ files:
 - README.md
 - fluent_logger_rails.gemspec
 - lib/fluent_logger_rails.rb
-- lib/fluent_logger_rails/hash_formatter.rb
-- lib/fluent_logger_rails/json_formatter.rb
 - lib/fluent_logger_rails/logger.rb
-- lib/fluent_logger_rails/pretty_json_formatter.rb
-- lib/fluent_logger_rails/tagged_logging.rb
+- lib/fluent_logger_rails/tagged_hash_formatter.rb
 - lib/fluent_logger_rails/version.rb
 homepage: https://github.com/Hacker0x01/fluent_logger_rails
 licenses:
@@ -116,5 +117,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A wrapper for fluent-logger gem to support tagged logging
+summary: A wrapper for fluent-logger gem with support for tagged logging
 test_files: []

data/lib/fluent_logger_rails/hash_formatter.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-class HashFormatter
-  def call(severity, timestamp, _progname, msg)
-    severity_display = if severity.blank?
-      'ANY'
-    elsif severity.is_a? Integer
-      ActiveSupport::Logger::SEV_LABEL[severity]
-    else
-      severity
-    end
-
-    {
-      severity: severity_display,
-      timestamp: timestamp.in_time_zone.strftime('%Y-%m-%d %H:%M:%S.%3N%z'),
-      message: msg.is_a?(String) ? msg.strip : msg,
-    }.merge(compact_tags)
-  end
-
-  def tagged(*tags)
-    add_tags(*tags)
-    yield self
-  ensure
-    remove_tags(*tags)
-  end
-
-  def add_tags(*tags)
-    tags = tags.first if tags.length == 1
-
-    if tags.is_a? Array
-      current_tags[:tags] ||= []
-      current_tags[:tags] += tags
-    elsif tags.is_a? String
-      current_tags[:tags] ||= []
-      current_tags[:tags] << tags
-    else
-      current_tags.merge! tags
-    end
-  end
-
-  def remove_tags(*tags)
-    tags = tags.first if tags.length == 1
-
-    if tags.is_a? Array
-      current_tags[:tags] ||= []
-      tags.each { |tag| current_tags[:tags].delete(tag) }
-    elsif tags.is_a? String
-      current_tags[:tags] ||= []
-      current_tags[:tags].delete(tags)
-    else
-      tags.each_key { |key| current_tags.delete(key) }
-    end
-  end
-
-  def clear_tags!
-    current_tags.clear
-  end
-
-  def current_tags
-    # We use our object ID here to avoid conflicting with other instances
-    thread_key = @thread_key ||= "fluent_logger_rails:#{object_id}"
-    Thread.current[thread_key] ||= {}
-  end
-
-  def compact_tags
-    current_tags.delete_if { |_k, v| v.blank? }
-  end
-end

data/lib/fluent_logger_rails/json_formatter.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class JsonFormatter < HashFormatter
-  def call(severity, timestamp, progname, msg)
-    super(severity, timestamp, progname, msg).to_json
-  end
-end

data/lib/fluent_logger_rails/pretty_json_formatter.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class PrettyJsonFormatter < HashFormatter
-  def call(severity, timestamp, progname, msg)
-    JSON.pretty_generate(super(severity, timestamp, progname, msg))
-  end
-end

data/lib/fluent_logger_rails/tagged_logging.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module FluentLoggerRails
-  module TaggedLogging
-    def self.new(logger, format: :hash)
-      logger.formatter = if format == :hash
-        HashFormatter.new
-      elsif format == :pretty_json
-        PrettyJsonFormatter.new
-      elsif format == :json
-        JsonFormatter.new
-      else
-        fail "Unrecognized log format: '#{format}'"
-      end
-
-      logger.extend(self)
-    end
-
-    delegate :add_tags, :remove_tags, :clear_tags!, to: :formatter
-
-    def tagged(*tags)
-      formatter.tagged(*tags) { yield self }
-    end
-
-    def flush
-      clear_tags!
-      super if defined?(super)
-    end
-  end
-end