dogstatsd-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 824f7af6b9721c4038b9f1ab00721721b86f1c94
+  data.tar.gz: 7a0698ce32f8396dcb5f8bfd47145d1dbcc9de27
+SHA512:
+  metadata.gz: ef1309218bfec2701a2b211cb7ac2e4bc60d9d6248cdad28f8eab88d3bb1b96fcd0cbe15f08782d52ff2740732419489ffb0c1ed37d4e34c7e503f64a932d595
+  data.tar.gz: 9a15666e7859f8412d768f4261568c7125aa1633293cc5de1f8faa77079e86d18b5fdf5649b5722037e3d94a86c9196ec85e8c9567c35f7d799f53006319ebc1

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Wealthsimple
+
+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 @@
+# DogStatsd::Instrumentation
+
+[![Gem Version](https://badge.fury.io/rb/dogstatsd-instrumentation.svg)](http://badge.fury.io/rb/dogstatsd-instrumentation)
+[![CircleCI](https://circleci.com/gh/wealthsimple/dogstatsd-instrumentation.svg?style=shield)](https://circleci.com/gh/wealthsimple/dogstatsd-instrumentation) 
+[![Dependency Status](https://gemnasium.com/badges/github.com/wealthsimple/dogstatsd-instrumentation.svg)](https://gemnasium.com/github.com/wealthsimple/dogstatsd-instrumentation)
+[![Code Climate](https://codeclimate.com/github/wealthsimple/dogstatsd-instrumentation/badges/gpa.svg)](https://codeclimate.com/github/wealthsimple/dogstatsd-instrumentation)
+[![codecov](https://codecov.io/gh/wealthsimple/dogstatsd-instrumentation/branch/master/graph/badge.svg)](https://codecov.io/gh/wealthsimple/dogstatsd-instrumentation)
+[![Gitter chat](https://img.shields.io/gitter/room/wealthsimple/Lobby.svg?style=flat)](https://gitter.im/wealthsimple/Lobby)
+
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+  - [Examples](#examples)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+
+DogStatsd::Instrumentation collects various [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) and sends them to StatsD, more precisely, Datadog's DogStatsD.
+
+
+## Examples
+
+# Requirements
+
+0. [Ruby 2.3.0](https://www.ruby-lang.org)
+
+# Setup
+
+For a secure install, type the following (recommended):
+
+    gem cert --add <(curl --location --silent /gem-public.pem)
+    gem install dogstatsd-instrumentation --trust-policy MediumSecurity
+
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification
+while allowing the installation of unsigned dependencies since they are beyond the scope of this
+gem.
+
+For an insecure install, type the following (not recommended):
+
+    gem install dogstatsd-instrumentation
+
+Add the following to your Gemfile:
+
+    gem "dogstatsd-instrumentation"
+
+# Tests
+
+To test, run:
+
+    bundle exec rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
+participating in this project you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+[MIT License](LICENSE.md)
+
+Copyright (c) 2016 [Wealthsimple](https://wealthsimple.com).
+
+# History
+
+Read [CHANGES](CHANGES.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Marco Costa](http://marcotc.com) at [Wealthsimple](https://wealthsimple.com).

data/lib/dogstatsd/instrumentation.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "dogstatsd/instrumentation/identity"
+require "dogstatsd/instrumentation/request"

data/lib/dogstatsd/instrumentation/identity.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DogStatsd
+  module Instrumentation
+    # Gem identity information.
+    module Identity
+      def self.name
+        "dogstatsd-instrumentation"
+      end
+
+      def self.label
+        "DogStatsd::Instrumentation"
+      end
+
+      def self.version
+        "0.1.0"
+      end
+
+      def self.version_label
+        "#{label} #{version}"
+      end
+    end
+  end
+end

data/lib/dogstatsd/instrumentation/request.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'gem_config'
+require 'datadog/statsd'
+
+module DogStatsd
+  module Instrumentation
+    module Request
+      include GemConfig::Base
+
+      with_configuration do
+        has :environments, classes: Array, default: ['production']
+        has :host, classes: String, default: Datadog::Statsd::DEFAULT_HOST
+        has :port, classes: Integer, default: Datadog::Statsd::DEFAULT_PORT
+        has :opts, classes: Hash, default: {}
+        has :max_buffer_size, classes: Integer, default: 50
+      end
+
+      # From GemConfig::Base
+      def self.configure
+        super
+        @@subscriber.unsubscribe if @@subscriber
+        @@subscriber = Subscriber.new(configuration)
+      end
+
+      @@subscriber = nil
+
+      class Subscriber
+        def initialize(configuration)
+          @statsd = Datadog::Statsd.new(
+            configuration.host,
+            configuration.port,
+            configuration.opts,
+            configuration.max_buffer_size
+          )
+
+          @subscriber = ActiveSupport::Notifications.subscribe /process_action.action_controller/ do |*args|
+            event = ActiveSupport::Notifications::Event.new(*args)
+            tags = {
+              controller: event.payload[:controller],
+              action: event.payload[:action],
+              method: event.payload[:method],
+              status: event.payload[:status],
+            }
+
+            instrument stat: 'process_action.action_controller.duration', value: event.duration, tags: tags
+
+            event.payload.select { |key, _| key.to_s.end_with? '_runtime' }.each do |name, duration|
+              instrument stat: "process_action.action_controller.#{name}", value: duration, tags: tags
+            end
+          end
+        end
+
+        def instrument(stat:, value:, tags:)
+          @statsd.histogram stat, value, tags: tagify(tags)
+        end
+
+        def tagify(hash)
+          hash.select{|_,value| value.present? }.map { |key, value| "#{key}:#{value}" }
+        end
+
+        def unsubscribe
+          ActiveSupport::Notifications.unsubscribe @subscriber
+        end
+      end
+    end
+  end
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "reek/rake/task"
+  Reek::Rake::Task.new
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: dogstatsd-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marco Costa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  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: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+description: This gem processes relevant ActiveSupport::Notifications for Rails, Sinatra
+  and Rake applications, sending metrics to Datadog.
+email:
+- marco@marcotc.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- lib/dogstatsd/instrumentation.rb
+- lib/dogstatsd/instrumentation/identity.rb
+- lib/dogstatsd/instrumentation/request.rb
+- lib/tasks/reek.rake
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
+homepage: https://github.com/wealthsimple/dogstatsd-instrumentation
+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: Reports instrumention metrics from various Ruby web frameworks to Datadog.
+test_files: []