semlogr 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de0c524223dc5ae215d6ea1792a8431fe372622a
-  data.tar.gz: 35b4860c12da0efe181e71cc000b9f25148774b6
+  metadata.gz: bd4e69c32518a7128075aabc31c8ec3384dd4c8b
+  data.tar.gz: 1e264cb0025475bf2774b05d5484756f99585131
 SHA512:
-  metadata.gz: 2337de225c49f303b6edecfee4c765cd7b7524024b191ef2405278afff508246c2d6bd768bff09a84164c0aca0de578f591fb1aa077b84798a915c2d63735423
-  data.tar.gz: 97620d9df3c5755143e2089556181cd8e23a0ad1795ad66042f5df7cb664886a1ae7d6d55bb3cf360585e8f1a5115a421c6ab83b718a841e18140a84e80e981c
+  metadata.gz: e556941e43501f47c519d55eeed10f99317d7ec7ec804e9c537da9d82185a881ca4a0f8309f4856af63639eab3314f6606e142d4d4aeaf5155c1ed8b702a9090
+  data.tar.gz: 465b051b985524bd0d1c2012df6e0a52c982c0f93fd5c2d0e76cad325f0603ec372912ab8b0940ca552dc34efbec9662b6c1427c712e104731f221afea0b0d8f

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
+--require spec_helper
 --color

data/.rubocop.yml

@@ -3,19 +3,34 @@ AllCops:
 
 Documentation:
   Enabled: false
+OrderedGems:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
 
+# Do not use Rubocop to enforce complexity rules, these will me
+# managed via the PR prorcess to not let in clearly complex code.
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
 Metrics/AbcSize:
-  Max: 24
-Metrics/BlockLength:
-  ExcludedMethods: ['describe']
+  Enabled: false
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
 Metrics/LineLength:
-  Max: 120
-Metrics/MethodLength:
-  Max: 20
+  Enabled: false
 
 Style/EmptyMethod:
   EnforcedStyle: expanded
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+### 0.2.0
+
+* Introduce simpler logger configuration
+* Add ambient log property context
+* Add samples
+* Specs specs specs!
+* Fix coloring of exceptions with colored console sink
+
+### 0.1.3
+
+* Move to Oj for json serialization of log events
+
+### 0.1.2
+
+* Do not format backtrace as newline seperated string in json formatter
+* Change from configure to create_logger and don't implicitly set Semlogr.logger
+* Add null logger
+
+### 0.1.1
+
+* Various fixes
+
+### 0.1.0
+
+* Initial release

data/README.md

@@ -2,7 +2,7 @@
 
 # Semlogr
 
-Semlogr is a semantic logger for Ruby inspired by the amazing semantic logger for .NET [Serilog](http://serilog.net/).
+Semlogr is a semantic logger for Ruby inspired and primarily ported from the awesome semantic logger for .NET [Serilog](http://serilog.net/).
 
 ## Installation
 
@@ -20,31 +20,26 @@ then:
 
 ## Getting Started
 
-Create an instance of the logger configuring one or more sinks.
+Create an instance of the logger configuring one or more sinks. 
 
 ```ruby
 require "semlogr"
-require "semlogr/sinks/colored_console"
 
-logger = Semlogr::Logger.create do |c|
-  c.log_at(Semlogr::LogSeverity::INFO)
+Semlogr.logger = Semlogr.create_logger do |c|
+  c.log_at :info
 
-  c.write_to(Semlogr::Sinks::ColoredConsole.new)
+  c.write_to :colored_console
 end
 
-logger.info('Customer {customer_id} did something interesting', customer_id: 1234)
+Semlogr.info('Customer {customer_id} did something interesting', customer_id: 1234)
 ```
 
+More configuration examples can be found inside the samples directory.
+
 ## Development
 
 After cloning the repository run `bundle install` to get up and running, to run the specs just run `rake spec`. You can also experiment in an interactive pry console using `bin/console`.
 
-## Changes
-
-### 0.1.0
-
-  - Initial commit, long long way to go :)!
-
 ## Contributing
 
 See anything broken or something you would like to improve? feel free to submit an issue or better yet a pull request!

data/Rakefile

@@ -2,7 +2,17 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:spec, :rubocop]
+RSpec::Core::RakeTask.new('test:unit') do |c|
+  c.rspec_opts = '--fail-fast --pattern spec/unit/**{,/*/**}/*_spec.rb'
+end
+
+task 'test:performance' do
+  Dir['spec/performance/**/*.rb'].each do |file|
+    require_relative file
+  end
+end
+
+task test: %w[test:unit test:performance]
+task default: %w[rubocop test]

