betterlog 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dade612b41a387e538c98ef623a79fdb483d4e230daed8d154cad2fa64465235
-  data.tar.gz: ac0ada91ced10e9d1cf64f4dfaecef4a7e9c24b63715fe7e7ddca231044646ed
+  metadata.gz: 93ac0b92fff87f8005af14b59044b35a17981c2fd30ca1a3614d52967cf711b8
+  data.tar.gz: 22756efdebaa24185c28ffa2ba76cec177e83177f94b874d4bac13c3d8d87ac5
 SHA512:
-  metadata.gz: 1b896f2288f53dedad255dccc578c072052fa6db07f6dfb2093db32ca8b38cfc1464ce5f26b2d94b4e8cf40b25889f1759920974cc0be6890f9cba026e8b83f9
-  data.tar.gz: 8dd4191451947ed9c9be2ff04ad2877b5902685599c1db9e32a25797a7393b5c9a49141565afa1216e2348fa90addab371664151cf01a973f9c8dc7a80f8628d
+  metadata.gz: f4f4313920141cf7b4549da03362eb1ac585a8ac6f8d6bd80bc95cbff178797f507267ae9c9b56ab2423271c0a69dc5e9c3f0cb4c8454c7ff6824530ede26c8d
+  data.tar.gz: 2626a52f7915d4a2699cfcbde0425a736e5c41d1fefb03e13adefaa44961f1f118ac44921f37f34fe9adb7a65b3ee03b145d3cb331e9ca7ac4e6909ca1a45097

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.11.0

data/betterlog.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: betterlog 0.10.0 ruby lib
+# stub: betterlog 0.11.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterlog".freeze
-  s.version = "0.10.0"
+  s.version = "0.11.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 = "2020-01-22"
+  s.date = "2020-04-02"
   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/bin/betterlog

@@ -27,12 +27,12 @@ module Betterlog
           -h            to display this help
           -p FORMAT     to pretty print the log file if possible
           -e EMITTER    only output events from these emitters
-          -s MATCH      only display events matching this search string
+          -s MATCH      only display events matching this search string (can be repeated)
           -S SEVERITY   only output events with severity, e. g. -S '>=warn'
           -n NUMBER     rewind this many lines backwards before tailing log file
           -F SHORTCUT   to open the config files with SHORTCUT
 
-        FORMAT values are: #{Array(cc.log.formats?&.attribute_names) * ?,}
+        FORMAT values are: #{(Array(cc.log.formats?&.attribute_names) + %w[j json]) * ?,}
 
         SEVERITY values are: #{Log::Severity.all * ?|}
 
@@ -93,15 +93,18 @@ module Betterlog
     end
 
     def search_matched?(event)
-      case @opts[?s]
-      when /:\?\z/
-        event[$`].present?
-      when /:([^:]+)\z/
-        event[$`].full?(:include?, $1)
-      when String
-        event.to_json.include?(@opts[?s])
-      else
-        return true
+      return true unless @opts[?s]
+      @opts[?s].all? do |param|
+        case param
+        when /:\?\z/
+          event[$`].present?
+        when /:([^:]+)\z/
+          event[$`].full?(:include?, $1)
+        when String
+          event.to_json.include?(@opts[?s])
+        else
+          return true
+        end
       end
     end
 
@@ -109,7 +112,10 @@ module Betterlog
       return unless @severities.include?(event.severity)
       return if emitters.full? && !emitters.include?(event.emitter)
       search_matched?(event) or return
-      if format = @opts[?p]
+      format = @opts[?p]&.to_sym
+      if format == :json || format == :j
+        puts event.format(pretty: false, color: @opts[?c])
+      elsif format
         puts event.format(pretty: :format, color: @opts[?c], format: format)
       else
         puts "#{prefix}#{event}"

data/cloudbuild.yaml

@@ -1,7 +1,7 @@
 steps:
-- name: gcr.io/cloud-builders/docker
+- name: eu.gcr.io/betterplace-183212/better-builder
   args: ['pull', '${_BASE_IMAGE}']
