microservice_logging 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70668c95dde5a8d9eea56520d5656df2a90405ce
+  data.tar.gz: 193cdce129fd559b1b29741ae63ccc12185f32db
+SHA512:
+  metadata.gz: e53a4fd2861baf3f0b03fbb47ab66c375512fd0e8e9f9af63c58a877a0b73f33dfad6e1c4495211e7681eb2b9f1a414d45a499912bd1df8621b25fe6ecc36bb8
+  data.tar.gz: 03c7a91b1c5affe41f47f49a48aa4c988a4dc69257f29b8e956fe9b16fc38ccff28b99aaed57c744e614c77452cdf0eb3370b6bb6babcd6bfa5c6a2ddd0ead2f

data/lib/json_event_logger.rb

@@ -0,0 +1,67 @@
+# A machine-readable first, human-readable second logging library
+class MicroserviceLogger
+  class JsonEventLogger
+    def initialize(service_name:,
+                   clock:,
+                   output:,
+                   scoped_properties:,
+                   event_type:)
+      @service_name = service_name
+      @clock = clock
+      @output = output
+      @scoped_properties = scoped_properties
+      @event_type = event_type
+    end
+
+    def debug(extra_properties)
+      log 'DEBUG', normalize(extra_properties)
+    end
+
+    def info(extra_properties)
+      log 'INFO', normalize(extra_properties)
+    end
+
+    def warning(extra_properties)
+      log 'WARNING', normalize(extra_properties)
+    end
+
+    def error(extra_properties)
+      log 'ERROR', normalize(extra_properties)
+    end
+
+    def critical(extra_properties)
+      log 'CRITICAL', normalize(extra_properties)
+    end
+
+    private
+
+    def log(severity, extra_properties)
+      properties =
+        required_properties(severity)
+        .merge(@scoped_properties)
+        .merge(extra_properties)
+
+      @output.puts(properties.to_json)
+    end
+
+    def required_properties(severity)
+      {
+        service: @service_name,
+        event_type: @event_type,
+        timestamp: @clock.now.utc.iso8601(3),
+        severity: severity
+      }
+    end
+
+    def normalize(properties)
+      case properties
+      when Hash
+        properties
+      else
+        { message: properties.to_s }
+      end
+    end
+  end
+
+  private_constant :JsonEventLogger
+end

data/lib/microservice_logging.rb

@@ -0,0 +1,69 @@
+require 'json'
+require 'time'
+
+require_relative './json_event_logger'
+
+# Log all the things in JSON
+class MicroserviceLogger
+  def initialize(service_name:,
+                 clock:,
+                 output:,
+                 scoped_properties: {},
+                 events: DEFAULT_EVENT_TYPES)
+    @service_name = service_name
+    @clock = clock
+    @output = output
+    @scoped_properties = scoped_properties
+    @event_loggers = {}
+    @events = events
+    @events.each do |method_name|
+      event_type = method_name.to_s
+      @event_loggers[method_name] =
+        JsonEventLogger.new(:service_name => @service_name,
+                            :clock => @clock,
+                            :output => @output,
+                            :scoped_properties => @scoped_properties,
+                            :event_type => event_type)
+    end
+  end
+
+  def method_missing(event)
+    super unless @events.include? event
+    @event_loggers[event]
+  end
+
+  DEFAULT_EVENT_TYPES = [
+    :http_request,
+    :applejack,
+    :startup,
+    :exception
+  ].freeze
+
+  def with(scoped_properties)
+    MicroserviceLogger.new(:service_name => @service_name,
+                           :clock => @clock,
+                           :output => @output,
+                           :scoped_properties => scoped_properties)
+  end
+
+  # The fields 'event_type' and 'serverity' in the JSON output that is logged
+  # are not passed as parameters, but as methods.
+  #
+  # Therefore to log something like
+  #
+  #   logger.log(
+  #     'event_type' => 'startup',
+  #     'serverity' => 'info',
+  #     'other_property' => 'some value',
+  #     ...
+  #   )
+  #
+  # one instead will call
+  #
+  #   logger.startup.info('other_property' => 'some value')
+  #
+  # The event types are defined on this class.
+  #
+  # Each of them returns a private JsonEventLogger that in turn has the methods
+  # corresponding to the severity levels.
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: microservice_logging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- "@sleepyfox"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-06 00:00:00.000000000 Z
+dependencies: []
+description: A library aiming to help microservice developers with producing structured
+  JSON logs suitable for use with StackDriver, ElasticSearch etc.
+email: developers@yourgolftravel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/json_event_logger.rb
+- lib/microservice_logging.rb
+homepage: https://github.com/ygt/microservice-logging/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Structured logging for microservices
+test_files: []