splunky 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50cc059c6361974c3e0c97eb2b361ba742d385c3
+  data.tar.gz: 0973b8a23049e435fc793aebd3df04a9981b9611
+SHA512:
+  metadata.gz: 9586f71b6fdeb9409c03d5602d1f826d7e69b3ca0f60ddf6eb785d33d5ff0db3dedb3d9edd191010d0e747ce72567fc84bc98a6cf2c2bb21f30127ef63bfd795
+  data.tar.gz: c9f567425bbcd14ce1f578de19a601e0b5dd7177332e3f5187f0356c76aacc2c766902f111b03103597c653747388974b0058e71ac1590871ab10117d7778a8e

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache:
+  - bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem 'rails_request_id', '~> 0.1'
+
+group :development do
+  gem 'rspec',    '~> 3.0'
+  gem 'bundler',  '~> 1.0'
+  gem 'jeweler',  '~> 2.0'
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.7)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.0.0)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    minitest (5.3.5)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rails_request_id (0.1.1)
+      activesupport (~> 4.1)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0)
+  rails_request_id (~> 0.1)
+  rspec (~> 3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Kunal Parikh
+
+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,22 @@
+#Splunky [![Build Status](https://travis-ci.org/techthumb/splunky.svg)](https://travis-ci.org/techthumb/splunky)
+
+Splunky defines and changes the standard log formatter to produce output that is splunkable.
+The log line includes Rails' request id in a key=value format.
+This allows for easy splunking as you can simply do a ```transaction request_id``` to corelate all log lines associated with a single user request.
+
+
+```
+2014-06-22 08:56:46.297 +1000 request_id=4a160cbb-9ddc-45d2-8c16-0c4a2c3f183a the log message
+```
+
+## Installation
+Add this to your Gemfile
+```ruby
+gem 'splunky'
+```
+
+## Get in touch!
+If you're using ```splunky```, I'd love to hear from you. Drop me a line and tell me what you think at: ```kunal+splunky@techthumb.in```
+
+## Contributing
+It's on GitHub, you know what to do!

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name        = "splunky"
+  gem.homepage    = "http://github.com/techthumb/splunky"
+  gem.license     = "MIT"
+  gem.summary     = %Q{A splunk friendly log formatter}
+  gem.description = %Q{Generates log lines with request_id=xxx for easy splunking!}
+  gem.email       = "kunal@techthumb.in"
+  gem.authors     = ["Kunal Parikh"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/splunky.rb

@@ -0,0 +1,10 @@
+module Splunky
+end
+require 'logger'
+require 'rails_request_id'
+require 'splunky/formatter'
+require 'splunky/initializer'
+require 'splunky/railtie' if defined?(rails)
+
+
+

data/lib/splunky/formatter.rb

@@ -0,0 +1,13 @@
+class Splunky::Formatter < Logger::Formatter
+
+  def initialize
+    @datetime_format = '%Y-%m-%d %H:%M:%S.%L %z'
+  end
+
+  def call(severity, time, progname, msg)
+    "#{format_datetime(time)} request_id=#{RailsRequestId.get} #{msg.strip}\n"
+  end
+end
+
+
+

data/lib/splunky/initializer.rb

@@ -0,0 +1,5 @@
+class ::Splunky::Initializer
+  def self.initialize(config)
+    config.log_formatter = ::Splunky::LogFormatter.new
+  end
+end

data/lib/splunky/railtie.rb

@@ -0,0 +1,5 @@
+class ::Splunky::Railtie < ::Rails::Railtie
+  initializer :rails_request_id do
+    ::Splunky::Initializer.initialize(config)
+  end
+end

data/spec/formatter_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Splunky::Formatter do
+  let(:message)     { 'the log message' }
+  let(:time)        { Time.now }
+  let(:request_id)  { SecureRandom.uuid }
+
+  subject { Splunky::Formatter.new.call(Logger::Severity::INFO, time, 'program name', message) }
+
+  before { RailsRequestId::Registry.request_id = request_id }
+
+  it { should == "#{time.strftime('%Y-%m-%d %H:%M:%S.%L %z')} request_id=#{request_id} #{message}\n" }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'splunky'

data/splunky.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: splunky 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "splunky"
+  s.version = "0.0.1"
+
+  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-06-21"
+  s.description = "Generates log lines with request_id=xxx for easy splunking!"
+  s.email = "kunal@techthumb.in"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/splunky.rb",
+    "lib/splunky/formatter.rb",
+    "lib/splunky/initializer.rb",
+    "lib/splunky/railtie.rb",
+    "spec/formatter_spec.rb",
+    "spec/spec_helper.rb",
+    "splunky.gemspec"
+  ]
+  s.homepage = "http://github.com/techthumb/splunky"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.3.0"
+  s.summary = "A splunk friendly log formatter"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails_request_id>, ["~> 0.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<rails_request_id>, ["~> 0.1"])
+      s.add_dependency(%q<rspec>, ["~> 3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<rails_request_id>, ["~> 0.1"])
+    s.add_dependency(%q<rspec>, ["~> 3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+  end
+end
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: splunky
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kunal Parikh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails_request_id
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Generates log lines with request_id=xxx for easy splunking!
+email: kunal@techthumb.in
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/splunky.rb
+- lib/splunky/formatter.rb
+- lib/splunky/initializer.rb
+- lib/splunky/railtie.rb
+- spec/formatter_spec.rb
+- spec/spec_helper.rb
+- splunky.gemspec
+homepage: http://github.com/techthumb/splunky
+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.3.0
+signing_key: 
+specification_version: 4
+summary: A splunk friendly log formatter
+test_files: []