logatron 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 996a82f534fa1a3877a7e06053872b349ebbb4e5
-  data.tar.gz: 7c9c7e45c9c117a92b3a29e58ab62da46a108725
+  metadata.gz: c0d3fc64e66b4cdc0f85cdd1dd9124edb59a77ce
+  data.tar.gz: d0cc1924c4c28c1a475224e3146710635d7fb0a0
 SHA512:
-  metadata.gz: d16b54849df41e7d97b11888acdfafede8d0a11b73f1c7a70f5a3cc9c06202b412e1d0d016c312dc64612b36095b1a7a2483aa268c4badce4c17c9d5535c2304
-  data.tar.gz: caba7a2dfc16ecc7be6e5da47896fbce5c9911cf7f345962674d2e2ebd9f6b94f1017e99fa8b6eea2e8d37008ec2ebc7e1b090b22fbd76638e2933262509d18d
+  metadata.gz: adea0b753a1eb719124166d3aadc7b507054cd971c3873c62ffc9b7464b922ea105cf01348cab27ae7b5da57ac36e324517695c4d5440e9304b9c02052e8f2b1
+  data.tar.gz: 64d1ee8c85bc03a8dfb056758d429f3a793d65a22ec94427f5940547c33bb5fba84e676c0760b62344cbfa8adbc603808896f7dce120bbd67288a47ee0b05c34

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    logatron (0.2.5)
+    logatron (0.2.6)
       activesupport (~> 4.2, >= 4.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.5)
+    activesupport (4.2.5.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)

data/README.md

@@ -1,9 +1,5 @@
 # Logatron
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/logatron/logatron`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,13 +22,15 @@ Or install it yourself as:
 Severities are used to examine and filter server logs, create alerts, and analyze user behavior.
 
 * Debug - use for fixing production bugs or deeper inspection into behavior
-* Invalid Use - use for user errors due to invalid inputs
 * Info - use for general information (successful operations, ec.)
+* Invalid Use - use for user errors due to invalid inputs
 * Warn - use for recoverable errors
 * Error - use for known unrecoverable errors
 * Critical - use for unknown unrecoverable errors (system-level rescues)
 * Fatal - use for system errors
 
+*Invalid Use* - inappropriate inputs from a user - are not immediately actionable for a development team, but may provide input into customer care, future features, or bug fixes for poorly implemented features. This makes them a discrete category similar to `INFO` so that any queries on the logs can be readily consumed by such information seekers.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/logatron/basic_logger.rb

@@ -22,6 +22,10 @@ module Logatron
       write(format_log(msg: msg, severity: DEBUG), SEVERITY_MAP[DEBUG])
     end
 
+    def invalid_use(msg)
+      write(format_log(msg: msg, severity: INVALID_USE), SEVERITY_MAP[INVALID_USE])
+    end
+
     def error(msg)
       write(format_log(msg: msg, severity: ERROR), SEVERITY_MAP[ERROR])
     end
@@ -39,16 +43,16 @@ module Logatron
       start = Time.now
       begin
         res = block.call(ml)
-        write(format_log(severity: severity, msg: msg, status: status, duration: milliseconds_elapsed(Time.now, start), inputs: source, request: request),SEVERITY_MAP[severity])
+        write(format_log(severity: severity, msg: msg, status: status, duration: milliseconds_elapsed(Time.now, start), inputs: source, request: request), SEVERITY_MAP[severity])
         res
       rescue Exception => e
-        write(format_log(severity: severity, msg: msg, status: status, duration: milliseconds_elapsed(Time.now, start), inputs: source, request: request),SEVERITY_MAP[severity])
+        write(format_log(severity: severity, msg: msg, status: status, duration: milliseconds_elapsed(Time.now, start), inputs: source, request: request), SEVERITY_MAP[severity])
         ml.flush
         raise e
       end
     end
 
-    def write(string,severity)
+    def write(string, severity)
       Logatron.configuration.logger.log(severity, string)
     end
   end

data/lib/logatron/basic_scoped_logger.rb

@@ -9,14 +9,7 @@ module Logatron
 
     def initialize(logger)
       @logger = logger
-      @logs = {
-          DEBUG => [],
-          INFO => [],
-          WARN => [],
-          ERROR => [],
-          CRITICAL => [],
-          FATAL => []
-      }
+      @logs = Hash[Logatron::SEVERITY_MAP.keys.map{|key| [key, []]}]
     end
 
     def info(msg)
@@ -31,6 +24,10 @@ module Logatron
       write(format_log(msg: msg, severity: DEBUG), DEBUG)
     end
 
+    def invalid_use(msg)
+      write(format_log(msg: msg, severity: INVALID_USE), INVALID_USE)
+    end
+
     def error(msg)
       write(format_log(msg: msg, severity: ERROR), ERROR)
     end
@@ -50,10 +47,9 @@ module Logatron
     def flush
       Logatron.configuration.loggable_levels.each do |key|
         @logs[key].each do |item|
-          @logger.write(item,SEVERITY_MAP[key])
+          @logger.write(item, SEVERITY_MAP[key])
         end
       end
     end
   end
-
 end

data/lib/logatron/configuration.rb

@@ -30,13 +30,9 @@ module Logatron
       @transformer =  proc {|x| x.to_json}
       @host = `hostname`.chomp
       @level = INFO
-      levels = [DEBUG,
-                INFO,
-                WARN,
-                ERROR,
-                CRITICAL,
-                FATAL]
-      @loggable_levels = levels.slice(levels.index(@level), levels.size-1)
+      level_threshold = SEVERITY_MAP[@level]
+      levels = Logatron::SEVERITY_MAP.keys
+      @loggable_levels = levels.select{|level| SEVERITY_MAP[level] >= level_threshold}
       bc = ActiveSupport::BacktraceCleaner.new
       bc.add_filter { |line| line.gsub(Rails.root.to_s, '') } if defined? Rails
       bc.add_silencer { |line| line =~ /gems/ }

data/lib/logatron/const.rb

@@ -1,20 +1,31 @@
 module Logatron
-  WARN = 'WARN'.freeze
+  MSG_ID = :msg_id
+  SITE = :site
+
+  DEBUG = 'DEBUG'.freeze
+  INVALID_USE = 'INVALID_USE'.freeze
   INFO = 'INFO'.freeze
+  WARN = 'WARN'.freeze
   ERROR = 'ERROR'.freeze
   CRITICAL = 'CRITICAL'.freeze
   FATAL = 'FATAL'.freeze
-  DEBUG = 'DEBUG'.freeze
-  INVALID_USE = 'INVALID_USE'.freeze
-  MSG_ID = :msg_id
-  SITE = :site
+
+  # Maps Constants to the Logger Severity Integers:
+  #   DEBUG = 0
+  #   INFO = 1
+  #   WARN = 2
+  #   ERROR = 3
+  #   FATAL = 4
+  #   UNKNOWN = 5
+  # Note that the Logatron Severities will be put into
+  # the logs (severity => INVALID_USE), for filtering purposes
   SEVERITY_MAP =  {
       Logatron::DEBUG => 0,
+      Logatron::INFO => 1,
       Logatron::INVALID_USE => 1,
-      Logatron::INFO => 2,
-      Logatron::WARN => 3,
-      Logatron::ERROR => 4,
-      Logatron::CRITICAL => 5,
-      Logatron::FATAL => 6
+      Logatron::WARN => 2,
+      Logatron::ERROR => 3,
+      Logatron::CRITICAL => 4,
+      Logatron::FATAL => 5
   }
 end

data/lib/logatron/message_formatting.rb

@@ -7,18 +7,17 @@ module Logatron
     end
 
     def format_log(msg: '-', status: '-', duration: '-', request: '-', inputs: '-', severity: '-')
-      Logatron.configuration.transformer.call({
-                                                  timestamp: Time.now.iso8601,
-                                                  severity: severity,
-                                                  host: Logatron.configuration.host,
-                                                  id: Contexts.msg_id,
-                                                  site: Contexts.site,
-                                                  status: status,
-                                                  duration: duration,
-                                                  request: request,
-                                                  source: inputs,
-                                                  body: msg
-                                              }) + "\n"
+      Logatron.configuration.transformer.call(
+        timestamp: Time.now.iso8601,
+        severity: severity,
+        host: Logatron.configuration.host,
+        id: Contexts.msg_id,
+        site: Contexts.site,
+        status: status,
+        duration: duration,
+        request: request,
+        source: inputs,
+        body: msg) + "\n"
     end
   end
 end

data/logatron.gemspec

@@ -5,7 +5,7 @@ require 'logatron/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'logatron'
-  spec.version       = '0.2.5'
+  spec.version       = '0.2.6'
   spec.authors       = ['Justin Grimes']
   spec.email         = ['justin.mgrimes@gmail.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logatron
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Justin Grimes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport