better_logs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ece6d96bc5daf1b196109b2c1c2862ea7a148a77
-  data.tar.gz: c109e15ba3a254740b285505310bdfbde6bb6037
+  metadata.gz: 521fb57af9ac3d78d727ec9edf639525aa35af90
+  data.tar.gz: 9433ca34f7841ea1de887fb09cf84e3617e7547e
 SHA512:
-  metadata.gz: 485eadc726d53f1b691872d19ccab0cb33ddb17f4352eb2883ca64f0b82eeb6da0d83c67f4e91407a719efa4982c9f1f384985c045104f116a264b01e67608e1
-  data.tar.gz: 59655ca7c6337bc82ca761c0fe69dbcbcbb62ead6b416c24e064c1571502724b23731e6356ff001a25920d6ee53d12d5b004ca1561f7ae57ded6638e70b5f894
+  metadata.gz: 5ece79f690f24d8dbe0319974ac53fc887db26c21c2a7fba9ac467f99a43cabe99a430db7240b645fca072f283a347ef385f0fef7a991664eb3e89aa52e013a2
+  data.tar.gz: afbd7540449d2ab74f22cb2fd5aaabf0ea70e882cb715170fc09ce98b922e4c0d75344cfb26dfc0aa3a2c0565728466ecf744240cef52b97523f15c94d909112

data/Gemfile

@@ -1,16 +1,17 @@
 source 'https://rubygems.org'
 
-gem 'activesupport', '~> 4.0'
-gem 'actionpack',    '~> 4.0'
-gem 'railties',      '~> 4.0'
-gem 'flat_keys',     '~> 0.0'
+gem 'activesupport',  '~> 4.0'
+gem 'actionpack',     '~> 4.0'
+gem 'railties',       '~> 4.0'
+gem 'flat_keys',      '~> 0.0'
+gem 'useragent',      '~> 0.10'
 
 group :development do
-  gem 'rdoc',                      '~> 4.1'
-  gem 'bundler',                   '~> 1.0'
-  gem 'jeweler',                   '~> 2.0'
-  gem 'rspec',                     '~> 2.14'
-  gem 'guard-rspec',               '~> 4.2'
-  gem 'terminal-notifier-guard',   '~> 1.5'
-  gem 'codeclimate-test-reporter', '~> 0.3', require: nil
+  gem 'rdoc',                       '~> 4.1'
+  gem 'bundler',                    '~> 1.0'
+  gem 'jeweler',                    '~> 2.0'
+  gem 'rspec',                      '~> 2.14'
+  gem 'guard-rspec',                '~> 4.2'
+  gem 'terminal-notifier-guard',    '~> 1.5'
+  gem 'codeclimate-test-reporter',  '~> 0.3', require: nil
 end

data/Gemfile.lock

@@ -128,6 +128,7 @@ GEM
     timers (1.1.0)
     tzinfo (1.1.0)
       thread_safe (~> 0.1)
+    useragent (0.10.0)
 
 PLATFORMS
   ruby
@@ -144,3 +145,4 @@ DEPENDENCIES
   rdoc (~> 4.1)
   rspec (~> 2.14)
   terminal-notifier-guard (~> 1.5)
+  useragent (~> 0.10)

data/README.md

@@ -0,0 +1,27 @@
+# BetterLogs [![Build Status](https://travis-ci.org/techthumb/better_logs.svg?branch=v0.1.0)](https://travis-ci.org/techthumb/better_logs) [![Gem Version](https://badge.fury.io/rb/better_logs.svg)](http://badge.fury.io/rb/better_logs) [![Code Climate](https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/badges/1196b8f5d38c79f87546/gpa.png)](https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/feed) [![Code Climate](https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/badges/1196b8f5d38c79f87546/coverage.png)](https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/feed)
+
+Better Logs adds an additional two log lines for all HTTP requests.
+Currently, it logs data in key=value pairs to allow for Splunk indexing.
+
+```
+format=html method=GET path=/ status=200  view_runtime=45.67 db_runtime=23.45 controller=rails/welcome action=index
+```
+```
+remote_ip=127.0.0.1 browser_name=Chrome browser_platform=Macintosh browser_version=34.0.1847.131
+```
+
+## Installation
+Add this to your Gemfile
+```ruby
+gem 'better_logs'
+```
+
+## Get in touch!
+If you're using ```better_logs```, I'd love to hear from you. Drop me a line and tell me what you think at: ```kunal+better_logs@techthumb.in```
+
+## Contributing
+1. Fork it
+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/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/better_logs.gemspec

@@ -2,21 +2,21 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: better_logs 0.1.0 ruby lib
+# stub: better_logs 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "better_logs"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kunal Parikh"]
-  s.date = "2014-04-27"
+  s.date = "2014-05-02"
   s.description = "Logging for Rails request/response lifecycle in a machine readable format (starting with Splunk)"
   s.email = "kunal@techthumb.in"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".coveralls.yml",
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
     "Gemfile.lock",
     "Guardfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "better_logs.gemspec",
@@ -34,18 +34,23 @@ Gem::Specification.new do |s|
     "lib/better_logs/action_controller.rb",
     "lib/better_logs/action_controller/log_subscriber.rb",
     "lib/better_logs/action_controller/payload.rb",
+    "lib/better_logs/action_dispatch.rb",
+    "lib/better_logs/action_dispatch/log_subscriber.rb",
+    "lib/better_logs/action_dispatch/payload.rb",
     "lib/better_logs/formatters.rb",
     "lib/better_logs/formatters/key_value_formatter.rb",
     "lib/better_logs/initializer.rb",
     "lib/better_logs/railtie.rb",
     "spec/lib/better_logs/action_controller/log_subscriber_spec.rb",
     "spec/lib/better_logs/action_controller/payload_spec.rb",
+    "spec/lib/better_logs/action_dispatch/log_subscriber_spec.rb",
+    "spec/lib/better_logs/action_dispatch/payload_spec.rb",
     "spec/lib/better_logs/formatters/key_value_formatter_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/techthumb/better_logs"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.1"
+  s.rubygems_version = "2.2.2"
   s.summary = "Better logging for Rails request/response lifecycle."
 
   if s.respond_to? :specification_version then
@@ -56,6 +61,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<actionpack>, ["~> 4.0"])
       s.add_runtime_dependency(%q<railties>, ["~> 4.0"])
       s.add_runtime_dependency(%q<flat_keys>, ["~> 0.0"])
+      s.add_runtime_dependency(%q<useragent>, ["~> 0.10"])
       s.add_development_dependency(%q<rdoc>, ["~> 4.1"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
@@ -68,6 +74,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<actionpack>, ["~> 4.0"])
       s.add_dependency(%q<railties>, ["~> 4.0"])
       s.add_dependency(%q<flat_keys>, ["~> 0.0"])
+      s.add_dependency(%q<useragent>, ["~> 0.10"])
       s.add_dependency(%q<rdoc>, ["~> 4.1"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0"])
@@ -81,6 +88,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<actionpack>, ["~> 4.0"])
     s.add_dependency(%q<railties>, ["~> 4.0"])
     s.add_dependency(%q<flat_keys>, ["~> 0.0"])
+    s.add_dependency(%q<useragent>, ["~> 0.10"])
     s.add_dependency(%q<rdoc>, ["~> 4.1"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0"])

data/lib/better_logs/action_controller/payload.rb

@@ -8,6 +8,6 @@ class ::BetterLogs::ActionController::Payload < DelegateClass(ActiveSupport::Has
       data[:controller] = data[:params].delete(:controller)
       data[:action] = data[:params].delete(:action)
     end
-    super(data.flat_keys)
+    super(data.flat_keys('_'))
   end
 end

data/lib/better_logs/action_dispatch/log_subscriber.rb

@@ -0,0 +1,13 @@
+class ::BetterLogs::ActionDispatch::LogSubscriber < ActiveSupport::LogSubscriber
+  attr_reader :formatter, :logger
+
+  def initialize(formatter = ::BetterLogs::Formatters::KeyValueFormatter.new,
+                 logger    = ::Rails.logger)
+    @formatter = formatter
+    @logger    = logger
+  end
+
+  def request(event)
+    logger.info formatter.format(::BetterLogs::ActionDispatch::Payload.new(event.payload))
+  end
+end

data/lib/better_logs/action_dispatch/payload.rb

@@ -0,0 +1,15 @@
+class ::BetterLogs::ActionDispatch::Payload < DelegateClass(ActiveSupport::HashWithIndifferentAccess)
+  def initialize(payload)
+    request = payload[:request]
+    user_agent = UserAgent.parse(request.headers['HTTP_USER_AGENT'] || '')
+    data = {
+      remote_ip: request.remote_ip,
+      browser:   {
+        name:     user_agent.browser,
+        platform: user_agent.platform,
+        version:  user_agent.version.to_s
+      }
+    }.flat_keys('_')
+    super(data)
+  end
+end

data/lib/better_logs/action_dispatch.rb

@@ -0,0 +1,2 @@
+module BetterLogs::ActionDispatch
+end

data/lib/better_logs/initializer.rb

@@ -1,5 +1,6 @@
 class ::BetterLogs::Initializer
   def self.initialize
     ::BetterLogs::ActionController::LogSubscriber.attach_to :action_controller
+    ::BetterLogs::ActionDispatch::LogSubscriber.attach_to :action_dispatch
   end
 end

data/lib/better_logs.rb

@@ -2,6 +2,7 @@ module ::BetterLogs
 end
 
 require 'flat_keys'
+require 'useragent'
 require 'rails'
 require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
@@ -13,6 +14,10 @@ require_relative 'better_logs/action_controller'
 require_relative 'better_logs/action_controller/log_subscriber'
 require_relative 'better_logs/action_controller/payload'
 
+require_relative 'better_logs/action_dispatch'
+require_relative 'better_logs/action_dispatch/log_subscriber'
+require_relative 'better_logs/action_dispatch/payload'
+
 require_relative 'better_logs/formatters'
 require_relative 'better_logs/formatters/key_value_formatter'
 

data/spec/lib/better_logs/action_controller/payload_spec.rb

@@ -4,9 +4,9 @@ describe ::BetterLogs::ActionController::Payload do
   subject { ::BetterLogs::ActionController::Payload.new(payload) }
 
   describe 'when payload is a nested hash' do
-    let(:payload) { {nested: {keys: {should: {be: {flattened: 'with dots'}}}}} }
+    let(:payload) { {nested: {keys: {should: {be: {flattened: 'with underscores'}}}}} }
     it 'flattens nested keys' do
-      subject.should == { 'nested.keys.should.be.flattened' => 'with dots' }
+      subject.should == { 'nested_keys_should_be_flattened' => 'with underscores' }
     end
   end
 

data/spec/lib/better_logs/action_dispatch/log_subscriber_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ::BetterLogs::ActionDispatch::LogSubscriber do
+  context 'formatter' do
+    subject { described_class.new.formatter }
+
+    it "defaults to '#{::BetterLogs::Formatters::KeyValueFormatter.name}'" do
+      should be_an_instance_of ::BetterLogs::Formatters::KeyValueFormatter
+    end
+  end
+
+  context 'logger' do
+    before              { Rails.stub(:logger).and_return(rails_logger) }
+    let(:rails_logger)  { double(ActiveSupport::Logger) }
+    subject             { described_class.new.logger }
+
+    it "defaults to 'Rails.logger'" do
+      should === rails_logger
+    end
+  end
+end

data/spec/lib/better_logs/action_dispatch/payload_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+describe ::BetterLogs::ActionDispatch::Payload do
+  let(:remote_ip) { '8.8.8.8' }
+  let(:headers)   do
+    {'HTTP_USER_AGENT' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36'}
+  end
+
+  let(:request) do
+    double(ActionDispatch::Request, remote_ip: remote_ip, headers: headers)
+  end
+
+  let(:payload) do
+    { request: request }
+  end
+
+  subject { OpenStruct.new(described_class.new(payload)) }
+
+  its(:remote_ip)         { should == remote_ip       }
+  its(:browser_name)      { should == 'Chrome'        }
+  its(:browser_platform)  { should == 'Macintosh'     }
+  its(:browser_version)   { should == '34.0.1847.131' }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_logs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kunal Parikh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +185,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .coveralls.yml
 - .document
@@ -180,7 +194,7 @@ files:
 - Gemfile.lock
 - Guardfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - better_logs.gemspec
@@ -188,12 +202,17 @@ files:
 - lib/better_logs/action_controller.rb
 - lib/better_logs/action_controller/log_subscriber.rb
 - lib/better_logs/action_controller/payload.rb
+- lib/better_logs/action_dispatch.rb
+- lib/better_logs/action_dispatch/log_subscriber.rb
+- lib/better_logs/action_dispatch/payload.rb
 - lib/better_logs/formatters.rb
 - lib/better_logs/formatters/key_value_formatter.rb
 - lib/better_logs/initializer.rb
 - lib/better_logs/railtie.rb
 - spec/lib/better_logs/action_controller/log_subscriber_spec.rb
 - spec/lib/better_logs/action_controller/payload_spec.rb
+- spec/lib/better_logs/action_dispatch/log_subscriber_spec.rb
+- spec/lib/better_logs/action_dispatch/payload_spec.rb
 - spec/lib/better_logs/formatters/key_value_formatter_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/techthumb/better_logs
@@ -216,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Better logging for Rails request/response lifecycle.

data/README.rdoc

@@ -1,22 +0,0 @@
-{<img src="https://travis-ci.org/techthumb/better_logs.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/techthumb/better_logs]
-{<img src="https://badge.fury.io/rb/better_logs.svg" alt="Gem Version" />}[http://badge.fury.io/rb/better_logs]
-{<img src="https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/badges/1196b8f5d38c79f87546/gpa.png" />}[https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/feed]
-{<img src="https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/badges/1196b8f5d38c79f87546/coverage.png" />}[https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/feed]
-= BetterLogs
-
-Logging for Rails request/response lifecycle in a machine readable format (starting with Splunk) — Edit
-
-== Contributing
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2014 Kunal Parikh. See LICENSE.txt for
-further details.