blinkbox-common_logging 0.5.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njk4YzRhMzg4NjcyZjVjZWQ4NDRjMjg4ZjM0OTQwM2VjMWMzMzRiNQ==
+  data.tar.gz: !binary |-
+    YjAxYTcxMjQ5ZGE1ODY2MDgzNzBhYmZmMDJmNzYwNTY1NmQzNmZjNw==
+SHA512:
+  metadata.gz: !binary |-
+    NWM5MTFlNTkwOGMzZTQxZWY4MjZiODQ4ZDhmYWVmOWQzYzhlNWMxZWMyMWMy
+    ZTFkMDcyOTNjYWY4NGQzZjA0MjcwYjVmMWYxMTAzY2JkMWI5NDM2ZGRiYjQx
+    YjZjYTQ3YTI2MWI3ZWY2ZGU4YWVmZjdlMTAyZDdjZDNhY2I2YjQ=
+  data.tar.gz: !binary |-
+    MzU1NzIwMDA2MDI1YmNhMGM3NmYyM2RiOTIwOGUwYmY4OTFlYmJmZjk3MDFj
+    Y2E4YjY5MDU3NTZkYTA0ZDZmODliYTc4ZjRjYjY1M2RmZjNlZjdlMzZkYjYw
+    OTNiZTU5NmFmNGQ3M2ZkNjBkZDlkNTRiNzQ0ZDViODJmOGFhYWE=

data/CHANGELOG.md

@@ -0,0 +1,94 @@
+# Change log
+
+## Open Source release (2015-01-28 14:11:21)
+
+Today we have decided to publish parts of our codebase on Github under the [MIT licence](LICENCE). The licence is very permissive, but we will always appreciate hearing if and where our work is used!
+
+## 0.5.1 ([#8](https://git.mobcastdev.com/Platform/common_logging.rb/pull/8) 2014-12-15 15:01:11)
+
+Changed level mapping to :direct
+
+### Bug fixes
+
+- Changed the level mapping to be `:direct` which means that
+`logger.error` causes an error level message in Graylog, `logger.warn`
+causes a warning level message, and so on. The default mappings mean
+that `logger.error` causes a warning level message, and `logger.warn`
+causes a notice level message which is nuts.
+
+## 0.5.0 ([#7](https://git.mobcastdev.com/Platform/common_logging.rb/pull/7) 2014-10-03 15:02:14)
+
+Log to console as well as Graylog
+
+### New features
+
+- Setting `logging.console.enabled` to `true` will now output to stdout as well as graylog.
+- Slight refactoring of code in files.
+
+## 0.4.1 ([#6](https://git.mobcastdev.com/Platform/common_logging.rb/pull/6) 2014-10-02 08:31:38)
+
+Validation of values
+
+### Improvements
+
+- Validates input from config and raises an `ArgumentError` if anything is unusable.
+- Will list out *all* problematic variables so fixing the config is faster.
+- Translates the named invalid keys between `from_config` and `new` so that the error message makes sense for the code being used.
+
+## 0.4.0 ([#5](https://git.mobcastdev.com/Platform/common_logging.rb/pull/5) 2014-09-25 10:46:32)
+
+Shallow hashes
+
+### New feature
+
+- Graylog can't deal with nested hashes, so I've added functionality to flatten deep hashes given to the logging methods into dot-separated shallow ones:
+
+```ruby
+{
+  a: {
+    b: "will become a.b"
+  }
+}
+```
+
+becomes
+
+```ruby
+{
+  "a.b" => "will become a.b"
+}
+```
+
+## 0.3.1 ([#4](https://git.mobcastdev.com/Platform/common_logging.rb/pull/4) 2014-09-22 13:53:00)
+
+Ensure from_config actually works from a config!
+
+### Bugfix
+
+- `.from_config` now expects a shallow hash (with dots in keys) just as common_config.rb provides.
+
+## 0.3.0 ([#3](https://git.mobcastdev.com/Platform/common_logging.rb/pull/3) 2014-08-14 16:45:39)
+
+Allow adding of service version to default params
+
+### New feature
+
+- Allows us to add the default `serviceVersion` parameter to the messages sent to GrayLog which, along with the facility (which should be the service name) will allow us to pinpoint what code needs to be looked at when issues occur.
+
+## 0.2.0 ([#2](https://git.mobcastdev.com/Platform/common_logging.rb/pull/2) 2014-08-14 13:09:41)
+
+Support loading directly from config
+
+### New feature
+
+- Allow the injection of a hash from common_config to initialise a logger.
+
+## 0.1.0 ([#1](https://git.mobcastdev.com/Platform/common_logging.rb/pull/1) 2014-08-12 17:05:06)
+
+First release
+
+### New Features
+
+- Logs messages and exceptions.
+- Pretty much only wraps the `GELF::Notifier` class (may need to check log levels) at the moment, but we may extend this to include extra functionality as the ruby logging requirements become clear.
+

