rails-logstasher 0.1.0

data/test/rack/logger_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+# TODO These tests are fragile because they rely on the output being added
+# to the last line of the log file. See if there is a better way to do this
+class LoggerTest < ActiveSupport::IntegrationCase
+  class MyLogger < RailsLogstasher::Logger
+    def flush(*)
+    end
+
+  end
+
+  setup do
+    @output = StringIO.new
+    Rails.logger = RailsLogstasher::TaggedLogging.new(MyLogger.new(@output))
+    visit('/widgets')
+  end
+
+  test 'writes a hash to the log file when a request is received' do
+    assert_equal Hash, entry.class
+  end
+
+  test 'fills in the client_ip' do
+    assert_equal "127.0.0.1", entry['@fields']['client_ip']
+  end
+
+  test 'fills in the method' do
+    assert_equal "GET", entry['@fields']['method']
+  end
+
+  test 'fills in the path' do
+    assert_equal "/widgets", entry['@fields']['path']
+  end
+
+  test 'fills in the status' do
+    assert_equal "/widgets", entry['@fields']['path']
+  end
+
+  test 'fills in the total_duration' do
+    assert entry['@fields']['total_duration'].to_f >= 0, "total_duration was not a positive number"
+  end
+
+  test 'fills in the rendering_duration' do
+    assert entry['@fields']['rendering_duration'].to_f >= 0, "rendering_duration was not a positive number"
+  end
+
+  test 'fills in the sql_duration' do
+    assert entry['@fields']['rendering_duration'].to_f >= 0, "sql_duration was not a positive number"
+  end
+
+  test 'fills in the method name tag' do
+    assert_equal 32, entry['@fields']['uuid'].size
+  end
+
+  test 'fills in the string tag' do
+    assert_match "Hello", entry['@tags'].first
+  end
+
+  test 'fills in the proc tag' do
+    assert_match "Proc", entry['@tags'].last
+  end
+
+  #TODO Add tests for view and SQL rendering summaries
+
+  def entry
+    JSON.parse(@output.string)
+  end
+
+end

data/test/rails_logstasher_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class RailsLogstasherTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, RailsLogstasher
+  end
+end

data/test/support/fake_models.rb

@@ -0,0 +1,12 @@
+require "active_model"
+
+class Customer < Struct.new(:name, :id)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+end
+
+class BadCustomer < Customer
+end
+
+class GoodCustomer < Customer
+end

data/test/support/integration_case.rb

@@ -0,0 +1,5 @@
+# Define a bare test case to use with Capybara
+class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
+  include Capybara::DSL
+  include Rails.application.routes.url_helpers
+end

data/test/support/multibyte_test_helpers.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module MultibyteTestHelpers
+  UNICODE_STRING = 'こにちわ'
+  ASCII_STRING = 'ohayo'
+  BYTE_STRING = "\270\236\010\210\245".force_encoding("ASCII-8BIT")
+
+  def chars(str)
+    ActiveSupport::Multibyte::Chars.new(str)
+  end
+
+  def inspect_codepoints(str)
+    str.to_s.unpack("U*").map{|cp| cp.to_s(16) }.join(' ')
+  end
+
+  def assert_equal_codepoints(expected, actual, message=nil)
+    assert_equal(inspect_codepoints(expected), inspect_codepoints(actual), message)
+  end
+end

data/test/tagged_logging_test.rb

