vx-lib-instrumentation 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff72ddb7a88101050f23d3b0db56c0da7ae6b572
+  data.tar.gz: 2494e7d6263470e413b384abb6d2d182ea518b8c
+SHA512:
+  metadata.gz: 6e9c21e8460dc11e54117e2aa1e949e512319c149483075250588a40d14512c169cb00255080eaf9a640b6bdfdd0c2d766b9142427d2215c37e0a2d9aca37766
+  data.tar.gz: f185366f214dcf37d10e3a848b36a2f03d91b50cc7d745022a0d8fee4f08f3ea29d95e38c592167648283bc39d01b2d5a329b06df2bce3f259fcde16f127672b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-fd
+--order=rand

data/.travis.yml

@@ -0,0 +1 @@
+script: "rspec spec/"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vx-instrumentation.gemspec
+gemspec
+
+group :development do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dmitry Galinsky
+
+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,29 @@
+# Vx::Instrumentation
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vx-instrumentation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vx-instrumentation
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/vx-instrumentation/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vx/lib/instrumentation/logger.rb

@@ -0,0 +1,103 @@
+require 'json'
+require 'logger'
+require 'active_support/core_ext/hash/deep_merge'
+
+module Vx ; module Lib ; module Instrumentation
+
+  class Logger
+
+    def initialize(device)
+      @device = device
+    end
+
+    def method_missing(sym, *args, &block)
+      if @device.respond_to?(sym)
+        begin
+          @device.send(sym, *args, &block)
+        rescue Exception => e
+          $stderr.puts "#{e.class.to_s}, #{e.message.inspect} [#{sym.inspect} #{args.inspect}]"
+          $stderr.puts e.backtrace.map{|b| "\t#{b}" }.join("\n")
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to?(sym)
+      @device.respond_to?(sym)
+    end
+
+    class << self
+      attr_accessor :logger
+
+      def setup(target)
+        log = ::Logger.new(target, 7, 50_000_000)
+        log.formatter = Lib::Instrumentation::Logger::Formatter
+        @logger = new(log)
+      end
+    end
+
+    class Formatter
+
+      def self.safe_value(value, options = {})
+        new_value = case value.class.to_s
+          when "String", "Fixnum", "Float"
+            value
+          when "Symbol", "BigDecimal"
+            value.to_s
+          when "Array"
+            value = value.map(&:to_s)
+            options[:join_arrays] ? value.join("\n") : value
+          when 'NilClass'
+            nil
+          else
+            value.inspect
+          end
+        if new_value.is_a?(String)
+          new_value.encode('UTF-8', {:invalid => :replace, :undef => :replace, :replace => '?'})
+        else
+          new_value
+        end
+      end
+
+      def self.make_safe_hash(msg, options = {})
+        msg.inject({}) do |acc, pair|
+          msg_key, msg_value = pair
+
+          if msg_key == "@fields"
+            acc[msg_key] = make_safe_hash(msg_value, join_arrays: true)
+          else
+            acc[msg_key] = safe_value(msg_value, options)
+          end
+          acc
+        end
+      end
+
+      def self.call(severity, _, _, msg)
+        values = Lib::Instrumentation.default.dup
+
+        case
+        when msg.is_a?(Hash)
+          values.deep_merge! msg
+        when msg.respond_to?(:to_h)
+          values.merge! msg.to_h
+        else
+          values.deep_merge!(message: msg)
+        end
+
+        values.deep_merge!(severity: severity.to_s.downcase)
+
+        values = make_safe_hash(values)
+
+        if ENV['VX_INSTRUMENTATION_PRETTY']
+          ::JSON.pretty_generate(values) + "\n"
+        else
+          ::JSON.dump(values) + "\n"
+        end
+      end
+
+    end
+
+  end
+
+end ; end ; end

data/lib/vx/lib/instrumentation/probe/action_controller.rb

@@ -0,0 +1,6 @@
+require 'active_support/notifications'
+
+ActiveSupport::Notifications.subscribe(/\.action_controller$/) do |event, started, finished, _, payload|
+  Vx::Lib::Instrumentation.delivery event, payload, event.split("."), started, finished
+end
+

data/lib/vx/lib/instrumentation/probe/action_dispatch.rb

@@ -0,0 +1,15 @@
+require 'active_support/notifications'
+
+ActiveSupport::Notifications.subscribe(/\.action_dispatch$/) do |event, started, finished, _, payload|
+  req = payload[:request]
+  payload = {
+    path:           req.fullpath,
+    ip:             req.remote_ip,
+    method:         req.method,
+    referer:        req.referer,
+    content_length: req.content_length,
+    user_agent:     req.user_agent
+  }
+  Vx::Lib::Instrumentation.delivery event, payload, event.split("."), started, finished
+end
+

data/lib/vx/lib/instrumentation/probe/action_mailer.rb

@@ -0,0 +1,6 @@
+require 'active_support/notifications'
+
+ActiveSupport::Notifications.subscribe(/\.action_mailer$/) do |event, started, finished, _, payload|
+  Vx::Lib::Instrumentation.delivery event, payload, event.split("."), started, finished
+end
+

data/lib/vx/lib/instrumentation/probe/action_view.rb

@@ -0,0 +1,8 @@
+require 'active_support/notifications'
+require 'vx/instrumentation'
+
+ActiveSupport::Notifications.subscribe(/\.action_view$/) do |event, started, finished, _, payload|
+  if event[0] != "!"
+    Vx::Lib::Instrumentation.delivery event, payload, event.split("."), started, finished
+  end
+end

data/lib/vx/lib/instrumentation/probe/active_record.rb

@@ -0,0 +1,26 @@
+require 'active_support/notifications'
+
+ActiveSupport::Notifications.subscribe(/\.active_record$/) do |event, started, finished, _, payload|
+
+  binds =
+    (payload[:binds] || []).map do |column, value|
+      if column
+        if column.binary?
+          value = "<#{value.bytesize} bytes of binary data>"
+        end
+        [column.name, value]
+      else
+        [nil, value]
+      end
+    end.inspect
+
+  payload = {
+    sql:      payload[:sql],
+    binds:    binds,
+    name:     payload[:name],
+    duration: payload[:duration]
+  }
+
+  Vx::Lib::Instrumentation.delivery event, payload, event.split("."), started, finished
+end
+

data/lib/vx/lib/instrumentation/probe/active_support.rb

@@ -0,0 +1,6 @@
+require 'active_support/notifications'
+
+ActiveSupport::Notifications.subscribe(/\.active_support$/) do |event, started, finished, _, payload|
+  Vx::Lib::Instrumentation.delivery event, payload, event.split("."), started, finished
+end
+

data/lib/vx/lib/instrumentation/probe/faraday.rb

@@ -0,0 +1,24 @@
+require 'active_support/notifications'
+
+ActiveSupport::Notifications.subscribe(/\.faraday$/) do |event, started, finished, _, payload|
+
+  render_http_header = ->(headers) {
+    (headers || []).map do |key,value|
+      if %{ PRIVATE-TOKEN Authorization }.include?(key)
+        value = value.gsub(/./, "*")
+      end
+      "#{key}: #{value}"
+    end.join("\n")
+  }
+
+  payload = {
+    method:           payload[:method],
+    url:              payload[:url].to_s,
+    status:           payload[:status],
+    response_headers: render_http_header.call(payload[:response_headers]),
+    request_headers:  render_http_header.call(payload[:request_headers])
+  }
+
+  Vx::Lib::Instrumentation.delivery event, payload, event.split("."), started, finished
+end
+

data/lib/vx/lib/instrumentation/rack/handle_exceptions_middleware.rb

@@ -0,0 +1,51 @@
+module Vx ; module Lib ; module Instrumentation
+  module Rack
+
+    HandleExceptionsMiddleware = Struct.new(:app) do
+
+      IGNORED_EXCEPTIONS = %w{
+        ActionController::RoutingError
+      }
+
+      def clean_env(env)
+        env = env.select{|k,v| k !~ /^(action_dispatch|puma|session|rack\.session|action_controller)/ }
+        env['HTTP_COOKIE'] &&= env['HTTP_COOKIE'].scan(/.{80}/).join("\n")
+        env
+      end
+
+      def notify(exception, env)
+        unless ignore?(exception)
+          Lib::Instrumentation.handle_exception(
+            'handle_exception.rack',
+            exception,
+            clean_env(env)
+          )
+        end
+      end
+
+      def call(env)
+        begin
+          response = app.call(env)
+        rescue Exception => ex
+          notify ex, env
+          raise ex
+        end
+
+        if ex = framework_exception(env)
+          notify ex, env
+        end
+
+        response
+      end
+
+      def framework_exception(env)
+        env['rack.exception'] || env['action_dispatch.exception']
+      end
+
+      def ignore?(ex)
+        IGNORED_EXCEPTIONS.include? ex.class.name
+      end
+
+    end
+  end
+end ; end ; end

data/lib/vx/lib/instrumentation/stderr.rb

@@ -0,0 +1,10 @@
+module Vx ; module Lib ; module Instrumentation
+  module Stderr
+
+    def notify_stderr(e)
+      backtrace = e.backtrace || []
+      puts "#{backtrace.first}: #{e.message} (#{e.class})", backtrace.drop(1).map{|s| "\t#{s}"}
+    end
+
+  end
+end ; end ; end

data/lib/vx/lib/instrumentation/version.rb

@@ -0,0 +1,3 @@
+module Vx ; module Lib ; module Instrumentation
+  VERSION = "0.1.9"
+end ; end ; end

data/lib/vx/lib/instrumentation.rb

@@ -0,0 +1,83 @@
+require 'thread'
+
+require File.expand_path("../instrumentation/version",  __FILE__)
+require File.expand_path("../instrumentation/logger",   __FILE__)
+require File.expand_path("../instrumentation/stderr",   __FILE__)
+require File.expand_path("../instrumentation/rack/handle_exceptions_middleware", __FILE__)
+
+module Vx ; module Lib ; module Instrumentation
+
+  extend Lib::Instrumentation::Stderr
+
+  DATE_FORMAT = '%Y-%m-%dT%H:%M:%S.%N%z'
+  THREAD_KEY  = 'vx_lib_instrumentation_keys'
+
+  extend self
+
+  def root
+    File.expand_path("../", __FILE__)
+  end
+
+  def activate!
+    Dir[root + "/*.rb"].each do |f|
+      require f
+    end
+  end
+
+  def install(target, log_level = 0)
+    $stdout.puts " --> activate Vx::Instrumentation, log stored in #{target}"
+    Lib::Instrumentation::Logger.setup target
+    Lib::Instrumentation::Logger.logger.level = log_level
+
+    activate!
+  end
+
+  def with(new_keys)
+    old_keys = Thread.current[THREAD_KEY]
+    begin
+      Thread.current[THREAD_KEY] = (old_keys || {}).merge(new_keys)
+      yield if block_given?
+    ensure
+      Thread.current[THREAD_KEY] = old_keys
+    end
+  end
+
+  def default
+    Thread.current[THREAD_KEY] || {}
+  end
+
+  def handle_exception(event, ex, env = {})
+    tags = event.split(".")
+    tags << "exception"
+    tags.uniq!
+
+    payload = {
+      "@event"     => event,
+      "@timestamp" => Time.now.strftime(DATE_FORMAT),
+      "@tags"      => tags,
+      "@fields"    => env,
+      process_id:  Process.pid,
+      thread_id:   Thread.current.object_id,
+      exception:   ex.class.to_s,
+      message:     ex.message.to_s,
+      backtrace:   (ex.backtrace || []).map(&:to_s).join("\n"),
+    }
+
+    notify_stderr(ex)
+    Lib::Instrumentation::Logger.logger.error(payload)
+  end
+
+  def delivery(name, payload, tags, started, finished)
+    Lib::Instrumentation::Logger.logger.log(
+      ::Logger::INFO,
+      "@event"      => name,
+      process_id:  Process.pid,
+      thread_id:   Thread.current.object_id,
+      "@timestamp"  => started.strftime(DATE_FORMAT),
+      "@duration"   => (finished - started).to_f,
+      "@fields"     => payload,
+      "@tags"       => tags
+    )
+  end
+
+end ; end ; end

data/spec/lib/instrumentation_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Vx::Lib::Instrumentation do
+  let(:out)  { StringIO.new }
+  let(:inst) { described_class }
+  let(:result) {
+    out.rewind
+    JSON.parse out.read
+  }
+
+  it "should successfully install" do
+    expect(inst.install out).to be
+  end
+
+  it "should work with default values" do
+    inst.with(x: "y") do
+      inst.with(a: "b") do
+        expect(inst.default).to eq(
+          x: "y",
+          a: "b"
+        )
+      end
+      expect(inst.default).to eq(x: "y")
+    end
+    expect(inst.default).to eq({})
+  end
+
+  it "should handle exception" do
+    inst::Logger.setup out
+    ex = Exception.new("message")
+    inst.handle_exception('event.name', ex, {key: "value"})
+    expect(result["@event"]).to eq 'event.name'
+    expect(result["@tags"]).to eq ["event", "name", "exception"]
+    expect(result["@fields"]).to eq("key" => "value")
+    expect(result["exception"]).to eq 'Exception'
+    expect(result["message"]).to eq 'message'
+  end
+end

data/spec/lib/logger_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Vx::Lib::Instrumentation::Logger do
+  let(:out)    { StringIO.new }
+  let(:logger) { described_class.setup out }
+  let(:result) {
+    out.rewind
+    JSON.parse(out.read)
+  }
+
+  it "should write string mesage" do
+    logger.info "I am string"
+    expect(result).to eq(
+      "message"  => "I am string",
+      "severity" => "info"
+    )
+  end
+
+  it "should write a simple hash" do
+    logger.info(key: "value")
+    expect(result).to eq(
+      'key'      => 'value',
+      "severity" => "info"
+    )
+  end
+
+  it "should write a nested hash" do
+    logger.info(
+      root: {
+        child: {
+          subchild: "value"
+        }
+      }
+    )
+    expect(result).to eq(
+      "root"     => "{:child=>{:subchild=>\"value\"}}",
+      "severity" => "info"
+    )
+  end
+
+  it "should write nested hash with @fields" do
+    logger.info(
+      "@fields" => {
+        child: {
+          subchild: "value"
+        }
+      }
+    )
+    expect(result).to eq(
+      "@fields" => {
+        "child"=>"{:subchild=>\"value\"}"
+      },
+      "severity" => "info"
+    )
+  end
+
+  it "should write nested hash with arrays" do
+    logger.info(
+      a: %w{ 1 2 3 },
+      "@fields" => {
+        c: %w{ 4 5 6 }
+      }
+    )
+    expect(result).to eq(
+      "a" => ["1", "2", "3"],
+      "@fields" => {
+        "c" => "4\n5\n6"
+      },
+      "severity" => "info"
+    )
+  end
+
+  it "should work with default values" do
+    Vx::Lib::Instrumentation.with(foo: "bar") do
+      logger.info(key: "value")
+    end
+    expect(result).to eq(
+      "foo" => "bar",
+      "key" => "value",
+      "severity" => "info"
+    )
+  end
+
+  it "should work with nested default values" do
+    Vx::Lib::Instrumentation.with("@fields" => {a: 1}) do
+      logger.info("@fields" => {b: 2})
+    end
+    expect(result).to eq(
+      "@fields" => {"a"=>1, "b"=>2},
+      "severity" => "info"
+    )
+  end
+end

data/spec/lib/rack/handle_exceptions_middleware_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Vx::Lib::Instrumentation::Rack::HandleExceptionsMiddleware do
+  let(:env)        { {} }
+  let(:app)        { ->(e){ e.merge(foo: :bar) } }
+  let(:output)     { StringIO.new }
+  let(:middleware) { described_class.new(app) }
+  let(:result) {
+    output.rewind
+    c = output.read
+    if c.to_s != ""
+      JSON.parse c
+    end
+  }
+
+  before do
+    Vx::Lib::Instrumentation::Logger.setup output
+  end
+
+  it "should work when no exceptions raised" do
+    expect(middleware.call(env)).to eq(foo: :bar)
+    expect(result).to be_nil
+  end
+
+  it "should catch raised exception" do
+    app = ->(_) { raise RuntimeError, "Ignore Me" }
+    mid = described_class.new(app)
+    expect{ mid.call(env) }.to raise_error(RuntimeError, 'Ignore Me')
+
+    expect(result["@tags"]).to eq ["handle_exception", "rack", "exception"]
+    expect(result["@event"]).to eq 'handle_exception.rack'
+    expect(result['exception']).to eq 'RuntimeError'
+    expect(result['message']).to eq 'Ignore Me'
+    expect(result['backtrace']).to_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require File.expand_path("../../lib/vx/lib/instrumentation", __FILE__)
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+end

data/vx-lib-instrumentation.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vx/lib/instrumentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vx-lib-instrumentation"
+  spec.version       = Vx::Lib::Instrumentation::VERSION
+  spec.authors       = ["Dmitry Galinsky"]
+  spec.email         = ["dima.exe@gmail.com"]
+  spec.summary       = %q{ summary }
+  spec.description   = %q{ description }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: vx-lib-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.9
+platform: ruby
+authors:
+- Dmitry Galinsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: " description "
+email:
+- dima.exe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vx/lib/instrumentation.rb
+- lib/vx/lib/instrumentation/logger.rb
+- lib/vx/lib/instrumentation/probe/action_controller.rb
+- lib/vx/lib/instrumentation/probe/action_dispatch.rb
+- lib/vx/lib/instrumentation/probe/action_mailer.rb
+- lib/vx/lib/instrumentation/probe/action_view.rb
+- lib/vx/lib/instrumentation/probe/active_record.rb
+- lib/vx/lib/instrumentation/probe/active_support.rb
+- lib/vx/lib/instrumentation/probe/faraday.rb
+- lib/vx/lib/instrumentation/rack/handle_exceptions_middleware.rb
+- lib/vx/lib/instrumentation/stderr.rb
+- lib/vx/lib/instrumentation/version.rb
+- spec/lib/instrumentation_spec.rb
+- spec/lib/logger_spec.rb
+- spec/lib/rack/handle_exceptions_middleware_spec.rb
+- spec/spec_helper.rb
+- vx-lib-instrumentation.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: summary
+test_files:
+- spec/lib/instrumentation_spec.rb
+- spec/lib/logger_spec.rb
+- spec/lib/rack/handle_exceptions_middleware_spec.rb
+- spec/spec_helper.rb