fluent-plugin-sentry 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+vendor/*

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+before_script:
+ - export RAILS_ENV=default
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fluent-plugin-sentry.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2014- Kentaro Yoshida
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,92 @@
+# fluent-plugin-sentry [![Build Status](https://travis-ci.org/y-ken/fluent-plugin-sentry.png?branch=master)](https://travis-ci.org/y-ken/fluent-plugin-sentry)
+
+## Overview
+
+Fluentd output plugin to send aggregated errors/exception events to Sentry which are a realtime event logging and aggregation platform.<br>
+
+If you have sent events to Sentry directory from front webpage without aggregation, you may got down response time and performance problem (e.g. PHP).<br>
+To use Sentry and Fluentd together, it will got best perfomance because Fluentd acts messege queue for Sentry.
+
+* [Sentry Official web](https://getsentry.com/welcome/)
+* [Sentry Documents](http://sentry.readthedocs.org/en/latest/) [Screenshots](https://github.com/getsentry/sentry#screenshots)
+
+## Installation
+
+install with gem or fluent-gem command as:
+
+`````
+### native gem
+gem install fluent-plugin-sentry
+
+### td-agent gem
+/usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-sentry
+`````
+
+## Preparation
+
+create sentry dashboard first. It could start with cost free!!
+
+* Create an account at https://getsentry.com/pricing/
+
+OR
+
+* Launch Sentry at the self manager server with https://github.com/getsentry/sentry
+
+## Usage
+
+```xml
+<source>
+ type forward
+</source>
+
+<match notify.**>
+  type sentry
+
+  # Set endpoint API URL
+  endpoint_url       https://${api_key}:${api_password}@app.getsentry.com/${project_id}
+
+  # Set default events value of 'server_name'
+  hostname_command   hostname -s
+
+  # rewrite shown tag name for Sentry dashboard
+  remove_tag_prefix  notify.
+</match>
+```
+
+## Parameters
+
+* endpoint_url (Required)<br>
+Set endpoint API URL which shows at Sentry dashboard. (it is not sentry account information)
+
+* default_level<br>
+[default] error
+
+* defalut_logger<br>
+[default] flunetd
+
+* hostname_command<br>
+Set default frontend value of 'server_name'
+
+* flush_interval<br>
+[default] 0sec
+
+It also support rewriting Tag with SetTagKeyMixin.
+
+* remove_tag_prefix
+* remove_tag_suffix
+* add_tag_prefix
+* add_tag_suffix
+
+## Blog Articles
+
+## TODO
+
+Pull requests are very welcome!!
+
+## Copyright
+
+Copyright © 2014- Kentaro Yoshida ([@yoshi_ken](https://twitter.com/yoshi_ken))
+
+## License
+
+Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-sentry.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-sentry"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Kentaro Yoshida"]
+  spec.email         = ["y.ken.studio@gmail.com"]
+  spec.summary       = %q{Fluentd output plugin to send aggregated errors/exception events to sentry which are a realtime event logging and aggregation platform.}
+  spec.homepage      = "https://github.com/y-ken/fluent-plugin-sentry"
+  spec.license       = "Apache License, Version 2.0"
+
+  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"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+  spec.add_runtime_dependency "fluentd"
+  spec.add_runtime_dependency "sentry-raven"
+end

data/lib/fluent/plugin/out_sentry.rb

@@ -0,0 +1,81 @@
+class Fluent::SentryOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('sentry', self)
+
+  include Fluent::HandleTagNameMixin
+
+  LOG_LEVEL = %w(fatal error warning info debug)
+  EVENT_KEYS = %w(logger level tags modules message)
+  DEFAULT_HOSTNAME_COMMAND = 'hostname'
+
+  config_param :default_level, :string, :default => 'error'
+  config_param :default_logger, :string, :default => 'fluentd'
+  config_param :endpoint_url, :string
+  config_param :flush_interval, :time, :default => 0
+  config_param :hostname_command, :string, :default => 'hostname'
+
+  def initialize
+    require 'time'
+    require 'raven'
+
+    super
+  end
+
+  def configure(conf)
+    super
+
+    if @endpoint_url.nil?
+      raise Fluent::ConfigError, "sentry: missing parameter for 'endpoint_url'"
+    end
+
+    unless LOG_LEVEL.include?(@default_level)
+      raise Fluent::ConfigError, "sentry: unsupported default reporting log level for 'default_level'"
+    end
+
+    hostname_command = @hostname_command || DEFAULT_HOSTNAME_COMMAND
+    hostname = `#{hostname_command}`.chomp
+
+    @configuration = Raven::Configuration.new
+    @configuration.server = @endpoint_url
+    @configuration.server_name = hostname
+    @client = Raven::Client.new(@configuration)
+  end
+
+  def start
+    super
+  end
+
+  def format(tag, time, record)
+    [tag, time, record].to_msgpack
+  end
+
+  def shutdown
+    super
+  end
+
+  def write(chunk)
+    chunk.msgpack_each do |tag, time, record|
+      begin
+        notify_sentry(tag, time, record)
+      rescue => e
+        $log.error("Sentry Error:", :error_class => e.class, :error => e.message)
+      end
+    end
+  end
+
+  def notify_sentry(tag, time, record)
+    event = Raven::Event.new(
+      :configuration => @configuration, 
+      :context => Raven::Context.new, 
+      :message => record['message']
+    )
+    event.timestamp = Time.at(time).utc.strftime('%Y-%m-%dT%H:%M:%S')
+    event.logger = record['logger'] || @default_logger
+    event.level = record['level'] || @default_level
+    event.tags = record['tags'] || { :tag => tag }
+    event.extra = record.reject{ |key| EVENT_KEYS.include?(key) }
+    event.modules = record['modules'] || nil
+    event.platform = record['platform'] if record['platform']
+    event.server_name = record['server_name'] if record['server_name']
+    @client.send(event)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_sentry'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_sentry.rb

@@ -0,0 +1,69 @@
+require 'helper'
+require 'webmock/test_unit'
+require 'yajl'
+
+WebMock.disable_net_connect!
+
+class SentryOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    type sentry
+    endpoint_url      https://user:password@app.getsentry.com/12345
+    hostname_command  hostname -s
+    remove_tag_prefix input.
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::SentryOutput, tag).configure(conf)
+  end
+
+  def stub_endpoint(url="https://app.getsentry.com/api/12345/store/")
+    parser = Yajl::Parser.new
+    stub_request(:post, url).with do |req|
+      @content_type = req.headers["Content-Type"]
+      @body = parser.parse(req.body)
+    end
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    d = create_driver(CONFIG)
+    assert_equal 'https://user:password@app.getsentry.com/12345', d.instance.config['endpoint_url']
+  end
+
+  def test_emit
+    stub_endpoint
+    d1 = create_driver(CONFIG, 'input.app1_error')
+    emit_level = 'warning'
+    emit_message = 'error has occoured.'
+    emit_extra = {'foo' => {'array' => [1,2,3]}, 'hash' => {'nest' => 'data'}}
+    d1.run do
+      d1.emit({
+        'level' => emit_level,
+        'message' => emit_message,
+        'something' => emit_extra
+      })
+    end
+    p @body
+    emits = d1.emits
+    assert_equal 0, emits.length
+    assert_equal 'application/json', @content_type
+    assert_equal emit_message, @body['message']
+    timestamp = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S')
+    assert_equal timestamp, @body['timestamp']
+    assert_equal emit_level, @body['level']
+    assert_equal '12345', @body['project']
+    assert_equal 'fluentd', @body['logger']
+    assert_equal 'ruby', @body['platform']
+    assert_equal 'app1_error', @body['tags'][':tag']
+    hostname = `#{d1.instance.config['hostname_command']}`.chomp
+    assert_equal hostname, @body['server_name']
+    extra_message = {'something' => emit_extra}
+    assert_equal extra_message, @body['extra']
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sentry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Yoshida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  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: sentry-raven
+  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'
+description: 
+email:
+- y.ken.studio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-sentry.gemspec
+- lib/fluent/plugin/out_sentry.rb
+- test/helper.rb
+- test/plugin/test_out_sentry.rb
+homepage: https://github.com/y-ken/fluent-plugin-sentry
+licenses:
+- Apache License, Version 2.0
+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: Fluentd output plugin to send aggregated errors/exception events to sentry
+  which are a realtime event logging and aggregation platform.
+test_files:
+- test/helper.rb
+- test/plugin/test_out_sentry.rb