fluent-plugin-sentry-ex 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bb0c8ec02c50b37310e6ba5734cfdf7005430cf0ef6dfc30dd3f741c3355444
+  data.tar.gz: 59b2e6abf80381032d605c4f5611738e32fe3b40426409f7eab24fc19102701d
+SHA512:
+  metadata.gz: 4addf3dff74dfb512c0bfd72297b202de9bd332fbd40a4a1e3561482fc92787ecfc186b2558e0fe2fdc509966132ecf2f5ae679be9b19a70113be9ebb94f8699
+  data.tar.gz: e396407515247e0bdefc5b1a8c6987b5a74cc6bef62939d823e35acd03cf670eebee610e0936a4101e7f903fc23a0b3e49a773cdacbe8a4a8193128d7b78dd1b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+
+rvm:
+  - 2.2
+  - 2.1
+
+before_script:
+ - export RAILS_ENV=default
+
+gemfile:
+  - Gemfile
+  - gemfiles/fluentd_v0.10.gemfile
+  - gemfiles/fluentd_v0.12.gemfile
+
+# to avoid travis-ci issue since 2015-12-25
+before_install:
+  - gem update bundler
+
+matrix:
+  include:
+    - rvm: 1.9.3
+      gemfile: gemfiles/fluentd_v0.10.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/fluentd_v0.12.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/fluentd_v0.10.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/fluentd_v0.12.gemfile
+

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "fluentd v0.10" do
+  gem "fluentd", "~> 0.10.46"
+end
+
+appraise "fluentd v0.12" do
+  gem "fluentd", "~> 0.12.0"
+end
+

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,102 @@
+# 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
+
+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>
+
+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 td-agent provided command as:
+
+```bash
+# for fluentd
+$ gem install fluent-plugin-sentry
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-sentry
+
+# for td-agent2
+$ sudo td-agent-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'
+  # To set short hostname, set like below.
+  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>
+[default] hostname
+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-ex.gemspec

@@ -0,0 +1,32 @@
+# 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-ex"
+  spec.version       = "0.0.5"
+  spec.authors       = ["Kentaro Yoshida"]
+  spec.email         = ["y.ken.studio@gmail.com"]
+  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/chuanwenchen/fluent-plugin-sentry-ex"
+  spec.license       = "Apache-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_development_dependency "test-unit", ">= 3.1.0"
+  spec.add_development_dependency "appraisal"
+
+  # Since Fluentd v0.14 requires ruby 2.1 or later.
+  if defined?(RUBY_VERSION) && RUBY_VERSION < "2.1"
+    spec.add_runtime_dependency "fluentd", "< 0.14"
+  else
+    spec.add_runtime_dependency "fluentd"
+  end
+  spec.add_runtime_dependency "sentry-raven", "~> 0.15.0"
+end

data/gemfiles/fluentd_v0.10.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "fluentd", "~> 0.10.46"
+
+gemspec :path => "../"

data/gemfiles/fluentd_v0.12.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "fluentd", "~> 0.12.0"
+
+gemspec :path => "../"

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(message timestamp time_spent level logger culprit server_name release tags)
+  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 = 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.logger = record['logger'] || @default_logger
+    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) }
+    @client.send_event(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,129 @@
+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',use_v1=false)
+    require 'fluent/version'
+    if Gem::Version.new(Fluent::VERSION) < Gem::Version.new('0.12')
+      Fluent::Test::OutputTestDriver.new(Fluent::SentryOutput, tag).configure(conf, use_v1)
+    else
+      Fluent::Test::BufferedOutputTestDriver.new(Fluent::SentryOutput, tag).configure(conf, use_v1)
+    end
+  end
+
+  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"]
+      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
+
+  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_post
+    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
+    timestamp = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S')
+    assert_equal 0, emits.length
+    assert_equal 'application/octet-stream', @content_type
+    assert_equal emit_message, @body['message']
+    assert_equal timestamp, @body['timestamp']
+    assert_equal emit_level, @body['level']
+    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
+
+  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

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sentry-ex
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Kentaro Yoshida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: webmock
+  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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: fluentd
+  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'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+description: 
+email:
+- y.ken.studio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-sentry-ex.gemspec
+- gemfiles/fluentd_v0.10.gemfile
+- gemfiles/fluentd_v0.12.gemfile
+- lib/fluent/plugin/out_sentry.rb
+- test/helper.rb
+- test/plugin/test_out_sentry.rb
+homepage: https://github.com/chuanwenchen/fluent-plugin-sentry-ex
+licenses:
+- Apache-2.0
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+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