grape-datadog 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ba4b9a27af459dcef450e036d45bcfb8f41b08f
+  data.tar.gz: 599981b5f22f182a9834055ed00338f37b103461
+SHA512:
+  metadata.gz: c0a3c9077a3fb3bcd784a6969980a559e68bfbe5ebe96e747a9c41e87059149cf2d0e590671a328bf103658f4a0f5e635cb6c50b06f4d674029ac5c62aa479bb
+  data.tar.gz: 77e186ee2d920fc3505e8b4c7b74a5d2481df12eabf0741685c255881eca5b27bac010989c1c8cf722b339424fde634f1b159008cefe67006e39af3d830e3ed4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Artem Chernyshev
+
+MIT License
+
+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,41 @@
+grape-datadog
+=============
+
+Datadog stats reporter for [Grape][0], based on code from [this Librato
+gem][1], which is based on [this NewRelic gem][2], using [dogstatsd-ruby][3]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape-datadog'
+
+Or install:
+
+    $ gem install grape-datadog
+
+Include it in your Grape API like this:
+
+    class TestAPI < Grape::API
+      use Grape::Datadog::Middleware
+
+      get 'hello' do
+        "Hello World"
+      end
+    end
+
+For full configuration options, please see the [Documentation][4].
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make a pull request
+
+[0]: https://github.com/intridea/grape
+[1]: https://github.com/seanmoon/grape-librato
+[2]: https://github.com/flyerhzm/newrelic-grape
+[3]: https://github.com/DataDog/dogstatsd-ruby
+[4]: http://www.rubydoc.info/gems/grape-datadog

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+
+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 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/grape-datadog.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/datadog/version'
+
+Gem::Specification.new do |s|
+  s.name          = "grape-datadog"
+  s.version       = Grape::Datadog::VERSION.dup
+  s.authors       = ["Artem Chernyshev", "Dimitrij Denissenko"]
+  s.email         = ["artem.0xD2@gmail.com"]
+  s.description   = %q{Datadog metrics for grape}
+  s.summary       = %q{Datadog metrics for grape}
+  s.homepage      = "https://github.com/bsm/grape-datadog"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(spec)/})
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency(%q<grape>)
+  s.add_runtime_dependency(%q<dogstatsd-ruby>)
+
+  s.add_development_dependency(%q<rake>)
+  s.add_development_dependency(%q<bundler>)
+  s.add_development_dependency(%q<rack-test>)
+  s.add_development_dependency(%q<rspec>, "~> 3.0")
+end

data/lib/grape-datadog.rb

@@ -0,0 +1 @@
+require "grape/datadog"

data/lib/grape/datadog.rb

@@ -0,0 +1,3 @@
+%w|version middleware|.each do |name|
+  require "grape/datadog/#{name}"
+end

data/lib/grape/datadog/middleware.rb

@@ -0,0 +1,59 @@
+require 'grape'
+require 'statsd'
+require 'socket'
+
+module Grape
+  module Datadog
+
+    class Middleware < ::Grape::Middleware::Base
+
+      # Create a new +Datadog+ middleware instance.
+      #
+      # ==== Options
+      # * <tt>:hostname</tt> - the hostname used for instrumentation, defaults to system hostname, respects +INSTRUMENTATION_HOSTNAME+ env variable
+      # * <tt>:metric_name</tt> - the metric name (prefix) to use, defaults to "grape.request"
+      # * <tt>:tags</tt> - array of custom tags, these can be plain strings or lambda blocks accepting a rack env instance
+      # * <tt>:statsd_host</tt> - the statsD host, defaults to "localhost", respects +STATSD_HOST+ env variable
+      # * <tt>:statsd_port</tt> - the statsD port, defaults to 8125, respects +STATSD_PORT+ env variable
+      # * <tt>:prefer_global</tt> - if set, tries to find global `$statsd` instance, otherwise connects to +statsd_host+:+statsd_port. Default: true
+      def initialize(app, opts = {})
+        hostname    = opts[:hostname] || ENV['INSTRUMENTATION_HOSTNAME'] || Socket.gethostname
+        statsd_host = opts[:statsd_host] || ENV['STATSD_HOST'] || "localhost"
+        statsd_port = (opts[:statsd_port] || ENV['STATSD_PORT'] || 8125).to_i
+
+        @app    = app
+        @metric = opts[:metric_name] || "grape.request"
+        @statsd = opts[:prefer_global] == false || !defined?($statsd) ? ::Statsd.new(statsd_host, statsd_port) : $statsd
+        @tags   = opts[:tags] || []
+        @tags.push "host:#{hostname}"
+      end
+
+      def call(env)
+        tags = prepare_tags(env)
+        @statsd.time "#{@metric}.time", :tags => tags do
+          resp = @app.call(env)
+          tags.push "status:#{resp.status}"
+          @statsd.increment @metric, :tags => tags
+          resp
+        end
+      end
+
+      private
+
+      def prepare_tags(env)
+        path = env['api.endpoint'].routes.first.route_path[1..-1].gsub("/", ".").sub(/\(\.:format\)\z/, "").gsub(/\.:(\w+)/, '.{\1}')
+        @tags.map do |tag|
+          case tag
+          when String
+            tag
+          when Proc
+            tag.call(env)
+          end
+        end.compact + ["method:#{env[Rack::REQUEST_METHOD]}", "path:#{path}"]
+      end
+
+    end
+
+  end
+end
+

data/lib/grape/datadog/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Datadog
+    VERSION = "1.1.0"
+  end
+end

data/spec/grape/datadog/middleware_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Grape::Datadog::Middleware do
+
+  class TestAPI < Grape::API
+    use Grape::Datadog::Middleware,
+      hostname: "test.host",
+      tags:     ["custom:tag", lambda {|env| "scheme:#{Rack::Request.new(env).scheme}" }]
+
+    get 'echo/:key1/:key2' do
+      "#{params['key1']} #{params['key2']}"
+    end
+  end
+
+  def app; TestAPI; end
+
+  before { $statsd.buffer.clear }
+
+  it 'should be configurable' do
+    subject = described_class.new(nil, hostname: "test.host")
+    expect(subject.instance_variable_get(:@tags)).to eq(["host:test.host"])
+    expect(subject.instance_variable_get(:@statsd)).to be_instance_of(MockStatsd)
+
+    subject = described_class.new(nil, prefer_global: false)
+    expect(subject.instance_variable_get(:@statsd)).to be_instance_of(Statsd)
+  end
+
+  it 'should send an increment and timing event for each request' do
+    get '/echo/1/1234'
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('1 1234')
+
+    expect($statsd.buffer).to eq([
+      "grape.request:1|c|#custom:tag,scheme:http,host:test.host,method:GET,path:echo.{key1}.{key2},status:200",
+      "grape.request.time:333|ms|#custom:tag,scheme:http,host:test.host,method:GET,path:echo.{key1}.{key2},status:200"
+    ])
+  end
+end

data/spec/grape/datadog/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Grape::Datadog do
+  it "has a version" do
+    expect(Grape::Datadog::VERSION).to be_instance_of(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rack/test'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+require 'grape'
+require 'grape-datadog'
+
+class MockStatsd < Statsd
+  def timing(stat, ms, opts={}); super(stat, 333, opts); end
+  def flush_buffer; end
+  alias :send_stat :send_to_buffer
+end
+
+$statsd = MockStatsd.new(nil, nil, {}, 10000)

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: grape-datadog
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Artem Chernyshev
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  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: dogstatsd-ruby
+  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: 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: 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: rack-test
+  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: 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: Datadog metrics for grape
+email:
+- artem.0xD2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-datadog.gemspec
+- lib/grape-datadog.rb
+- lib/grape/datadog.rb
+- lib/grape/datadog/middleware.rb
+- lib/grape/datadog/version.rb
+- spec/grape/datadog/middleware_spec.rb
+- spec/grape/datadog/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/grape-datadog
+licenses: []
+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.7
+signing_key: 
+specification_version: 4
+summary: Datadog metrics for grape
+test_files:
+- spec/grape/datadog/middleware_spec.rb
+- spec/grape/datadog/version_spec.rb
+- spec/spec_helper.rb