loggery 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0b7a03ec7d234a7fde324b7c5d08f01cfad7f64
-  data.tar.gz: 89318bb7a4a045a9248d0c78a7897fca044f738f
+  metadata.gz: 51aab323d0268f155d0cb2d3b4706a72409dda2d
+  data.tar.gz: f576a02b4fcebb0a6136cc471f546613177ec4e6
 SHA512:
-  metadata.gz: ab421d8f289c4a5a059d6f0e1d651e2020a469099bf84adc808bce618d47843451ecc14ef5998c15abcde4482b1a2f3cf537ca355e839749a4edf6ba282b60f0
-  data.tar.gz: 3ebff63c9e25d2b0ca1e73e571b102b27985265b63dc4622d69e998277ab94b2053d8f216a3d9e30b7729cff5053df060cf6f875dc9cbbc855391f65c1c51935
+  metadata.gz: 70609887ea649f271a3d362be6dd3b6adce2bbbccd1a3f2ccaf05e65b7a7efe756ee4dbaccaa079d49c1d6d72fad1d861fe4cf41f25056b0e29bd40cc593898a
+  data.tar.gz: 9e39ac654b31a0b58778a86b1db32eabd17177af5b066d1ec87c45d78181eba90894a25a2e3599bc071f9f9913a8efae07325b1e1779b7f344e443da663c8b1b

data/.gitignore

@@ -14,3 +14,5 @@ log
 
 # rspec failure tracking
 .rspec_status
+
+*.gemfile.lock

data/.rubocop.yml

@@ -7,8 +7,9 @@ Style/StringLiterals:
 Metrics/LineLength:
     Max: 120
 
-Style/BlockLength:
+Metrics/BlockLength:
   Exclude:
+    - loggery-gem.gemspec
     - 'spec/**/*.rb'
 
 Documentation:
@@ -17,5 +18,13 @@ Documentation:
 Style/Lambda:
   EnforcedStyle: literal
 
-Style/MethodLength:
+Metrics/MethodLength:
   Max: 20
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - gemfiles/**/*
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table

data/.travis.yml

@@ -2,6 +2,15 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.2
+gemfile:
+  - gemfiles/rails4.2.gemfile
+  - gemfiles/rails5.0.gemfile
+  - gemfiles/rails5.1.gemfile
+  - gemfiles/rails5.2.gemfile
+before_install:
+  - rvm use @global
+  - gem uninstall bundler -x
+  - gem install -v 1.17.2 bundler --no-rdoc --no-ri
 script:  
 - bundle exec rubocop
 - bundle exec rspec

data/Appraisals

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+appraise "rails4.2" do
+  gem "rails", "~> 4.2.0"
+end
+
+appraise "rails5.0" do
+  gem "rails", "~> 5.0.0"
+end
+
+appraise "rails5.1" do
+  gem "rails", "~> 5.1.0"
+end
+
+appraise "rails5.2" do
+  gem "rails", "5.2.0.beta2"
+end

data/README.md

@@ -24,11 +24,17 @@ And then execute:
     $ bundle
 
 ### Basic Rails integration
+
+To enable, add 
+
 ```ruby
 config.loggery.enabled = true
 ```
 
-to your `config/application.rb`. In this basic setup, Loggery will save your log output to
+to your `config/application.rb` or to the environment specific `config/staging.rb` and/or
+`config/production.rb`.
+
+In this basic setup, Loggery will save your log output to
 `log/logstash-<rails-env>.log` in JSON format. It will also:
 * use [lograge](https://github.com/roidrage/lograge) to create a single-line log entry for every
   Rails request including the db / view / total duration, controller name, action, http status, etc...

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.2.0.beta2"
+
+gemspec path: "../"

data/lib/loggery.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require "lograge"
+require "logstash-event"
+require "logstash-logger"
+require "rails"
+
 require "loggery/gem/version"
 require "loggery/util"
 require "loggery/controller/logging_context"
@@ -11,10 +16,6 @@ require "loggery/metadata/middleware/rack"
 require "loggery/metadata/middleware/sidekiq"
 require "loggery/railtie"
 
-require "lograge"
-require "logstash-event"
-require "logstash-logger"
-
 module Loggery
   def self.setup_sidekiq
     Loggery::Sidekiq::Setup.setup

data/lib/loggery/controller/logging_context.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 # Provides a hook in Rails controllers that allows enriching log lines from within a Rails request
 # with data that is available only within a controller action, for instance user information.
 
@@ -19,6 +21,7 @@ module Loggery
 
       def loggery_set_metadata
         return unless Loggery::Metadata::Store.store
+
         metadata = loggery_default_metadata.merge loggery_log_context
         Loggery::Metadata::Store.store.merge!(metadata)
       end

data/lib/loggery/gem/version.rb

@@ -2,6 +2,6 @@
 
 module Loggery
   module Gem
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/loggery/metadata/logstash_event_util.rb

@@ -6,33 +6,32 @@
 module Loggery
   module Metadata
     module LogstashEventUtil
-      extend self
+      MAGIC_FIELDS = %i[type uid _id _type _source _all _parent _fieldnames _routing
+                        _index _size _timestamp _ttl].freeze
 
-      MAGIC_FIELDS = %i{type uid _id _type _source _all _parent _fieldnames _routing 
-                        _index _size _timestamp _ttl }.freeze
-
-      def event_metadata(event)
+      def self.event_metadata(event)
         return unless loglevel_includes_event?(event)
+
         stored_metadata = Loggery::Metadata::Store.store || {}
         metadata = default_metadata.merge(stored_metadata)
         set_logstash_event_metadata(event, metadata)
       end
 
-      def set_logstash_event_metadata(event, metadata)
+      def self.set_logstash_event_metadata(event, metadata)
         metadata.each { |k, v| event[k] = v }
         fail_if_magic_fields_are_used(event)
       end
 
-      def default_metadata
+      def self.default_metadata
         { pid: Process.pid }
       end
 
-      def loglevel_includes_event?(event)
-        severity = event['severity'].downcase
+      def self.loglevel_includes_event?(event)
+        severity = event["severity"].downcase
         Rails.logger.respond_to?(severity) && Rails.logger.public_send("#{severity}?")
       end
 
-      def fail_if_magic_fields_are_used(event)
+      def self.fail_if_magic_fields_are_used(event)
         MAGIC_FIELDS.each do |magic_field|
           if event[magic_field.to_s].present? || event[magic_field.to_sym].present?
             raise "'#{magic_field}' is a reserved field name of logstash. It should not be set in a custom event"

data/lib/loggery/metadata/middleware/rack.rb

@@ -12,7 +12,7 @@ module Loggery
 
         def call(env)
           Loggery::Metadata::Store.with_metadata(worker_type: "web",
-                                                 request_id: env["action_dispatch.request_id"]) do
+                                                 request_id:  env["action_dispatch.request_id"]) do
             @app.call(env)
           end
         end

