rack-logstash-writer 1.0.3

data/examples/regular rack file/config.ru

@@ -0,0 +1,31 @@
+puts File.expand_path("../lib" , __FILE__)
+$:.unshift File.expand_path("../lib" , __FILE__)
+require 'rack/logstash-writer'
+
+# Example for using this with rack
+class JSONServer
+  def call(env)
+    [200, {"Content-Type" => "application/json"}, ['{ "message" : "Hello!" }']]
+  end
+end
+
+class JSONServerError
+  def call(env)
+    [555, {"Content-Type" => "application/json"}, ['{ "message" : "Goodbye mr error, this is an error for sure." }']]
+  end
+end
+
+use Rack::LogstashWriter , {url: "file:///home/org/Desktop/logsample", # or another examples   "udp://localhost:5228" #  "tcp://localhost:5228"
+    request_headers: {'head1'=>'head1'},
+    response_headers: {'head1'=>'head1'},
+    statuses: [*(500..600)] ,
+    body_len: 50 }
+
+map '/hello.json' do
+  run JSONServer.new
+end
+
+map '/goodbye.json' do
+  run JSONServerError.new
+end
+

data/examples/sinatra-project/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "rack-logstash-writer"
+gem 'rake'
+gem 'rack'
+gem 'sinatra'
+

data/examples/sinatra-project/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: https://rubygems.org/
+  remote: http://gems.kontera.com/
+  specs:
+    rack (1.6.1)
+    rack-logstash-writer (0.0.1)
+      rake (~> 10.0)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack
+  rack-logstash-writer
+  rake
+  sinatra

data/examples/sinatra-project/config.ru

@@ -0,0 +1,10 @@
+require 'rack/logstash-writer'
+
+# Rails.root/config.ru
+require ::File.expand_path('../lib/sinatra', __FILE__)
+
+# use Rails::Rack::Debugger
+# use Rack::ContentLength
+use Rack::LogstashWriter, {url: "file:///home/org/Desktop/logsample" ,statuses: [*(200..600)], body_len: 0, #response_headers: {'User-agent'=>'ua-nimrod'},
+                           request_headers: {'User-agent'=>'ua-nimrod'}} #"udp://localhost:5228" #  "udp://localhost:5228"
+run Sinatra::Application

data/examples/sinatra-project/lib/sinatra.rb

@@ -0,0 +1,15 @@
+# myapp.rb
+require 'sinatra'
+
+get '/' do
+  'Hello world!'
+end
+
+get '/hello/:name' do |n|
+  ssdaasdsdwads
+  # matches "GET /hello/foo" and "GET /hello/bar"
+  # params['name'] is 'foo' or 'bar'
+  # n stores params['name']
+  "Hello #{n}!"
+end
+

data/lib/rack/logstash-writer/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class LogstashWriter
+    VERSION = "1.0.3"
+  end
+end

data/lib/rack/logstash-writer.rb

