cloudreach-logger 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04a9b586d3de32b7d29e0a9d430a85cd675eaaf6
+  data.tar.gz: 8e4d6402741e1c0ca71325cd91a5ab14c7e4e3d4
+SHA512:
+  metadata.gz: 9f4fa7ee23f43804c98c028677eaeef9e5a895e4f9f7970c5d0b6279e2bee65b9f890d94fe2dc700eb1f74aef118bbb134d20ba305caf19efefdbeec57bfb882
+  data.tar.gz: 4bd241b982f5a28bbd5f295587f48fab4337becb94f5a5be0c44474a6e500c31d6140927f8bb5fb39251ebbd9b84411b36780ef8a5270edba6198a27532b1e0e

data/lib/cloudreach-logger.rb

@@ -0,0 +1,114 @@
+# Splunk friendly logger
+
+# Accepts either a string or a hash.
+# A hash will be serialized into splunk friendly key value pairs like key1=value, key2="some value" ...
+# A string will be logged out with the key line="my log message"
+
+require 'logger'
+
+# HACK: this patches the logger class so we can set pairs of values
+# to append to every log after initialisation (e.g request_id)
+#
+# TODO: write a proper logger class for ourselves
+class Logger
+  attr_accessor :_pairs
+
+  def set(**params)
+    @_pairs = @_pairs || {}
+    @_pairs = @_pairs.merge(params)
+  end
+end
+
+module Cloudreach
+  class MultiIO
+    def initialize(*targets)
+      @targets = targets
+    end
+
+    def write(*args)
+      @targets.each do |target|
+        target.write(*args)
+      end
+    end
+
+    def close
+      @targets.each(&:close)
+    end
+  end
+
+  # this class is just a factory that produces instances of Ruby's own Logger class
+  class Logger
+    @@log_levels = {
+      :debug => ::Logger::DEBUG,
+      :info  => ::Logger::INFO,
+      :warn  => ::Logger::WARN,
+      :error => ::Logger::ERROR,
+      :fatal => ::Logger::FATAL
+    }
+
+    def self.create(logfile: nil, level: :debug, stdout: false, name: nil)
+      if name == nil
+        # default to using folder name as name
+        name = ENV['PWD']
+        name = name.slice(name.rindex('/')+1, name.length)
+      end
+
+      if logfile == nil
+        env = ENV['RUBY_ENV'] || ENV['RACK_ENV'] || 'development'
+        logfile = "log/#{env}.log"
+      end
+
+      if !logfile && !stdout
+        raise ArgumentError, "You aren't going to log anything. What?"
+      end
+
+      if logfile
+        file = File.open(logfile, 'a')
+        file.sync = true
+      end
+
+      if logfile && stdout
+        file = MultiIO.new(file, STDOUT)
+      elsif !logfile && stdout
+        file = STDOUT
+      end
+
+      logger = ::Logger.new(file)
+      logger.level = @@log_levels[level]
+      logger.formatter = lambda { |severity, timestamp, progname, msg|
+        if msg.is_a? Hash
+          pairs = splunkify(msg)
+        else
+          pairs = "line=#{sanitize(msg)}"
+        end
+
+        if logger._pairs
+          pairs = "#{splunkify(logger._pairs)}, #{pairs}"
+        end
+
+        "[#{timestamp.strftime("%Y-%m-%d %H:%M:%S")}] service_name=#{sanitize(name)}, severity=#{severity}, #{pairs}\n"
+      }
+
+      logger.set(instance_id: ENV['CLOUDREACH_INSTANCE_ID']) if ENV['CLOUDREACH_INSTANCE_ID']
+      logger.set(container_id: ENV['CLOUDREACH_CONTAINER_ID']) if ENV['CLOUDREACH_CONTAINER_ID']
+
+      logger
+    end
+
+    private
+
+    # strip out newlines, add quotes if there's whitespace, & escape double quotes
+    def self.sanitize(value)
+      value = value.to_s.gsub(/(\n|\r)/, ' ')
+      value = value.gsub(/(?<!\\)(?:\\{2})*\K"/) { %q(\") } # match unescaped quotes
+      value = "\"#{value}\"" if value.match /\s/
+      value
+    end
+
+    # munge a hash into key/value pairs
+    def self.splunkify(hash)
+      pairs = hash.map { |key, value| "#{key}=#{sanitize(value)}" }
+      pairs.join ', '
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: cloudreach-logger
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- John Houston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: A gem to create splunk friendly logs
+email: john.houston@cloudreach.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cloudreach-logger.rb
+homepage: https://bitbucket.org/cloudreach/cloudreach-logger
+licenses:
+- Apache2
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Cloudreach Logger
+test_files: []