railstash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 464a34fd86b5ca71063c461a5eb065837369efa2
+  data.tar.gz: 3517b2f6746235e6a07195fa7437389499609482
+SHA512:
+  metadata.gz: 0a7be782c057a099fea57cbd139146874f229060e63afee35b7838e836200930956d66f6662a756c82592adf70d2d677118da6f2a5f886e0dcf3d829cac508c5
+  data.tar.gz: af910c7f1193d0d2aa80eb73f92e1c2f5a14d11ae6ebd0b944a3d4a082ea4b11b0d7da357ed76791696001d42ce03863840b10ed0146367687eb89e2a0b3ca2b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in railstash.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# Railstash
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'railstash'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+*config/initializers/railstash.rb*
+
+```
+Railstash.configure do |c|
+  c.on_log { |data| data.merge!(app_name: 'dummy_app', source: 'dummy.example.com')  }
+  c.on_log_action { |context, data| data['host'] = context.request.host }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/railstash.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "railstash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/railstash.rb

@@ -0,0 +1,43 @@
+require "railstash/version"
+require "railstash/instrumentation"
+require "railstash/subscribers"
+require "railstash/railtie"
+
+module Railstash
+  mattr_accessor :logger, instance_accessor: false
+  mattr_accessor(:on_log_callbacks, instance_accessor: false) { [] }
+  mattr_accessor(:on_log_action_callbacks, instance_accessor: false) { [] }
+
+  def self.configure
+    yield self
+  end
+
+  def self.on_log(&block)
+    self.on_log_callbacks << block
+  end
+
+  def self.on_log_action(&block)
+    self.on_log_action_callbacks << block
+  end
+
+  def self.log_action(context, data)
+    run_callbacks :on_log_action_callbacks, context, data
+    log(data.merge(Railstash::Instrumentation.extract_context_data(context)))
+  end
+
+  def self.log(data)
+    data[:tags] ||= ["log"]
+    run_callbacks :on_log_callbacks, data
+
+    _log(data)
+  end
+
+  def self._log(data)
+    logstash_event = ::LogStash::Event.new(data)
+    Railstash.logger << logstash_event.to_json + "\n"
+  end
+
+  def self.run_callbacks(chain, *args)
+    send(chain).each { |callback| callback.call(*args) }
+  end
+end

data/lib/railstash/instrumentation.rb

@@ -0,0 +1,37 @@
+module Railstash
+  module Instrumentation
+    def self.extract_context_data(context)
+      request = context.request
+      params = request.parameters
+      data = {}
+      data[:method] = request.request_method
+      data[:path] = request.path
+      data[:fullpath] = request.fullpath
+      data[:controller] = params["controller"]
+      data[:action] = params["action"]
+      data[:route] = "#{params["controller"]}##{params["action"]}"
+      data[:format] = request.format.ref
+      data[:ip] = request.remote_ip
+      data[:user_agent] = request.user_agent
+      data[:referer] = request.referer
+      data[:parameters] = request.filtered_parameters.except("utf8","authenticity_token",
+                                                             *ActionController::LogSubscriber::INTERNAL_PARAMS)
+      if request.respond_to? :request_id
+        data[:request_id] = request.request_id
+      else
+        data[:request_id] = request.uuid
+      end
+      data
+    end
+
+    module ControllerRuntime
+      def append_info_to_payload(payload)
+        super
+        data = Railstash::Instrumentation.extract_context_data(self)
+        Railstash.run_callbacks :on_log_action_callbacks, self, data
+
+        payload[:railstash] = data
+      end
+    end
+  end
+end

data/lib/railstash/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+
+module Railstash
+  class Railtie < Rails::Railtie
+    initializer "railstash.instrumentation" do
+      require 'logstash-event'
+      Railstash.logger ||= Logger.new(Rails.root + "log/railstash_#{Rails.env}.log")
+
+      ActiveSupport.on_load(:action_controller) do
+        include Railstash::Instrumentation::ControllerRuntime
+        Railstash::ControllerLogSubscriber.attach_to :action_controller
+      end
+    end
+  end
+end

data/lib/railstash/subscribers.rb

@@ -0,0 +1,26 @@
+require 'active_support/log_subscriber'
+
+module Railstash
+  class ControllerLogSubscriber < ::ActiveSupport::LogSubscriber
+    def process_action(event)
+      payload = event.payload
+      data = {
+        tags: ['request'],
+        status: payload[:status]
+      }
+      data.merge!(payload[:railstash])
+      data.merge!(runtimes(event))
+
+      Railstash.log(data)
+    end
+
+    private
+    def runtimes(event)
+      {
+        duration: event.duration,
+        view: event.payload[:view_runtime],
+        db: event.payload[:db_runtime]
+      }.transform_values { |value| value.to_f.round(2) if value }
+    end
+  end
+end

data/lib/railstash/version.rb

@@ -0,0 +1,3 @@
+module Railstash
+  VERSION = "0.0.1"
+end

data/railstash.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'railstash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "railstash"
+  spec.version       = Railstash::VERSION
+  spec.authors       = ["Yves Senn"]
+  spec.email         = ["yves.senn@gmail.com"]
+
+  spec.summary       = %q{Writes Logstash specific Rails logs.}
+  spec.description   = %q{Railstash provides a simple way to write Rails events into Logstash and augment them with your own information.}
+  spec.homepage      = "https://github.com/senny/railstash"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "logstash-event", "~> 1.2"
+  spec.add_dependency "rails", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: railstash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yves Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Railstash provides a simple way to write Rails events into Logstash and
+  augment them with your own information.
+email:
+- yves.senn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- lib/railstash.rb
+- lib/railstash/instrumentation.rb
+- lib/railstash/railtie.rb
+- lib/railstash/subscribers.rb
+- lib/railstash/version.rb
+- railstash.gemspec
+homepage: https://github.com/senny/railstash
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Writes Logstash specific Rails logs.
+test_files: []