@@ -0,0 +1,100 @@
+require 'socket'
+require 'uri'
+require 'json'
+
+module Rack
+
+  class LogstashWriter
+
+    # Initialize a new Rack adapter, logstash writer
+    # @param [Hash] options
+    # @option options [String] :url: required, udp and files schemes are also avaliable. no default values.
+    # @option options [Hash] :request_headers,optional, parameters to add to the report from the request headers. default nil
+    # @option options [Hash] :response_headers, optional, parameters to add to the report from the responce headers. default nil
+    # @option options [Fixnum] :body_len, optional, include the first given chars from the body. default 1000
+    # @option options [Array] :statuses, optional, send events to log stash only for those statuses. default [*(500..600)]
+    def initialize app, options = {} #, statuses = [*(500..600)] , body_len = 1000 , url
+      @app = app
+      @options = validate defaults.merge options
+      @options[:url]= URI(@options[:url])
+    end
+
+    # Call to the app cal and log if the returned status is in the array of return data.
+    # @param [Hash] env : the enviroment
+    def call env
+      began = Time.now
+      s, h, b = @app.call env
+      b = BodyProxy.new(b) { log(env, s, h, began, b) } if @options[:statuses].include? s.to_i
+      [s, h, b]
+    end
+
+    # Return the correct connection by the uri - udp/tcp/file
+    private
+    def defaults
+         { request_headers: nil, response_headers: nil, statuses: [*(500..600)], body_len: 1000 }
+      end
+
+    def validate opt
+      opt.tap { raise ":url is required" unless opt[:url] }
+    end
+
+    def device
+      @device ||=
+          case @options[:url].scheme
+            when "file" then
+              ::File.new(@options[:url].path,"a").tap {|f| f.sync=true}
+            when "udp" then
+              UDPSocket.new.tap { |s| s.connect @options[:url].host, @options[:url].port}
+            when "tcp" then
+              TCPSocket.new @options[:url].host,@options[:url].port
+            else
+              raise "Unknown scheme #{@options[:url].scheme}"
+          end
+    end
+
+    # Log to the device the data
+    def log(env, status, response_headers, began_at, body)
+      data = {
+          :method => env["REQUEST_METHOD"],
+          :path => env["PATH_INFO"],
+          :query_string => env["QUERY_STRING"],
+          :status => status.to_i,
+          :duration => (Time.now - began_at),
+          :remote_addr => env['REMOTE_ADDR'],
+          :request => request_line(env),
+          :length => extract_content_length(response_headers),
+          :"X-Forwarded-For" => response_headers['X-Forwarded-For']
+      }
+
+      if(body.is_a? String)
+        data[:body] = body.join[0..@options[:body_len]]
+      elsif body.is_a? BodyProxy
+         (body.respond_to?(:body) ? data[:body] = body.body: data[:body] = body)
+         data[:body] = data[:body].join[0..@options[:body_len]]
+      end
+      @options[:request_headers].each { |header, log_key| env_key = "HTTP_#{header.upcase.gsub('-', '_')}" ; data[log_key] = env[env_key] if env[env_key]} if !@options[:request_headers].nil?
+      @options[:response_headers].each { |header, log_key| data[log_key] = response_headers[header] if response_headers[header] } if !@options[:response_headers].nil?
+
+      data[:error_msg] = env["sinatra.error"] if env.has_key?("sinatra.error")
+
+      event = {'@fields' => data, '@tags' => ['request'], '@timestamp' => ::Time.now.utc, '@version' => 1}
+      begin
+        device.puts( event.to_json + '\n' )
+      rescue Errno::EPIPE, Errno::EINVAL
+        @device = nil
+      end
+    end
+
+    def request_line env
+      line = "#{env["REQUEST_METHOD"]} #{env["SCRIPT_NAME"]}#{env['PATH_INFO']}"
+      line << "?#{env["QUERY_STRING"]}" if env["QUERY_STRING"] and ! env["QUERY_STRING"].empty?
+      line << " #{env["SERVER_PROTOCOL"]}"
+      line
+    end
+
+    def extract_content_length headers
+      value = headers[CONTENT_LENGTH] or return '-'
+      value.to_s == '0' ? '-' : value
+    end
+  end
+end

data/rack-logstash-writer.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rack/logstash-writer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-logstash-writer"
+  spec.version       = Rack::LogstashWriter::VERSION
+  spec.authors       = ["or garfunkel"]
+  spec.email         = ["or@amobee.com"]
+  spec.summary       = %q{Rack adapter for sending events to logstash server, from the chosen statuses code.}
+  spec.description   = %q{Rack adapter for sending events to logstash server, from the chosen statuses code, can send event to file/udp/tcp servers.}
+  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_dependency "rake", "~> 10.0"
+
+end

data/test/unit/logstash_writer_tests.rb

@@ -0,0 +1,47 @@
+require_relative '../units_helper'
+
+module Rack
+    class LogstashWriterTests < UnitsHelper
+
+      class JSONServer
+        def call(env)
+          [200, {"Content-Type" => "application/json"}, ['{ "message" : "Hello!" }']]
+        end
+      end
+
+      class JSONServerError
+        def call(env)
+          [555, {"Content-Type" => "application/json"}, ['{ "message" : "Goodbye mr error, this is an error for sure." }']]
+        end
+      end
+
+
+      def test_general_working_no_error
+        logstash = LogstashWriter.new JSONServer.new, url: "udp://localhost:8086"
+        s,h,b = logstash.call ENV
+        assert_equal(s , 200)
+        assert_equal(h , {"Content-Type" => "application/json"})
+        assert_equal(b , ['{ "message" : "Hello!" }'])
+      end
+
+      def test_udp
+          logstash = LogstashWriter.new JSONServerError.new, url:"udp://localhost:8086"
+          s, h, b = logstash.call ENV
+          assert_equal(s , 555)
+          assert_equal(h , {"Content-Type" => "application/json"})
+          assert_equal( b.class.to_s ,"Rack::BodyProxy" )
+      end
+
+      def test_file
+        begin
+          logstash = LogstashWriter.new JSONServerError.new, url:"file://not_existing_file"
+          s, h, b = logstash.call ENV
+          b.close
+        rescue Exception => e
+          puts e
+          assert_includes(e.to_s , "No such file or directory @ rb_sysopen -")
+        end
+      end
+
+    end
+end

data/test/units_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path("../../lib" , __FILE__)
+require 'minitest'
+require "minitest/autorun"
+require "minitest/mock"
+require "rack/logstash-writer"
+require 'rack'
+
+# TODO - is there a real need for this
+module Rack
+  class UnitsHelper < Minitest::Test
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rack-logstash-writer
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- or garfunkel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Rack adapter for sending events to logstash server, from the chosen statuses
+  code, can send event to file/udp/tcp servers.
+email:
+- or@amobee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/rails-project/Gemfile
+- examples/rails-project/Gemfile.lock
+- examples/rails-project/README.rdoc
+- examples/rails-project/Rakefile
+- examples/rails-project/app/assets/images/.keep
+- examples/rails-project/app/assets/javascripts/application.js
+- examples/rails-project/app/assets/stylesheets/application.css
+- examples/rails-project/app/controllers/application_controller.rb
+- examples/rails-project/app/controllers/concerns/.keep
+- examples/rails-project/app/helpers/application_helper.rb
+- examples/rails-project/app/mailers/.keep
+- examples/rails-project/app/models/.keep
+- examples/rails-project/app/models/concerns/.keep
+- examples/rails-project/app/views/layouts/application.html.erb
+- examples/rails-project/bin/bundle
+- examples/rails-project/bin/rails
+- examples/rails-project/bin/rake
+- examples/rails-project/bin/setup
+- examples/rails-project/bin/spring
+- examples/rails-project/config.ru
+- examples/rails-project/config/application.rb
+- examples/rails-project/config/boot.rb
+- examples/rails-project/config/database.yml
+- examples/rails-project/config/environment.rb
+- examples/rails-project/config/environments/development.rb
+- examples/rails-project/config/environments/production.rb
+- examples/rails-project/config/environments/test.rb
+- examples/rails-project/config/initializers/assets.rb
+- examples/rails-project/config/initializers/backtrace_silencers.rb
+- examples/rails-project/config/initializers/cookies_serializer.rb
+- examples/rails-project/config/initializers/filter_parameter_logging.rb
+- examples/rails-project/config/initializers/inflections.rb
+- examples/rails-project/config/initializers/mime_types.rb
+- examples/rails-project/config/initializers/session_store.rb
+- examples/rails-project/config/initializers/wrap_parameters.rb
+- examples/rails-project/config/locales/en.yml
+- examples/rails-project/config/routes.rb
+- examples/rails-project/config/secrets.yml
+- examples/rails-project/db/development.sqlite3
+- examples/rails-project/db/seeds.rb
+- examples/rails-project/lib/assets/.keep
+- examples/rails-project/lib/tasks/.keep
+- examples/rails-project/log/.keep
+- examples/rails-project/log/development.log
+- examples/rails-project/public/404.html
+- examples/rails-project/public/422.html
+- examples/rails-project/public/500.html
+- examples/rails-project/public/favicon.ico
+- examples/rails-project/public/robots.txt
+- examples/rails-project/test/controllers/.keep
+- examples/rails-project/test/fixtures/.keep
+- examples/rails-project/test/helpers/.keep
+- examples/rails-project/test/integration/.keep
+- examples/rails-project/test/mailers/.keep
+- examples/rails-project/test/models/.keep
+- examples/rails-project/test/test_helper.rb
+- examples/rails-project/vendor/assets/javascripts/.keep
+- examples/rails-project/vendor/assets/stylesheets/.keep
+- examples/regular rack file/config.ru
+- examples/sinatra-project/Gemfile
+- examples/sinatra-project/Gemfile.lock
+- examples/sinatra-project/config.ru
+- examples/sinatra-project/lib/sinatra.rb
+- lib/rack/logstash-writer.rb
+- lib/rack/logstash-writer/version.rb
+- rack-logstash-writer.gemspec
+- test/unit/logstash_writer_tests.rb
+- test/units_helper.rb
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Rack adapter for sending events to logstash server, from the chosen statuses
+  code.
+test_files:
+- test/unit/logstash_writer_tests.rb
+- test/units_helper.rb