data/lib/semlogr/component_registry.rb

@@ -0,0 +1,18 @@
+require 'semlogr/error'
+
+module Semlogr
+  class ComponentRegistry
+    @mappings = {}
+
+    def self.register(type, mapping)
+      (@mappings[type] ||= {}).update(mapping)
+    end
+
+    def self.resolve(type, key, *params)
+      mapping = @mappings[type] && @mappings[type][key]
+      raise ComponentNotRegisteredError.new(type, key) unless mapping
+
+      mapping.new(*params)
+    end
+  end
+end

data/lib/semlogr/context/log_context.rb

@@ -0,0 +1,27 @@
+module Semlogr
+  module Context
+    class LogContext
+      def self.current
+        Thread.current[:semlogr_log_context] ||= []
+      end
+
+      def self.push_property(**properties)
+        LogContext.current << properties
+
+        yield if block_given?
+      ensure
+        LogContext.current.pop
+      end
+
+      def self.get_property(key)
+        LogContext.current
+          .reverse_each
+          .each do |properties|
+            return properties[key] if properties.key?(key)
+          end
+
+        nil
+      end
+    end
+  end
+end

data/lib/semlogr/enrichers/aggregate.rb

@@ -0,0 +1,15 @@
+module Semlogr
+  module Enrichers
+    class Aggregate
+      def initialize(enrichers)
+        @enrichers = enrichers
+      end
+
+      def enrich(log_event)
+        @enrichers.each do |enricher|
+          enricher.enrich(log_event)
+        end
+      end
+    end
+  end
+end

data/lib/semlogr/enrichers/host.rb

@@ -1,11 +1,14 @@
 require 'socket'
+require 'semlogr/component_registry'
 
 module Semlogr
   module Enrichers
     class Host
       def enrich(log_event)
-        log_event.add_property(host: Socket.gethostname)
+        log_event.add_property_if_absent(host: Socket.gethostname)
       end
     end
+
+    ComponentRegistry.register(:enricher, host: Host)
   end
 end

data/lib/semlogr/enrichers/log_context.rb

@@ -0,0 +1,16 @@
+require 'semlogr/context/log_context'
+
+module Semlogr
+  module Enrichers
+    class LogContext
+      def enrich(log_event)
+        Context::LogContext.current
+          .each do |properties|
+            log_event.add_property_if_absent(properties)
+          end
+      end
+    end
+
+    ComponentRegistry.register(:enricher, log_context: LogContext)
+  end
+end

data/lib/semlogr/enrichers/property.rb

@@ -1,3 +1,5 @@
+require 'semlogr/component_registry'
+
 module Semlogr
   module Enrichers
     class Property
@@ -6,8 +8,10 @@ module Semlogr
       end
 
       def enrich(log_event)
-        log_event.add_property(@properties)
+        log_event.add_property_if_absent(@properties)
       end
     end
+
+    ComponentRegistry.register(:enricher, property: Property)
   end
 end

data/lib/semlogr/enrichers/thread.rb

@@ -1,9 +1,13 @@
+require 'semlogr/component_registry'
+
 module Semlogr
   module Enrichers
     class Thread
       def enrich(log_event)
-        log_event.add_property(thread_id: ::Thread.current.object_id)
+        log_event.add_property_if_absent(thread_id: ::Thread.current.object_id)
       end
     end
