vitals 0.0.2 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 144354fc633911fa91781b4ceefc10e9e8b0f7f7
+  data.tar.gz: 72b1133aa8c4ac7aa9bdcc59d69781f946ef9551
+SHA512:
+  metadata.gz: 037a86c00abc7b8e1206f3ce651538a93d177b26853c57dda4f0d1511f57555b293bb72da24f9e930c8bfa1099686d92face5faf397b5de925e4877f34432e71
+  data.tar.gz: 0abeedcabd6f8a33403b5c894555b5729bb3b2fd1d960eaa01d22469217837d98ba6c3a976a0373bc9b5e39fe772a9839953cb6e82dec4002b079e1cf37dacc2

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/coverage/
+coverage/

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+#  - ruby-head
+# use latest bundler because of ruby-head exposing a bundler bug.
+# see https://github.com/bundler/bundler/pull/3559
+# So, that didn't work. so let's not use ruby-head for a while
+before_install: gem install bundler
+matrix:
+  include:
+    - rvm: 2.3.0
+      script: bundle exec rake multiverse

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vitals.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,157 @@
+PATH
+  remote: .
+  specs:
+    vitals (0.3.0)
+      statsd-ruby (~> 1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.2.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    benchmark-ips (2.5.0)
+    builder (3.2.2)
+    coderay (1.1.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    grape (0.15.0)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.4)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    guard-rubocop (1.2.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    hashie (3.4.3)
+    i18n (0.7.0)
+    ice_nine (0.11.2)
+    json (1.8.3)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    memory_profiler (0.9.6)
+    method_source (0.8.2)
+    minitest (5.8.4)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    nenv (0.3.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.3.0.6)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rr (1.1.2)
+    rubocop (0.38.0)
+      parser (>= 2.3.0.6, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.7.5)
+    shellany (0.0.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    slop (3.6.0)
+    statsd-ruby (1.3.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.2)
+    tins (1.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.0.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.2.6)
+  benchmark-ips (~> 2.5.0)
+  bundler (~> 1.11)
+  coveralls (~> 0.8.13)
+  grape (~> 0.15.0)
+  guard-minitest (~> 2.4.4)
+  guard-rubocop (~> 1.2.0)
+  memory_profiler (~> 0.9.6)
+  minitest (~> 5.0)
+  rack-test (~> 0.6.3)
+  rake (~> 10.0)
+  rr (~> 1.1.2)
+  sinatra (~> 1.4.7)
+  vitals!
+
+BUNDLED WITH
+   1.11.2

data/Guardfile

@@ -0,0 +1,11 @@
+guard :minitest do
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end
+
+#guard :rubocop do
+#  watch(%r{.+\.rb$})
+#  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+#end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dotan Nahum
+
+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

@@ -1,22 +1,148 @@
 # Vitals
 
-Vitals is a very simple rails 3 plugin which reports `ActiveSupport` `Notification`s
-back to `statsd`.
+[![Build Status](https://travis-ci.org/jondot/vitals.svg?branch=master)](https://travis-ci.org/jondot/vitals.svg)
+[![Coverage Status](https://coveralls.io/repos/github/jondot/vitals/badge.svg?branch=master)](https://coveralls.io/github/jondot/vitals?branch=master)
 
-## Getting Started
+Vitals is the one stop shop to doing metrics in Ruby. It currently support Rails,
+Rack (Sinatra and any Rack-supported frameworks), and Grape.
 
-Add `vitals` to your `Gemfile`. Then, run:
 
-    $ rails g vitals
+## Installation
 
-or, if you're not running `statsd` at the default configuration
-(localhost/8125) try:
+Add this line to your application's Gemfile:
 
-    $ rails g vitals --statsd-host=<YOURHOST> --port=<PORT>
+```ruby
+gem 'vitals'
+```
 
-Which places a convenience initializer for you; and you're done!
+And then execute:
 
+    $ bundle
 
+Or install it yourself as:
 
+    $ gem install vitals
 
+## Usage
 
+### Rails or Grape
+
+Make an `initializers/vitals.rb` initializer, and cofigure Vitals as you'd like:
+```ruby
+require 'vitals'
+Vitals.configure! do |c|
+  c.facility = 'my_service'
+  c.reporter = Vitals::Reporters::StatsdReporter.new(host: 'statsd-host', port: 8125)
+end
+
+#
+# Rails
+#
+require 'vitals/integrations/notifications/action_controller'
+Vitals::Integrations::Notifications::ActionController.subscribe!
+
+# if you also want ActiveJob metrics
+require 'vitals/integrations/notifications/action_job'
+Vitals::Integrations::Notifications::ActiveJob.subscribe!
+
+
+#
+# Grape
+#
+require 'vitals/integrations/notifications/grape'
+Vitals::Integrations::Notifications::Grapej.subscribe!
+```
+
+### Rack
+
+Here, you can use the `Requests` middleware. Here is a sample Sinatra app:
+
+```ruby
+require 'vitals'
+require 'vitals/integrations/rack/requests'
+
+class SinatraTestAPI < Sinatra::Base
+  use Vitals::Integrations::Rack::Requests
+
+  get '/foo/bar/baz' do
+    sleep 0.1
+    "hello get"
+  end
+
+  post '/foo/bar/:name' do
+    sleep 0.1
+    "hello post"
+  end
+end
+```
+
+### Ruby
+
+You can emit metrics from anywhere:
+
+```ruby
+Vitals.inc('my_metric')
+
+Vitals.gauge('my_metric', 42)
+
+Vitals.timing('my_metric', 500) # milliseconds
+
+Vitals.time('my_metric'){
+ # so something slow
+}
+
+# Use a dot to logically separate segments
+
+Vitals.timing('category.my_metric', 500) # milliseconds
+```
+
+### Configuration Options
+
+The Vitals API is extensible. It should resemble the standard `Logger` look and feel,
+and it revolves around 3 concepts:
+
+1. `Reporter` - the thing that takes your metrics and flushes them to a metrics agent. Use `StatsdReporter` in production
+and `ConsoleReporter` in development. `ConsoleReporter` will spit out metrics to `stdout` as they come. You can also
+wire them _both_ with `MultiReporter`. Check the [specs](/spec/reporters) for how to do that.
+2. `Format` - takes the contextual information (host, service, environment) and your metric, and formats them in an
+order that makes sense for working with Graphite. You have the `ProductionFormat` and `HostLastFormat`.
+3. `Integrations` - integrations hook things that we're able to instrument with Vitals. Check [integrations](/lib/vitals/integrations) for more.
+
+Here's what's available to you at configuration time:
+
+```ruby
+Vitals.configure! do |c|
+  # Set your service name (default: 'default')
+  c.facility = 'my_service'
+
+  # Set environment (default: taken from RACK_ENV)
+  # c.environment = 'env'
+
+  # Set a host (default: taken from hostname)
+  # c.host = 'foohost'
+
+  # Use a specific reporter (default: InmemReporter)
+  # c.reporter = Vitals::Reporters::ConsoleReporter.new
+
+  # Use a different format perhaps? (default: ProductionFormat)
+  # c.format = Vitals::Formats::HostLastFormat
+end
+```
+
+
+
+## Development
+
+Tests and benchmarks should be run with at least Ruby 2.1 (because of memory profiling API)
+
+```
+$ bundle install && rake spec && rake bench
+```
+
+# Contributing
+
+Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :).
+
+# Copyright
+
+Copyright (c) 2011-2016 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See [LICENSE](LICENSE.txt) for further details.

data/Rakefile

@@ -1,37 +1,23 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Vitals'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
 end
 
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+Rake::TestTask.new(:multiverse) do |t|
+  t.libs << "integration"
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['integration/multiverse_spec.rb']
 end
 
+Rake::TestTask.new(:bench) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_bench.rb']
+end
 
-task :default => :test
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vitals"
+
+# 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/integration/multiverse/grape-on-rack/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.rvmrc
+.redcar
+.irbrc
+.bundle
+log
+vendor/

data/integration/multiverse/grape-on-rack/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=progress

data/integration/multiverse/grape-on-rack/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/integration/multiverse/grape-on-rack/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-28 08:52:35 -0400 using RuboCop version 0.33.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 19
+
+# Offense count: 27
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 126
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 15
+Style/Documentation:
+  Exclude:
+    - 'api/content_type.rb'
+    - 'api/entities.rb'
+    - 'api/get_json.rb'
+    - 'api/header_versioning.rb'
+    - 'api/path_versioning.rb'
+    - 'api/ping.rb'
+    - 'api/post_json.rb'
+    - 'api/post_put.rb'
+    - 'api/rescue_from.rb'
+    - 'api/upload_file.rb'
+    - 'api/wrap_response.rb'
+    - 'api/wrap_response_decorator.rb'
+    - 'app/acme_app.rb'
+    - 'app/api.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Lambda:
+  Exclude:
+    - 'app/acme_app.rb'
+
+# Offense count: 1
+Style/RescueModifier:
+  Exclude:
+    - 'api/get_json.rb'

data/integration/multiverse/grape-on-rack/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+
+rvm:
+  - 2.2.4
+
+language: ruby
+
+cache: bundler
+
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

data/integration/multiverse/grape-on-rack/Gemfile

@@ -0,0 +1,28 @@
+source 'http://rubygems.org'
+
+
+gem 'grape'
+gem 'grape-entity'
+gem 'json'
+gem 'newrelic_rpm'
+gem 'rack-cors'
+gem 'grape-swagger'
+gem 'mime-types'
+gem 'nokogiri'
+
+group :development do
+  gem 'rake'
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rack'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rack-test'
+  gem 'capybara'
+  gem 'selenium-webdriver'
+end
+
+gem 'vitals', path: '../../../'