data/README.md

@@ -0,0 +1,35 @@
+# Blinkbox::CommonLogging
+
+Automatic configuration for logging in the blinkbox format.
+
+## Usage
+
+```ruby
+# $ gem install blinkbox-common_logging
+require "blinkbox/common_logging"
+
+log_server = {
+  host: "127.0.0.1",
+  port: 12201,
+  # This is the name of the invoked script
+  facility: $0,
+
+}
+# These are the defaults
+
+logger = Blinkbox::CommonLogging.new(log_server)
+
+# Usual levels are available
+logger.debug "This is a basic debug message"
+logger.info  "This is a basic info message"
+logger.warn  "This is a basic warn message"
+logger.error "This is a basic error message"
+logger.fatal "This is a basic fatal message"
+
+# You can also pass an exception to #notify
+begin
+  "raise an exception".by_calling_a_missing_method
+raise StandardError => e
+  logger.notify(e)
+end
+```

data/VERSION

@@ -0,0 +1 @@
+0.5.1

data/lib/blinkbox/common_logging.rb

@@ -0,0 +1,85 @@
+require "blinkbox/utilities/extra_hash_methods"
+require "gelf"
+require "logger"
+
+module Blinkbox
+  class CommonLogging < GELF::Logger
+    def initialize(host: "localhost", port: 12201, facility: $0, max_size: 8192, facility_version: nil, echo_to_console: false)
+      validity_issues = []
+      validity_issues.push("host") unless host.is_a?(String)
+      validity_issues.push("port") unless port.is_a?(Integer)
+      validity_issues.push("facility") unless facility.is_a?(String)
+      validity_issues.push("max_size") unless max_size.is_a?(Integer)
+      raise ArgumentError, "Cannot start the logger, the following settings weren't valid: #{validity_issues.join(", ")}" if !validity_issues.empty?
+
+      if echo_to_console
+        @stdout_logger = Logger.new(STDOUT)
+        @stdout_logger.formatter = proc do |severity, datetime, progname, msg|
+          # Using console output is only for live-debug, so we can strip the timestamp, progname
+          l = msg.dup
+          l.delete("facility")
+          l.delete(:facility)
+          log_msg = "#{severity[0..0]} #{l.delete("short_message")}#{l.delete(:short_message)}"
+          log_msg << " (#{l})" if l.any?
+          log_msg << "\n"
+          log_msg
+        end
+      end
+      options = { facility: facility }
+      options[:facilityVersion] = facility_version unless facility_version.nil?
+      super(host, port, max_size, options)
+    end
+
+    # Allows the setting of the facility version default parameter.
+    # @param [String] semver The semantic version of the service which is sending logs
+    def facility_version=(semver)
+      self.default_options['facilityVersion'] = semver
+    end
+
+    # Accepts a hash detailing log config settings in the format used in blinkbox Books
+    # config files and returns a CommonLogging object.
+    #
+    # @example Load from config
+    #   config = Blinkbox::CommonConfig.new
+    #   logger = Blinkbox::CommonLogging.from_config(config.tree(:logging))
+    #
+    # @param [Hash] hash The returned hash from CommonConfig#tree
+    # @option hash [String] :udp.host (localhost) The Graylog host
+    # @option hash [Integer] :udp.port (12201) The Graylog port number
+    # @option hash [String] :gelf.facility Organisation/app_name eg. Marvin/cover_processor
+    # @option hash [Integer] :gelf.maxChunkSize (8192) The default size for UDP chunks sent to the server.
+    # @option hash ["DEBUG","INFO","WARN","ERROR","FATAL"] :level ("INFO") The level below which messages will not be sent to Graylog.
+    # @return [CommonLogging]
+    def self.from_config(hash)
+      mapping = {
+        host:            :'udp.host',
+        port:            :'udp.port',
+        facility:        :'gelf.facility',
+        max_size:        :'gelf.maxChunkSize',
+        echo_to_console: :'console.enabled'
+      }
+      begin
+        logger = new(Hash[mapping.map { |k, v| [k, hash[v]] }])
+      rescue ArgumentError => e
+        msg = e.message
+        mapping.each do |k, v|
+          msg.sub!(k.to_s, v.to_s)
+        end
+        raise e.class, msg
+      end
+      logger.level = GELF.const_get(hash[:level].upcase) rescue GELF::INFO
+      logger.level_mapping = :direct
+      logger
+    end
+
+    private
+    def notify_with_level!(message_level, msg)
+      if @stdout_logger
+        level = GELF::Levels.constants[message_level].to_s.downcase.to_sym
+        @stdout_logger.send(level, msg)
+      end
+      msg.extend(ExtraHashMethods).shallow! if msg.is_a?(Hash)
+      super(message_level, msg)
+    end
+  end
+end

