applicaster-logger 0.1.0

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vitaly Gorodetsky
+
+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,56 @@
+# ApplicasterLogger
+
+Dispatches all Rails and DelayedJob log events to logstash
+
+Combines [Lograge](https://github.com/roidrage/lograge) with [logstash-logger](https://github.com/dwbutler/logstash-logger)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'applicaster-logger'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+1. Enable it for the relevant environments, e.g. production:
+
+  ```ruby
+  # config/environments/production.rb
+  MyApp::Application.configure do
+    config.applicaster_logger.enabled = true
+  end
+  ```
+
+2. Configuring logstash output:
+
+  ```ruby
+  # config/environments/production.rb
+  MyApp::Application.configure do
+    config.applicaster_logger.logstash_config = { type: :redis }
+  end
+  ```
+  defaults to: `{ type: :stdout }`
+
+  For availible options see: https://github.com/dwbutler/logstash-logger#basic-usage
+
+3. To set the application name:
+
+  ```ruby
+  # config/environments/production.rb
+  MyApp::Application.configure do
+    config.applicaster_logger.application_name = "my_best_app"
+  end
+  ```
+  defaults to: `Rails.application.class.parent.to_s.underscore`
+
+## 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 @@
+require "bundler/gem_tasks"

data/applicaster-logger.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'applicaster/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "applicaster-logger"
+  spec.version       = Applicaster::Logger::VERSION
+  spec.authors       = ["Vitaly Gorodetsky"]
+  spec.email         = ["v.gorodetsky@applicaster.com"]
+  spec.description   = %q{ Applicaster Logger configurator }
+  spec.summary       = %q{ Configures loggers to send logs to logstash }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'logstash-logger'
+  spec.add_dependency 'lograge'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/applicaster-logger.rb

@@ -0,0 +1 @@
+require 'applicaster/logger'

data/lib/applicaster/logger.rb

@@ -0,0 +1,34 @@
+require "applicaster/logger/version"
+require "applicaster/logger/railtie"
+require "applicaster/logger/formatter"
+
+module Applicaster
+  module Logger
+    def self.setup_lograge(app)
+      app.config.lograge.enabled = true
+      app.config.lograge.formatter = Lograge::Formatters::Logstash.new
+      app.config.lograge.custom_options = lambda do |event|
+        {
+          params: event.payload[:params].except('controller', 'action', 'format'),
+          facility: "action_controller",
+        }
+      end
+    end
+
+    def self.setup_logger(app)
+      logstash_config = app.config.applicaster_logger.logstash_config
+
+      app.config.logger = LogStashLogger.new(logstash_config)
+      app.config.logger.level = app.config.applicaster_logger.level
+      app.config.logger.formatter =
+        Applicaster::Logger::Formatter.new(facility: "rails_logger")
+
+      if defined?(Delayed)
+        Delayed::Worker.logger = LogStashLogger.new(logstash_config)
+        Delayed::Worker.logger.level = app.config.applicaster_logger.level
+        Delayed::Worker.logger.formatter =
+          Applicaster::Logger::Formatter.new(facility: "delayed_job")
+      end
+    end
+  end
+end

data/lib/applicaster/logger/formatter.rb

@@ -0,0 +1,57 @@
+require 'logger'
+require 'socket'
+require 'time'
+
+module Applicaster
+  module Logger
+    HOST = ::Socket.gethostname
+
+    class Formatter < ::Logger::Formatter
+      include LogStashLogger::TaggedLogging::Formatter
+
+      attr_accessor :facility
+
+      def initialize(options = {})
+        @facility = options[:facility]
+        @datetime_format = nil
+      end
+
+      def call(severity, time, progname, message)
+        build_event(message, severity, time)
+      end
+
+      protected
+
+      def build_event(message, severity, time)
+        data = JSON.parse(message).symbolize_keys rescue nil if message.is_a?(String)
+        data ||= message
+
+        event =
+          case data
+          when LogStash::Event
+            data.clone
+          when Hash
+            LogStash::Event.new(data.merge("@timestamp" => time))
+          else
+            LogStash::Event.new(message: msg2str(data), "@timestamp" => time)
+          end
+
+        event[:severity] ||= severity
+        event[:host] ||= HOST
+        event[:application] ||= Rails.application.config.applicaster_logger.application_name
+        event[:environment] ||= Rails.env
+        event[:facility] ||= facility
+
+        current_tags.each do |tag|
+          event.tag(tag)
+        end
+
+        # In case Time#to_json has been overridden
+        if event.timestamp.is_a?(Time)
+          event.timestamp = event.timestamp.iso8601(3)
+        end
+        "#{event.to_json}\n"
+      end
+    end
+  end
+end

data/lib/applicaster/logger/railtie.rb

@@ -0,0 +1,23 @@
+require 'rails/railtie'
+require 'lograge'
+require 'logstash-logger'
+
+module Applicaster
+  module Logger
+    class Railtie < Rails::Railtie
+      config.applicaster_logger = ActiveSupport::OrderedOptions.new
+      config.applicaster_logger.enabled = false
+      config.applicaster_logger.level = ::Logger::INFO
+      config.applicaster_logger.logstash_config = { type: :stdout }
+      config.applicaster_logger.application_name = Rails.application.class.parent.to_s.underscore
+
+      initializer :applicaster_logger_lograge, before: :lograge do |app|
+        Applicaster::Logger.setup_lograge(app) if app.config.applicaster_logger.enabled
+      end
+
+      initializer :applicaster_logger, before: :initialize_logger do |app|
+        Applicaster::Logger.setup_logger(app) if app.config.applicaster_logger.enabled
+      end
+    end
+  end
+end

data/lib/applicaster/logger/version.rb

@@ -0,0 +1,5 @@
+module Applicaster
+  module Logger
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: applicaster-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Vitaly Gorodetsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Applicaster Logger configurator '
+email:
+- v.gorodetsky@applicaster.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- applicaster-logger.gemspec
+- lib/applicaster-logger.rb
+- lib/applicaster/logger.rb
+- lib/applicaster/logger/formatter.rb
+- lib/applicaster/logger/railtie.rb
+- lib/applicaster/logger/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Configures loggers to send logs to logstash
+test_files: []