green_log 0.1.0

data/lib/green_log/rack/request_logging.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "rack"
+
+module GreenLog
+
+  module Rack
+
+    # Structured request logging.
+    class RequestLogging
+
+      def initialize(app, logger, log_request_bodies: false)
+        @app = app
+        @logger = logger
+        @log_request_bodies = log_request_bodies
+      end
+
+      def call(env)
+        started_at = Time.now
+        status, headers, _body = @app.call(env)
+      ensure
+        status ||= 500
+        headers ||= {}
+        duration = Time.now - started_at
+        log(
+          request: ::Rack::Request.new(env),
+          response: Response.new(status, headers, duration),
+        )
+      end
+
+      Response = Struct.new(:status, :headers, :duration)
+
+      protected
+
+      attr_reader :logger
+      attr_reader :log_request_bodies
+
+      def log(request:, response:)
+        logger.info(
+          "#{request.request_method} #{request.path} #{response.status}",
+          request: request_details(request),
+          response: response_details(response),
+        )
+      end
+
+      def request_details(request)
+        {
+          method: request.request_method,
+          scheme: request.scheme,
+          host: request.host,
+          path: request.path,
+          query: request.query_string,
+          remote_user: request.env["REMOTE_USER"],
+          remote_addr: request.ip,
+        }.merge(optional_request_details(request))
+      end
+
+      def optional_request_details(request)
+        return {} unless log_request_bodies
+
+        {
+          body: request_body(request),
+        }
+      end
+
+      def request_body(request)
+        original_position = request.body.pos
+        request.body.rewind
+        request.body.read
+      ensure
+        request.body.seek(original_position)
+      end
+
+      def response_details(response)
+        {
+          status: response.status.to_i,
+          length: response.headers["Content-Length"].to_i,
+          duration: response.duration.round(3),
+        }
+      end
+
+    end
+
+  end
+
+end

data/lib/green_log/severity.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module GreenLog
+
+  # Levels of severity.
+  module Severity
+
+    # Low-level information, mostly for developers.
+    DEBUG = 0
+    # Generic (useful) information about system operation.
+    INFO = 1
+    # A warning.
+    WARN = 2
+    # A handleable error condition.
+    ERROR = 3
+    # An unhandleable error that results in a program crash.
+    FATAL = 4
+
+    NAMES = %i[DEBUG INFO WARN ERROR FATAL].freeze
+
+    class << self
+
+      def name(severity)
+        NAMES[severity]
+      end
+
+      def resolve(arg)
+        value = _resolve(arg)
+        return value if value && (DEBUG..FATAL).cover?(value)
+
+        raise ArgumentError, "invalid severity: #{arg.inspect}"
+      end
+
+      private
+
+      def _resolve(arg)
+        case arg
+        when Integer
+          arg
+        when Symbol, String
+          NAMES.index(arg.to_sym.upcase)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/green_log/severity_filter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "green_log/severity"
+
+module GreenLog
+
+  # Log middleware that filters by severity.
+  class SeverityFilter
+
+    def initialize(downstream, threshold:)
+      @downstream = downstream
+      @severity_threshold = GreenLog::Severity.resolve(threshold)
+    end
+
+    attr_reader :downstream
+    attr_reader :severity_threshold
+
+    def <<(entry)
+      return if entry.severity < severity_threshold
+
+      downstream << entry
+    end
+
+  end
+
+end

data/lib/green_log/severity_threshold_support.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "green_log/severity"
+
+module GreenLog
+
+  # Common logic for deriving a #severity_threshold.
+  module SeverityThresholdSupport
+
+    def severity_threshold
+      return downstream.severity_threshold if downstream.respond_to?(:severity_threshold)
+
+      GreenLog::Severity::DEBUG
+    end
+
+  end
+
+end

data/lib/green_log/simple_writer.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "green_log/entry"
+require "green_log/severity"
+
+module GreenLog
+
+  # A simple log formatter, aimed at humans.
+  class SimpleWriter
+
+    def initialize(dest)
+      @dest = dest
+    end
+
+    attr_reader :dest
+
+    def <<(entry)
+      raise ArgumentError, "GreenLog::Entry expected" unless entry.is_a?(GreenLog::Entry)
+
+      output = [
+        format_part(entry, :severity),
+        format_part(entry, :context),
+        "--",
+        format_part(entry, :message),
+        format_part(entry, :data),
+      ].compact.join(" ") + "\n"
+
+      output << format_exception(entry.exception)
+
+      dest << output
+    end
+
+    protected
+
+    def format_part(entry, part)
+      value = entry.public_send(part)
+      return nil if value.nil?
+
+      send("format_#{part}", value)
+    end
+
+    def format_severity(severity)
+      Severity.name(severity)[0].upcase
+    end
+
+    def format_data(data)
+      return nil if data.empty?
+
+      "[" + each_part_of(data).to_a.join(" ") + "]"
+    end
+
+    alias format_context format_data
+
+    def format_message(message)
+      message
+    end
+
+    def format_exception(exception)
+      return "" if exception.nil?
+
+      result = "  ! #{exception.class.name}: #{exception.message}\n"
+      exception.backtrace.each do |line|
+        result += "    #{line}\n"
+      end
+      result
+    end
+
+    private
+
+    def each_part_of(data, prefix = nil, &block)
+      return enum_for(:each_part_of, data, prefix) unless block_given?
+
+      data.each do |k, v|
+        label = [prefix, k].compact.join(".")
+        if v.is_a?(Hash)
+          each_part_of(v, label, &block)
+        else
+          yield "#{label}=#{v.inspect}"
+        end
+      end
+    end
+
+  end
+
+end

data/lib/green_log/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GreenLog
+
+  VERSION = "0.1.0"
+
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: green_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: values
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+description: 
+email:
+- mike.williams@greensync.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- doc/adr/0001-record-architecture-decisions.md
+- doc/adr/0002-avoid-global-configuration.md
+- doc/adr/0003-decouple-generation-and-handling.md
+- doc/adr/0004-use-stacked-handlers-to-solve-many-problems.md
+- doc/adr/0005-restrict-data-types-allowable-in-log-entries.md
+- doc/adr/0006-use-lock-free-io.md
+- examples/multi-threaded
+- examples/try-it
+- green_log.gemspec
+- lib/green_log.rb
+- lib/green_log/classic_logger.rb
+- lib/green_log/contextualizer.rb
+- lib/green_log/core_refinements.rb
+- lib/green_log/entry.rb
+- lib/green_log/json_writer.rb
+- lib/green_log/logger.rb
+- lib/green_log/rack/request_logging.rb
+- lib/green_log/severity.rb
+- lib/green_log/severity_filter.rb
+- lib/green_log/severity_threshold_support.rb
+- lib/green_log/simple_writer.rb
+- lib/green_log/version.rb
+homepage: https://github.com/greensync/green_log
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Structured logging for cloud-native systems.
+test_files: []