fluent-plugin-sentry 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bfaae537c17396c389b8ccd323104190294ccd6
+  data.tar.gz: d68fd5b98458bded9adf0f69733409ec78dffda3
+SHA512:
+  metadata.gz: 29e7dd065b655557f1e311881c2d2b937b69bf5dbad4e26948e6f137a250d4217134e8a07e6caffdfa8202ebfefc59bc0a2a4372a5c26c5de4f90fbfd47431fc
+  data.tar.gz: 6278d264c328045eed79c1037b6100d142888789cad79c78e6b983f238400dad2f7156f95900fa2d85ac37f4f1e8ebfad47c6409e9c1d0c451595e4d5a5c9a75

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 
 rvm:
-  - 2.1.0
+  - 2.2.0
+  - 2.1
   - 2.0.0
   - 1.9.3
 

data/README.md

@@ -2,25 +2,30 @@
 
 ## Overview
 
-Fluentd output plugin to send aggregated errors/exception events to Sentry which are a realtime event logging and aggregation platform.<br>
+fluent-plugin-sentry is a fluentd output plugin that sends aggregated errors/exception events to Sentry. Sentry is a 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 alone does not buffer incoming requests, so if your Sentry instance is under load, Sentry can respond with a 503 Service Unavailable.<br>
+
+fluent-plugin-sentry extends fluent buffered output and enables a fluend user to buffer and flush messages to Sentry with reliable delivery.
 
 * [Sentry Official web](https://getsentry.com/welcome/)
 * [Sentry Documents](http://sentry.readthedocs.org/en/latest/) [Screenshots](https://github.com/getsentry/sentry#screenshots)
 
+> ![http://blog.getsentry.com/images/hero.png](https://cloud.githubusercontent.com/assets/1734549/5498750/2b471a6c-8767-11e4-8634-961c99e635ed.png)
+(quoted from http://blog.getsentry.com/)
+
+
 ## Installation
 
-install with gem or fluent-gem command as:
+install with `gem` or `fluent-gem` command as:
 
-`````
-### native gem
-gem install fluent-plugin-sentry
+```bash
+# for fluentd
+$ gem install fluent-plugin-sentry
 
-### td-agent gem
-/usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-sentry
-`````
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-sentry
+```
 
 ## Preparation
 
@@ -43,9 +48,10 @@ OR
   type sentry
 
   # Set endpoint API URL
-  endpoint_url       https://${api_key}:${api_password}@app.getsentry.com/${project_id}
+  endpoint_url       https://API_KEY:API_PASSWORD@app.getsentry.com/PROJECT_ID
 
   # Set default events value of 'server_name'
+  # To set short hostname, set like below.
   hostname_command   hostname -s
 
   # rewrite shown tag name for Sentry dashboard
@@ -65,6 +71,7 @@ Set endpoint API URL which shows at Sentry dashboard. (it is not sentry account
 [default] flunetd
 
 * hostname_command<br>
+[default] hostname
 Set default frontend value of 'server_name'
 
 * flush_interval<br>

data/fluent-plugin-sentry.gemspec

@@ -4,12 +4,12 @@ $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.version       = "0.0.2"
   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.summary       = %q{Fluentd output plugin that sends aggregated errors/exception events to Sentry. Sentry is a event logging and aggregation platform.}
   spec.homepage      = "https://github.com/y-ken/fluent-plugin-sentry"
-  spec.license       = "Apache License, Version 2.0"
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -19,6 +19,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "webmock"
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    spec.add_development_dependency "test-unit", '~> 3'
+  end
+  
   spec.add_runtime_dependency "fluentd"
-  spec.add_runtime_dependency "sentry-raven"
+  spec.add_runtime_dependency "sentry-raven", "~> 0.15.0"
 end

data/lib/fluent/plugin/out_sentry.rb

@@ -4,7 +4,7 @@ class Fluent::SentryOutput < Fluent::BufferedOutput
   include Fluent::HandleTagNameMixin
 
   LOG_LEVEL = %w(fatal error warning info debug)
-  EVENT_KEYS = %w(logger level tags modules message)
+  EVENT_KEYS = %w(message timestamp time_spent level logger culprit server_name release tags)
   DEFAULT_HOSTNAME_COMMAND = 'hostname'
 
   config_param :default_level, :string, :default => 'error'
@@ -32,11 +32,11 @@ class Fluent::SentryOutput < Fluent::BufferedOutput
     end
 
     hostname_command = @hostname_command || DEFAULT_HOSTNAME_COMMAND
-    hostname = `#{hostname_command}`.chomp
+    @hostname = `#{hostname_command}`.chomp
 
     @configuration = Raven::Configuration.new
     @configuration.server = @endpoint_url
-    @configuration.server_name = hostname
+    @configuration.server_name = @hostname
     @client = Raven::Client.new(@configuration)
   end
 
@@ -68,14 +68,15 @@ class Fluent::SentryOutput < Fluent::BufferedOutput
       :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.timestamp = record['timestamp'] || Time.at(time).utc.strftime('%Y-%m-%dT%H:%M:%S')
+    event.time_spent = record['time_spent'] || nil
     event.level = record['level'] || @default_level
-    event.tags = record['tags'] || { :tag => tag }
+    event.logger = record['logger'] || @default_logger
+    event.culprit = record['culprit'] || nil
+    event.server_name = record['server_name'] || @hostname
+    event.release = record['release'] if record['release']
+    event.tags = event.tags.merge({ :tag => tag }.merge(record['tags'] || {}))
     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)
+    @client.send_event(event)
   end
 end

data/test/plugin/test_out_sentry.rb

@@ -20,11 +20,20 @@ class SentryOutputTest < Test::Unit::TestCase
     Fluent::Test::OutputTestDriver.new(Fluent::SentryOutput, tag).configure(conf)
   end
 
-  def stub_endpoint(url="https://app.getsentry.com/api/12345/store/")
+  def stub_post(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)
+      message = Zlib::Inflate.inflate(Base64.decode64(req.body))
+      @body = parser.parse(message)
+    end
+  end
+
+  def stub_response(url="https://app.getsentry.com/api/12345/store/")
+    stub_request(:post, url).with do |req|
+      @content_type = req.headers["Content-Type"]
+      message = Zlib::Inflate.inflate(Base64.decode64(req.body))
+      @body = {"eventID"=>"fe0263d6f55d014cade15a8681ae58ed", "tags"=>[["tag", "app1_error"], ["cool", "bar"], ["level", "warning"], ["logger", "zaphod"], ["server_name", "bc40a4be7b2d"], ["sentry:release", "wingnut"]], "nextEventID"=>nil, "dateCreated"=>"2015-10-30T08:25:48Z", "timeSpent"=>13, "user"=>nil, "entries"=>[], "previousEventID"=>nil, "message"=>"error has occoured.", "packages"=>{"fluentd"=>"0.12.16", "sentry-raven"=>"0.15.2", "cool.io"=>"1.4.1", "faraday"=>"0.9.2", "safe_yaml"=>"1.0.4", "msgpack"=>"0.5.12", "bundler"=>"1.10.6", "json"=>"1.8.3", "crack"=>"0.4.2", "tzinfo"=>"1.2.2", "thread_safe"=>"0.3.5", "tzinfo-data"=>"1.2015.7", "rake"=>"10.4.2", "yajl-ruby"=>"1.2.1", "hashdiff"=>"0.2.2", "sigdump"=>"0.2.3", "multipart-post"=>"2.0.0", "string-scrub"=>"0.0.5", "addressable"=>"2.3.8", "webmock"=>"1.22.2", "http_parser.rb"=>"0.6.0", "fluent-plugin-sentry"=>"0.0.1"}, "id"=>"127", "platform"=>"ruby", "context"=>{"something"=>{"foo"=>{"array"=>[1, 2, 3]}, "hash"=>{"nest"=>"data"}}}, "groupID"=>127}
     end
   end
 
@@ -37,7 +46,7 @@ class SentryOutputTest < Test::Unit::TestCase
   end
 
   def test_emit
-    stub_endpoint
+    stub_post
     d1 = create_driver(CONFIG, 'input.app1_error')
     emit_level = 'warning'
     emit_message = 'error has occoured.'
@@ -52,18 +61,64 @@ class SentryOutputTest < Test::Unit::TestCase
     p @body
     emits = d1.emits
     assert_equal 0, emits.length
-    assert_equal 'application/json', @content_type
+    assert_equal 'application/octet-stream', @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']
+    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
+
+  def test_emit_mock
+    stub_response
+    emit_level = 'warning'
+    emit_message = 'error has occoured.'
+    emit_timestamp = '2015-10-30T08:25:48Z'.force_encoding("UTF-8")
+    emit_time_spent = '13'
+    emit_logger = 'zaphod'
+    emit_server_name = 'bc40a4be7b2d'
+    emit_culprit = 'whodonit'
+    emit_release = 'wingnut'
+    emit_extra = {'foo' => {'array' => [1,2,3]}, 'hash' => {'nest' => 'data'}}
+    d1 = create_driver(CONFIG, 'input.app1_error')
+    d1.run do
+      d1.emit({
+        'level' => emit_level,
+        'message' => emit_message,
+        'something' => emit_extra,
+        'tags' => {'cool' => 'bar'},
+        'timestamp' => emit_timestamp,
+        'logger' => emit_logger,
+        'server_name' => emit_server_name,
+        'release' => emit_release,
+        'time_spent' => emit_time_spent,
+        'culprit' => emit_culprit
+      })
+    end
+    p @body
+    emits = d1.emits
+    extra_message = {'something' => emit_extra}
+    assert_equal 0, emits.length
+    assert_equal 'application/octet-stream', @content_type
+    assert_equal extra_message, @body['context']
+    assert_equal emit_timestamp, @body['dateCreated']
+    assert_equal emit_message, @body['message']
+    assert_equal emit_level, Hash[ @body['tags'] ]['level']
+    assert_equal emit_logger, Hash[ @body['tags'] ]['logger']
+    assert_equal emit_server_name, Hash[ @body['tags'] ]['server_name']
+    assert_equal emit_release, Hash[ @body['tags'] ]['sentry:release']
+    assert_equal 'bar', Hash[ @body['tags'] ]['cool']
+    assert_equal 'app1_error', Hash[ @body['tags'] ]['tag']
+    assert_equal 'ruby', @body['platform']
+    assert_equal nil, @body['user']
+    # these values seem to only be visible in the ui. need to find the api to grab them
+    #assert_equal emit_culprit, @body['culprit']
+    #assert_equal emit_time_spent, @body['timeSpent']
+  end
 end

metadata

@@ -1,96 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-sentry
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Kentaro Yoshida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2015-10-30 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: test-unit
+  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: 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'
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.0
 description: 
 email:
 - y.ken.studio@gmail.com
@@ -98,8 +101,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -110,30 +113,29 @@ files:
 - test/plugin/test_out_sentry.rb
 homepage: https://github.com/y-ken/fluent-plugin-sentry
 licenses:
-- Apache License, Version 2.0
+- Apache-2.0
+metadata: {}
 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
+rubygems_version: 2.4.5
 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.
+specification_version: 4
+summary: Fluentd output plugin that sends aggregated errors/exception events to Sentry.
+  Sentry is a event logging and aggregation platform.
 test_files:
 - test/helper.rb
 - test/plugin/test_out_sentry.rb