betterlog 0.13.1 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29fe6dd6fca5b0294e9f55388615d6d8b58885a2f1898682525d19f239bd4552
-  data.tar.gz: f5495f46f7a6473edbe7a1e4973f9ac021213eb121dd149f5b50d23d191ab9dc
+  metadata.gz: 27e6af480e7ec65272867c76176a644ce2c925e853aff060074840f17ad5d714
+  data.tar.gz: 0531306c3a7b421691b67e78be5d7e960c91cb421e4e2db22657cdbe2cc248e0
 SHA512:
-  metadata.gz: 1345db77124853df14e65a3bfb5680b7936de5711cc0f21449d172822e8f44981a500b03cc29a072781039e4692cfc544e63387d817fa1eb65c4ea55995d83c3
-  data.tar.gz: f63ed3284d529d6df4f76f3e885d1c52d6d7dbba024ee08c61fcce8e79e0b8f3e04c1a4d15c7c7de7f017568a3ffea0c0cdd9c4da7f649b38172317abf735a09
+  metadata.gz: '096483149f340b0cb1f8fc5253ad033e7ce7a4dc4abdd2c07c78beb464a8cd95538b956c4f82b45133d2287cfb767c754fdd1fd8079de780534ed9def9532267'
+  data.tar.gz: 610301cb7fc4b028816d78f5ce5f8330b5c04e291ff5099035af49ab3de85def2048455276767b0253f60bebc9d7dd1eb9fb3c3902414ae60e79bf4057ac054b

data/.semaphore/semaphore.yml

@@ -0,0 +1,63 @@
+version: v1.0
+name: Betterlog pipeline
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+
+blocks:
+  - name: Caching
+    task:
+      prologue:
+        commands:
+          - checkout
+      jobs:
+        - name: cache bundle
+          commands:
+            - sem-version ruby 2.7.2
+            - cache restore gems-$SEMAPHORE_GIT_BRANCH,gems-master
+            - bundle config set path 'vendor/bundle'
+            - bundle config jobs $(getconf _NPROCESSORS_ONLN)
+            - bundle install
+            - cache store gems-$SEMAPHORE_GIT_BRANCH vendor/bundle
+
+  - name: "Unit tests"
+    task:
+      env_vars:
+        - name: RAILS_ENV
+          value: test
+      prologue:
+        commands:
+          - checkout
+
+          # Setup ruby
+          - sem-version ruby 2.7.2
+
+          # Setup gems
+          - cache restore gems-$SEMAPHORE_GIT_BRANCH,gems-master
+          - bundle config set path 'vendor/bundle'
+          - bundle config jobs $(getconf _NPROCESSORS_ONLN)
+          - bundle install
+
+      jobs:
+        - name: RSpec Unit Tests
+          commands:
+            - bundle exec rake
+
+  - name: Building Docker Image
+    task:
+
+      secrets:
+        - name: GCP
+
+      prologue:
+        commands:
+          - gcloud auth activate-service-account --key-file=.secrets/gcp.json
+          - gcloud auth configure-docker -q eu.gcr.io
+          - checkout
+
+      jobs:
+        - name: Building and pushing
+          commands:
+            - make build
+            - test "$SEMAPHORE_GIT_BRANCH" = "master" && make push-latest

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.12.0 AS builder
+FROM alpine:3.12.3 AS builder
 
 # Update/Upgrade/Add packages for building
 
@@ -16,9 +16,9 @@ RUN make clobber
 
 RUN go get -u github.com/betterplace/go-init
 
-RUN make fetch all
+RUN make setup all
 
-FROM alpine:3.12.0 AS runner
+FROM alpine:3.12.3 AS runner
 
 # Update/Upgrade/Add packages
 

data/Makefile