data/lib/loggery/metadata/middleware/sidekiq.rb

@@ -13,15 +13,12 @@ module Loggery
           attr_accessor(:error_handler) { ->(e) { Sidekiq::Logging.logger.error(e) } }
         end
 
-        def call(_worker, msg, queue)
-          Loggery::Metadata::Store.with_metadata(jid:         msg["jid"],
-                                                 thread_id:   Thread.current.object_id.to_s(36),
-                                                 worker:      msg["class"],
-                                                 args:        msg["args"].inspect,
-                                                 queue:       queue,
-                                                 retry_count: msg["retry_count"],
-                                                 worker_type: "sidekiq") do
-            log_job_runtime(:sidekiq_job, "#{msg['class']} (#{msg['args']})") do
+        def call(_worker, message, queue)
+          Loggery::Metadata::Store.with_metadata(build_metadata(message, queue)) do
+            job_instance_name = "#{message['class']} (#{message['args']})"
+            log_job_start(message, job_instance_name)
+
+            log_job_runtime(:sidekiq_job, job_instance_name) do
               begin
                 yield
               rescue StandardError => e
@@ -33,6 +30,31 @@ module Loggery
             end
           end
         end
+
+        private
+
+        def build_metadata(message, queue)
+          {
+            jid:         message["jid"],
+            thread_id:   Thread.current.object_id.to_s(36),
+            worker:      message["class"],
+            args:        message["args"].inspect,
+            queue:       queue,
+            retry_count: message["retry_count"],
+            worker_type: "sidekiq"
+          }
+        end
+
+        def log_job_start(message, job_instance_name)
+          execution_delay =
+            (Time.current - Time.zone.at(message["enqueued_at"]) if message["enqueued_at"])
+
+          Rails.logger.info(
+            event_type:      :sidekiq_job_started,
+            message:         "Job type sidekiq_job - #{job_instance_name} started",
+            execution_delay: execution_delay
+          )
+        end
       end
     end
   end

data/lib/loggery/railtie.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "rails/railtie"
+require "rails/rack/logger"
+
 module Loggery
   module LogstashSetup
     def self.setup(config)

data/lib/loggery/util.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/time/calculations"
+
 module Loggery
   module Util
-    def log_job_runtime(job_type, job_instance_name = nil)
-      job_name = ["Job type #{job_type}", job_instance_name].compact.join " - "
-
-      Rails.logger.info event_type: :"#{job_type}_started", message: "#{job_name} started"
+    def log_job_runtime(job_type, job_instance_name)
+      job_name = "Job type #{job_type} - #{job_instance_name}"
 
       begin
         start_time = Time.current
@@ -15,8 +15,8 @@ module Loggery
         duration = end_time - start_time
 
         Rails.logger.info event_type: :"#{job_type}_finished",
-                          message: "#{job_name} finished",
-                          duration: duration
+                          message:    "#{job_name} finished",
+                          duration:   duration
       end
     end
   end

data/loggery-gem.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "loggery/gem/version"
 
@@ -21,13 +21,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "actionpack", ">= 4.2.0"
+  spec.add_runtime_dependency "activesupport", ">= 4.2.0"
   spec.add_runtime_dependency "lograge", "~> 0.6"
   spec.add_runtime_dependency "logstash-event", "~> 1.2"
   spec.add_runtime_dependency "logstash-logger", "~> 0.25"
-  spec.add_runtime_dependency "rails", ">= 4.0"
+  spec.add_runtime_dependency "railties", ">= 4.2.0"
 
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rails", ">= 4.2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: loggery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Stemplinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.25'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -175,11 +231,17 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/.bundle/config
+- gemfiles/rails4.2.gemfile
+- gemfiles/rails5.0.gemfile
+- gemfiles/rails5.1.gemfile
+- gemfiles/rails5.2.gemfile
 - lib/loggery.rb
 - lib/loggery/controller/logging_context.rb
 - lib/loggery/gem/version.rb
@@ -212,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Generate logstash compatible log output from Rails apps.