data/lib/blinkbox/utilities/extra_hash_methods.rb

@@ -0,0 +1,76 @@
+module Blinkbox
+  module ExtraHashMethods
+    # Turns a deep/nested hash into a shallow one by concatenating nested key names.
+    #
+    # @example: Removing nesting
+    #   hash = {
+    #     "a" => {
+    #       "1" => 'will be a.1'
+    #     },
+    #     "b" => 'will be b'
+    #   }
+    #   hash.extend(ExtraHashMethods).shallow!
+    #   # => true
+    #   p hash
+    #   # => { "a.1" => 'will be a.1', "b" => 'will be b' }
+    #
+    # @example: Removing nesting - custom join string
+    #   hash = {
+    #     "a" => {
+    #       "1" => 'will be merged down'
+    #     },
+    #     "b" => 'will be the same'
+    #   }
+    #   hash.extend(ExtraHashMethods).shallow!("~")
+    #   # => true
+    #   p hash
+    #   # => { "a~1" => 'will be merged down', "b" => 'will be the same' }
+    #
+    # @example: No removal needed
+    #   hash = {
+    #     "a" => 'no deep keys here'
+    #   }
+    #   hash.extend(ExtraHashMethods).shallow!
+    #   # => false
+    #   p hash
+    #   # => { "a" => 'no deep keys here' }
+    #
+    # @example: Conflicting key names
+    #   hash = {
+    #     "a" => {
+    #       "1" => 'will be a.1'
+    #     },
+    #     "a.1" => 'will be lost!'
+    #   }
+    #   hash.extend(ExtraHashMethods).shallow!
+    #   # => ["a.1"]
+    #   p hash
+    #   # => { "a.1" => 'will be a.1' }
+    #
+    # @param [String] join The string to use to join keys.
+    # @return [Boolean] Whether any keys were changed
+    def shallow!(join = ".")
+      shallowed = false
+      keys = self.keys.select { |k| self[k].is_a?(Hash) }
+      while (k = keys.shift) do
+        shallowed = shallowed || true
+        v = self.delete(k)
+        v.each do |sub_k, sub_v|
+          new_key = [k, sub_k].join(join)
+          if self.has_key?(new_key)
+            shallowed = [] unless shallowed.is_a?(Array)
+            shallowed.push(new_key)
+          end
+          self[new_key] = if sub_v.is_a?(Hash)
+            sub_v.extend(ExtraHashMethods).shallow!(join)
+            keys.push(new_key)
+            sub_v
+          else
+            sub_v
+          end
+        end
+      end
+      shallowed
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: blinkbox-common_logging
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- JP Hastings-Spital
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '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: rspec-mocks
+  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: simplecov
+  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'
+description: Simple helper for logging to gelf in the format required by blinkbox
+  Books
+email:
+- jphastings@blinkbox.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- README.md
+- VERSION
+- lib/blinkbox/common_logging.rb
+- lib/blinkbox/utilities/extra_hash_methods.rb
+homepage: ''
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Simple helper for logging to gelf in the format required by blinkbox Books
+test_files: []