rails-graylogger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42cf591e1b56d39e146aa353a2ed0f3bbb0bd93e
+  data.tar.gz: 9a7779e5a53422ea3e6e6fc946b9c58c8df3490c
+SHA512:
+  metadata.gz: 9fc47c8907de6a7d46b567d191936d627790d91125f408d84b8ccca9a64605c0f5cd5623fa86cee00fef17c5330aedd7740d5a92d9c241f7379f4f6d91b21977
+  data.tar.gz: 88b6c0dadbe9e8f81de79fbb6a170c063f9114dd063c9733aa8a4a1cda232655fffaea5ef1bef20e8b5de998d7f78c876402646f242599bc4e4e4ae0f4fe7f60

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+pkg
+.yardoc
+test.log

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    rails-graylogger (0.1.0)
+      activesupport (~> 4)
+      gelf (~> 1.4.0)
+      request_store (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    gelf (1.4.0)
+      json
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.5.1)
+    rake (10.4.2)
+    request_store (1.1.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails-graylogger!
+  rake
+  rspec (~> 3)

data/README.md

@@ -0,0 +1,34 @@
+# rails-graylogger
+Rails logs to Graylog2
+
+# Configuring Middleware
+Add the following to config/application.rb:
+
+```
+config.middleware.insert_before Rack::Runtime, RailsGraylogger::Middleware
+config.after_initialize do
+  config.logger = Rails.logger = RailsGraylogger::Logger.new(Rails.logger)
+end
+```
+
+# Watching output without graylog2
+One way is to use logstash to listen for gelf input and output it to a file
+
+Config:
+
+```
+input {
+  gelf {
+  }
+}
+output {
+  file {
+    path => "/tmp/test.log"
+  }
+}
+```
+
+```
+brew install logstash
+logstash -f <path_to_config>
+```

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rails-graylogger/log_subscriber.rb

@@ -0,0 +1,37 @@
+module RailsGraylogger
+  class LogSubscriber < ::ActiveSupport::LogSubscriber
+
+    def process_action(event)
+      payload = event.payload
+      payload[:path] = URI(payload[:path]).path if payload[:path]
+      payload[:ipaddress] = RequestStore.store[:ipaddress]
+      payload[:duration] = event.duration.round
+      payload[:status] = status_from_exception(payload[:exception]) unless payload[:status].present?
+
+      message = RailsGraylogger::Message.from_event_payload(payload)
+      message.tags = RailsGraylogger::Logger.request_tags
+      message.full_message = buffered_messages
+
+      RailsGraylogger::Notifier.notify!(message.to_hash)
+    rescue => ex
+      Rails.logger.error "Exception in RailsGraylogger: #{ex.class}: #{ex.message}"
+    end
+
+    def buffered_messages
+      unless RailsGraylogger::Logger.request_buffer.blank?
+        RailsGraylogger::Logger.request_buffer.map{ |item| item[:short_message] unless item[:short_message].blank? }.compact.join("\n")
+      else
+        []
+      end
+    end
+
+    def status_from_exception(exception)
+      if exception.present?
+        exception_class_name = exception.first
+        ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+      end
+    end
+  end
+end
+
+RailsGraylogger::LogSubscriber.attach_to :action_controller

data/lib/rails-graylogger/logger.rb

@@ -0,0 +1,59 @@
+module RailsGraylogger
+  class Logger
+    FIELD_KEY_REGEXP = /^[\w\.\-]*$/
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    class << self
+      def initialize_log_buffer
+        RequestStore.store[:graylog2_buffer] = []
+      end
+
+      def request_tags
+        RequestStore.store[:graylog2_tags] ||= []
+      end
+
+      def request_buffer
+        RequestStore.store[:graylog2_buffer]
+      end
+    end
+
+    def tagged(*new_tags, &block)
+      new_tags = Array.wrap(new_tags).flatten.reject(&:blank?)
+      self.class.request_tags << new_tags - ( self.class.request_tags & new_tags )
+      @logger.send("tagged", *new_tags, &block)
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      if [:add, :info, :debug, :warn, :error, :fatal].include?(method) && !args[0].nil?
+        if args.size == 1 && args[0].is_a?(String)
+          hash = { short_message: args[0] }
+        else
+          return if args.blank?
+          hash = { short_message: args.compact.map(&:to_s).join("\n") }
+        end
+
+        unless self.class.request_buffer.nil?
+          self.class.request_buffer << hash
+        else
+          notify!(method, hash)
+        end
+      end
+      @logger.send(method, *args, &block)
+    end
+
+    def notify!(method, payload)
+      message = RailsGraylogger::Message.new({
+        level: "GELF::Levels::#{method.upcase}".constantize,
+        short_message: payload.delete(:short_message)
+      })
+      message.process_extra_fields(payload)
+      message.tags = self.class.request_tags unless self.class.request_tags.blank?
+      RailsGraylogger::Notifier.notify!(message.to_hash)
+    end
+  end
+end

data/lib/rails-graylogger/message.rb

@@ -0,0 +1,74 @@
+module RailsGraylogger
+  class Message
+    FIELD_KEY_REGEXP = /^[\w\.\-]*$/
+
+    attr_accessor :level, :full_message, :short_message, :extra_fields
+
+    def initialize(opts = {})
+      @level = opts[:level] || GELF::Levels::INFO
+      @short_message = opts[:short_message] || ""
+      @full_message = opts[:full_message] || ""
+      @extra_fields = {}
+    end
+
+    class << self
+      def from_event_payload(payload)
+        message = self.new
+        message.process_event_payload(payload)
+        message
+      end
+    end
+
+    def process_event_payload(payload)
+      self.level = level_from_status(payload[:status])
+      self.short_message = "#{payload[:controller]}##{payload[:action]} #{payload[:method]} \"#{payload[:path]}\" from #{payload[:ipaddress]}"
+      process_extra_fields(payload)
+    end
+
+    def tags=(tags)
+      raise ArgumentError.new("Not an array: #{tags.inspect}") unless tags.is_a?(Array)
+      self.extra_fields[:_tags] = tags.join(" ")
+    end
+
+    def to_hash
+      {
+        level: level,
+        short_message: short_message
+      }.tap do |hash|
+        hash[:full_message] = short_message + "\n" + full_message unless full_message.blank?
+      end.merge(extra_fields)
+    end
+
+    def process_extra_fields(payload)
+      process_exception_data(payload.delete(:exception)) if payload[:exception]
+
+      payload.each do |key, value|
+        @extra_fields["_#{key}"] = formatted_value(value) if valid_key?(key)
+      end
+    end
+
+    private
+
+    def formatted_value(value)
+      if value.is_a?(Numeric)
+        value
+      else
+        value.to_s
+      end
+    end
+
+    def valid_key?(key)
+      key.match(FIELD_KEY_REGEXP)
+    end
+
+    def level_from_status(status)
+      status < 400 ? GELF::Levels::INFO : GELF::Levels::ERROR
+    end
+
+    def process_exception_data(exception)
+      exception.each do |key, value|
+        @extra_fields["_exception_#{key}"] = value.to_s if valid_key?(key)
+      end
+    end
+  end
+end

data/lib/rails-graylogger/middleware.rb

@@ -0,0 +1,18 @@
+module RailsGraylogger
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      RailsGraylogger::Logger.initialize_log_buffer
+      logger = Rails.logger
+      request = Rack::Request.new(env)
+      RequestStore.store[:ipaddress] = request.ip
+
+      status, headers, body = @app.call(env)
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/rails-graylogger/notifier.rb

@@ -0,0 +1,35 @@
+module RailsGraylogger
+  class Notifier
+    class << self
+      def notify!(gelf_message)
+        @@notifier ||= self.new
+        @@notifier.notify!(gelf_message)
+      end
+    end
+
+    def initialize
+      @gelf_notifier = GELF::Notifier.new(remote_host, remote_port, 1420, facility: facility, host: sender_host)
+    end
+
+    def remote_host
+      ENV["GRAYLOG_HOST"] || "127.0.0.1"
+    end
+
+    def remote_port
+      ENV["GRAYLOG_PORT"] || 12201
+    end
+
+    def facility
+      ENV["GRAYLOG_FACILITY"] || "Rails"
+    end
+
+    def sender_host
+      Socket.gethostname.split(".").first
+    end
+
+    def notify!(gelf_message)
+      return if Rails.env == 'test'
+      @gelf_notifier.notify!(gelf_message.merge(timestamp: Time.now.utc.to_f))
+    end
+  end
+end

data/lib/rails-graylogger/version.rb

@@ -0,0 +1,3 @@
+module RailsGraylogger
+  VERSION = '0.1.0'
+end

data/lib/rails-graylogger.rb

@@ -0,0 +1,7 @@
+require 'gelf'
+require 'request_store'
+require 'rails-graylogger/middleware.rb'
+require 'rails-graylogger/notifier.rb'
+require 'rails-graylogger/logger.rb'
+require 'rails-graylogger/message.rb'
+require 'rails-graylogger/log_subscriber.rb'

data/rails-graylogger.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails-graylogger/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rails-graylogger"
+  s.version     = RailsGraylogger::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tuomas Silen"]
+  s.email       = ["tuomas@flowdock.com"]
+  s.homepage    = "https://github.com/flowdock/rails-graylogger"
+  s.summary     = "Push Rails logs also to Graylog2"
+  s.description = s.summary
+
+  s.add_dependency 'gelf', '~> 1.4.0'
+  s.add_dependency 'activesupport', '~> 4'
+  s.add_dependency 'request_store', '~> 1.0'
+
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rake'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/rails-graylogger/logger_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe RailsGraylogger::Logger do
+  before :each do
+    RequestStore.clear!
+    @logger = RailsGraylogger::Logger.new(ActiveSupport::TaggedLogging.new(Logger.new("test.log")))
+  end
+
+  it "sends log lines to Graylog server" do
+    expect(RailsGraylogger::Notifier).to receive(:notify!).with(level: GELF::Levels::INFO, short_message: "Foobar").once
+    @logger.info("Foobar")
+  end
+
+  it "handles tagged logging with nested tags" do
+    expect(RailsGraylogger::Notifier).to receive(:notify!).with(level: GELF::Levels::INFO, short_message: "Test", _tags: "Foo Bar").once
+    @logger.tagged("Foo") do
+      @logger.tagged("Bar") do
+        @logger.info("Test")
+      end
+    end
+  end
+
+  it "handles tagged logging with multiple log lines" do
+    expect(RailsGraylogger::Notifier).to receive(:notify!).with(_tags: "Foobar", short_message: "Line1", level: GELF::Levels::INFO).once
+    expect(RailsGraylogger::Notifier).to receive(:notify!).with(_tags: "Foobar", short_message: "Line2", level: GELF::Levels::INFO).once
+    @logger.tagged("Foobar") do
+      @logger.info("Line1")
+      @logger.info("Line2")
+    end
+  end
+
+  it "handles passing a hash as argument" do
+    hash = { foo: "test", bar: "test" }
+    expect(RailsGraylogger::Notifier).to receive(:notify!).with(level: GELF::Levels::INFO, short_message: "{:foo=>\"test\", :bar=>\"test\"}", _tags: "Foobar").once
+    @logger.tagged("Foobar") do
+      @logger.info(hash)
+    end
+  end
+
+  it "should buffer logging output when request store is initialized" do
+    allow(RailsGraylogger::Notifier).to receive(:notify!)
+    RailsGraylogger::Logger.initialize_log_buffer
+    expect(RailsGraylogger::Logger.request_buffer.size).to eq(0)
+    @logger.info("Foobar")
+    expect(RailsGraylogger::Notifier).not_to have_received(:notify!)
+    expect(RailsGraylogger::Logger.request_buffer.size).to eq(1)
+    expect(RailsGraylogger::Logger.request_buffer[0]).to eq({short_message: "Foobar"})
+  end
+end

data/spec/rails-graylogger/message_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe RailsGraylogger::Message do
+  describe "#process_extra_fields" do
+    before(:each) do
+      @msg = RailsGraylogger::Message.new
+    end
+
+    it "should add undescrore before field names" do
+      @msg.process_extra_fields({ test: "abc" })
+      expect(@msg.extra_fields).to eq({ "_test" => "abc" })
+    end
+
+    it "should keep numeric values" do
+      @msg.process_extra_fields({ test: 123 })
+      expect(@msg.extra_fields).to eq({ "_test" => 123 })
+    end
+
+    it "should convert hash to string" do
+      @msg.process_extra_fields({ test: { foo: "bar" } })
+      expect(@msg.extra_fields).to eq({ "_test" => "{:foo=>\"bar\"}" })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+ENV["RAILS_ENV"] = "test"
+require "active_support"
+require "active_support/inflector"
+require "active_support/core_ext"
+require File.expand_path("../../lib/rails-graylogger", __FILE__)
+
+#require "rspec/rails"
+
+RSpec.configure do |config|
+  config.filter_run_excluding slow: true unless ENV["CI"] == "true"
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Randomise spec order
+#  config.order = :random
+#  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = false
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rails-graylogger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tuomas Silen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Push Rails logs also to Graylog2
+email:
+- tuomas@flowdock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rails-graylogger.rb
+- lib/rails-graylogger/log_subscriber.rb
+- lib/rails-graylogger/logger.rb
+- lib/rails-graylogger/message.rb
+- lib/rails-graylogger/middleware.rb
+- lib/rails-graylogger/notifier.rb
+- lib/rails-graylogger/version.rb
+- rails-graylogger.gemspec
+- spec/rails-graylogger/logger_spec.rb
+- spec/rails-graylogger/message_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flowdock/rails-graylogger
+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
+signing_key: 
+specification_version: 4
+summary: Push Rails logs also to Graylog2
+test_files:
+- spec/rails-graylogger/logger_spec.rb
+- spec/rails-graylogger/message_spec.rb
+- spec/spec_helper.rb