+
+    ComponentRegistry.register(:enricher, thread: Thread)
   end
 end

data/lib/semlogr/error.rb

@@ -0,0 +1,10 @@
+module Semlogr
+  class Error < StandardError
+  end
+
+  class ComponentNotRegisteredError < Error
+    def initialize(type, key)
+      super(":#{key} is not a registered :#{type}")
+    end
+  end
+end

data/lib/semlogr/events/log_event.rb

@@ -1,3 +1,5 @@
+require 'semlogr/templates/parser'
+
 module Semlogr
   module Events
     class LogEvent
@@ -7,7 +9,7 @@ module Semlogr
       attr_reader :properties
       attr_reader :timestamp
 
-      def initialize(severity, template, error, properties)
+      def initialize(severity, template, error: nil, **properties)
         @timestamp = Time.now.utc
         @severity = severity
         @template = template
@@ -15,6 +17,12 @@ module Semlogr
         @properties = properties
       end
 
+      def self.create(severity, template, properties)
+        template = Templates::Parser.parse(template)
+
+        LogEvent.new(severity, template, properties)
+      end
+
       def get_property(name)
         @properties[name]
       end
@@ -23,6 +31,10 @@ module Semlogr
         @properties.merge!(properties)
       end
 
+      def add_property_if_absent(properties)
+        @properties.merge!(properties) { |_, old, _| old }
+      end
+
       def render(output)
         @template.render(output, @properties)
       end

data/lib/semlogr/log_severity.rb

@@ -9,6 +9,23 @@ module Semlogr
       @display_string = display_string
     end
 
+    def self.create(severity)
+      case severity
+      when :debug
+        LogSeverity::DEBUG
+      when :info
+        LogSeverity::INFO
+      when :warn
+        LogSeverity::WARN
+      when :error
+        LogSeverity::ERROR
+      when :fatal
+        LogSeverity::FATAL
+      else
+        LogSeverity::DEBUG
+      end
+    end
+
     def <=>(other)
       @value <=> other.value
     end
@@ -21,10 +38,10 @@ module Semlogr
       @display_string
     end
 
-    DEBUG = LogSeverity.new(::Logger::DEBUG, 'DEBUG')
-    INFO = LogSeverity.new(::Logger::INFO, 'INFO')
-    WARN = LogSeverity.new(::Logger::WARN, 'WARN')
-    ERROR = LogSeverity.new(::Logger::ERROR, 'ERROR')
-    FATAL = LogSeverity.new(::Logger::FATAL, 'FATAL')
+    DEBUG = LogSeverity.new(0, 'DEBUG')
+    INFO = LogSeverity.new(1, 'INFO')
+    WARN = LogSeverity.new(2, 'WARN')
+    ERROR = LogSeverity.new(3, 'ERROR')
+    FATAL = LogSeverity.new(4, 'FATAL')
   end
 end

data/lib/semlogr/logger.rb

@@ -1,17 +1,15 @@
-require 'logger'
 require 'semlogr/logger_configuration'
 require 'semlogr/log_severity'
 require 'semlogr/events/log_event'
-require 'semlogr/templates/parser'
 require 'semlogr/enrichers/property'
+require 'semlogr/enrichers/aggregate'
 
 module Semlogr
   class Logger
-    def initialize(min_severity, enrichers, filters, sinks)
+    def initialize(min_severity, enricher, sink)
       @min_severity = min_severity
-      @filters = filters
-      @enrichers = enrichers
-      @sinks = sinks
+      @enricher = enricher
+      @sink = sink
     end
 
     def self.create
@@ -41,39 +39,40 @@ module Semlogr
       @min_severity <= LogSeverity::FATAL
     end
 
-    def debug(template = nil, error: nil, **properties, &block)
-      log(LogSeverity::DEBUG, template, error, properties, &block)
+    def debug(template = nil, **properties, &block)
+      log(LogSeverity::DEBUG, template, properties, &block)
     end
 
