betterlog 0.14.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca69ec750626ef4b6a76e40dcfb19bc1a9334410ee60b2714c611afb21a804c6
-  data.tar.gz: 1ec3c97e0aac9f04452606c1af507c7102aac37033a8c371841435dcd152c6c7
+  metadata.gz: b4506f76d220e94df7933aa69c972215d14f74563f2fe87fa803223788fcfc8d
+  data.tar.gz: 98ca98c122cc33e647ebd3724df28eb02f151053f465f5014e86fec867f4cec5
 SHA512:
-  metadata.gz: aecbebf1fe2fdb3a9341ac6c0e9704bb8c20161ffb3c76fc11d2de386345a6f8d4d96cd103e97dc115e1b290d9f63144ae130984626e53d87b2b91feadf0b7f3
-  data.tar.gz: 01cab4c0d493f3b9ae5a884338121f1b758838709050e375c8d85a433bae129e9cb7d5c8ccd0664f8afa9a4fe99b3f8ad1513ee6b53f6853b745233cc18795ee
+  metadata.gz: 98516988066c8b36d09beca0b6d5bce79b65a146c0316ffdf4e01718e3c63fd2dab0f4690b933a144088845a5b1c36b8408cb9814eebed3c76e8768bc926ea77
+  data.tar.gz: 68e69a38f1389678e5e862c02b8e31e9d5863d4a47d2e343329372995fca4df442952d6302ed308ad41d9239f559b6473a74902f6f4ebf01f5014aa348ea92d4

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 -n "$SEMAPHORE_GIT_TAG_NAME" && make push-latest

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.12.0 AS builder
+FROM alpine:3.13.2 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.13.2 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.14.0
+0.18.0

data/betterlog.gemspec

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
-# stub: betterlog 0.14.0 ruby lib
+# stub: betterlog 0.18.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterlog".freeze
-  s.version = "0.14.0"
+  s.version = "0.18.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-07-30"
+  s.date = "2021-03-05"
   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.8".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,9 +1,6 @@
 require 'tins/xt'
 require 'json'
-require 'logger'
-require 'time'
 require 'complex_config'
-require 'term/ansicolor'
 
 module Betterlog
 end
@@ -14,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

@@ -11,7 +11,7 @@ module Betterlog
 
     class_attr_accessor :default_logger
     self.default_logger = Logger.new(STDERR)
-    if level = cc.log.level?
+    if level = cc.log?&.level?
       default_logger.level = level
     end
 
@@ -138,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,11 +75,19 @@ 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)
-        Log::EventFormatter.new(self).format(*args)
+      def format(**args)
+        Log::EventFormatter.new(self).format(**args)
       end
 
       alias to_s format

data/lib/betterlog/log/event_formatter.rb

@@ -1,3 +1,6 @@
+require 'time'
+require 'term/ansicolor'
+
 module Betterlog
   class Log
     class EventFormatter
@@ -15,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

@@ -36,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,4 +1,8 @@
-require 'redis'
+begin
+  require 'redis' unless defined?(Redis)
+rescue LoadError
+end
+require 'logger'
 
 module Betterlog
   class Logger < ::Logger

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.14.0'
+  VERSION         = '0.18.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

@@ -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.14.0
+  version: 0.18.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2021-03-05 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.8
 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