elastic_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed027f810badc2de1a6a7dc4006bc8cfe30ff87b
+  data.tar.gz: d4b82848b6452585d537f0fe876dcae40e204811
+SHA512:
+  metadata.gz: 9b796cb23416d6f95fe619450dfd744f5e4ff85c38de109e5493db278bd936cba9b658e79638af4d6ae599c434501f274de55dfdadf13a14aa0de1f20a356688
+  data.tar.gz: 43ad99bc00c4849bb800293c3f725c1ac1e56edda062166bfe3baeccaa99d9c58962e43903a23e02de607bdec5e4af7a24bf6dea810afa2dad5fdc22b3e545e0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/tags
+/Gemfile.lock
+/*.gem

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0.pre.3
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+env:
+  global:
+    - CC_TEST_REPORTER_ID=ec4fd9d5fdb3f0b610069686575e97d79b4b3c03f3102517e6145076b5ee22d5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant, version 1.2.0](http://contributor-covenant.org/version/1/2/0/).

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in elastic_notifier.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Fabio Pitino
+
+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,95 @@
+# ElasticNotifier
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/92763b5c5c012431d829/maintainability)](https://codeclimate.com/github/hspazio/elastic_notifier/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/92763b5c5c012431d829/test_coverage)](https://codeclimate.com/github/hspazio/elastic_notifier/test_coverage)
+[![Build Status](https://travis-ci.org/hspazio/elastic_notifier.svg?branch=master)](https://travis-ci.org/hspazio/elastic_notifier)
+
+ElasticNotifier gem provides a simple API to send error notifications to an Elastic Search instance. 
+
+It can also be used as plug-in for [exception_notification][exception_notification] gem to send error notifications caught by the Rack middleware. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elastic_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastic_notifier
+
+## Usage
+
+```ruby
+NOTIFIER = ElasticNotifier.new(
+  url: "http://myserver.com:9200", # default is http://localhost:9200
+  index: "my_custom_index",        # default is :elastic_notifier
+  type: "my_document_type"         # default is :signals
+)
+```
+
+For __Rails__ applications you can add the code above to `config/initializers/elastic_notifier.rb` so it will be available throghout the app.
+
+Then send error notifications as you rescue errors:
+
+```ruby
+begin
+  # some code that raises an exception
+rescue => error
+  NOTIFIER.notify_error(error)
+end
+```
+
+## As ExceptionNotification's Plugin
+
+If you are already using [exception_notification][exception_notification] gem within a Rails app you can use ElasticNotifier out of the box.
+
+In `config/initializers/elastic_notifier.rb`, after initializing the notifier object as described above, you need to register it [as documented here](https://github.com/smartinez87/exception_notification#custom-notifier).
+
+```ruby
+notifier = ElasticNotifier.new(url: "http://myserver.com:9200")
+ExceptionNotifier.add_notifier :elastic_search, notifier
+```
+
+## What information is being sent?
+
+At the time the notifier is invoked it collects some information from the environment, serializes it together with the exception details and sent it to the Elastic instance.
+
+```ruby
+{
+  severity: "error",
+  timestamp: "2017-12-31 23:59:59",
+  program_name: "my_app.rb",
+  pid: 1345,
+  hostname: "myservicename",
+  ip: "123.123.123.123",
+  data: {
+    name: "NoMethodError",
+    message: "undefined method `test` for nil:NilClass",
+    backtrace: [...]
+  }
+}
+
+```
+
+It is possible to override parameters such as `program_name` which will remain static for the notifier instance.
+
+```ruby
+notifier = ElasticNotifier.new(url: "http://myserver.com:9200", program_name: "custom_name")
+```
+
+## Contributing
+
+Bug reports and pull requests are very welcome. Please be aware that you are expected to follow the [code of conduct](https://github.com/hspazio/elastic_notifier/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+Copyright (c) 2017 Fabio Pitino, released under the [MIT license](http://www.opensource.org/licenses/MIT).
+
+[exception_notification]: https://github.com/smartinez87/exception_notification

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elastic_notifier"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elastic_notifier.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "elastic_notifier/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "elastic_notifier"
+  spec.version       = ElasticNotifier::VERSION
+  spec.authors       = ["Fabio Pitino"]
+  spec.email         = ["pitinofabio@gmail.com"]
+
+  spec.summary       = %q{ElasticSearch error notifier}
+  spec.description   = %q{Send errors to ElasticSearch }
+  spec.homepage      = "https://github.com/hspazio/elastic_notifier"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_dependency "elasticsearch-persistence", "~> 5.0"
+  spec.add_dependency "typhoeus", "~> 1.3"
+end

data/lib/elastic_notifier.rb

@@ -0,0 +1,34 @@
+require 'elasticsearch/persistence'
+require 'typhoeus/adapters/faraday'
+require 'socket'
+
+require 'elastic_notifier/signal'
+require 'elastic_notifier/error'
+require 'elastic_notifier/version'
+
+module ElasticNotifier
+  def self.new(options = {})
+    Notifier.new(options)
+  end
+
+  class Notifier
+    def initialize(options)
+      @repo ||= Elasticsearch::Persistence::Repository.new do
+        client Elasticsearch::Client.new url: options[:url]
+        index  options.fetch(:index, :elastic_notifier)
+        type   options.fetch(:type, :signals)
+      end
+      @options = options
+    end
+
+    def notify_error(exception, params = {})
+      overrides = {
+        program_name: @options[:program_name]
+      }
+      error = Error.new(exception, overrides).to_hash
+      @repo.save(error)
+    end
+    alias call notify_error
+  end
+end
+

data/lib/elastic_notifier/error.rb

@@ -0,0 +1,22 @@
+module ElasticNotifier
+  class Error < Signal
+    attr_reader :attributes
+
+    def initialize(error, overrides = {})
+      super(overrides)
+      @error = error
+    end
+
+    def severity
+      'error'
+    end
+
+    def data
+      { 
+        name: @error.class.name,
+        message: @error.message,
+        backtrace: @error.backtrace
+      }
+    end
+  end
+end

data/lib/elastic_notifier/signal.rb

@@ -0,0 +1,39 @@
+module ElasticNotifier
+  class Signal
+    attr_reader :attributes
+
+    def initialize(overrides = {})
+      @pid = Process.pid
+      @hostname = Socket.gethostname
+      @ip = find_ip_address
+      @timestamp = Time.now.strftime('%Y-%m-%dT%H:%M:%S')
+      @program_name = overrides[:program_name] || $PROGRAM_NAME
+    end
+
+    def to_hash
+      { 
+        severity: severity,
+        timestamp: @timestamp,
+        program_name: @program_name,
+        pid: @pid,
+        hostname: @hostname,
+        ip: @ip,
+        data: data
+      }
+    end
+
+    def severity
+      raise NotImplementedError
+    end
+
+    def data
+      raise NotImplementedError
+    end
+
+    private 
+
+    def find_ip_address
+      Socket.ip_address_list.find { |ip| ip.ipv4? && !ip.ipv4_loopback? }.ip_address
+    end
+  end
+end

data/lib/elastic_notifier/version.rb

@@ -0,0 +1,3 @@
+module ElasticNotifier
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: elastic_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabio Pitino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-persistence
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 'Send errors to ElasticSearch '
+email:
+- pitinofabio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elastic_notifier.gemspec
+- lib/elastic_notifier.rb
+- lib/elastic_notifier/error.rb
+- lib/elastic_notifier/signal.rb
+- lib/elastic_notifier/version.rb
+homepage: https://github.com/hspazio/elastic_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: ElasticSearch error notifier
+test_files: []