-    def info(template = nil, error: nil, **properties, &block)
-      log(LogSeverity::INFO, template, error, properties, &block)
+    def info(template = nil, **properties, &block)
+      log(LogSeverity::INFO, template, properties, &block)
     end
 
-    def warn(template = nil, error: nil, **properties, &block)
-      log(LogSeverity::WARN, template, error, properties, &block)
+    def warn(template = nil, **properties, &block)
+      log(LogSeverity::WARN, template, properties, &block)
     end
 
-    def error(template = nil, error: nil, **properties, &block)
-      log(LogSeverity::ERROR, template, error, properties, &block)
+    def error(template = nil, **properties, &block)
+      log(LogSeverity::ERROR, template, properties, &block)
     end
 
-    def fatal(template = nil, error: nil, **properties, &block)
-      log(LogSeverity::FATAL, template, error, properties, &block)
+    def fatal(template = nil, **properties, &block)
+      log(LogSeverity::FATAL, template, properties, &block)
     end
 
     def with_context(**properties)
+      property_enricher = Enrichers::Property.new(properties)
+      enricher = Enrichers::Aggregate.new([@enricher, property_enricher])
+
       Logger.new(
         @min_severity,
-        @enrichers + [Enrichers::Property.new(properties)],
-        @filters,
-        @sinks
+        enricher,
+        @sink
       )
     end
 
     private
 
-    def log(severity, template, error, properties, &block)
-      return true if @sinks.size.zero?
+    def log(severity, template, properties, &block)
       return true if severity < @min_severity
 
       if block
@@ -82,42 +81,13 @@ module Semlogr
 
         properties ||= {}
         properties[:progname] = progname if progname
-        error = properties.delete(:error)
       end
 
-      log_event = create_log_event(severity, template, error, properties)
-      return false if filter?(log_event)
-
-      enrich(log_event)
-      emit(log_event)
+      log_event = Events::LogEvent.create(severity, template, properties)
+      @enricher.enrich(log_event)
+      @sink.emit(log_event)
 
       true
     end
-
-    def create_log_event(severity, template, error, properties)
-      template = Templates::Parser.parse(template)
-
-      Events::LogEvent.new(severity, template, error, properties)
-    end
-
-    def filter?(log_event)
-      @filters.each do |filter|
-        return true if filter.call(log_event)
-      end
-
-      false
-    end
-
-    def enrich(log_event)
-      @enrichers.each do |enricher|
-        enricher.enrich(log_event)
-      end
-    end
-
-    def emit(log_event)
-      @sinks.each do |sink|
-        sink.emit(log_event)
-      end
-    end
   end
 end

data/lib/semlogr/logger_configuration.rb

@@ -1,10 +1,10 @@
+require 'semlogr/component_registry'
+require 'semlogr/enrichers/aggregate'
+require 'semlogr/sinks/aggregate'
+require 'semlogr/sinks/filtering'
+
 module Semlogr
   class LoggerConfiguration
-    attr_reader :min_severity
-    attr_reader :enrichers
-    attr_reader :filters
-    attr_reader :sinks
-
     def initialize
       @min_severity = LogSeverity::DEBUG
       @enrichers = []
@@ -13,27 +13,32 @@ module Semlogr
     end
 
     def log_at(severity)
-      @min_severity = severity
+      @min_severity = LogSeverity.create(severity)
     end
 
-    def filter_when(filter)
+    def filter(filter)
       @filters << filter
     end
 
-    def enrich_with(enricher)
+    def enrich_with(enricher, *params)
+      enricher = ComponentRegistry.resolve(:enricher, enricher, *params) if enricher.is_a?(Symbol)
       @enrichers << enricher
     end
 
-    def write_to(sink)
+    def write_to(sink, *params)
+      sink = ComponentRegistry.resolve(:sink, sink, *params) if sink.is_a?(Symbol)
       @sinks << sink
     end
 
     def create_logger
+      enricher = Enrichers::Aggregate.new(@enrichers)
+      sink = Sinks::Aggregate.new(@sinks)
+      sink = Sinks::Filtering.new(@filters, sink) if @filters.any?
+
       Logger.new(
         @min_severity,
-        @enrichers,
-        @filters,
-        @sinks
+        enricher,
+        sink
       )
     end
   end

data/lib/semlogr/properties/output_properties.rb

@@ -8,7 +8,6 @@ module Semlogr
         )
 
         properties[:error] = log_event.error if log_event.error
-
         properties
       end
     end

data/lib/semlogr/sinks/aggregate.rb

@@ -0,0 +1,15 @@
+module Semlogr
+  module Sinks
+    class Aggregate
+      def initialize(sinks)
+        @sinks = sinks
+      end
+
+      def emit(log_event)
+        @sinks.each do |sink|
+          sink.emit(log_event)
+        end
+      end
+    end
+  end
+end

data/lib/semlogr/sinks/colored_console.rb

@@ -48,14 +48,13 @@ module Semlogr
         when :message
           render_message(output, log_event)
         when :severity
-          color = LOG_SEVERITY_COLORS[log_event.severity] || :white
-          colorize(output, color) do
+          colorize(output, LOG_SEVERITY_COLORS[log_event.severity]) do
             token.render(output, output_properties)
           end
         when :error
           return unless output_properties[:error]
 
-          colorize(output, :red) do
+          colorize(output, LOG_SEVERITY_COLORS[log_event.severity]) do
             token.render(output, output_properties)
           end
         else
@@ -79,10 +78,14 @@ module Semlogr
       end
 
       def colorize(output, color)
+        color = :white unless color
+
         output << "\e[#{COLOR_CODES[color]}m"
         yield
         output << "\e[0m"
       end
     end
+
+    ComponentRegistry.register(:sink, colored_console: ColoredConsole)
   end
 end

data/lib/semlogr/sinks/console.rb

@@ -12,5 +12,7 @@ module Semlogr
         STDOUT.write(output)
       end
     end
+
+    ComponentRegistry.register(:sink, console: Console)
   end
 end

data/lib/semlogr/sinks/file.rb

@@ -1,9 +1,10 @@
+require 'logger'
 require 'semlogr/formatters/text_formatter'
 
 module Semlogr
   module Sinks
     class File
-      def initialize(file, shift_age: nil, shift_size: nil, formatter: nil)
+      def initialize(file, shift_age: 0, shift_size: 1_048_576, formatter: nil)
         @logdev = ::Logger::LogDevice.new(file, shift_age: shift_age, shift_size: shift_size)
         @formatter = formatter || Formatters::TextFormatter.new
       end
@@ -13,5 +14,7 @@ module Semlogr
         @logdev.write(output)
       end
     end
+
+    ComponentRegistry.register(:sink, file: File)
   end
 end

data/lib/semlogr/sinks/filtering.rb

@@ -0,0 +1,16 @@
+module Semlogr
+  module Sinks
+    class Filtering
+      def initialize(filters, sink)
+        @filters = filters
+        @sink = sink
+      end
+
+      def emit(log_event)
+        filtered = @filters.any? { |filter| filter.call(log_event) }
+
+        @sink.emit(log_event) unless filtered
+      end
+    end
+  end
+end

data/lib/semlogr/version.rb

@@ -1,3 +1,3 @@
 module Semlogr
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/semlogr.rb

@@ -1,6 +1,22 @@
 require 'semlogr/version'
 require 'semlogr/logger'
 require 'semlogr/null_logger'
+require 'semlogr/context/log_context'
+
+# Built-in enrichers
+require 'semlogr/enrichers/host'
+require 'semlogr/enrichers/log_context'
+require 'semlogr/enrichers/property'
+require 'semlogr/enrichers/thread'
+
+# Built-in sinks
+require 'semlogr/sinks/console'
+require 'semlogr/sinks/colored_console'
+require 'semlogr/sinks/file'
+
+# Built-in formatters
+require 'semlogr/formatters/json_formatter'
+require 'semlogr/formatters/text_formatter'
 
 module Semlogr
   @logger = nil
@@ -20,22 +36,26 @@ module Semlogr
   end
 
   def self.debug(template = nil, **properties, &block)
-    logger.debug(template, **properties, &block)
+    logger.debug(template, properties, &block)
   end
 
   def self.info(template = nil, **properties, &block)
-    logger.info(template, **properties, &block)
+    logger.info(template, properties, &block)
   end
 
   def self.warn(template = nil, **properties, &block)
-    logger.warn(template, **properties, &block)
+    logger.warn(template, properties, &block)
   end
 
   def self.error(template = nil, **properties, &block)
-    logger.error(template, **properties, &block)
+    logger.error(template, properties, &block)
   end
 
   def self.fatal(template = nil, **properties, &block)
-    logger.fatal(template, **properties, &block)
+    logger.fatal(template, properties, &block)
+  end
+
+  def self.with_context(**properties)
+    logger.with_context(properties)
   end
 end

data/samples/basic.rb

@@ -1,64 +1,9 @@
 require 'bundler/setup'
 require 'semlogr'
-require 'semlogr/sinks/console'
-require 'semlogr/sinks/colored_console'
-require 'semlogr/sinks/file'
-require 'semlogr/formatters/json_formatter'
-require 'semlogr/enrichers/thread'
-require 'semlogr/enrichers/host'
-require 'semlogr/enrichers/property'
 
-logger = Semlogr::Logger.create do |c|
-  c.log_at Semlogr::LogSeverity::DEBUG
-
-  c.write_to Semlogr::Sinks::Console.new
-  c.write_to Semlogr::Sinks::ColoredConsole.new
-  c.write_to Semlogr::Sinks::Console.new(formatter: Semlogr::Formatters::JsonFormatter.new)
-
-  c.enrich_with Semlogr::Enrichers::Thread.new
-  c.enrich_with Semlogr::Enrichers::Host.new
-  c.enrich_with Semlogr::Enrichers::Property.new(version: '1.0')
-
-  c.filter_when lambda { |log_event|
-    log_event.get_property(:id) == 123
-  }
+Semlogr.logger = Semlogr::Logger.create do |c|
+  c.write_to :console
 end
 
-logger.debug('Test {id}, string {string}')
-logger.debug('Test {id}, string {string}', id: nil, string: nil)
-logger.debug('Test {id}, string {string}', id: 123, string: 'foo')
-logger.debug('Test {id}, string {string}', id: 1234, string: 'foo')
-logger.info('Test {id}, string {string}', id: 1234, string: 'foo')
-logger.warn('Test {id}, string {string}', id: 1234, string: 'foo')
-logger.fatal('Test {id}, string {string}', id: 1234, string: 'foo')
-logger.fatal('Test array {array}', array: [1, 2, 3, 'foo'])
-
-logger.debug do
-  'Testing with a block'
-end
-
-logger.debug do
-  ['Testing with a block, id: {id}', id: 1234]
-end
-
-logger.error('ERROR!!!', error: StandardError.new('test'))
-logger.error('ERROR!!!', error: StandardError.new('test'))
-
-begin
-  def bob
-    foo
-  end
-
-  def foo
-    raise StandardError, 'foo'
-  end
-
-  bob
-rescue => ex
-  logger.warn('Oops, id: {id}', id: 1234, error: ex)
-  logger.error('Oops, id: {id}', id: 1234, error: ex)
-
-  logger.error do
-    ['Testing error with a block, id: {id}', error: ex, id: 1234]
-  end
-end
+Semlogr.info('Customer {id} checked out', id: 123)
+Semlogr.error('Failed to save data', error: StandardError.new('foo'))

data/samples/context.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'semlogr'
+
+Semlogr.logger = Semlogr::Logger.create do |c|
+  c.write_to :console, formatter: Semlogr::Formatters::JsonFormatter.new
+end
+
+Semlogr.with_context(id: 2, correlation_id: '1234')
+  .info('Customer {id} checked out', id: 1)