@@ -18,7 +18,7 @@ betterlog-server: cmd/betterlog-server/main.go betterlog/*.go
 local: betterlog-server
 	REDIS_URL=$(REDIS_URL) ./betterlog-server
 
-fetch: fake-package
+setup: fake-package
 	go mod download
 
 fake-package:

data/Rakefile

@@ -30,6 +30,7 @@ GemHadar do
   development_dependency 'rake'
   development_dependency 'rspec'
   development_dependency 'simplecov'
+  development_dependency 'mock_redis'
 end
 
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.13.1
+0.15.2

data/betterlog.gemspec

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
-# stub: betterlog 0.13.1 ruby lib
+# stub: betterlog 0.15.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterlog".freeze
-  s.version = "0.13.1"
+  s.version = "0.15.2"
 
   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-07-20"
+  s.date = "2021-02-03"
   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]
   s.extra_rdoc_files = ["README.md".freeze, "lib/betterlog.rb".freeze, "lib/betterlog/global_metadata.rb".freeze, "lib/betterlog/log.rb".freeze, "lib/betterlog/log/event.rb".freeze, "lib/betterlog/log/event_formatter.rb".freeze, "lib/betterlog/log/severity.rb".freeze, "lib/betterlog/log_event_formatter.rb".freeze, "lib/betterlog/logger.rb".freeze, "lib/betterlog/notifiers.rb".freeze, "lib/betterlog/railtie.rb".freeze, "lib/betterlog/version.rb".freeze]
-  s.files = [".gitignore".freeze, ".travis.yml".freeze, "Dockerfile".freeze, "Gemfile".freeze, "LICENSE".freeze, "Makefile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "betterlog.gemspec".freeze, "betterlog/config.go".freeze, "betterlog/healthz.go".freeze, "betterlog/redis_cert_cache.go".freeze, "bin/betterlog".freeze, "bin/betterlog_pusher".freeze, "bin/betterlog_sink".freeze, "cloudbuild.yaml".freeze, "cmd/betterlog-server/LICENSE".freeze, "cmd/betterlog-server/main.go".freeze, "config/log.yml".freeze, "go.mod".freeze, "go.sum".freeze, "lib/betterlog.rb".freeze, "lib/betterlog/global_metadata.rb".freeze, "lib/betterlog/log.rb".freeze, "lib/betterlog/log/event.rb".freeze, "lib/betterlog/log/event_formatter.rb".freeze, "lib/betterlog/log/severity.rb".freeze, "lib/betterlog/log_event_formatter.rb".freeze, "lib/betterlog/logger.rb".freeze, "lib/betterlog/notifiers.rb".freeze, "lib/betterlog/railtie.rb".freeze, "lib/betterlog/version.rb".freeze, "spec/betterlog/global_metadata_spec.rb".freeze, "spec/betterlog/log/event_spec.rb".freeze, "spec/betterlog/log/severity_spec.rb".freeze, "spec/betterlog/log_spec.rb".freeze, "spec/betterlog/logger_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.files = [".gitignore".freeze, ".semaphore/semaphore.yml".freeze, "Dockerfile".freeze, "Gemfile".freeze, "LICENSE".freeze, "Makefile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "betterlog.gemspec".freeze, "betterlog/config.go".freeze, "betterlog/healthz.go".freeze, "betterlog/redis_cert_cache.go".freeze, "bin/betterlog".freeze, "bin/betterlog_pusher".freeze, "bin/betterlog_sink".freeze, "cloudbuild.yaml".freeze, "cmd/betterlog-server/LICENSE".freeze, "cmd/betterlog-server/main.go".freeze, "config/log.yml".freeze, "go.mod".freeze, "go.sum".freeze, "lib/betterlog.rb".freeze, "lib/betterlog/global_metadata.rb".freeze, "lib/betterlog/log.rb".freeze, "lib/betterlog/log/event.rb".freeze, "lib/betterlog/log/event_formatter.rb".freeze, "lib/betterlog/log/severity.rb".freeze, "lib/betterlog/log_event_formatter.rb".freeze, "lib/betterlog/logger.rb".freeze, "lib/betterlog/notifiers.rb".freeze, "lib/betterlog/railtie.rb".freeze, "lib/betterlog/version.rb".freeze, "spec/betterlog/global_metadata_spec.rb".freeze, "spec/betterlog/log/event_spec.rb".freeze, "spec/betterlog/log/severity_spec.rb".freeze, "spec/betterlog/log_spec.rb".freeze, "spec/betterlog/logger_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "http://github.com/betterplace/betterlog".freeze
   s.rdoc_options = ["--title".freeze, "Betterlog".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.1.2".freeze
+  s.rubygems_version = "3.2.5".freeze
   s.summary = "Structured logging support for bp".freeze
   s.test_files = ["spec/betterlog/global_metadata_spec.rb".freeze, "spec/betterlog/log/event_spec.rb".freeze, "spec/betterlog/log/severity_spec.rb".freeze, "spec/betterlog/log_spec.rb".freeze, "spec/betterlog/logger_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<rake>.freeze, [">= 0"])
     s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
     s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_development_dependency(%q<mock_redis>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.3", ">= 1.22.0"])
     s.add_runtime_dependency(%q<complex_config>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<file-tail>.freeze, ["~> 1.0"])
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rake>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])
     s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<mock_redis>.freeze, [">= 0"])
     s.add_dependency(%q<tins>.freeze, ["~> 1.3", ">= 1.22.0"])
     s.add_dependency(%q<complex_config>.freeze, [">= 0"])
     s.add_dependency(%q<file-tail>.freeze, ["~> 1.0"])

data/bin/betterlog

@@ -96,10 +96,10 @@ module Betterlog
       return true unless @opts[?s]
       @opts[?s].all? do |param|
         case param
-        when /:\?\z/
-          event[$`].present?
-        when /:([^:]+)\z/
-          event[$`].full?(:include?, $1)
+        when /\A([^:]+):([^=]+)=(.+)\z/
+          event[$1]&.[]($2.to_sym)&.include?($3)
+        when /\A([^=]+)=(.+)\z/
+          event[$1]&.include?($2)
         when String
           event.to_json.include?(@opts[?s])
         else

data/lib/betterlog.rb

@@ -1,8 +1,6 @@
 require 'tins/xt'
 require 'json'
-require 'logger'
-require 'time'
-require 'term/ansicolor'
+require 'complex_config'
 
 module Betterlog
 end
@@ -13,7 +11,6 @@ require 'betterlog/global_metadata'
 require 'betterlog/logger'
 
 if defined? Rails
-  require 'betterlog/log_event_formatter'
   require 'betterlog/railtie'
 end
 

data/lib/betterlog/log.rb

@@ -7,12 +7,16 @@ require 'betterlog/log/severity'
 module Betterlog
   class Log
     include Tins::SexySingleton
+    extend ComplexConfig::Provider::Shortcuts
 
     class_attr_accessor :default_logger
     self.default_logger = Logger.new(STDERR)
+    if level = cc.log?&.level?
+      default_logger.level = level
+    end
 
     def logger
-      defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : ::Logger.new(STDERR)
+      defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : self.class.default_logger
     end
 
     # Logs a message on severity info.
@@ -134,7 +138,7 @@ module Betterlog
       end
       event[:emitter] = self.class.name.downcase
       notify(event)
-      logger.send(event.severity.to_sym, event.to_json)
+      logger.send(event.severity.to_sym, JSON.generate(event))
       self
     ensure
       GlobalMetadata.data.clear

data/lib/betterlog/log/event.rb

@@ -75,7 +75,15 @@ module Betterlog
       end
 
       def to_json(*a)
-        as_json.to_json(*a)
+        JSON.generate(as_json)
+      rescue
+        # Sometimes rails logging messages contain invalid utf-8 characters
+        # generating various standard errors. Let's fallback to a barebones
+        # event with just a cleaned up message for these cases.
+        JSON.generate({
+          severity: @data[:severity],
+          message: @data.fetch(:message, '').encode('utf-8', invalid: :replace, undef: :replace, replace: ''),
+        })
       end
 
       def format(*args)

data/lib/betterlog/log/event_formatter.rb

@@ -1,7 +1,11 @@
+require 'time'
+require 'term/ansicolor'
+
 module Betterlog
   class Log
     class EventFormatter
       include Term::ANSIColor
+      include ComplexConfig::Provider::Shortcuts
 
       def initialize(event)
         @event = event
@@ -14,7 +18,7 @@ module Betterlog
         when :format
           format_pattern(format: format)
         else
-          @event.to_json
+          JSON.generate(@event)
         end
       ensure
         Term::ANSIColor.coloring = old_coloring

data/lib/betterlog/log/severity.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module Betterlog
   class Log
     class Severity

data/lib/betterlog/log_event_formatter.rb

@@ -1,6 +1,7 @@
 module Betterlog
   class LogEventFormatter < ActiveSupport::Logger::Formatter
     include ActiveSupport::TaggedLogging::Formatter
+    include ComplexConfig::Provider::Shortcuts
 
     def emitter
       'legacy'
@@ -35,7 +36,7 @@ module Betterlog
             event[:location] = [ l.absolute_path, l.lineno ] * ?:
           end
           program and event[:program] = program
-          message = event.to_json
+          message = JSON.generate(event)
         end
       end
     rescue => e

data/lib/betterlog/logger.rb

@@ -1,10 +1,20 @@
-require 'redis'
+begin
+  require 'redis' unless defined?(Redis)
+rescue LoadError
+end
+require 'logger'
 
 module Betterlog
   class Logger < ::Logger
+    include ComplexConfig::Provider::Shortcuts
+
     def initialize(redis, shift_age = 0, shift_size = 1048576, name: nil, buffer_size: nil, **opts)
       @redis       = redis
       @fallback    = ::Logger.new(STDERR)
+      if level = cc.log.level?
+        self.level      = level
+        @fallback.level = level
+      end
       @name        = name || self.class.name
       @buffer_size = determine_buffer_size(buffer_size)
       super(nil, shift_age, shift_size, **opts)
@@ -92,7 +102,9 @@ module Betterlog
         s = 0
         e = @redis.strlen(name_tmp) - 1
         until s > e
-          y.yield @redis.getrange(name_tmp, s, s + chunk_size - 1)
+          range = @redis.getrange(name_tmp, s, s + chunk_size - 1)
+          range.force_encoding 'ASCII-8BIT'
+          y.yield range
           s += chunk_size
         end
 
@@ -115,9 +127,10 @@ module Betterlog
       chunk_size > 0 or raise ArgumentError, 'chunk_size > 0 required'
       Enumerator.new do |y|
         buffer = ''
+        buffer.encode! 'ASCII-8BIT'
         each_chunk(chunk_size: chunk_size) do |chunk|
           buffer << chunk
-          buffer.gsub!(/\A(.*?#$/)/) do |line|
+          buffer.gsub!(/\A(.*?#$/)/n) do |line|
             y.yield(line)
             ''
           end

data/lib/betterlog/railtie.rb

@@ -1,6 +1,7 @@
 module Betterlog
   class Railtie < Rails::Railtie
     initializer "betterlog_railtie.configure_rails_initialization" do
+      require 'betterlog/log_event_formatter'
       Rails.logger.formatter = Betterlog::LogEventFormatter.new
     end
   end

data/lib/betterlog/version.rb

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

@@ -26,6 +26,17 @@ describe Betterlog::Log do
     end
   end
 
+  describe 'Log::Event.to_json' do
+    it 'can be called' do
+      expect(event.to_json).to be_present
+    end
+
+    it 'can handle invalid UTF-8 characters' do
+      event = Log::Event.ify("foo\xCEbar")
+      expect(event.to_json).to eq(JSON(severity: "DEBUG", message: 'foobar'))
+    end
+  end
+
   describe '.parse' do
     it 'can parse an event as a JSON document' do
       expect(Log::Event.parse(event.to_json)).to eq event

data/spec/spec_helper.rb

@@ -9,5 +9,11 @@ begin
   require 'byebug'
 rescue LoadError
 end
+require 'mock_redis'
+class MockRedis
+  class BaseConnectionError < StandardError; end
+  class CannotConnectError < BaseConnectionError; end
+end
+Redis=MockRedis
 require 'betterlog'
 Betterlog::Log.default_logger = Logger.new(nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterlog
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.2
 platform: ruby
 authors:
 - betterplace Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +220,7 @@ extra_rdoc_files:
 - lib/betterlog/version.rb
 files:
 - ".gitignore"
-- ".travis.yml"
+- ".semaphore/semaphore.yml"
 - Dockerfile
 - Gemfile
 - LICENSE
@@ -267,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.5
 signing_key:
 specification_version: 4
 summary: Structured logging support for bp

data/.travis.yml

@@ -1,6 +0,0 @@
-rvm:
-  - 2.6
-  - 2.7
-sudo: false
-services:
-  - redis-server