-- name: gcr.io/cloud-builders/docker
+- name: eu.gcr.io/betterplace-183212/better-builder
   args: ['build', '-t', 'eu.gcr.io/$PROJECT_ID/${_IMAGE_NAME}:$SHORT_SHA', '-t', 'eu.gcr.io/$PROJECT_ID/${_IMAGE_NAME}', '--build-arg=BASE_IMAGE=${_BASE_IMAGE}', '.']
 images:
   - 'eu.gcr.io/$PROJECT_ID/${_IMAGE_NAME}:$SHORT_SHA'

data/go.mod

@@ -1,12 +1,13 @@
 module github.com/betterplace/betterlog
 
-go 1.13
+go 1.14
 
 require (
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible // indirect
-	github.com/go-redis/redis v6.15.5+incompatible
+	github.com/go-redis/redis v6.15.7+incompatible
 	github.com/kelseyhightower/envconfig v1.4.0 // indirect
 	github.com/labstack/echo v3.3.10+incompatible
 	github.com/labstack/gommon v0.3.0 // indirect
-	golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392
+	github.com/valyala/fasttemplate v1.1.0 // indirect
+	golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59
 )

data/go.sum

@@ -1,10 +1,12 @@
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dgrijalva/jwt-go v1.0.2 h1:KPldsxuKGsS2FPWsNeg9ZO18aCrGKujPoWXn2yo+KQM=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
-github.com/go-redis/redis v6.15.5+incompatible h1:pLky8I0rgiblWfa8C1EV7fPEUv0aH6vKRaYHc/YRHVk=
-github.com/go-redis/redis v6.15.5+incompatible/go.mod h1:NAIEuMOZ/fxfXJIrKDQDz8wamY7mA7PouImQ2Jvg6kA=
+github.com/go-redis/redis v6.15.7+incompatible h1:3skhDh95XQMpnqeqNftPkQD9jL9e5e36z/1SUm6dy1U=
+github.com/go-redis/redis v6.15.7+incompatible/go.mod h1:NAIEuMOZ/fxfXJIrKDQDz8wamY7mA7PouImQ2Jvg6kA=
 github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8=
 github.com/kelseyhightower/envconfig v1.4.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg=
+github.com/labstack/echo v1.4.4 h1:1bEiBNeGSUKxcPDGfZ/7IgdhJJZx8wV/pICJh4W2NJI=
 github.com/labstack/echo v3.3.10+incompatible h1:pGRcYk231ExFAyoAjAfD85kQzRJCRI8bbnE7CX5OEgg=
 github.com/labstack/echo v3.3.10+incompatible/go.mod h1:0INS7j/VjnFxD4E2wkz67b8cVwCLbBmJyDaka6Cmk1s=
 github.com/labstack/gommon v0.3.0 h1:JEeO0bvc78PKdyHxloTKiF8BD5iGrH8T6MSeGvSgob0=
@@ -19,17 +21,18 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
 github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
-github.com/valyala/fasttemplate v1.0.1 h1:tY9CJiPnMXf1ERmG2EyK7gNUd+c6RKGD0IfU8WdUSz8=
 github.com/valyala/fasttemplate v1.0.1/go.mod h1:UQGH1tvbgY+Nz5t2n7tXsz52dQxojPUpymEIMZ47gx8=
+github.com/valyala/fasttemplate v1.1.0 h1:RZqt0yGBsps8NGvLSGW804QQqCUYYLsaOjTVHy1Ocw4=
+github.com/valyala/fasttemplate v1.1.0/go.mod h1:UQGH1tvbgY+Nz5t2n7tXsz52dQxojPUpymEIMZ47gx8=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392 h1:ACG4HJsFiNMf47Y4PeRoebLNy/2lXT9EtprMuTFWt1M=
-golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392/go.mod h1:/lpIB1dKB+9EgE3H3cr1v9wB50oz8l4C4h62xy7jSTY=
+golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59 h1:3zb4D3T4G8jdExgVU/95+vQXfpEPiMdCaZgmGVxjNHM=
+golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3 h1:0GoQqolDA55aaLxZyTzK/Y2ePZzZTUrRacwib7cNsYQ=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190813064441-fde4db37ae7a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20190922100055-0a153f010e69/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

data/lib/betterlog/log.rb

@@ -89,29 +89,11 @@ module Betterlog
     # evaluation.
     #
     # @param name the name of the recorded metric.
