grape-datadog 1.2.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b14dbd829e8c193af488bfcde4a5bbd625a5ecbf
-  data.tar.gz: c3055618f84b9970c4fc308bb363db61225691da
+  metadata.gz: a406efffcb252cbd474b6397fdc301c522e93aaf
+  data.tar.gz: 2632cc04b6453f1302393af0a38b57fc45762d54
 SHA512:
-  metadata.gz: bd8d20ca60f27da9cc0ee74d60410dbc4e79033ce7471a8be31e6ff71f79d9f0ddacfdb4d74a946bd02c109b2a4f555c7cc6c25cdb40b9fefe28acd4a2ab7fb0
-  data.tar.gz: 3be84c6ea24b6c259cd872a9b2fa3b1c3ee2996acd789f89971deff5b2fba0a55f8968b5dc776eee67935fde047edd296acd741b4214540e4e36a7a25a526804
+  metadata.gz: 603d3ae2b7146a31ae80880de9802bec51e364037ed56cb287be1c73c7e2ccefa7a0d4b95b72a927edc8c7d806aa06fe1f8e67948512ca20948a35b3183fc81d
+  data.tar.gz: 60de14bf54c7c1c264424f25de2d7ccde7ff7b34faa978ab07c4b4d940733aa93490057436a97e9a723f4408799bedb314756adfb78aae27a6923d39ab4dfe0c

data/README.md

@@ -1,8 +1,7 @@
 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]
+Datadog intrumentation for [Grape](https://github.com/intridea/grape), integrated via [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html).
 
 ## Installation
 
@@ -14,17 +13,14 @@ Or install:
 
     $ gem install grape-datadog
 
-Include it in your Grape API like this:
+Configure it in an initializer:
 
-    class TestAPI < Grape::API
-      use Grape::Datadog::Middleware
-
-      get 'hello' do
-        "Hello World"
-      end
+    Grape::Datadog.install! do |c|
+      c.hostname = "my-host"
+      c.tags = ["my:tag"]
     end
 
-For full configuration options, please see the [Documentation][4].
+For full configuration options, please see the [Documentation][http://www.rubydoc.info/gems/grape-datadog].
 
 ## Contributing
 
@@ -34,8 +30,3 @@ For full configuration options, please see the [Documentation][4].
 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/lib/grape/datadog.rb

@@ -1,3 +1,87 @@
-%w|version middleware|.each do |name|
-  require "grape/datadog/#{name}"
+require 'grape/datadog/version'
+require 'grape'
+require 'statsd'
+require 'socket'
+require 'active_support/notifications'
+
+module Grape
+  class Datadog
+    include Singleton
+
+    # Configure and install datadog instrumentation. Example:
+    #
+    #   Grape::Datadog.install! do |c|
+    #     c.hostname = "my-host"
+    #   end
+    #
+    # Settings:
+    # * <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>statsd</tt>      - custom statsd instance
+    def self.install!(&block)
+      block.call instance if block
+      instance.send(:subscribe!)
+    end
+
+    attr_accessor :hostname, :metric_name, :statsd_host, :statsd_port, :tags, :statsd
+
+    def initialize
+      @hostname     = ENV['INSTRUMENTATION_HOSTNAME'] || Socket.gethostname
+      @metric_name  = "grape.request"
+      @statsd_host  = ENV['STATSD_HOST'] || "localhost"
+      @statsd_port  = (ENV['STATSD_PORT'] || 8125).to_i
+      @tags         = []
+    end
+
+    private
+
+      def subscribe!
+        if frozen?
+          warn "#{self.class.name} is already installed (called from #{caller[1]})"
+          return
+        end
+
+        if tags.none? {|t| t =~ /^host\:/ }
+          tags.push("host:#{hostname}")
+        end
+
+        if ENV['RACK_ENV'] && tags.none? {|t| t =~ /^env\:/ }
+          tags.push("env:#{ENV['RACK_ENV']}")
+        end
+
+        ActiveSupport::Notifications.subscribe 'endpoint_run.grape' do |_, start, finish, _, payload|
+          record payload[:endpoint], ((finish-start)*1000).round
+        end
+
+        @statsd ||= ::Statsd.new(statsd_host, statsd_port)
+        freeze
+      end
+
+      def record(endpoint, ms)
+        route   = endpoint.route
+        version = route.route_version
+        method  = route.route_method
+
+        path = route.route_path
+        path.sub!("(.:format)", "")
+        path.sub!(":version/", "") if version
+        path.gsub!(/\(?:(\w+)\)?/) {|m| "_#{m[1..-1]}_" }
+
+        tags = self.tags.map do |tag|
+          case tag when String then tag when Proc then tag.call(endpoint) end
+        end
+        tags.push "method:#{method}"
+        tags.push "path:#{path}"
+        tags.push "version:#{version}" if version
+        tags.push "status:#{endpoint.status}"
+        tags.compact!
+
+        statsd.increment metric_name, :tags => tags
+        statsd.timing "#{metric_name}.time", ms, :tags => tags
+      end
+
+  end
 end

data/lib/grape/datadog/version.rb

@@ -1,5 +1,5 @@
 module Grape
-  module Datadog
-    VERSION = "1.2.0"
+  class Datadog
+    VERSION = "1.3.2"
   end
 end

data/spec/grape/datadog_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Grape::Datadog do
+
+  def app; TestAPI; end
+
+  before  { subject.statsd.buffer.clear }
+  subject { described_class.instance }
+
+  it 'should be configurable' do
+    expect(subject.tags.size).to eq(4)
+    expect(subject.tags).to include("host:test.host")
+    expect(subject.tags).to include("env:test")
+    expect(subject.tags).to include("custom:tag")
+    expect(subject.statsd).to be_instance_of(MockStatsd)
+  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(subject.statsd.buffer).to eq([
+      "grape.request:1|c|#custom:tag,format:txt,host:test.host,env:test,method:GET,path:/echo/_key1_/_key2_,status:200",
+      "grape.request.time:333|ms|#custom:tag,format:txt,host:test.host,env:test,method:GET,path:/echo/_key1_/_key2_,status:200",
+    ])
+  end
+
+  it 'should support namespaces and versioning' do
+    get '/api/v1/sub/versioned'
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('OK')
+
+    expect(subject.statsd.buffer).to eq([
+      "grape.request:1|c|#custom:tag,format:txt,host:test.host,env:test,method:GET,path:/api/sub/versioned,version:v1,status:200",
+      "grape.request.time:333|ms|#custom:tag,format:txt,host:test.host,env:test,method:GET,path:/api/sub/versioned,version:v1,status:200",
+    ])
+  end
+
+  it 'should support deep nesting' do
+    get '/sub/secure/resource'
+    expect(last_response.status).to eq(403)
+    expect(last_response.body).to eq('forbidden')
+
+    expect(subject.statsd.buffer).to eq([
+      "grape.request:1|c|#custom:tag,format:txt,host:test.host,env:test,method:GET,path:/sub/secure/resource,status:403",
+      "grape.request.time:333|ms|#custom:tag,format:txt,host:test.host,env:test,method:GET,path:/sub/secure/resource,status:403",
+    ])
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,19 +1,44 @@
+ENV['RACK_ENV'] ||= 'test'
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rack/test'
+require 'grape-datadog'
 
 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)
+class VersionedTestAPI < Grape::API
+  version 'v1'
+  prefix  'api'
+
+  get('versioned') { "OK" }
+end
+
+class TestAPI < Grape::API
+  get 'echo/:key1/:key2' do
+    "#{params['key1']} #{params['key2']}"
+  end
+
+  namespace :sub do
+    mount VersionedTestAPI
+
+    namespace :secure do
+      get("/resource") { error!("forbidden", 403) }
+    end
+  end
+end
+
+Grape::Datadog.install! do |c|
+  c.hostname = "test.host"
+  c.statsd   = MockStatsd.new(nil, nil, {}, 10000)
+  c.tags     = ["custom:tag", lambda{|e| "format:#{e.env['api.format']}" }]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-datadog
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Artem Chernyshev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -110,10 +110,9 @@ files:
 - 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/grape/datadog_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/grape-datadog
 licenses: []
@@ -139,6 +138,6 @@ 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/grape/datadog_spec.rb
 - spec/spec_helper.rb

data/lib/grape/datadog/middleware.rb

@@ -1,62 +0,0 @@
-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  += ["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)
-        endpoint = env['api.endpoint']
-        path     = File.join endpoint.namespace, endpoint.options[:path].join('/').gsub(/:(\w+)/) {|m| "_#{m[1..-1]}_" }
-        versions = endpoint.namespace_inheritable(:version)
-        version  = versions.first if versions
-
-        @tags.map do |tag|
-          case tag when String then tag when Proc then tag.call(env) end
-        end.compact + [
-          "method:#{env[Rack::REQUEST_METHOD]}",
-          "path:#{path}",
-          (version ? "version:#{version}" : nil),
-        ].compact
-      end
-
-    end
-
-  end
-end
-

data/spec/grape/datadog/middleware_spec.rb

@@ -1,61 +0,0 @@
-require 'spec_helper'
-
-describe Grape::Datadog::Middleware do
-
-  class VersionedTestAPI < Grape::API
-    version 'v1'
-    prefix  'api'
-
-    get('versioned') { "OK" }
-  end
-
-  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
-
-    namespace :sub do
-      mount VersionedTestAPI
-    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
-
-  it 'should support namespaces and versioning' do
-    get '/api/v1/sub/versioned'
-    expect(last_response.status).to eq(200)
-    expect(last_response.body).to eq('OK')
-
-    expect($statsd.buffer).to eq([
-      "grape.request:1|c|#custom:tag,scheme:http,host:test.host,method:GET,path:/sub/versioned,version:v1,status:200",
-      "grape.request.time:333|ms|#custom:tag,scheme:http,host:test.host,method:GET,path:/sub/versioned,version:v1,status:200",
-    ])
-  end
-
-end