reevoo_app_monitor 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d4488b68e07d2fb7d83150a4da60b0709fdd9b6
+  data.tar.gz: 39ef1f29fdcf9302e3c8de1424521cee0a034286
+SHA512:
+  metadata.gz: 54a3659a2b607cbdb2ff9611356c4e0f0d3a8924a4ec622e9f2552ac70db64a49116af08a94d4591910c7a5e93a24771431e1f9eadf97540152f7c6ff9cc7a4f
+  data.tar.gz: e5c3931d595f0f0299c6809a6697215f2cf8e70d300cc367ad1cab61a1f80d7b8054e6f626c566a6fb4e6e4a93c000991c296af94350993edfda5c81ab316497

data/.gitignore

@@ -0,0 +1,6 @@
+/Gemfile.lock
+/coverage/
+/spec/reports/
+/tmp/
+.idea
+log/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+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 contacting a project maintainer at alex.malkov@reevoo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reevoo_app_monitor.gemspec
+gemspec
+
+group :test do
+  gem 'pry-nav'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Reevoo Ltd
+
+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,111 @@
+# ReevooAppMonitor
+
+ReevooAppMonitor consolidates logstasher, statsd and sentry raven into a single library with one setup.
+It's designed for Rack/Grape apps. It automatically tracks all log messages into logstash, exceptions into
+sentry and updates exceptions stats in statsd. It also allow you to call methods directly on instances of statsd
+and raven if needed.
+
+## Installation
+
+### In your Gemfile:
+
+```ruby
+gem 'reevoo_app_monitor'
+```
+
+### Init app monitor:
+
+```ruby
+module TestApp
+  def self.production?
+    ENV["RACK_ENV"] == "production"
+  end
+
+  def self.app_monitor
+    @app_monitor ||= ReevooAppMonitor.new(
+      app_name: "foo_app",
+      root_dir: Rack::Directory.new("").root
+      device: STDOUT,
+      raven_conf: {
+        dsn: "https://00c73aa8f93f4hbwjehb4r20af10afb@app.getsentry.com/502146"
+      }
+    ) if production?
+  end
+
+  def self.logger
+    production? ? app_monitor.logger : Logger.new(STDOUT)
+  end
+
+  def self.stats
+    production? ? app_monitor.stats : ReevooAppMonitor.nil_service
+  end
+end
+```
+
+All constructor arguments:
+
+```ruby
+ReevooAppMonitor.new(
+  app_name: "foo_app",
+  root_dir: Rack::Directory.new("").root
+  device: STDOUT, # default is file log in log/logstasher.log
+  integrations: [:logstasher, :statsd, :raven], # you can turn off individual integrations
+  raven_conf: {
+    dsn: "https://00c73aa8f93f4hbwjehb4r20af10afb@app.getsentry.com/502146"
+  },
+  statsd_conf: { # in most cases you should be fine with default localhost:8125
+    host: "my-host",
+    port: 1234
+  }
+)
+```
+
+
+### Setup Grape request/exception logging
+
+Add to Gemfile
+
+```ruby
+gem 'grape_logging'
+```
+
+Setup in Grape::API class
+
+```ruby
+module TestApp
+  class API < Grape::API
+    logger TestApp.logger
+    use GrapeLogging::Middleware::RequestLogger, logger: TestApp.logger
+
+    rescue_from TestApp::NotFound do |err|
+      # Tag your exception
+      API.logger.info(exception: err, tags: "rescued_exception", status: 404)
+      error_response(message: "Not found", status: 404)
+    end
+
+    rescue_from :all do |e|
+      API.logger.error(e)
+      error_response(message: e.message, status: 500)
+    end
+  end
+end
+```
+
+
+### Track statsd metrics directly
+
+You can call all methods supported by https://github.com/DataDog/dogstatsd-ruby
+
+```ruby
+  TestApp.stats.increment('foo.bar')
+  TestApp.stats.gauge('foo.online', 123)
+  TestApp.stats.histogram('foo.upload.size', 1234)
+  TestApp.stats.time('page.render') do
+    render_page('home.html')
+  end
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reevoo_app_monitor"
+
+# 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

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/lib/reevoo_app_monitor.rb

@@ -0,0 +1,63 @@
+require "reevoo_app_monitor/version"
+require "reevoo_app_monitor/logger"
+require "logstasher"
+require "statsd"
+require "raven/base"
+
+class ReevooAppMonitor
+  DEFAULT_INTEGRATIONS = [:logstasher, :statsd, :raven]
+
+  attr_reader :logger, :stats
+
+  def initialize(app_name:, root_dir: nil, device: nil, level: ::Logger::INFO,
+      env: ENV["RACK_ENV"], integrations: DEFAULT_INTEGRATIONS, statsd_conf: {}, raven_conf: {})
+
+    @stats = init_statsd(statsd_conf, app_name, env)              if integrations.include?(:statsd)
+    raven = init_raven(raven_conf, app_name, env)                 if integrations.include?(:raven)
+    formatter = LogStasher::LogFormatter.new(app_name, root_dir)  if integrations.include?(:logstasher)
+
+    device ||= get_device(root_dir)
+    @logger = init_logger(device, level, formatter, statsd: @stats, raven: raven)
+  end
+
+  def nil_service
+    @nil_service ||= ReevooAppMonitor::NilService.new
+  end
+
+  private
+
+  def get_device(root_dir)
+    return STDOUT unless root_dir
+
+    log_dir = File.join(root_dir, 'log')
+    Dir.mkdir(log_dir) unless File.exists?(log_dir)
+    device = File.join(log_dir, 'logstasher.log')
+    FileUtils.touch(device)
+    device
+  end
+
+  def init_logger(device, level, formatter, statsd: nil, raven: nil)
+    Logger.new(device, statsd: statsd, raven: raven).tap do |new_logger|
+      new_logger.level     = level
+      new_logger.formatter = formatter if formatter
+    end
+  end
+
+  def init_statsd(statsd_conf, app_name, env)
+    Statsd.new(
+      statsd_conf.fetch(:host, 'localhost'),
+      statsd_conf.fetch(:port, 8125),
+      namespace: app_name,
+      tags: ["env:#{env}"],
+    )
+  end
+
+  def init_raven(raven_conf, app_name, env)
+    Raven.configure do |config|
+      config.tags = { env: env }
+      config.silence_ready = true
+      raven_conf.each_pair { |key, value| config.send("#{key}=", value) }
+    end
+    Raven
+  end
+end

data/lib/reevoo_app_monitor/logger.rb

@@ -0,0 +1,60 @@
+require 'active_support/core_ext/string/inflections'
+require 'logger'
+
+class ReevooAppMonitor
+  class Logger < ::Logger
+
+    def initialize(device, statsd: nil, raven: nil)
+      super(device)
+      @statsd = statsd
+      @raven = raven
+    end
+
+    def add(severity, message = nil, progname = nil, &block)
+      super
+
+      # Naming of these arguments is weird, if no block is given to debug|info|warn|error|fatal method
+      # it passes the message to #add as a progname and message argument is always nil. See the test for this class.
+      exception = extract_exception(progname)
+      tags = extract_tags(progname)
+      track_exception_to_statsd(severity, exception, tags) if exception && @statsd
+      track_exception_to_raven(severity, exception, tags) if exception && @raven
+    end
+
+    private
+
+    def extract_exception(message)
+      if message.is_a?(Exception)
+        message
+      elsif message.is_a?(Hash) && message[:exception] && message[:exception].is_a?(Exception)
+        message[:exception]
+      end
+    end
+
+    def extract_tags(message)
+      message.is_a?(Hash) ? Array(message[:tags]) : []
+    end
+
+    def track_exception_to_statsd(severity, exception, tags)
+      key_parts = ['exception', exception.class.to_s.underscore]
+      if exception.message != exception.class.to_s # message is the class name if not provided when raising
+        # Remove all non LATIN1 characters and get only first 100 characters
+        key_parts << exception.message.downcase.gsub(/[^a-zA-Z0-9]/, '_')[0...100]
+      end
+
+      @statsd.increment(key_parts.join('.'), tags: ["severity:#{severity_text(severity)}"] + tags)
+    end
+
+    def track_exception_to_raven(severity, exception, tags)
+      return if severity < ERROR
+      options = { tags: { severity: severity_text(severity) } }
+      options[:extra] = { extra_tags: tags } unless tags.empty?
+      @raven.capture_exception(exception, options)
+    end
+
+    def severity_text(severity)
+      format_severity(severity).downcase
+    end
+
+  end
+end

data/lib/reevoo_app_monitor/nil_service.rb

@@ -0,0 +1,7 @@
+class ReevooAppMonitor
+  class NilService
+    def method_missing(*args)
+      nil
+    end
+  end
+end

data/lib/reevoo_app_monitor/rack/common_logger_adapter.rb

@@ -0,0 +1,8 @@
+require "logstasher/rack/common_logger_adapter"
+
+class ReevooAppMonitor
+  module Rack
+    class CommonLoggerAdapter < LogStasher::Rack::CommonLoggerAdapter
+    end
+  end
+end

data/lib/reevoo_app_monitor/version.rb

@@ -0,0 +1,3 @@
+class ReevooAppMonitor
+  VERSION = "0.2.0"
+end

data/reevoo_app_monitor.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reevoo_app_monitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reevoo_app_monitor"
+  spec.version       = ReevooAppMonitor::VERSION
+  spec.authors       = ["Alex Malkov", "David Sevcik"]
+  spec.email         = ["alex.malkov@reevoo.com", "david.sevcik@reevoo.com"]
+
+  spec.summary       = %q{Produces log in the logstash format with ability to log events into DataDog}
+  spec.description   = %q{Produces log in the logstash format with ability to log events into DataDog}
+  spec.homepage      = "https://github.com/reevoo/reevoo_app_monitor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rv-logstasher", "~> 1.3"
+  spec.add_dependency "dogstatsd-ruby", "~> 1.6"
+  spec.add_dependency "sentry-raven", "~> 0.15.6"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: reevoo_app_monitor
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alex Malkov
+- David Sevcik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rv-logstasher
+  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'
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  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'
+description: Produces log in the logstash format with ability to log events into DataDog
+email:
+- alex.malkov@reevoo.com
+- david.sevcik@reevoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reevoo_app_monitor.rb
+- lib/reevoo_app_monitor/logger.rb
+- lib/reevoo_app_monitor/nil_service.rb
+- lib/reevoo_app_monitor/rack/common_logger_adapter.rb
+- lib/reevoo_app_monitor/version.rb
+- reevoo_app_monitor.gemspec
+homepage: https://github.com/reevoo/reevoo_app_monitor
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Produces log in the logstash format with ability to log events into DataDog
+test_files: []