-    # @param value of the recorded metric.
+    # @param value of the recorded metric, defaults to duration if block was given.
     # @param **rest additional rest is logged as well.
     # @return [ Log ] this object itself.
-    def metric(name:, value:, **rest)
-      protect do
-        event = build_metric(name: name, value: value, **rest)
-        emit event
-      end
-    end
-
-    # Logs a time measure on severity debug, by default, this can be changed by
-    # passing the severity: keyword.
-    #
-    # If an error occurs during measurement details about it are added to the
-    # metric event.
-    #
-    # @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(name:, **rest, &block)
-      raise ArgumentError, 'must be called with a block' unless block_given?
-      time_block { yield }
+    def metric(name:, value: nil, **rest, &block)
+      time_block(&block)
     rescue => error
       e = Log::Event.ify(error)
       rest |= e.as_hash.subhash(:error_class, :backtrace, :message)
@@ -119,7 +101,14 @@ module Betterlog
       raise error
     ensure
       protect do
-        event = build_metric(name: name, value: timed_duration, **rest)
+        if timed_duration
+          rest[:duration] = timed_duration
+        end
+        event = build_metric(
+          name:     name,
+          value:    value || timed_duration,
+          **rest
+        )
         emit event
       end
     end
@@ -190,11 +179,12 @@ module Betterlog
 
     thread_local :timed_duration
 
-    def time_block
+    def time_block(&block)
+      block or return
       s = Time.now
-      yield
+      block.call
     ensure
-      self.timed_duration = Time.now - s
+      block and self.timed_duration = Time.now - s
     end
   end
 end

data/lib/betterlog/version.rb

@@ -1,6 +1,6 @@
 module Betterlog
   # Betterlog version
-  VERSION         = '0.10.0'
+  VERSION         = '0.11.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

@@ -137,22 +137,60 @@ describe Betterlog::Log do
     end
   end
 
-  describe '#measure' do
+  describe '#metric' do
     after do
       Time.dummy = nil
     end
 
+    it 'logs metrics with a specific structure on info log level' do
+      expected_event = Log::Event.new(
+        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', value: 0.123)
+    end
+
+    it 'logs metrics on a given log level' do
+      expected_event = Log::Event.new(
+        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', value: 0.123)
+    end
+
+    it 'logs metrics with additional data' do
+      expected_event = Log::Event.new(
+        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', value: 0.123, foo: 'bar')
+    end
+
     it 'can be sent after measuring times' do
       expected_event = Log::Event.new(
         message:   'a metric foo=10.0',
         name:      'foo',
         value:     10.0,
+        duration:  10.0,
         timestamp: "2011-11-11T10:11:21.000Z",
         type:      'metric',
         severity:  'info'
       )
       expect(instance).to receive(:emit).with(expected_event)
-      Log.measure(name: 'foo') do
+      Log.metric(name: 'foo') do
         Time.dummy = Time.now + 10
       end
     end
@@ -167,6 +205,7 @@ describe Betterlog::Log do
       expected_event = Log::Event.new(
         name:       'foo',
         value:       3.0,
+        duration:    3.0,
         timestamp:   "2011-11-11T10:11:14.000Z",
         message:     '"MyEx: we were fucked" while measuring metric foo',
         error_class: 'MyEx',
@@ -177,7 +216,7 @@ describe Betterlog::Log do
       expect(instance).to receive(:emit).with(expected_event)
       raised = false
       begin
-        Log.measure(name: 'foo') do
+        Log.metric(name: 'foo') do
           Time.dummy = Time.now + 3
           raise MyEx, "we were fucked"
           Time.dummy = Time.now + 7
@@ -187,44 +226,6 @@ describe Betterlog::Log do
       end
       expect(raised).to eq true
     end
-  end
-
-  describe '#metric' do
-    it 'logs metrics with a specific structure on info log level' do
-      expected_event = Log::Event.new(
-        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', value: 0.123)
-    end
-
-    it 'logs metrics on a given log level' do
-      expected_event = Log::Event.new(
-        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', value: 0.123)
-    end
 
-    it 'logs metrics with additional data' do
-      expected_event = Log::Event.new(
-        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', 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.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar