scout_statsd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5dcea9774fccaefcd3e2c41580b49c03e3a51f0
+  data.tar.gz: 2195978792707286259a77b1eae692bd6b6a34a2
+SHA512:
+  metadata.gz: 3a2583bfe86a12d41f24bc88e86e818b2940372287c6741a7780e51e44289ae3eba906ea54ca4219e66f71f6c2c98dd7f99b36207d1b2f83e9636365c748d578
+  data.tar.gz: 63e1c6c123a56b75e3470e4f2512d42211bb80c0693485f9dc960ad5beb494fc738504179a3b7a1564456eac98aa712d94fee536ce7511d316f5223a660db675

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "2.4"
+  - "2.5"
+cache: bundler
+before_install:
+  - gem update --system
+  - gem install bundler
+jobs:
+  include:
+    - script: bundle exec rake test
+      rvm: "2.5"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scout_statsd.gemspec
+gemspec
+
+# Load the gem locally if modifying core extension functionality
+# gem 'scout_apm', path: '~/projects/scout_apm_ruby'
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Derek Haynes
+
+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,81 @@
+# ScoutStatsd
+
+[![Build Status](https://travis-ci.org/scoutapp/scout_statsd_ruby.svg?branch=master)](https://travis-ci.org/scoutapp/scout_statsd_ruby)
+
+Want your Rails performance KPIs in your StatsD-compatible metric system with _almost_ zero effort? Of course you do! Meet `scout_statsd`! This gem is an extension of the [Scout](https://scoutapp.com) Ruby monitoring agent ([`scout_apm`](https://github.com/scoutapp/scout_apm_ruby)), and makes it easy to create an app performance dashboard.
+
+A [Scout](https://scoutapp.com) account isn't required, but it certainly makes getting to the source of app performance easier 😉.
+
+## Metrics 
+
+The following metrics are reported w/o any custom instrumentation steps:
+
+| Metric Name | Type | Description |
+| - | - | - |
+web.duration_ms | timer | The total duration of web requests in milliseconds
+job.duration_ms | timer | The total duration of background jobs (Sidekiq, DelayedJob, etc.) in milliseconds
+web.error_count | counter | A count of web requests that throw an exception
+job.error_count | counter | A count of background jobs that throw an exception
+web.queue_time_ms | timer | The [time spent in request queuing](http://help.apm.scoutapp.com/#request-queuing) in milliseconds
+job.queue_time_ms | timer | The time between when a job is inserted into a background job queue and when execution begins in milliseconds
+
+Now, you can correlate app performance metrics with all of your other system metrics.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scout_statsd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scout_statsd
+
+## Configuration
+
+__1. Add a `config/initializers/scout_statsd.rb` file to your Rails app:__
+
+```ruby
+ScoutStatsd.configure(StatsD) # StatsD uses one of the statsd-instrument backends
+```
+
+Note that `StatsD` is a [statsd-instrument](https://github.com/Shopify/statsd-instrument) client.
+
+__2. Add a `config/scout_apm.yml` file to your Rails app:__
+
+_This step isn't required if you are already using Scout._
+
+```yaml
+common: &defaults
+  monitor: true
+
+development:
+  <<: *defaults
+  monitor: false # set to true to test in your development environment
+
+production:
+  <<: *defaults
+```
+
+_Metrics are only sent if `monitor: true` for the associated Rails environment._
+
+[See the Scout docs](http://help.apm.scoutapp.com/#ruby-agent) for advanced configuration instructions.
+
+## How it works
+
+After each transaction (a web request or background job), the metrics specific to that transaction are transmitted via the StatsD protocol to the client passed through to `ScoutStatsd#configure`. No code changes are required: the `scout_apm` gem automatically instruments Rails controller-actions and background jobs. Easy peasy!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/scoutapp/scout_statsd_ruby.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+
+task :test do
+  $: << File.expand_path(File.dirname(__FILE__) + "/test")
+  Dir.glob('./test/*_test.rb').each { |file| require file }
+end
+
+desc "Run tests"
+task :default => :test
+

data/bin/console

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

@@ -0,0 +1,20 @@
+module ScoutStatsd
+  @@prefix ||= nil
+
+  def self.configure(options = {})
+    @@prefix ||= options[:prefix]
+  end
+
+  def self.prefix
+    @@prefix ? "#{@@prefix}." : ''
+  end
+
+  def self.rails?
+    defined? Rails::Railtie
+  end
+end
+
+require "scout_statsd/version"
+require "scout_statsd/transaction_callback"
+
+ScoutApm::Extensions::Config.add_transaction_callback(ScoutStatsd::TransactionCallback.new)

data/lib/scout_statsd/transaction_callback.rb

@@ -0,0 +1,16 @@
+module ScoutStatsd
+  class TransactionCallback
+    def call(payload)
+      @payload = payload
+      StatsD.measure("#{ScoutStatsd.prefix}#{payload.transaction_type_slug}.duration_ms", payload.duration_ms)
+
+      if payload.queue_time_ms
+        StatsD.measure("#{ScoutStatsd.prefix}#{payload.transaction_type_slug}.queue_time_ms", payload.queue_time_ms)
+      end
+
+      if payload.error?
+        StatsD.increment("#{ScoutStatsd.prefix}#{payload.transaction_type_slug}.error_count")
+      end
+    end
+  end
+end

data/lib/scout_statsd/version.rb

@@ -0,0 +1,3 @@
+module ScoutStatsd
+  VERSION = "0.1.0"
+end

data/scout_statsd.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scout_statsd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scout_statsd"
+  spec.version       = ScoutStatsd::VERSION
+  spec.authors       = ["Derek Haynes", "Mike Stewart"]
+  spec.email         = ["derek.haynes@gmail.com"]
+
+  spec.summary       = %q{Reports app performance KPIs (response time, error rate, throughput, etc) via a StatsD client}
+  spec.homepage      = "https://github.com/scoutapp/scout_statsd_ruby"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+
+  spec.add_runtime_dependency "scout_apm", "~> 2.4.11"
+  spec.add_runtime_dependency "statsd-instrument"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: scout_statsd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek Haynes
+- Mike Stewart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-08 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  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: mocha
+  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: scout_apm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.11
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  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'
+description: 
+email:
+- derek.haynes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scout_statsd.rb
+- lib/scout_statsd/transaction_callback.rb
+- lib/scout_statsd/version.rb
+- scout_statsd.gemspec
+homepage: https://github.com/scoutapp/scout_statsd_ruby
+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.6
+signing_key: 
+specification_version: 4
+summary: Reports app performance KPIs (response time, error rate, throughput, etc)
+  via a StatsD client
+test_files: []