data/samples/enrichment.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'semlogr'
+
+Semlogr.logger = Semlogr::Logger.create do |c|
+  c.write_to :console, formatter: Semlogr::Formatters::JsonFormatter.new
+
+  c.enrich_with :host
+  c.enrich_with :thread
+  c.enrich_with :property, correlation_id: '1234'
+end
+
+Semlogr.info('Customer {id} checked out', id: 1)

data/samples/filtering.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'semlogr'
+
+Semlogr.logger = Semlogr::Logger.create do |c|
+  c.write_to :console
+
+  c.filter ->(e) { e.get_property(:id) == 123 }
+end
+
+Semlogr.info('Customer {id} checked out', id: 123)
+Semlogr.info('Customer {id} checked out', id: 456)

data/samples/log_context.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'semlogr'
+
+Semlogr.logger = Semlogr::Logger.create do |c|
+  c.write_to :console, formatter: Semlogr::Formatters::JsonFormatter.new
+
+  c.enrich_with :log_context
+end
+
+Semlogr::Context::LogContext.push_property(a: 1) do
+  Semlogr.info('Customer {id} checked out', id: 1)
+end

data/samples/sinks.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'semlogr'
+
+Semlogr.logger = Semlogr::Logger.create do |c|
+  c.write_to :console, formatter: Semlogr::Formatters::JsonFormatter.new
+  c.write_to :colored_console
+end
+
+Semlogr.info('Customer {id} checked out', id: 123)
+Semlogr.error('Failed to save data', error: StandardError.new('foo'))

data/semlogr.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -27,5 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.10.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.46'
+  spec.add_development_dependency 'rubocop', '0.49.1'
+  spec.add_development_dependency 'simplecov', '~>0.15.1'
+  spec.add_development_dependency 'benchmark-memory', '~>0.1.2'
+  spec.add_development_dependency 'benchmark-ips', '~>2.7.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semlogr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Stefan Sedich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lru_redux
@@ -96,18 +96,60 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: benchmark-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: 2.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: 2.7.2
 description: A modern semantic logger for Ruby inspired by Serilog.
 email:
 - stefan.sedich@gmail.com
@@ -118,6 +160,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
@@ -125,9 +168,14 @@ files:
 - bin/console
 - bin/setup
 - lib/semlogr.rb
+- lib/semlogr/component_registry.rb
+- lib/semlogr/context/log_context.rb
+- lib/semlogr/enrichers/aggregate.rb
 - lib/semlogr/enrichers/host.rb
+- lib/semlogr/enrichers/log_context.rb
 - lib/semlogr/enrichers/property.rb
 - lib/semlogr/enrichers/thread.rb
+- lib/semlogr/error.rb
 - lib/semlogr/events/log_event.rb
 - lib/semlogr/formatters/json_formatter.rb
 - lib/semlogr/formatters/property_value_formatter.rb
@@ -137,17 +185,23 @@ files:
 - lib/semlogr/logger_configuration.rb
 - lib/semlogr/null_logger.rb
 - lib/semlogr/properties/output_properties.rb
+- lib/semlogr/sinks/aggregate.rb
 - lib/semlogr/sinks/colored_console.rb
 - lib/semlogr/sinks/console.rb
 - lib/semlogr/sinks/file.rb
+- lib/semlogr/sinks/filtering.rb
 - lib/semlogr/templates/parser.rb
 - lib/semlogr/templates/property_token.rb
 - lib/semlogr/templates/template.rb
 - lib/semlogr/templates/template_cache.rb
 - lib/semlogr/templates/text_token.rb
 - lib/semlogr/version.rb
-- output.html
 - samples/basic.rb
+- samples/context.rb
+- samples/enrichment.rb
+- samples/filtering.rb
+- samples/log_context.rb
+- samples/sinks.rb
 - semlogr.gemspec
 homepage: https://github.com/semlogr/semlogr
 licenses:
@@ -169,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Semantic logging for Ruby