@@ -0,0 +1,155 @@
+require 'rails_logstasher/logger'
+require 'rails_logstasher/tagged_logging'
+
+class TaggedLoggingTest < ActiveSupport::TestCase
+  class MyLogger < RailsLogstasher::Logger
+  end
+
+  setup do
+    @output = StringIO.new
+    @logger = RailsLogstasher::TaggedLogging.new(MyLogger.new(@output))
+  end
+
+  test 'sets logger.formatter if missing and extends it with a tagging API' do
+    logger = ::Logger.new(StringIO.new)
+    # assert_nil logger.formatter #TODO This assertion is failing but I do not think it is end of the world
+    RailsLogstasher::TaggedLogging.new(logger)
+    assert_not_nil logger.formatter
+    assert logger.formatter.respond_to?(:tagged)
+  end
+
+  test 'fills in the severity' do
+    @logger.info "Severity Test"
+    assert_equal "INFO", JSON.parse(@output.string)['@fields']['severity']
+  end
+
+  test "tagged once" do
+    @logger.tagged("BCX") { @logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Funky time", JSON.parse(@output.string)['@message']
+  end
+
+  test "tagged twice" do
+    @logger.tagged("BCX") { @logger.tagged("Jason") { @logger.info "Funky time" } }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Jason", JSON.parse(@output.string)['@tags'][1]
+  end
+
+  test "tagged thrice at once" do
+    @logger.tagged("BCX", "Jason", "New") { @logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Jason", JSON.parse(@output.string)['@tags'][1]
+    assert_equal "New", JSON.parse(@output.string)['@tags'][2]
+  end
+
+  test "tagged are flattened" do
+    @logger.tagged("BCX", %w(Jason New)) { @logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Jason", JSON.parse(@output.string)['@tags'][1]
+    assert_equal "New", JSON.parse(@output.string)['@tags'][2]
+  end
+
+
+  test "push and pop tags directly" do
+    assert_equal %w(A B C), @logger.push_tags('A', ['B', ' ', ['C']])
+    @logger.info 'a'
+    assert_equal %w(C), @logger.pop_tags
+    @logger.info 'b'
+    assert_equal %w(B), @logger.pop_tags(1)
+    @logger.info 'c'
+    assert_equal [], @logger.clear_tags!
+    @logger.info 'd'
+   # assert_equal "[A] [B] [C] a\n[A] [B] b\n[A] c\nd\n",  JSON.parse(@output.string)['@tags']
+
+    first_log = JSON.parse(@output.string.split("\n")[0])
+    assert_equal "A", first_log['@tags'][0]
+    assert_equal "B", first_log['@tags'][1]
+    assert_equal "C", first_log['@tags'][2]
+    assert_equal "a", first_log['@message']
+
+    second_log = JSON.parse(@output.string.split("\n")[1])
+    assert_equal "A", second_log['@tags'][0]
+    assert_equal "B", second_log['@tags'][1]
+    assert_equal "b", second_log['@message']
+
+    third_log = JSON.parse(@output.string.split("\n")[2])
+    assert_equal "A", third_log['@tags'][0]
+    assert_equal "c", third_log['@message']
+
+    fourth_log = JSON.parse(@output.string.split("\n")[3])
+    assert fourth_log['@tags'].empty?
+    assert_equal "d", fourth_log['@message']
+  end
+
+
+
+  test "does not strip message content" do
+    @logger.info " Hello"
+    assert_equal " Hello", JSON.parse(@output.string)['@message']
+  end
+
+  test "provides access to the logger instance" do
+    @logger.tagged("BCX") { |logger| logger.info "Funky time" }
+    assert_equal "BCX", JSON.parse(@output.string)['@tags'][0]
+    assert_equal "Funky time", JSON.parse(@output.string)['@message']
+  end
+
+  test "tagged once with blank and nil" do
+    @logger.tagged(nil, "", "New") { @logger.info "Funky time" }
+    assert_equal "New", JSON.parse(@output.string)['@tags'].last
+  end
+
+  test "keeps each tag in their own thread" do
+    @logger.tagged("BCX") do
+      Thread.new do
+        @logger.tagged("OMG") { @logger.info "Cool story bro" }
+      end.join
+      @logger.info "Funky time"
+    end
+
+    # Sub-thread
+    main_thread = JSON.parse(@output.string.split("\n").first)
+    assert_equal "OMG", main_thread['@tags'][0]
+    assert_equal "Cool story bro", main_thread['@message']
+
+    # Main thread
+    main_thread = JSON.parse(@output.string.split("\n").last)
+    assert_equal "BCX", main_thread['@tags'][0]
+    assert_equal "Funky time", main_thread['@message']
+  end
+
+  test "cleans up the taggings on flush" do
+    @logger.tagged("BCX") do
+      Thread.new do
+        @logger.tagged("OMG") do
+          @logger.flush
+          @logger.info "Cool story bro"
+        end
+      end.join
+    end
+
+    first_log = JSON.parse(@output.string.split("\n").first)
+    assert first_log['@tags'].empty?
+    assert_equal "Cool story bro", first_log['@message']
+  end
+
+
+  test "mixed levels of tagging" do
+    @logger.tagged("BCX") do
+      @logger.tagged("Jason") { @logger.info "Funky time" }
+      @logger.info "Junky time!"
+    end
+
+    first_log = JSON.parse(@output.string.split("\n").first)
+    assert_equal "BCX", first_log['@tags'][0]
+    assert_equal "Jason", first_log['@tags'][1]
+    assert_equal "Funky time", first_log['@message']
+
+    second_log = JSON.parse(@output.string.split("\n").last)
+    assert_equal "BCX", second_log['@tags'][0]
+    assert_equal "Junky time!", second_log['@message']
+  end
+
+end
+
+

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+unless defined? JRUBY_VERSION
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    add_filter '/test/'
+    add_filter '/vendor/'
+    add_filter '/bin/'
+    add_filter '/.bundle/'
+  end
+end
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Configure capybara for integration testing
+require 'capybara/rails' # Must be required after rails/test_help
+Capybara.default_driver = :rack_test
+Capybara.default_selector = :css
+
+#Run any available migrations
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: rails-logstasher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nadav Fischer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: logstash-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.02
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.02
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Replaces the default string based Ruby on Rails logging system with a
+  Logstash based one
+email:
+- nadav.fischer@capriza.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails_logstasher/event.rb
+- lib/rails_logstasher/core_ext/object/blank.rb
+- lib/rails_logstasher/version.rb
+- lib/rails_logstasher/active_resource/log_subscriber.rb
+- lib/rails_logstasher/rack/logger.rb
+- lib/rails_logstasher/railtie.rb
+- lib/rails_logstasher/logger.rb
+- lib/rails_logstasher/action_view/log_subscriber.rb
+- lib/rails_logstasher/tagged_logging.rb
+- lib/rails_logstasher/action_controller/log_subscriber.rb
+- lib/rails_logstasher/active_record/log_subscriber.rb
+- lib/rails_logstasher.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/support/integration_case.rb
+- test/support/fake_models.rb
+- test/support/multibyte_test_helpers.rb
+- test/test_helper.rb
+- test/core_ext/blank_test.rb
+- test/tagged_logging_test.rb
+- test/logger_test.rb
+- test/active_resource/log_subscriber_test.rb
+- test/rack/logger_test.rb
+- test/action_view/log_subscriber_test.rb
+- test/action_controller/log_subscriber_test.rb
+- test/rails_logstasher_test.rb
+- test/dummy/README.rdoc
+- test/dummy/config.ru
+- test/dummy/Rakefile
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/widgets.js
+- test/dummy/app/assets/stylesheets/scaffold.css
+- test/dummy/app/assets/stylesheets/widgets.css
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/widgets_helper.rb
+- test/dummy/app/controllers/widgets_controller.rb
+- test/dummy/app/controllers/log_subscriber_controller.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/models/widget.rb
+- test/dummy/app/views/widgets/new.html.erb
+- test/dummy/app/views/widgets/show.html.erb
+- test/dummy/app/views/widgets/edit.html.erb
+- test/dummy/app/views/widgets/index.html.erb
+- test/dummy/app/views/widgets/_form.html.erb
+- test/dummy/app/views/good_customers/_good_customer.html.erb
+- test/dummy/app/views/test/_customer.erb
+- test/dummy/app/views/test/hello_world.erb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/customers/_customer.html.erb
+- test/dummy/db/migrate/20120927084605_create_widgets.rb
+- test/dummy/db/schema.rb
+- test/dummy/public/500.html
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/favicon.ico
+- test/dummy/script/rails
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/application.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/locales/en.yml
+- test/active_record/log_subscriber_test.rb
+homepage: https://github.com/capriza/rails-logstasher
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Lostash format replacement for Ruby on Rails logging system
+test_files:
+- test/support/integration_case.rb
+- test/support/fake_models.rb
+- test/support/multibyte_test_helpers.rb
+- test/test_helper.rb
+- test/core_ext/blank_test.rb
+- test/tagged_logging_test.rb
+- test/logger_test.rb
+- test/active_resource/log_subscriber_test.rb
+- test/rack/logger_test.rb
+- test/action_view/log_subscriber_test.rb
+- test/action_controller/log_subscriber_test.rb
+- test/rails_logstasher_test.rb
+- test/dummy/README.rdoc
+- test/dummy/config.ru
+- test/dummy/Rakefile
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/widgets.js
+- test/dummy/app/assets/stylesheets/scaffold.css
+- test/dummy/app/assets/stylesheets/widgets.css
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/widgets_helper.rb
+- test/dummy/app/controllers/widgets_controller.rb
+- test/dummy/app/controllers/log_subscriber_controller.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/models/widget.rb
+- test/dummy/app/views/widgets/new.html.erb
+- test/dummy/app/views/widgets/show.html.erb
+- test/dummy/app/views/widgets/edit.html.erb
+- test/dummy/app/views/widgets/index.html.erb
+- test/dummy/app/views/widgets/_form.html.erb
+- test/dummy/app/views/good_customers/_good_customer.html.erb
+- test/dummy/app/views/test/_customer.erb
+- test/dummy/app/views/test/hello_world.erb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/customers/_customer.html.erb
+- test/dummy/db/migrate/20120927084605_create_widgets.rb
+- test/dummy/db/schema.rb
+- test/dummy/public/500.html
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/favicon.ico
+- test/dummy/script/rails
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/application.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/locales/en.yml
+- test/active_record/log_subscriber_test.rb