graylog2-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Artem Melnikov
+
+MIT License
+
+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,29 @@
+# Graylog2::Rails
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'graylog2-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graylog2-rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/config/graylog2_rails.yml

@@ -0,0 +1,22 @@
+default:
+  hostname: 127.0.0.1
+  port: 12201
+  local_app_name: rails_application
+  facility: rails_application
+  max_chunk_size: LAN
+  level: 3
+
+production:
+  <<: *defaults
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+stage:
+  <<: *defaults
+
+demo:
+  <<: *defaults

data/graylog2-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/graylog2-rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Artem Melnikov"]
+  gem.email         = ["artem.melnikov@ignar.name"]
+  gem.description   = %q{Wrapper for Graylog2 logging system}
+  gem.summary       = %q{Wrapper for Graylog2 logging system}
+  gem.homepage      = "https://github.com/ignar/graylog2-rails"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "graylog2-rails"
+  gem.require_paths = ["lib"]
+  gem.version       = Graylog2Rails::VERSION
+
+  gem.add_dependency("gelf", "~> 1.3.2")
+  gem.add_dependency("awesome_print")
+  gem.add_dependency("activesupport")
+  gem.add_dependency("rake")
+
+  gem.add_development_dependency("rspec", "~> 2.0")
+end

data/lib/generators/graylog2_rails/install_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators"
+require "rake"
+
+module Graylog2Rails
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Graylog2Rails install generator"
+    def install
+      say "Install Graylog2Rails", :green
+      @app_name = Rails.application.class.name.sub(/::Application$/, "").underscore
+      say "Copying config file"
+      template "config.erb", "config/graylog2_rails.yml"
+      say "Done", :green
+    end
+  end
+end

data/lib/generators/graylog2_rails/templates/config.erb

@@ -0,0 +1,30 @@
+default: &defaults
+  hostname: 127.0.0.1
+  port: 12201
+  max_chunk_size: LAN
+  level: 3
+
+production:
+  <<: *defaults
+  local_app_name: <%= @app_name %>_production
+  facility: <%= @app_name %>_production
+
+development:
+  <<: *defaults
+  local_app_name: <%= @app_name %>_development
+  facility: <%= @app_name %>_development
+
+test:
+  <<: *defaults
+  local_app_name: <%= @app_name %>_test
+  facility: <%= @app_name %>_test
+
+stage:
+  <<: *defaults
+  local_app_name: <%= @app_name %>_stage
+  facility: <%= @app_name %>_stage
+
+demo:
+  <<: *defaults
+  local_app_name: <%= @app_name %>_demo
+  facility: <%= @app_name %>_demo

data/lib/graylog2-rails.rb

@@ -0,0 +1,10 @@
+require "graylog2-rails/initializers"
+require "graylog2-rails/message"
+require "graylog2-rails/middleware"
+require "graylog2-rails/engine"
+require "graylog2-rails/notifier"
+require "graylog2-rails/version"
+
+module Graylog2Rails
+  mattr_accessor :gelf_config_options
+end

data/lib/graylog2-rails/engine.rb

@@ -0,0 +1,14 @@
+if defined?(Rails) && Rails.version.to_f > 3.1
+  class Engine < Rails::Engine
+    isolate_namespace Graylog2Rails
+    include Graylog2Rails::Initializers
+
+    initializer "graylog2_rails.establish_connection" do |app|
+      read_config!
+    end
+
+    initializer "graylog2_rails.add_middleware", :after => "graylog2_rails.establish_connection" do |app|
+      app.middleware.insert_after ActionDispatch::Head, Graylog2Rails::Middleware, Graylog2Rails.gelf_config_options
+    end
+  end
+end

data/lib/graylog2-rails/initializers.rb

@@ -0,0 +1,14 @@
+module Graylog2Rails
+  module Initializers
+    def read_config!
+      custom_config_file = Rails.root.join("config", "graylog2_rails.yml")
+      file_content = if custom_config_file.exist?
+                       File.open(custom_config_file).read
+                     else
+                       puts "WARNING: Graylog2 config not found. Using default configuration options. Please run `rake graylog2_rails:install'"
+                       File.open(File.expand_path(File.join("..", "..", "..", "config", "graylog2_rails.yml"), __FILE__)).read
+                     end
+      Graylog2Rails.gelf_config_options = YAML.load(ERB.new(file_content).result)[Rails.env]
+    end
+  end
+end

data/lib/graylog2-rails/message.rb

@@ -0,0 +1,140 @@
+module Graylog2Rails
+  class Message
+    attr_accessor :args
+    # The exception that caused this notice, if any
+    attr_reader :exception
+
+    # The backtrace from the given exception or hash.
+    attr_reader :backtrace
+
+    # The name of the class of error (such as RuntimeError)
+    attr_reader :error_class
+
+    # The name of the server environment (such as "production")
+    attr_reader :environment_name
+
+    # CGI variables such as HTTP_METHOD
+    attr_reader :cgi_data
+
+    # The message from the exception, or a general description of the error
+    attr_reader :error_message
+
+    # See Configuration#backtrace_filters
+    attr_reader :backtrace_filters
+
+    # See Configuration#params_filters
+    attr_reader :params_filters
+
+    # A hash of parameters from the query string or post body.
+    attr_reader :parameters
+    alias_method :params, :parameters
+
+    # The component (if any) which was used in this request (usually the controller)
+    attr_reader :component
+    alias_method :controller, :component
+
+    # The action (if any) that was called in this request
+    attr_reader :action
+
+    # A hash of session data from the request
+    attr_reader :session_data
+
+    # The path to the project that caused the error (usually Rails.root)
+    attr_reader :project_root
+
+    # The URL at which the error occurred (if any)
+    attr_reader :url
+
+    # The host name where this error occurred (if any)
+    attr_reader :hostname
+
+    attr_writer :exception, :backtrace, :error_class, :error_message,
+      :backtrace_filters, :parameters,
+      :environment_filters, :session_data, :url,
+      :component, :action, :cgi_data, :environment_name, :hostname
+
+    def initialize(args)
+      self.args         = args
+      self.exception    = args[:exception]
+      self.url          = args[:url] || rack_env(:url)
+
+      self.parameters   = args[:parameters] || action_dispatch_params || rack_env(:params) || {}
+      self.component    = args[:component] || args[:controller] || parameters['controller']
+      self.action       = args[:action] || parameters['action']
+
+      self.environment_name = args[:environment_name]
+      self.cgi_data         = args[:cgi_data] || args[:rack_env]
+      self.backtrace        = self.exception.backtrace.join("\n")
+      self.error_class      = exception_attribute(:error_class) {|exception| exception.class.name }
+      self.error_message    = exception_attribute(:error_message, 'Notification') do |exception|
+        "#{exception.class.name}: #{exception.message}"
+      end
+    end
+
+    def message
+      self.error_message
+    end
+
+    def rack_env(method)
+      rack_request.send(method) if rack_request
+    end
+
+    def action_dispatch_params
+      args[:rack_env]['action_dispatch.request.parameters'] if args[:rack_env]
+    end
+
+    def rack_request
+      @rack_request ||= if args[:rack_env]
+        ::Rack::Request.new(args[:rack_env])
+      end
+    end
+
+    def exception_attribute(attribute, default = nil, &block)
+      (exception && from_exception(attribute, &block)) || args[attribute] || default
+    end
+
+    def from_exception(attribute)
+      if block_given?
+        yield(exception)
+      else
+        exception.send(attribute)
+      end
+    end
+
+    def find_session_data
+      self.session_data = args[:session_data] || args[:session] || rack_session || {}
+      self.session_data = session_data[:data] if session_data[:data]
+    end
+
+    def to_s
+      message = []
+      message << "=================== Git revision"
+      message << `git log --pretty=format:'%H' -n 1`
+      message << "=================== Exception Class"
+      message << self.error_class
+      message << "=================== Exception Message"
+      message << self.error_message
+      message << "=================== URL"
+      message << self.url
+      message << "=================== Parameters"
+      message << args[:rack_env]['REQUEST_METHOD']
+      message << self.parameters
+      message << "=================== Component"
+      message << self.component
+      message << "=================== Action"
+      message << self.action
+      message << "=================== Ruby version"
+      message << RUBY_VERSION
+      message << "=================== Rails environment"
+      message << Rails.env
+      message << "=================== User information"
+      message << args[:rack_env]['HTTP_USER_AGENT']
+      message << args[:rack_env]['HTTP_ACCEPT_CHARSET']
+      message << "=================== Backtrace"
+      message << self.backtrace
+      message << "=================== ARGS"
+      message << self.args
+      message.join("\n\n")
+    end
+  end # Notice
+end

data/lib/graylog2-rails/middleware.rb

@@ -0,0 +1,48 @@
+module Graylog2Rails
+  class Middleware
+    attr_reader :args
+
+    def initialize(app, args = {})
+      @app, @args = app, args
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      begin
+        @app.call(env)
+      rescue Exception => err
+        send_to_graylog2(err, env)
+        raise
+      end
+    end
+
+    def send_to_graylog2 err, env
+      opts = {:rack_env => env}
+      begin
+        opts = opts.merge(:exception => err) if err.is_a?(Exception)
+        opts = opts.merge(err.to_hash) if err.respond_to?(:to_hash)
+        notice = Graylog2Rails::Message.new(opts)
+        args = {
+          :short_message => notice.message,
+          :full_message => notice.to_s,
+          :facility => @args.delete("facility") + "_exception",
+          :level => @args.delete("level"),
+          :host => @args.delete("local_app_name"),
+          :file => err.backtrace[0].split(":")[0],
+          :line => err.backtrace[0].split(":")[1],
+        }
+        Rails.logger.tagged("GRAYLOG") do
+          Rails.logger.info args.inspect
+        end
+        notifier = GELF::Notifier.new(@args.delete("hostname"), @args.delete("port"), @args.delete("max_chunk_size"))
+        notifier.notify!(args)
+      rescue => i_err
+        puts "Graylog2 Exception logger. Could not send message: " + i_err.message
+        puts i_err.backtrace.join("\n")
+      end
+    end
+  end # class Middleware
+end

data/lib/graylog2-rails/notifier.rb

@@ -0,0 +1,26 @@
+module Graylog2Rails
+  class Notifier
+    attr_reader :gelf
+
+    def initialize(args = {})
+      @gelf = GELF::Notifier.new(Graylog2Rails.gelf_config_options["host"],
+                                 Graylog2Rails.gelf_config_options["port"],
+                                 Graylog2Rails.gelf_config_options["max_chunk_size"], {
+                                   facility: Graylog2Rails.gelf_config_options["facility"],
+                                   level: args.has_key?("level") ? args["level"] : Graylog2Rails.gelf_config_options["level"],
+                                   host: Graylog2Rails.gelf_config_options["local_app_name"]
+                                 })
+    end
+
+    def self.notify! args
+      @notifier ||= new
+      timestamp = Time.now.utc
+      Rails.logger.tagged("GRAYLOG") do
+        Rails.logger.info "[#{timestamp.to_datetime}] #{args.inspect}"
+      end
+      args.merge!({timestamp: timestamp.to_f})
+      @notifier.gelf.notify! args unless Rails.env.development?
+    end
+
+  end
+end

data/lib/graylog2-rails/version.rb

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

data/lib/tasks/graylog2_rails.rake

@@ -0,0 +1,6 @@
+namespace :graylog2_rails do
+  desc "Install Graylog2"
+  task :install do
+    system "rails g graylog2_rails:install"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: graylog2-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Artem Melnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gelf
+  requirement: &70237560199040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237560199040
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70237560198620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237560198620
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70237560198080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237560198080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70237560197640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237560197640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70237560197140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70237560197140
+description: Wrapper for Graylog2 logging system
+email:
+- artem.melnikov@ignar.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config/graylog2_rails.yml
+- graylog2-rails.gemspec
+- lib/generators/graylog2_rails/install_generator.rb
+- lib/generators/graylog2_rails/templates/config.erb
+- lib/graylog2-rails.rb
+- lib/graylog2-rails/engine.rb
+- lib/graylog2-rails/initializers.rb
+- lib/graylog2-rails/message.rb
+- lib/graylog2-rails/middleware.rb
+- lib/graylog2-rails/notifier.rb
+- lib/graylog2-rails/version.rb
+- lib/tasks/graylog2_rails.rake
+- spec/spec_helper.rb
+homepage: https://github.com/ignar/graylog2-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2160470504534337998
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2160470504534337998
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Wrapper for Graylog2 logging system
+test_files:
+- spec/spec_helper.rb