semlogr 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2df855ceaaff9b2369b0927eafe755540631e5dd
-  data.tar.gz: 32c4226e07455a16a2554756dbdb5550eb987a25
+SHA256:
+  metadata.gz: 9b9b3d946fba51274115cf720b6f7170d3975582617a8da5224e911d266fdc78
+  data.tar.gz: a83c60b4b86d5c0c63ded34b4660876ff8c38e0d41ad7427876a7d5671a4606c
 SHA512:
-  metadata.gz: cf540cc6b31b8def59a0d5eb02cfa7cc7a69cb93d92706a8797b8d46cf79dab08baf84b9ab58db5328b6768a2a8da6fe65e047bbb04e078baf03e416e96ed0b2
-  data.tar.gz: 119b61ddf7908134f7f62d5715cca0ef6ae4e2ca90f1b2138726b9c05f52f4ec8738e6714a8eaa78e9cb62859b03d174958891afd4f0c34557bbe3afbc82dce0
+  metadata.gz: 494fb5ae48cb228372ca7e3ec7d2225fdec427103cc21cf6dc71e474dfc5c5a8bd413252c00eca2b3e6d9987d5499b317618a9e263f1026e08659635a02c1d73
+  data.tar.gz: f11c82c03c5d50bafc633e93247213c2699c1fc94f0c6061a2b0ce2ccb78c96ede6be547174b31acaa147a870ddf7943fe2a76abc082ab075a0adc3b55b7456e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 0.2.3
+
+* Add ability to configure sinks with it's own min severity, filters and enrichers.
+* Add enricher to tag log events with an event type, based on a hash of the template text.
+* Some pipeline cleanup and refactoring.
+
 ### 0.2.2
 
 * Fix bug introduced by 0.2.1 where the severity was being wrapped in quotes in console output

data/lib/semlogr.rb

@@ -4,6 +4,7 @@ require 'semlogr/null_logger'
 require 'semlogr/context/log_context'
 
 # Built-in enrichers
+require 'semlogr/enrichers/event_type'
 require 'semlogr/enrichers/host'
 require 'semlogr/enrichers/log_context'
 require 'semlogr/enrichers/property'

data/lib/semlogr/config/logger_config.rb

@@ -0,0 +1,48 @@
+require 'semlogr/component_registry'
+require 'semlogr/sinks/aggregate'
+require 'semlogr/sinks/enriching'
+require 'semlogr/sinks/filtering'
+require 'semlogr/config/sink_config'
+require 'semlogr/logger'
+require 'semlogr/log_severity'
+
+module Semlogr
+  module Config
+    class LoggerConfig
+      def initialize
+        @min_severity = LogSeverity::DEBUG
+        @enrichers = []
+        @filters = []
+        @sinks = []
+      end
+
+      def log_at(severity)
+        @min_severity = LogSeverity.create(severity)
+      end
+
+      def filter(filter)
+        @filters << filter
+      end
+
+      def enrich_with(enricher, *params)
+        enricher = ComponentRegistry.resolve(:enricher, enricher, *params) if enricher.is_a?(Symbol)
+        @enrichers << enricher
+      end
+
+      def write_to(sink, *params)
+        sink_config = SinkConfig.new
+        yield(sink_config) if block_given?
+
+        @sinks << sink_config.create_sink(sink, *params)
+      end
+
+      def create_logger
+        sink = Sinks::Aggregate.new(@sinks)
+        sink = Sinks::Filtering.new(@filters, sink) if @filters.any?
+        sink = Sinks::Enriching.new(@enrichers, sink) if @enrichers.any?
+
+        Logger.new(@min_severity, sink)
+      end
+    end
+  end
+end

data/lib/semlogr/config/sink_config.rb

@@ -0,0 +1,44 @@
+require 'semlogr/component_registry'
+require 'semlogr/sinks/enriching'
+require 'semlogr/sinks/filtering'
+require 'semlogr/log_severity'
+
+module Semlogr
+  module Config
+    class SinkConfig
+      def initialize
+        @min_severity = LogSeverity::DEBUG
+        @enrichers = []
+        @filters = []
+      end
+
+      def emit_at(severity)
+        @min_severity = LogSeverity.create(severity)
+      end
+
+      def filter(filter)
+        @filters << filter
+      end
+
+      def enrich_with(enricher, *params)
+        enricher = ComponentRegistry.resolve(:enricher, enricher, *params) if enricher.is_a?(Symbol)
+        @enrichers << enricher
+      end
+
+      def create_sink(sink, *params)
+        if sink.is_a?(Symbol)
+          sink = ComponentRegistry.resolve(:sink, sink, *params)
+        end
+
+        if @min_severity > LogSeverity::DEBUG
+          severity_filter = ->(log_event) { log_event.severity < @min_severity }
+          @filters.unshift(severity_filter)
+        end
+
+        sink = Sinks::Filtering.new(@filters, sink) if @filters.any?
+        sink = Sinks::Enriching.new(@enrichers, sink) if @enrichers.any?
+        sink
+      end
+    end
+  end
+end

data/lib/semlogr/enrichers/event_type.rb

@@ -0,0 +1,13 @@
+require 'semlogr/component_registry'
+
+module Semlogr
+  module Enrichers
+    class EventType
+      def enrich(log_event)
+        log_event.add_property_if_absent(event_type: log_event.type)
+      end
+    end
+
+    ComponentRegistry.register(:enricher, event_type: EventType)
+  end
+end

data/lib/semlogr/events/log_event.rb

@@ -1,3 +1,4 @@
+require 'digest/xxhash'
 require 'semlogr/templates/parser'
 
 module Semlogr
@@ -39,6 +40,10 @@ module Semlogr
         @template.render(output, @properties)
       end
 
+      def type
+        @type ||= Digest::XXH32.hexdigest(@template.text)
+      end
+
       def to_s
         output = ''
 

data/lib/semlogr/formatters/json_formatter.rb

@@ -17,7 +17,6 @@ module Semlogr
         event = {
           timestamp: log_event.timestamp.iso8601(3),
           severity: log_event.severity.to_s,
-          message_template: log_event.template.text,
           message: log_event.to_s
         }
 

data/lib/semlogr/log_severity.rb

@@ -11,6 +11,8 @@ module Semlogr
 
     def self.create(severity)
       case severity
+      when LogSeverity
+        severity
       when :debug
         LogSeverity::DEBUG
       when :info

data/lib/semlogr/logger.rb

@@ -1,19 +1,18 @@
-require 'semlogr/logger_configuration'
+require 'semlogr/config/logger_config'
 require 'semlogr/log_severity'
 require 'semlogr/events/log_event'
+require 'semlogr/sinks/enriching'
 require 'semlogr/enrichers/property'
-require 'semlogr/enrichers/aggregate'
 
 module Semlogr
   class Logger
-    def initialize(min_severity, enricher, sink)
+    def initialize(min_severity, sink)
       @min_severity = min_severity
-      @enricher = enricher
       @sink = sink
     end
 
     def self.create
-      config = LoggerConfiguration.new
+      config = Config::LoggerConfig.new
       yield(config)
 
       config.create_logger
@@ -61,13 +60,9 @@ module Semlogr
 
     def with_context(**properties)
       property_enricher = Enrichers::Property.new(properties)
-      enricher = Enrichers::Aggregate.new([@enricher, property_enricher])
+      sink = Sinks::Enriching.new([property_enricher], @sink)
 
-      Logger.new(
-        @min_severity,
-        enricher,
-        @sink
-      )
+      Logger.new(@min_severity, sink)
     end
 
     private
@@ -84,7 +79,6 @@ module Semlogr
       end
 
       log_event = Events::LogEvent.create(severity, template, properties)
-      @enricher.enrich(log_event)
       @sink.emit(log_event)
 
       true

data/lib/semlogr/sinks/enriching.rb

@@ -0,0 +1,15 @@
+module Semlogr
+  module Sinks
+    class Enriching
+      def initialize(enrichers, sink)
+        @enrichers = enrichers
+        @sink = sink
+      end
+
+      def emit(log_event)
+        @enrichers.each { |enricher| enricher.enrich(log_event) }
+        @sink.emit(log_event)
+      end
+    end
+  end
+end

data/lib/semlogr/version.rb

@@ -1,3 +1,3 @@
 module Semlogr
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/samples/sinks.rb

@@ -3,7 +3,10 @@ require 'semlogr'
 
 Semlogr.logger = Semlogr::Logger.create do |c|
   c.write_to :console, formatter: Semlogr::Formatters::JsonFormatter.new
-  c.write_to :colored_console
+
+  c.write_to :colored_console do |s|
+    s.emit_at :error
+  end
 end
 
 Semlogr.info('Customer {id} checked out', id: 123)

data/semlogr.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'digest-xxhash', '~> 0.1'
   spec.add_dependency 'lru_redux', '~> 1.1'
   spec.add_dependency 'oj', '~> 3.5'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: semlogr
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Stefan Sedich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: digest-xxhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: lru_redux
   requirement: !ruby/object:Gem::Requirement
@@ -169,8 +183,10 @@ files:
 - bin/setup
 - lib/semlogr.rb
 - lib/semlogr/component_registry.rb
+- lib/semlogr/config/logger_config.rb
+- lib/semlogr/config/sink_config.rb
 - lib/semlogr/context/log_context.rb
-- lib/semlogr/enrichers/aggregate.rb
+- lib/semlogr/enrichers/event_type.rb
 - lib/semlogr/enrichers/host.rb
 - lib/semlogr/enrichers/log_context.rb
 - lib/semlogr/enrichers/property.rb
@@ -182,12 +198,12 @@ files:
 - lib/semlogr/formatters/text_formatter.rb
 - lib/semlogr/log_severity.rb
 - lib/semlogr/logger.rb
-- 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/enriching.rb
 - lib/semlogr/sinks/file.rb
 - lib/semlogr/sinks/filtering.rb
 - lib/semlogr/templates/parser.rb
@@ -223,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Semantic logging for Ruby

data/lib/semlogr/enrichers/aggregate.rb

@@ -1,15 +0,0 @@
-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/logger_configuration.rb

@@ -1,45 +0,0 @@
-require 'semlogr/component_registry'
-require 'semlogr/enrichers/aggregate'
-require 'semlogr/sinks/aggregate'
-require 'semlogr/sinks/filtering'
-
-module Semlogr
-  class LoggerConfiguration
-    def initialize
-      @min_severity = LogSeverity::DEBUG
-      @enrichers = []
-      @filters = []
-      @sinks = []
-    end
-
-    def log_at(severity)
-      @min_severity = LogSeverity.create(severity)
-    end
-
-    def filter(filter)
-      @filters << filter
-    end
-
-    def enrich_with(enricher, *params)
-      enricher = ComponentRegistry.resolve(:enricher, enricher, *params) if enricher.is_a?(Symbol)
-      @enrichers << enricher
-    end
-
-    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,
-        enricher,
-        sink
-      )
-    end
-  end
-end