scout_dogstatsd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce1f0adaa54a58afc6218dcea16e5ed0f0a8863e
+  data.tar.gz: d1323a15338c12b38c071dd1767211e2d6df17a4
+SHA512:
+  metadata.gz: 4b949a201334db1ca15c7d8f828fe0cac1b5cefa0c768e2d58fc4ef6257333191702bb0cd62f4f7c170aeb217e4afec23693752028ff1b54e30b3a3f76d3acea
+  data.tar.gz: 747f3a4eec9f185b56474cf8976787a38362d6295c171fa1fdd7af87a1db5f9253443fcfb1f61004c6df11d3edf2590eacf35fba20ae904265d0ad3e821eaef8

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scout_dogstatsd.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,99 @@
+# ScoutDogstatsd
+
+[![Build Status](https://travis-ci.org/scoutapp/scout_dogstatsd_ruby.svg?branch=master)](https://travis-ci.org/scoutapp/scout_dogstatsd_ruby)
+
+Want your Rails performance KPIs in your DogStatsD-compatible metric system with _almost_ zero effort? Of course you do! Meet `scout_dogstatsd`! 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:
+
+![screen](https://s3-us-west-1.amazonaws.com/scout-blog/scout_dogstatsd/datadog_screen.png)
+
+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 | histogram | The total duration of web requests in milliseconds
+job.duration_ms | histogram | 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 | gauge | The [time spent in request queuing](http://help.apm.scoutapp.com/#request-queuing) in milliseconds
+job.queue_time_ms | gauge | The time between when a job is inserted into a background job queue and when execution begins in milliseconds
+
+## Tags
+
+These metrics are tagged too! Slice and dice! The following tags are added to each metric:
+
+| Tag Name | Description |
+| - | - |
+app | The name of the app. See the [name](http://help.apm.scoutapp.com/#name) Scout config option.
+hostname | The hostname of the app. See the [hostname](http://help.apm.scoutapp.com/#hostname) Scout config option.
+
+Now, you can correlate app performance metrics with all of your other system metrics.
+
+## Monitoring Platforms that Support the DogStatsD Protocol
+
+* DataDog
+* SignalFx via the [collectd dogstatsd plugin](https://github.com/signalfx/signalfx-collectd-plugin/blob/master/src/dogstatsd.py)
+* Prometheus via the [statsd exporter](https://github.com/prometheus/statsd_exporter)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scout_dogstatsd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scout_dogstatsd
+
+## Configuration
+
+__1. Add a `config/initializers/scout_dogstatsd.rb` file to your Rails app:__
+
+```ruby
+require 'datadog/statsd'
+statsd = Datadog::Statsd.new('localhost', 8125)
+ScoutDogstatsd.configure(statsd)
+```
+
+__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 DogStatsD protocol via the client passed through to `ScoutDogstatsd#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_dogstatsd_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_dogstatsd"
+
+# 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_dogstatsd.rb

@@ -0,0 +1,18 @@
+module ScoutDogstatsd
+  # All access to the agent is thru this class method to ensure multiple Agent instances are not initialized per-Ruby process.
+  def self.configure(dogstatsd_client)
+    @@client ||= dogstatsd_client
+    ScoutApm::Extensions::Config.add_transaction_callback(ScoutDogstatsd::TransactionCallback.new)
+  end
+
+  def self.client
+    @@client
+  end
+
+  def self.rails?
+    defined? Rails::Railtie
+  end
+end
+
+require "scout_dogstatsd/version"
+require "scout_dogstatsd/transaction_callback"

data/lib/scout_dogstatsd/transaction_callback.rb

@@ -0,0 +1,28 @@
+module ScoutDogstatsd
+  class TransactionCallback
+    def call(payload)
+      @payload = payload
+      ScoutDogstatsd.client.batch do |s|
+        s.histogram("#{payload.transaction_type_slug}.duration_ms", payload.duration_ms, :tags => tags)
+
+        if payload.queue_time_ms
+          s.gauge("#{payload.transaction_type_slug}.queue_time_ms", payload.queue_time_ms, :tags => tags)
+        end
+
+        if payload.error?
+          s.increment("#{payload.transaction_type_slug}.error_count", :tags => tags)
+        end
+      end
+    end
+
+    private
+
+    def tags
+      [
+        "hostname:#{@payload.hostname}",
+        "app:#{@payload.app_name}",
+      ]
+    end
+
+  end
+end

data/lib/scout_dogstatsd/version.rb

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

data/scout_dogstatsd.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_dogstatsd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scout_dogstatsd"
+  spec.version       = ScoutDogstatsd::VERSION
+  spec.authors       = ["Derek Haynes"]
+  spec.email         = ["derek.haynes@gmail.com"]
+
+  spec.summary       = %q{Reports app performance KPIs (response time, error rate, throughput, etc) via the DogStatsD client}
+  spec.homepage      = "https://github.com/scoutapp/scout_dogstatsd_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.pre"
+  spec.add_runtime_dependency "dogstatsd-ruby"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: scout_dogstatsd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek Haynes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-11 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.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.11.pre
+- !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'
+description: 
+email:
+- derek.haynes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scout_dogstatsd.rb
+- lib/scout_dogstatsd/transaction_callback.rb
+- lib/scout_dogstatsd/version.rb
+- scout_dogstatsd.gemspec
+homepage: https://github.com/scoutapp/scout_dogstatsd_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 the DogStatsD client
+test_files: []