l2meter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9d24762c770d4796433243c9a0e79fdab77a3a9
+  data.tar.gz: 4132e41611d13554df9caffe440764ef5d9c915d
+SHA512:
+  metadata.gz: e97d987cf5098a46759a41ea4102d96c5c25ea8c82b4c0555b6aec077958a5af78ea64d0e972611a882f0ad11ff90497d0672f972d5dba27cb1acebc51df7b14
+  data.tar.gz: aabc3a2a2861904bab33896aab903a922d103d45d8e6c503fb9065911e3abda36fcc41a1198783a0a6c0ea8c86a5f7f7e5d5e416926ae77a2b7ff1bf1439b36f

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pavel Pravosud
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# L2meter
+
+L2meter is a little gem that helps you build loggers that outputs things in l2met format.
+
+### Usage
+
+```ruby
+Metrics = L2meter.build do |config|
+  # sort output tokens, false by default
+  config.sort = true
+
+  # default context
+  config.context = { name: "my-app-name" }
+
+  # ... or dynamic context
+  config.context do
+    { random_thing: SecureRandom.uuid }
+  end
+
+  # $stdout by default
+  config.output = StringIO.new
+end
+
+Metrics.log "Hello world"                 # => hello-world
+
+Metrics.log :foo, :bar, fizz: :buzz       # => foo bar fizz=buzz
+
+Metrics.log :doing_work do                # => doing-work at=start
+  do_some_work                            #
+end                                       # => doing-work at=finish elapsed=3.1234s
+
+Metrics.log :deez_nutz do                 # => deez-nutz at=start
+  raise ArgumentError, "error here"       #
+end                                       # => deez-nutz at=exception exception=ArgumentError message="error here" elapsed=1.2345s
+```

data/lib/l2meter/configuration.rb

@@ -0,0 +1,51 @@
+module L2meter
+  class Configuration
+    attr_writer :output
+
+    def output
+      @output ||= $stdout
+    end
+
+    def key_formatter
+      @key_formatter ||= ->(key) do
+        key.to_s.strip.downcase.gsub(/[^-a-z\d]+/, ?-)
+      end
+    end
+
+    def format_keys(&block)
+      @key_formatter = block
+    end
+
+    def value_formatter
+      @value_formatter ||= ->(value) do
+        value = value.to_s
+        value =~ /\s/ ? value.inspect : value
+      end
+    end
+
+    def format_values(&block)
+      @value_formatter = block
+    end
+
+    def sort?
+      defined?(@apply_sort) ? @apply_sort : false
+    end
+
+    def sort=(value)
+      @apply_sort = !!value
+    end
+
+    def context(&block)
+      @context_block = block
+    end
+
+    def context=(value)
+      @static_context = value
+    end
+
+    def get_context
+      return @static_context if @static_context
+      @context_block ? @context_block.call.to_h : {}
+    end
+  end
+end

data/lib/l2meter/emitter.rb

@@ -0,0 +1,55 @@
+module L2meter
+  class Emitter
+    attr_reader :configuration
+
+    def initialize(configuration: Configuration.new)
+      @configuration = configuration
+    end
+
+    def log(*args, **params)
+      args = args.map { |key| [ key, true ] }.to_h
+      params = args.merge(params)
+      params = context.merge(params)
+
+      if block_given?
+        wrap params, &Proc.new
+      else
+        write params
+      end
+    end
+
+    private
+
+    def context
+      configuration.get_context
+    end
+
+    def write(params)
+      tokens = params.map do |key, value|
+        key = configuration.key_formatter.call(key)
+        next key if value == true
+        value = configuration.value_formatter.call(value)
+        [ key, value ] * ?=
+      end
+
+      tokens.sort! if configuration.sort?
+
+      configuration.output.puts tokens.join(" ")
+    end
+
+    def wrap(params)
+      time_at_start = Time.now
+      write params.merge(at: :start)
+      yield
+    rescue => error
+      status = { at: :exception, exception: error.class.to_s, message: error.message.strip }
+      raise
+    else
+      status = { at: :finish }
+    ensure
+      elapsed = Time.now - time_at_start
+      status.merge! elapsed: "%.4fs" % elapsed
+      write params.merge(status)
+    end
+  end
+end

data/lib/l2meter/version.rb

@@ -0,0 +1,3 @@
+module L2meter
+  VERSION = "0.0.1".freeze
+end

data/lib/l2meter.rb

@@ -0,0 +1,14 @@
+require "l2meter/version"
+
+module L2meter
+  extend self
+
+  autoload :Configuration, "l2meter/configuration"
+  autoload :Emitter,       "l2meter/emitter"
+
+  def build
+    Emitter.new.tap do |emitter|
+      yield emitter.configuration if block_given?
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: l2meter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pavel Pravosud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-09 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- pavel@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/l2meter.rb
+- lib/l2meter/configuration.rb
+- lib/l2meter/emitter.rb
+- lib/l2meter/version.rb
+homepage: https://github.com/heroku/l2meter
+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.4.8
+signing_key: 
+specification_version: 4
+summary: L2met friendly log formatter
+test_files: []