betterlog 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d0c9076a03bc4094bd5ec7541ce8a5c916a2711a7901c5230340d6d69da81a6
-  data.tar.gz: 8c9965f05f6cacefe03fbc2119f7c4d8d1c818b3f49171b00225210b427568a5
+  metadata.gz: d0808e5c0791eea5fc8603ab2b6b89bdfcad494290b7dd7e41065569aaaaae68
+  data.tar.gz: 0df0ef130d6f6b3ed31f940386906651d8d16a1b5f5823f8eb4aca54dd6c6e8a
 SHA512:
-  metadata.gz: 756b6170017c03287422e5999c70f2b416ea9859895aace4f7ff3316bdb50cb66df17d72fc1a9a8d41596aff4866e929fdbdbc5bcb582f280da0150432b4b9a9
-  data.tar.gz: 1ee36fdc3162f32947811db380bbbcb06edd27d328facf58801bbd6cfa8e4da2d1ebbee74c0aa5ce990b924fb11cccb68e5698f53fe3d6e555d36c32ab4bc6bb
+  metadata.gz: d53aa09dc1b81790f9582e5802b54af8ccbf7df80f599e6e82f473d16a41ef7e0daad414d4d81d71e3faab4f3c918ca92f498340f4f151da0b69309c070e6993
+  data.tar.gz: 3f7b71e06e31cf1d087b1a41d3b9394d38b70f4b3a76e4d973e81b44fac14d18793982f818922409991ea0804f901ad1eb7740b69f4b7d695d6c98af87f7a2b1

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.8.0

data/betterlog.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: betterlog 0.7.2 ruby lib
+# stub: betterlog 0.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterlog".freeze
-  s.version = "0.7.2"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["betterplace Developers".freeze]
-  s.date = "2019-11-06"
+  s.date = "2019-11-15"
   s.description = "This library provides structure json logging for our rails projects".freeze
   s.email = "developers@betterplace.org".freeze
   s.executables = ["betterlog".freeze, "betterlog_pusher".freeze, "betterlog_sink".freeze]

data/lib/betterlog/log.rb

@@ -12,7 +12,7 @@ module Betterlog
     self.default_logger = Logger.new(STDERR)
 
     def logger
-      defined?(Rails) && Rails.logger || self.class.default_logger
+      defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : ::Logger.new(STDERR)
     end
 
     # Logs a message on severity info.
@@ -83,16 +83,19 @@ module Betterlog
     end
 
     # Logs a metric on severity debug, by default, this can be changed by passing
-    # the severity: keyword.
+    # the severity: keyword. +name+ is for example 'Donation' and +type+
+    # 'Confirmation', and +value+ can be any value, but has to be somewhat
+    # consistent in terms of structure with +name/type+ to allow for correct
+    # evaluation.
     #
-    # @param metric the name of the recorded metric.
+    # @param name the name of the recorded metric.
     # @param type of the recorded metric.
     # @param value of the recorded metric.
     # @param **rest additional rest is logged as well.
     # @return [ Log ] this object itself.
-    def metric(metric:, type:, value:, **rest)
+    def metric(name:, type:, value:, **rest)
       protect do
-        event = build_metric(metric: metric, type: type, value: value, **rest)
+        event = build_metric(name: name, type: type, value: value, **rest)
         emit event
       end
     end
@@ -103,21 +106,21 @@ module Betterlog
     # If an error occurs during measurement details about it are added to the
     # metric event.
     #
-    # @param metric the name of the recorded metric.
+    # @param name the name of the recorded metric.
     # @param **rest additional rest is logged as well.
     # @param block the block around which the measure is teaken.
     # @return [ Log ] this object itself.
-    def measure(metric:, **rest, &block)
+    def measure(name:, **rest, &block)
       raise ArgumentError, 'must be called with a block' unless block_given?
       time_block { yield }
     rescue => error
       e = Log::Event.ify(error)
       rest |= e.as_hash.subhash(:error_class, :backtrace, :message)
-      rest[:message] = "#{rest[:message].inspect} while measuring metric #{metric}"
+      rest[:message] = "#{rest[:message].inspect} while measuring metric #{name}"
       raise error
     ensure
       protect do
-        event = build_metric(metric: metric, type: 'seconds', value: timed_duration, **rest)
+        event = build_metric(name: name, type: 'duration', value: timed_duration, **rest)
         emit event
       end
     end
@@ -149,14 +152,14 @@ module Betterlog
       self
     end
 
-    def build_metric(metric:, type:, value:, **rest)
+    def build_metric(name:, type:, value:, **rest)
       severity = rest.fetch(:severity, :debug)
       rest |= {
-        message: "a metric #{metric} of type #{type}",
+        message: "a metric #{name} of type #{type}",
       }
       Log::Event.ify(
         {
-          metric: metric,
+          name: name,
           type: type,
           value: value,
         } | rest,

data/lib/betterlog/version.rb

@@ -1,6 +1,6 @@
 module Betterlog
   # Betterlog version
-  VERSION         = '0.7.2'
+  VERSION         = '0.8.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/betterlog/log_spec.rb

@@ -140,14 +140,14 @@ describe Betterlog::Log do
 
     it 'can be sent after measuring times' do
       expected_event = Log::Event.new(
-        message: 'a metric foo of type seconds',
-        metric:    'foo',
-        type:      'seconds',
+        message: 'a metric foo of type duration',
+        name:    'foo',
+        type:      'duration',
         value:     10.0,
         timestamp: "2011-11-11T10:11:21.000Z"
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.measure(metric: 'foo') do
+      Log.measure(name: 'foo') do
         Time.dummy = Time.now + 10
       end
     end
@@ -160,8 +160,8 @@ describe Betterlog::Log do
 
     it 'adds exception information if block raises' do
       expected_event = Log::Event.new(
-        metric:      'foo',
-        type:        'seconds',
+        name:      'foo',
+        type:        'duration',
         value:       3.0,
         timestamp:   "2011-11-11T10:11:14.000Z",
         message:     '"MyEx: we were fucked" while measuring metric foo',
@@ -171,7 +171,7 @@ describe Betterlog::Log do
       expect(instance).to receive(:emit).with(expected_event)
       raised = false
       begin
-        Log.measure(metric: 'foo') do
+        Log.measure(name: 'foo') do
           Time.dummy = Time.now + 3
           raise MyEx, "we were fucked"
           Time.dummy = Time.now + 7
@@ -187,36 +187,36 @@ describe Betterlog::Log do
     it 'logs metrics with a specific structure on debug log level' do
       expected_event = Log::Event.new(
         message: 'a metric controller.action of type ms',
-        metric: 'controller.action',
+        name: 'controller.action',
         type: 'ms',
         value: 0.123,
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.metric(metric: 'controller.action', type: 'ms', value: 0.123)
+      Log.metric(name: 'controller.action', type: 'ms', value: 0.123)
     end
 
     it 'logs metrics on a given log level' do
       expected_event = Log::Event.new(
         message: 'a metric controller.action of type ms',
-        metric: 'controller.action',
+        name: 'controller.action',
         type:   'ms',
         value:  0.123,
         severity: :info,
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.metric(severity: :info, metric: 'controller.action', type: 'ms', value: 0.123)
+      Log.metric(severity: :info, name: 'controller.action', type: 'ms', value: 0.123)
     end
 
     it 'logs metrics with additional data' do
       expected_event = Log::Event.new(
         message: 'a metric controller.action of type ms',
         foo: 'bar',
-        metric: 'controller.action',
+        name: 'controller.action',
         type: 'ms',
         value: 0.123,
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.metric(metric: 'controller.action', type: 'ms', value: 0.123, foo: 'bar')
+      Log.metric(name: 'controller.action', type: 'ms', value: 0.123, foo: 'bar')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterlog
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar