betterlog 0.1.0 → 0.2.0

data/spec/betterlog/log_spec.rb

@@ -0,0 +1,221 @@
+require 'spec_helper'
+
+describe Betterlog::Log do
+  around do |example|
+    Time.dummy '2011-11-11 11:11:11+01:00' do
+      example.run
+    end
+  end
+
+  let :instance do
+    described_class.instance
+  end
+
+  let :event do
+    Log::Event.ify('hello')
+  end
+
+  describe 'Log::Event.ify' do
+    it 'can eventify a string' do
+      expect(event).to be_a Log::Event
+    end
+
+    it 'can eventify a hash' do
+      event = Log::Event.ify(message: 'hallo')
+      expect(event).to be_a Log::Event
+    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
+    end
+  end
+
+  describe "#[severity]" do
+    it 'logs freetext, unstructured messages to Rails.logger on used log level' do
+      for severity in %i[ debug error fatal info warn ] do
+        log_event = Log::Event.new(
+          message: 'some freetext message',
+          severity: severity
+        )
+        expect(instance).to receive(:emit).with(log_event)
+        Log.instance.send(severity, 'some freetext message')
+      end
+    end
+  end
+
+  describe '#output' do
+    it 'logs freetext, unstructured messages to Rails.logger on given log level' do
+      log_event = Log::Event.new(
+        message: 'some freetext message',
+        severity: :warn
+      )
+      expect(instance).to receive(:emit).with(log_event)
+      Log.output('some freetext message', severity: :warn)
+    end
+  end
+
+  describe '#info with internal logging error' do
+    it 'should not crash ever, just log the problem to Rails.logger' do
+      expect_any_instance_of(instance.logger.class).to receive(:fatal).and_call_original
+      expect(Log.info(BasicObject.new)).to eq Log.instance
+    end
+  end
+
+  describe '#notify?' do
+    let :notifier do
+      Class.new do
+        def notify(message, hash) end
+      end.new
+    end
+
+    around do |example|
+      Betterlog::Notifiers.register(notifier)
+      example.run
+    ensure
+      Betterlog::Notifiers.notifiers.clear
+    end
+
+    it 'can send explicit notifications' do
+      expect(notifier).to receive(:notify).with(
+        'test',
+        hash_including(message: 'test')
+      )
+      Log.info('test', notify: true)
+    end
+
+    it 'can send explicit notifications with additional hash values' do
+      expect(notifier).to receive(:notify).with(
+        'test',
+        hash_including(message: 'test', foo: 'bar')
+      )
+      Log.info({ message: 'test', foo: 'bar' }, notify: true)
+    end
+
+    it 'can send explicit notifications for exceptions' do
+      e = raise "foo" rescue $!
+      expect(notifier).to receive(:notify).with(
+        'RuntimeError: foo',
+        hash_including(
+          error_class: 'RuntimeError'
+        )
+      )
+      Log.info(e, notify: true)
+    end
+  end
+
+  describe '#output exceptions' do
+    it 'logs ruby standard errors' do
+      exception = ArgumentError.new('unknown keyword: xyz')
+      exception.set_backtrace(Thread.current.backtrace)
+      expected_event = Log::Event.new(
+        error_class: exception.class.name,
+        message:     "#{exception.class.name}: #{exception.message}",
+        backtrace:   exception.backtrace,
+      )
+      expect(instance).to receive(:emit).with(expected_event)
+      Log.output(exception)
+    end
+
+    it 'logs a ruby exception with additional data' do
+      exception = ArgumentError.new('unknown keyword: xyz')
+      exception.set_backtrace(Thread.current.backtrace)
+      expected_event = Log::Event.new(
+        foo:         'bar',
+        error_class: exception.class.name,
+        message:     "#{exception.class.name}: #{exception.message}",
+        backtrace:   exception.backtrace,
+        severity:    :error,
+      )
+      expect(instance).to receive(:emit).with(expected_event)
+      Log.error(exception, foo: 'bar')
+    end
+  end
+
+  describe '#measure' do
+    after do
+      Time.dummy = nil
+    end
+
+    it 'can be sent after measuring times' do
+      expected_event = Log::Event.new(
+        message: 'a metric foo of type seconds',
+        metric:    'foo',
+        type:      'seconds',
+        value:     10.0,
+        timestamp: "2011-11-11T10:11:21.000Z"
+      )
+      expect(instance).to receive(:emit).with(expected_event)
+      Log.measure(metric: 'foo') do
+        Time.dummy = Time.now + 10
+      end
+    end
+
+    class MyEx < StandardError
+      def backtrace
+        []
+      end
+    end
+
+    it 'adds exception information if block raises' do
+      expected_event = Log::Event.new(
+        metric:      'foo',
+        type:        'seconds',
+        value:       10.0,
+        timestamp:   "2011-11-11T10:11:21.000Z",
+        message:     'MyEx: we were fucked while measuring metric foo',
+        error_class: 'MyEx',
+        backtrace:   [],
+      )
+      expect(instance).to receive(:emit).with(expected_event)
+      raised = false
+      begin
+        Log.measure(metric: 'foo') do
+          Time.dummy = Time.now + 10
+          raise MyEx, "we were fucked"
+        end
+      rescue MyEx
+        raised = true
+      end
+      expect(raised).to eq true
+    end
+  end
+
+  describe '#metric' 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',
+        type: 'ms',
+        value: 0.123,
+      )
+      expect(instance).to receive(:emit).with(expected_event)
+      Log.metric(metric: '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',
+        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)
+    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',
+        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')
+    end
+  end
+end

data/spec/betterlog/logger_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Betterlog::Logger do
+  let :logger do
+    described_class.new(Redis.new)
+  end
+
+  describe '#<<' do
+    it 'writes to redis' do
+      expect(logger.instance_variable_get(:@redis)).to receive(:append).
+        with('Betterlog::Logger', 'foo')
+      logger << 'foo'
+    end
+  end
+
+  describe '#add' do
+    it 'writes to redis' do
+      expect(logger.instance_variable_get(:@redis)).to receive(:append).
+        with('Betterlog::Logger', /INFO -- : foo/)
+      logger.info 'foo'
+    end
+  end
+
+  describe '#each_chunk' do
+    it 'iterates over chunks of data' do
+      logger.clear
+      logger << "foo" * 23
+      expect(logger.each_chunk(chunk_size: 10).to_a).to eq %w[
+        foofoofoof
+        oofoofoofo
+        ofoofoofoo
+        foofoofoof
+        oofoofoofo
+        ofoofoofoo
+        foofoofoo
+      ]
+    end
+
+    it 'works if no data is there' do
+      logger.clear
+      expect(logger.each_chunk(chunk_size: 1).to_a).to eq []
+    end
+
+    it 'iterates if chunk_size is 1 and 23' do
+      logger.clear
+      logger << ?. * 23
+      expect(logger.each_chunk(chunk_size: 1).to_a).to eq [ ?. ] * 23
+    end
+
+    it 'iterates if chunk_size is 1 and 22' do
+      logger.clear
+      logger << ?. * 22
+      expect(logger.each_chunk(chunk_size: 1).to_a).to eq [ ?. ] * 22
+    end
+  end
+
+  describe '#each' do
+    it 'iterates over log lines' do
+      logger.clear
+      logger << "foo\n"
+      logger << "bar\n"
+      expect(logger.to_a).to eq [ "foo\n", "bar\n" ]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+if ENV['START_SIMPLECOV'].to_i == 1
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "#{File.basename(File.dirname(__FILE__))}/"
+  end
+end
+require 'rspec'
+begin
+  require 'byebug'
+rescue LoadError
+end
+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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -39,45 +39,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tins
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.5
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
+        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
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
+        version: '1.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: complex_config
   requirement: !ruby/object:Gem::Requirement
@@ -134,44 +142,86 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This library provides structure json logging for our rails projects
 email: developers@betterplace.org
 executables:
 - betterlog
+- betterlog_pusher
 extensions: []
 extra_rdoc_files:
 - README.md
-- lib/betterdocs/version.rb
 - lib/betterlog.rb
-- lib/betterlog/betterlog_railtie.rb
 - lib/betterlog/global_metadata.rb
 - lib/betterlog/log.rb
 - lib/betterlog/log/event.rb
 - lib/betterlog/log/event_formatter.rb
 - lib/betterlog/log/severity.rb
 - lib/betterlog/log_event_formatter.rb
+- lib/betterlog/logger.rb
+- lib/betterlog/notifiers.rb
+- lib/betterlog/railtie.rb
 - lib/betterlog/version.rb
 files:
 - ".gitignore"
+- ".travis.yml"
+- Dockerfile
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
+- TODO.md
 - VERSION
-- betterdocs.gemspec
 - betterlog.gemspec
+- betterlog/healthz.go
 - bin/betterlog
-- lib/betterdocs/version.rb
+- bin/betterlog_pusher
+- cmd/betterlog-server/LICENSE
+- cmd/betterlog-server/main.go
+- config/log.yml
 - lib/betterlog.rb
-- lib/betterlog/betterlog_railtie.rb
 - lib/betterlog/global_metadata.rb
 - lib/betterlog/log.rb
 - lib/betterlog/log/event.rb
 - lib/betterlog/log/event_formatter.rb
 - lib/betterlog/log/severity.rb
 - lib/betterlog/log_event_formatter.rb
+- lib/betterlog/logger.rb
+- lib/betterlog/notifiers.rb
+- lib/betterlog/railtie.rb
 - lib/betterlog/version.rb
-- log.yml
+- spec/betterlog/global_metadata_spec.rb
+- spec/betterlog/log_spec.rb
+- spec/betterlog/logger_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/betterplace/betterlog
 licenses: []
 metadata: {}
@@ -194,8 +244,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Structured logging support for bp
-test_files: []
+test_files:
+- spec/betterlog/global_metadata_spec.rb
+- spec/betterlog/log_spec.rb
+- spec/betterlog/logger_spec.rb
+- spec/spec_helper.rb

data/betterdocs.gemspec

@@ -1,53 +0,0 @@
-# -*- encoding: utf-8 -*-
-# stub: betterdocs 0.0.1 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "betterdocs".freeze
-  s.version = "0.0.1"
-
-  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 = "2018-12-05"
-  s.description = "This library provides structure json logging for our rails projects".freeze
-  s.email = "developers@betterplace.org".freeze
-  s.extra_rdoc_files = ["README.md".freeze, "lib/betterlog.rb".freeze, "lib/betterlog/event.rb".freeze, "lib/betterlog/event_formatter.rb".freeze, "lib/betterlog/log.rb".freeze, "lib/betterlog/log_event_formatter.rb".freeze, "lib/betterlog/severity.rb".freeze]
-  s.files = ["README.md".freeze, "lib/betterlog.rb".freeze, "lib/betterlog/event.rb".freeze, "lib/betterlog/event_formatter.rb".freeze, "lib/betterlog/log.rb".freeze, "lib/betterlog/log_event_formatter.rb".freeze, "lib/betterlog/severity.rb".freeze]
-  s.homepage = "http://github.com/betterplace/betterdocs".freeze
-  s.rdoc_options = ["--title".freeze, "Betterdocs".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "2.7.6".freeze
-  s.summary = "Structured logging support for bp".freeze
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-      s.add_development_dependency(%q<rake>.freeze, [">= 0"])
-      s.add_runtime_dependency(%q<tins>.freeze, [">= 1.3.5", "~> 1.3"])
-      s.add_runtime_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
-      s.add_runtime_dependency(%q<complex_config>.freeze, [">= 0"])
-      s.add_runtime_dependency(%q<file-tail>.freeze, ["~> 1.0"])
-      s.add_runtime_dependency(%q<json>.freeze, ["~> 2.0"])
-      s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
-    else
-      s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-      s.add_dependency(%q<rake>.freeze, [">= 0"])
-      s.add_dependency(%q<tins>.freeze, [">= 1.3.5", "~> 1.3"])
-      s.add_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
-      s.add_dependency(%q<complex_config>.freeze, [">= 0"])
-      s.add_dependency(%q<file-tail>.freeze, ["~> 1.0"])
-      s.add_dependency(%q<json>.freeze, ["~> 2.0"])
-      s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
-    end
-  else
-    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-    s.add_dependency(%q<rake>.freeze, [">= 0"])
-    s.add_dependency(%q<tins>.freeze, [">= 1.3.5", "~> 1.3"])
-    s.add_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
-    s.add_dependency(%q<complex_config>.freeze, [">= 0"])
-    s.add_dependency(%q<file-tail>.freeze, ["~> 1.0"])
-    s.add_dependency(%q<json>.freeze, ["~> 2.0"])
-    s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
-  end
-end

data/lib/betterdocs/version.rb

@@ -1,8 +0,0 @@
-module Betterdocs
-  # Betterdocs version
-  VERSION         = '0.0.1'
-  VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
-  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
-  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
-  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
-end

data/lib/betterlog/betterlog_railtie.rb

@@ -1,5 +0,0 @@
-class BetterlogRailtie < Rails::Railtie
-  initializer "betterlog_railtie.configure_rails_initialization" do
-    Rails.logger.formatter = LogEventFormatter.new
-  end
-end