exception_notification-fluent_logger_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15f0d4a9779623de33ccda317f06e98b20295a72
+  data.tar.gz: eb6291516242f63432c9d9a16d863b9515f29d15
+SHA512:
+  metadata.gz: 1d5b6d9715ac0685adc21cc7f01245d2af0324a7c5c0c6a9a70a58ebf508174e6f632cdb4b00c83769b64c4a567df3259576023a8039638d74df272fe5dbffb1
+  data.tar.gz: 8988a3954288fc31ec9f744d683b55a5fe7744e8ca028e971fdbc26fcc47760bbed7317bea89e527740876708182cb298769a9f2b83eabde6cd1f2060ffea4f3

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/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+- 2.0
+- 2.1
+- 2.2
+- ruby-head

data/Gemfile

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

data/README.md

@@ -0,0 +1,58 @@
+# ExceptionNotifier::FluentLoggerNotifier
+
+`ExceptionNotifier::FluentLoggerNotifier` is a custom notifier for [ExceptionNotification](http://smartinez87.github.io/exception_notification/).
+It sends exception notifications to [Fluentd data collector](http://fluentd.org/) via [fluent-logger](https://github.com/fluent/fluent-logger-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exception_notification-fluent_logger_notifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_notification-fluent_logger_notifier
+
+## Usage
+
+As other exception notifiers, add settings at the environments.
+
+* Key `tag_prefix` is for the fluentd tag.
+* Key `template` is for setting log format and must be Hash.
+* Key `logger_settings` is for settings of the logger instance.
+* If key `test_logger` is `true`, the notifier uses `Fluent::Logger::TestLogger` instead of `FluentLogger`.
+
+See also [exception\_notifier's doc](http://smartinez87.github.io/exception_notification/#notifiers).
+
+### Example
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  fluent_logger: {
+    tag_prefix: "exceptions",
+    logger_settings: {
+      host: "localhost",
+      port: 8888,
+    }
+    template: {
+      exception_class: ->(exception, options) { exception.class_name },
+      exception_message: => -> (exception, options) { exception.messaage },
+    }
+  }
+```
+
+## 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
+
+## License
+
+[MIT](http://makimoto.mit-license.org/)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/exception_notification-fluent_logger_notifier.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "exception_notifier/fluent_logger_notifier/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_notification-fluent_logger_notifier"
+  spec.version       = ExceptionNotifier::FluentLoggerNotifier::VERSION
+  spec.authors       = ["Shimpei Makimoto"]
+  spec.email         = ["makimoto@tsuyabu.in"]
+  spec.summary       = %q{A custom notifier for ExceptionNotification which notifies exceptions to Fluentd via fluent-logger}
+  spec.homepage      = "https://github.com/makimoto/exception_notification-fluent_logger_notifier"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "exception_notification", "~> 4.0.1"
+  spec.add_dependency "fluent-logger"
+end

data/lib/exception_notification_fluent_logger_notifier.rb

@@ -0,0 +1 @@
+require "exception_notifier/fluent_logger_notifier"

data/lib/exception_notifier/fluent_logger_notifier.rb

@@ -0,0 +1,75 @@
+require "fluent-logger"
+module ExceptionNotifier
+  class FluentLoggerNotifier
+
+    attr_accessor :logger, :template
+    class ConfigurationError < Exception;end
+
+    def initialize(options)
+      @template = options.delete(:template)
+      raise ConfigurationError, "`template` key must be set" unless @template
+
+      logger_settings = options.delete(:logger_settings) || {}
+      if options.delete(:test_logger)
+        @logger = Fluent::Logger::TestLogger.new
+      else
+        tag_prefix = options.delete(:tag_prefix)
+        @logger = Fluent::Logger::FluentLogger.new(tag_prefix, logger_settings)
+      end
+    end
+
+    def call(exception, options={})
+      arg = Argument.build(template, exception, options)
+      logger.post(nil, arg)
+    end
+
+    class SetupError < Exception;end
+
+    class Argument
+      def initialize(template, exception, options = {})
+        @exception = exception
+        @options = options
+        @template = template
+      end
+
+      def build
+        expand_object(@template)
+      end
+
+      def self.build(template, exception, options = {})
+        self.new(template, exception, options).build
+      end
+
+      private
+
+      def expand_object(obj)
+        case obj
+        when Hash
+          expand_hash(obj)
+        when Array
+          expand_array(obj)
+        when Proc
+          expand_proc(obj)
+        else
+          obj
+        end
+      end
+
+      def expand_proc(prok)
+        expand_object(prok.call(@exception, @options))
+      end
+
+      def expand_array(array)
+        array.map {|element| expand_object(element) }
+      end
+
+      def expand_hash(hash)
+        {}.tap do |result|
+          hash.each do |k, v|
+            result[k] = expand_object(v)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exception_notifier/fluent_logger_notifier/version.rb

@@ -0,0 +1,5 @@
+module ExceptionNotifier
+  class FluentLoggerNotifier
+    VERSION = "0.1.0"
+  end
+end

data/spec/exception_notifier/fluent_logger_notifier_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+
+describe ExceptionNotifier::FluentLoggerNotifier do
+  class FooException < Exception;end
+
+  let(:exception) do
+    FooException.new("bar message")
+  end
+
+  let(:notifier) do
+    ExceptionNotifier::FluentLoggerNotifier.new(
+      test_logger: true,
+      logger_settings: {
+        :host => "localhost",
+        :port => 8888,
+      },
+      template: {
+        message: ->(exception, options) { "Exception: #{exception.class}: #{exception.message}" }
+      }
+    )
+  end
+
+  describe "#call" do
+    it "logs valid data" do
+      notifier.call(FooException.new("bar message"))
+      notifier.logger.queue.last.should == { message: "Exception: FooException: bar message" }
+    end
+  end
+
+  describe ExceptionNotifier::FluentLoggerNotifier::Argument do
+    subject do
+      ExceptionNotifier::FluentLoggerNotifier::Argument.build(template, exception, {})
+    end
+
+    context "with String" do
+      let(:template) do
+        "string"
+      end
+
+      it "returns string without any change" do
+        should == "string"
+      end
+    end
+
+    context "with Proc" do
+      let(:template) do
+        ->(e, opts) { "Exception: #{e.class}: #{e.message}" }
+      end
+
+      it "returns intended string" do
+        should == "Exception: FooException: bar message"
+      end
+    end
+
+    context "with Hash" do
+      let(:template) do
+        {
+          class_name: ->(e, opts) { e.class.to_s },
+          message: ->(e, opts) { e.message},
+          baz: 42,
+        }
+      end
+
+      it "returns intended hash" do
+        should == { class_name: "FooException", message: "bar message", baz: 42 }
+      end
+    end
+
+    context "with Array" do
+      let(:template) do
+        [
+          ->(e, opts) { 1 + 42 },
+          ->(e, opts) { e.class.to_s },
+          nil,
+        ]
+      end
+
+      it "returns intended array" do
+        [43, "FooException", nil]
+      end
+    end
+
+    context "with nested templates" do
+      let(:template) do
+        {
+          string: "string",
+          int: 42,
+          hash: {
+            proc: ->(e, opts) { e.class.to_s }
+          },
+          array: [42, ->(e, opts) { e.message }],
+        }
+      end
+
+      it "returns intended value" do
+        {
+          string: "string",
+          int: 42,
+          hash: {
+            proc: "FooException",
+          },
+          array: [42, "bar message"],
+        }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "fluent-logger"
+require "exception_notifier/fluent_logger_notifier"

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: exception_notification-fluent_logger_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shimpei Makimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- makimoto@tsuyabu.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- exception_notification-fluent_logger_notifier.gemspec
+- lib/exception_notification_fluent_logger_notifier.rb
+- lib/exception_notifier/fluent_logger_notifier.rb
+- lib/exception_notifier/fluent_logger_notifier/version.rb
+- spec/exception_notifier/fluent_logger_notifier_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/makimoto/exception_notification-fluent_logger_notifier
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A custom notifier for ExceptionNotification which notifies exceptions to
+  Fluentd via fluent-logger
+test_files:
+- spec/exception_notifier/fluent_logger_notifier_spec.rb
+- spec/spec_helper.rb