betterlog 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0808e5c0791eea5fc8603ab2b6b89bdfcad494290b7dd7e41065569aaaaae68
-  data.tar.gz: 0df0ef130d6f6b3ed31f940386906651d8d16a1b5f5823f8eb4aca54dd6c6e8a
+  metadata.gz: 669ea0d62356d1741924aa51d8648fc8968cc32a910a9bcd96f88c90d91e494c
+  data.tar.gz: db1a0fb6aea128b0bff226bb912c0d66f0ba40b8955a854a1c6f02fb22e798f9
 SHA512:
-  metadata.gz: d53aa09dc1b81790f9582e5802b54af8ccbf7df80f599e6e82f473d16a41ef7e0daad414d4d81d71e3faab4f3c918ca92f498340f4f151da0b69309c070e6993
-  data.tar.gz: 3f7b71e06e31cf1d087b1a41d3b9394d38b70f4b3a76e4d973e81b44fac14d18793982f818922409991ea0804f901ad1eb7740b69f4b7d695d6c98af87f7a2b1
+  metadata.gz: a32f1c9ed9581edba4047bc14691a3a94653a553897b478361d012871ae2aa57843786642e41313c836f5fc5bf284153f5bc6bb49e734daf603d19d8cb70d37c
+  data.tar.gz: 56e67e0133c821f0f945328c0d3ddcacbf42503d4b0d21b2e4d454b52291bf95737c38493840828d8ceb308a6c6b1d8ca53c0b8abd17eccf3684511104692520

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/betterlog.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: betterlog 0.8.0 ruby lib
+# stub: betterlog 0.8.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterlog".freeze
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

data/config/log.yml

@@ -21,7 +21,7 @@ development: &development
       timestamp: {%lt%timestamp}
       severity: {severity}
       message: "{message}"
-      metric: {metric} {value} {type}
+      metric: {metric} {value}
       error_class: {error_class}
       backtrace: {%O%backtrace}
       host: {host}
@@ -33,7 +33,7 @@ development: &development
       {%0.1s%severity} [{%lt%timestamp} #{%d%pid}] {%5s%severity} --
       {program}: {message}
     metric: >
-      {%ft%timestamp} {metric} {value} {type}
+      {%ft%timestamp} {metric} {value}
   config_files:
     rails:
       - log/development.log

data/lib/betterlog/log.rb

@@ -83,19 +83,18 @@ module Betterlog
     end
 
     # Logs a metric on severity debug, by default, this can be changed by passing
-    # 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
+    # the severity: keyword. +name+ is for example 'Donation.Confirmation' and
+    # +value+ can be any value, but has to be somewhat consistent in terms of
+    # structure with +name+ to allow for correct
     # evaluation.
     #
     # @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(name:, type:, value:, **rest)
+    def metric(name:, value:, **rest)
       protect do
-        event = build_metric(name: name, type: type, value: value, **rest)
+        event = build_metric(name: name, value: value, **rest)
         emit event
       end
     end
@@ -120,7 +119,7 @@ module Betterlog
       raise error
     ensure
       protect do
-        event = build_metric(name: name, type: 'duration', value: timed_duration, **rest)
+        event = build_metric(name: name, value: timed_duration, **rest)
         emit event
       end
     end
@@ -152,16 +151,16 @@ module Betterlog
       self
     end
 
-    def build_metric(name:, type:, value:, **rest)
-      severity = rest.fetch(:severity, :debug)
+    def build_metric(name:, value:, **rest)
+      severity = rest.fetch(:severity, :info)
       rest |= {
-        message: "a metric #{name} of type #{type}",
+        message: "a metric #{name}=#{value}",
       }
       Log::Event.ify(
         {
-          name: name,
-          type: type,
+          name:  name,
           value: value,
+          type: 'metric'
         } | rest,
         severity: severity
       )

data/lib/betterlog/version.rb

@@ -1,6 +1,6 @@
 module Betterlog
   # Betterlog version
-  VERSION         = '0.8.0'
+  VERSION         = '0.8.1'
   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,11 +140,12 @@ describe Betterlog::Log do
 
     it 'can be sent after measuring times' do
       expected_event = Log::Event.new(
-        message: 'a metric foo of type duration',
-        name:    'foo',
-        type:      'duration',
+        message:   'a metric foo=10.0',
+        name:      'foo',
         value:     10.0,
-        timestamp: "2011-11-11T10:11:21.000Z"
+        timestamp: "2011-11-11T10:11:21.000Z",
+        type:      'metric',
+        severity:  'info'
       )
       expect(instance).to receive(:emit).with(expected_event)
       Log.measure(name: 'foo') do
@@ -160,13 +161,14 @@ describe Betterlog::Log do
 
     it 'adds exception information if block raises' do
       expected_event = Log::Event.new(
-        name:      'foo',
-        type:        'duration',
+        name:       'foo',
         value:       3.0,
         timestamp:   "2011-11-11T10:11:14.000Z",
         message:     '"MyEx: we were fucked" while measuring metric foo',
         error_class: 'MyEx',
-        backtrace:   %w[ backtrace ]
+        backtrace:   %w[ backtrace ],
+        type:        'metric',
+        severity:    'info'
       )
       expect(instance).to receive(:emit).with(expected_event)
       raised = false
@@ -184,39 +186,41 @@ describe Betterlog::Log do
   end
 
   describe '#metric' do
-    it 'logs metrics with a specific structure on debug log level' do
+    it 'logs metrics with a specific structure on info log level' do
       expected_event = Log::Event.new(
-        message: 'a metric controller.action of type ms',
-        name: 'controller.action',
-        type: 'ms',
-        value: 0.123,
+        message:  'a metric controller.action=0.123',
+        name:     'controller.action',
+        value:    0.123,
+        type:     'metric',
+        severity: 'info'
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.metric(name: 'controller.action', type: 'ms', value: 0.123)
+      Log.metric(name: 'controller.action', 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',
-        name: 'controller.action',
-        type:   'ms',
-        value:  0.123,
+        message:  'a metric controller.action=0.123',
+        name:     'controller.action',
+        value:    0.123,
+        type:     'metric',
         severity: :info,
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.metric(severity: :info, name: 'controller.action', type: 'ms', value: 0.123)
+      Log.metric(severity: :info, name: 'controller.action', 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',
-        name: 'controller.action',
-        type: 'ms',
-        value: 0.123,
+        message:  'a metric controller.action=0.123',
+        foo:      'bar',
+        name:     'controller.action',
+        value:    0.123,
+        type:     'metric',
+        severity: 'info'
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.metric(name: 'controller.action', type: 'ms', value: 0.123, foo: 'bar')
+      Log.metric(name: 'controller.action', value: 0.123, foo: 'bar')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: betterlog
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - betterplace Developers