mojo_logger 0.1.2-java → 0.1.3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7e1f14860fb9109cc8a299e4404fcba0d6d16e3
-  data.tar.gz: bd519cb901083252da5a4f6e8d6f406531220640
+  metadata.gz: 89bc4925d6e1a37712cbc30f39e6a1fc828841b4
+  data.tar.gz: 7fc83948413cd2e371582e19e219ca3d281f1692
 SHA512:
-  metadata.gz: aa143461a6a84c68ebd2286a2f68774d2a096a1d247eca121595e0a78d4bef0d0af6bf52d28021689403fc9d9c5255c6d14c1676b8f570c5a9b11e5d230d6157
-  data.tar.gz: bc3838f80ed722cb807a506041462b4217d4c8d416d210c3a2398dfb14f0fac8fdb7acd5940cffaa5469907efd3f6c82d34e55030d6395321379681491cb77b7
+  metadata.gz: 7bd80e290202c5c9dd544198850f32a8ae58083dcf6f0f1836ce51bafe36b243eda537e5a6474b3252486f6275462c7de9e06b62ff288a4bcb48ec1e11573771
+  data.tar.gz: dbe16c3f70e848ba3a73bac0b1140cf082a3ade7ead5fbbf686f4f10e7b0839bb77b9c23a05f98ea230209d05cac41c797a5f795b75ce980375515efc5eaab36

data/README.md

@@ -1,8 +1,9 @@
 # MojoLogger
 
-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/mojo_logger`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is a wrapper around log4j and is primarily meant to be used in the Mojo framework. It will standardize logs accross Mojo applications and provide a single location to edit the Mojo Logger code base. It comes with a few benefits:
 
-TODO: Delete this and the text above, and describe your gem
+* **JSON** Logs will be printed for nice splunk logging when the mojo_* methods are called.
+* No need for a log4j.properties file (although you can use one if you prefer). You can configure the logger on the fly and this gem will build a StringIO object to mock the log4j.properties file
 
 ## Installation
 
@@ -22,7 +23,92 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Simple access to a CONSOLE appender:
+
+```ruby
+require 'mojo_logger'
+
+MojoLogger.logger.debug "This is a message"
+#=> This is a message 
+
+```
+
+#### Mojo Formatted JSON logs
+```ruby
+require 'mojo_logger'
+
+api_request = {
+    session_id: '111111-11111',
+    reference_id: 'client',
+    api: 'get-user-info'
+}
+
+MojoLogger.mojo_warn(api_request, "Oops", "Some Warn Message")
+#=> {"time":"08-25-2015 19:22:59.940 +0000","app":"Mojo","session_id":"111111-11111","reference_id":"client","api":"get-user-info","category":"Oops","message":"Some Warn Message"}
+
+```
+
+#### Mojo Formatted JSON logs with cusom keys
+```ruby
+require 'mojo_logger'
+
+api_request = {
+    session_id: '111111-11111',
+    reference_id: 'client',
+    api: 'get-user-info'
+}
+
+MojoLogger.mojo_warn(api_request, "Oops", "Some Warn Message", {my_key: "Some value", my_other_key: :another_val})
+#=> {"time":"08-25-2015 19:24:57.575 +0000","app":"Mojo","session_id":"111111-11111","reference_id":"client","api":"get-user-info","category":"Oops","message":"Some Warn Message","my_key":"Some value","my_other_key":"another_val"} 
+
+```
+
+
+## Configuration
+
+#### CONSOLE appender with "WARN" log level
+```ruby
+require 'mojo_logger'
+
+MojoLogger.config do |config|
+  config.default_log_level = :warn
+end
+
+MojoLogger.logger.debug "This won't show up"
+#=> nil
+
+MojoLogger.logger.warn "This will show up"
+#=> This will show up
+
+```
+
+
+#### Rolling File appender
+This will create a rolling file logger rather than a console logger with the following settings:
+Max File Size = 10MB
+Max Backup Index = 10
+Pattern = '%n %m %n'  (I need to change this but this is what it is for now.)
+
+```ruby
+require 'mojo_logger'
+
+MojoLogger.config do |config|
+  config.log_file = '/var/log/my_log.log'
+end
+
+```
+
+#### Add Custom lines to the generated log4j.properties 'file'
+
+```ruby
+require 'mojo_logger'
+
+MojoLogger.config do |config|
+  config.custom_line("log4j.logger.org.apache.zookeeper.ClientCnxn=INFO")
+end
+
+```
+
 
 ## Development
 

data/lib/mojo_logger/mojo_logger.rb

@@ -64,23 +64,29 @@ module MojoLogger
       logger.error(mojo_msg(*args))
     end
 
+    def default_log_level
+      configurator.default_log_level
+    end
 
     def config
-      @@config = MojoLogger::Configurator.new
-
-      yield(@@config) if block_given?
+      if block_given?
+        @@config = MojoLogger::Configurator.new
+        yield(@@config)
+        @@logger = configure_logger
+      end
 
-      @@logger = configure_logger
-      @@config
+      configurator
     end
 
 
-  private
+    private
 
-    def configure_logger
+    def configurator
       @@config ||= MojoLogger::Configurator.new
+    end
 
-      stringio = StringIO.new(@@config.generate_properties_string)
+    def configure_logger
+      stringio = StringIO.new(configurator.generate_properties_string)
       java_stringio = org.jruby.util.IOInputStream.new(stringio)
 
       Java::org.apache.log4j.PropertyConfigurator.configure(java_stringio)

data/lib/mojo_logger/version.rb

@@ -1,3 +1,3 @@
 module MojoLogger
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mojo_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: java
 authors:
 - John Thomas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement