logdna 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c55551804963d24df4eb0ea8582cce2043f0567d
-  data.tar.gz: 0e9aa46f633cfa23ebc9d9d13ce1203be38a6e59
+  metadata.gz: 783a6b3016403a140faca9e0e097d5a3997b59b2
+  data.tar.gz: 1d67f778ded84e82f7047e292256eca6ee51ca92
 SHA512:
-  metadata.gz: acd3e19e004f4b09a800558f2b82ed310fffedd2281829b6a7342492ff0fa403ac3ad4a9219797e44734d2da297b99546e1182bc74bce495cd11f541c91bc8f2
-  data.tar.gz: d90c07c141bb8a0ad76fe035177349db15d7a332c9d91081731aee278db55e3ed1c6b3e284d717530595bb671801d48edae2656f44560b4982d20cb92952459b
+  metadata.gz: 1e6653f54721fc2d7bc28df9dd546c9e7d34008b7dbb01080ef06da1e4b2c968c60ce4837e34c3f5f7ebb8a3937cc020dc8b0f3712d0378af22f9ff180a910fa
+  data.tar.gz: ed2c73279b66651f8894b40eb9baa2abececab4a9d66197db5e39ec9112fbb4f9334cd324532744f28b69d4e7a0a64256f897f50b538faff039bed83f71765a9

data/README.md

@@ -36,7 +36,7 @@ Or install it yourself as:
 
 After installation, call
 
-    logger = Logdna::Ruby.new(your_ingestion_key, options)
+    logger = Logdna::Ruby.new(your_api_key, options)
     => #<Logdna::Ruby:0x00000000000000>
 
 to set up the logger.
@@ -48,45 +48,44 @@ Options are optional variables that may contain hostname, app name, mac address,
         :ip =>  myIpAddress,
         :mac => myMacAddress,
         :app => myAppName,
-        :level => "INFO"    # LOG_LEVELS = ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'] or your customized log level
-        :env => "PRODUCTION"
+        :level => "INFO",    # LOG_LEVELS = ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'] or your customized log level
+        :env => "PRODUCTION",
+        :meta => {:once => {:first => "nested1", :another => "nested2"}}
     }
 
-
-To send logs, use "log" method.
+To send logs, use "log" method. Default log level is "INFO"
 
     logger.log('This is my first log')
     => "Saved"  # Saved to buffer. Ready to be flushed automatically
 
+Log a message with particular metadata, level, appname, environment (one-time)
 
-By default, it will log at the level of "INFO" unless you specified otherwise during the initialzation of the logger. 
-You can change a particular message's log level.
-
-    logger.log('This is warn message', {:level => "WARN"})
-
+    logger.log('This is warn message', {:meta => {:meta => "data"}, :level => "WARN", :app => "awesome", :env => "DEVELOPMENT"})
 
-You can also send a metadata with your message by specifying 'meta' field
-
-    logger.log('This is a message with metadata', {:meta => {:once => {:first => "nested1", :another => "nested2"}}, :level => "TRACE"})
+Log a message with lasting metadata, level, appname, environment (lasting)
 
+    logger.meta = {:once => {:first => "nested1", :another => "nested2"}}
+    logger.level = 'FATAL'  or  logger.level = Logger::FATAL
+    logger.app = 'NEW APP NAME'
+    logger.env = 'PRODUCTION'
+    logger.log('This messages and messages afterwards all have the above values')
 
-Hostname and app name cannot be more than 80 characters.
+Clear current metadata, level, appname, environment
 
-This logger extends the standard Ruby logger and inherits some of the conventions from it. 
+    logger.clear
 
-    logger.info('This is info log')   # same as logger.log('This is info message', {:level => "INFO"})
+Check current log level:
+    
     logger.info? => true
-    logger.trace('trace log')
-    logger.error('error log')
+    logger.warn? => false
 
-You can also set logger level, environment, app name this way:
+Log a message with a particular level easily
 
-    logger.env = 'PRODUCTION'
-    logger.app = 'NEW APP NAME'
-    logger.level = 'FATAL'
-    logger.level = Logger::FATAL
+    logger.warn('This is a warning message')
+    logger.fatal('This is a fatal message')
 
 
+Hostname and app name cannot be more than 80 characters.
 
 
 # Important Notes
@@ -109,6 +108,7 @@ Instantiates a new instance of the class it is called on. ingestion_key is requi
 |{ :app => App name } | 'default' |
 |{ :level => Log level } | 'INFO' |
 |{ :env => STAGING, PRODUCTION .. etc} | Nil |
+|{ :meta => metadata} | Nil |
 |{ :flushtime => Log flush interval in seconds } | 0.25 seconds |
 |{ :flushbyte => Log flush upper limit in bytes } | 500000 bytes ~= 0.5 megabytes |
 

data/lib/logdna.rb

@@ -6,10 +6,11 @@ require_relative 'logdna/resources.rb'
 module Logdna
     class Ruby < ::Logger
         Logger::TRACE = 5
-        attr_accessor :level, :app, :env
+        attr_accessor :level, :app, :env, :meta
         @level = nil
         @app = nil
         @env = nil
+        @meta = nil
 
         def initialize(key, opts={})
             @@client = Logdna::Client.new(key, opts)
@@ -23,14 +24,8 @@ module Logdna
         end
 
         def log(msg=nil, opts={})
-            if @level || @app || @env
-                @@client.change(@level, @app, @env)
-                @level = nil
-                @app = nil
-                @env = nil
-            end
-
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -38,6 +33,7 @@ module Logdna
         def trace(msg=nil, opts={})
             opts[:level] = "TRACE"
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -45,6 +41,7 @@ module Logdna
         def debug(msg=nil, opts={})
             opts[:level] = "DEBUG"
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -52,6 +49,7 @@ module Logdna
         def info(msg=nil, opts={})
             opts[:level] = "INFO"
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -59,6 +57,7 @@ module Logdna
         def warn(msg=nil, opts={})
             opts[:level] = "WARN"
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -66,6 +65,7 @@ module Logdna
         def error(msg=nil, opts={})
             opts[:level] = "ERROR"
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -73,6 +73,7 @@ module Logdna
         def fatal(msg=nil, opts={})
             opts[:level] = "FATAL"
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -125,6 +126,16 @@ module Logdna
             logLevel('FATAL')
         end
 
+        def clear
+            loggerExist?
+            @@client.clear()
+            @level = nil
+            @app = nil
+            @env = nil
+            @meta = nil
+            return true
+        end
+
         def loggerExist?
             if @@client.nil?
                 puts "Logger Not Initialized Yet"
@@ -132,6 +143,16 @@ module Logdna
             end
         end
 
+        def optionChanged?
+            if @level || @app || @env || @meta
+                @@client.change(@level, @app, @env, @meta)
+                @level = nil
+                @app = nil
+                @env = nil
+                @meta = nil
+            end
+        end
+
         def logLevel(comparedTo)
             if @level.is_a? Numeric
                 @level = Resources::LOG_LEVELS[@level]
@@ -142,6 +163,7 @@ module Logdna
         def <<(msg=nil, opts={})
             opts[:level] = ""
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end
@@ -154,6 +176,7 @@ module Logdna
         def unknown(msg=nil, opts={})
             opts[:level] = "UNKNOWN"
             loggerExist?
+            optionChanged?
             @response = @@client.tobuffer(msg, opts)
             'Saved'
         end

data/lib/logdna/client.rb

@@ -18,7 +18,8 @@ module Logdna
                     :mac => opts.key?(:mac) ? "&mac=#{opts[:mac]}" : "",
                     :app => (opts[:app] ||= "default"),
                     :level => (opts[:level] ||= "INFO"),
-                    :env => (opts[:env])
+                    :env => (opts[:env]),
+                    :meta => (opts[:meta])
                 }.reject { |k,v| k === :env && v.nil? }
 
                 begin
@@ -54,7 +55,7 @@ module Logdna
             end
         end
 
-        def change(level, app, env)
+        def change(level, app, env, meta)
             if level
                 if level.is_a? Numeric
                     level = Resources::LOG_LEVELS[level]
@@ -67,6 +68,16 @@ module Logdna
             if env
                 @qs[:env] = env
             end
+            if meta
+                @qs[:meta] = meta
+            end
+        end
+
+        def clear()
+            @qs[:level] = "INFO"
+            @qs[:app] = "default"
+            @qs[:env] = nil
+            @qs[:meta] = nil
         end
 
         def getLevel
@@ -101,8 +112,8 @@ module Logdna
                         :app => opts[:app] ||= @qs[:app],
                         :level => opts[:level] ||= @qs[:level],
                         :timestamp => Time.now.to_i,
-                        :meta => opts[:meta] ||= nil,
-                        :env => (opts[:env]) ? opts[:env] : (@qs[:env]) ? @qs[:env] : nil
+                        :meta => (opts[:meta]) ? opts[:meta] : (@qs[:meta]) ? @qs[:meta] : nil,
+                        :env => (opts[:env]) ? opts[:env] : (@qs[:env]) ? @qs[:env] : nil,
                     }.reject { |k,v| k === :meta && v.nil? })
                 else
                     @secondbytesize += msg.bytesize
@@ -111,8 +122,8 @@ module Logdna
                         :app => opts[:app] ||= @qs[:app],
                         :level => opts[:level] ||= @qs[:level],
                         :timestamp => Time.now.to_i,
-                        :meta => opts[:meta] ||= nil,
-                        :env => (opts[:env]) ? opts[:env] : (@qs[:env]) ? @qs[:env] : nil
+                        :meta => (opts[:meta]) ? opts[:meta] : (@qs[:meta]) ? @qs[:meta] : nil,
+                        :env => (opts[:env]) ? opts[:env] : (@qs[:env]) ? @qs[:env] : nil,
                     }.reject { |k,v| k === :meta && v.nil? })
                 end
 

data/lib/logdna/version.rb

@@ -1,3 +1,3 @@
 module LogDNA
-  VERSION = '1.0.8'.freeze
+  VERSION = '1.0.9'.freeze
 end

data/test.rb

@@ -2,13 +2,40 @@ require 'require_all'
 require_all 'lib'
 
 
-options = {hostname: "new"}
+options = {hostname: "new", meta:{:once => {:first => "nested1", :another => "nested2"}}}
 
 
-logger1 = Logdna::Ruby.new('Your API Key', options)
+logger1 = Logdna::Ruby.new('You API KEY', options)
+
+logger1.log('This is the start of test')
+logger1.env = 'STAGING'
+logger1.app = 'HELLO'
+logger1.warn('Warn message with Staging and Hello')
+logger1.clear
+logger1.log('Is everything back to normal?')
+
+
+logger1.log('Testing env app name change using log')
+logger1.env = 'PRODUCTION'
+logger1.app = 'CHANGED'
+logger1.log('This should be stage = PRODUCTION and appname = CHANGED')
+logger1.log('Testing env app name change using other messages')
+
+
+logger1.error('This is error message with env = DEVELOPMENT and appname = NIHAO', {:env => 'DEVELOPMENT', :app => 'NIHAO'})
+logger1.log('Should not stay as DEVELOPMENT and NIHAO')
+logger1.env = 'DEVELOPMENT'
+logger1.app = 'NIHAO'
+logger1.log('Now should be DEVELOPMENT and NIHAO')
+logger1.log('Logging metadata in trace level', {:meta => {:once => {:first => "nested1", :another => "nested2"}}, :level => "TRACE"})
+
+
+logger1.level = Logger::DEBUG
+logger1.log('This is debug message')
+logger1.add('this should not be supported')
+logger1.fatal('Does this continue as fatal?')
+logger1.log('This should be debug')
 
-logger1.level = Logger::TRACE
-logger1.log('is this trace')
 
 =begin
 logger1.level = Logger::WARN

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logdna
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Gun Woo Choi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby