scout_signalfx 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abeaadc06120e178633cafabfac1c3bb59f9e400
+  data.tar.gz: 9d869beaecf1eec2fcfa107fd6e7037c9d78a693
+SHA512:
+  metadata.gz: 56342be9ee7df5a2ec0b688c3062183b614a840d680d35b86fc6b889a394ed064e1479aadc16cd3436e68e81d0f5e718e870b06a0fc1183cf7f93de14ea554b1
+  data.tar.gz: cb1e3d858f6038943549f845417e0b548a62f783902b4a8aaa9a5c64e2ed755de3573436fcb808d94221aa2867ee6829ad5e86e973fdf3e24bee3463af89f1c8

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "2.4"
+  - "2.5"
+cache: bundler
+jobs:
+  include:
+    - script: bundle exec rake test
+      rvm: "2.5"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scout_signalfx.gemspec
+gemspec

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,84 @@
+# ScoutSignalfx
+
+[![Build Status](https://travis-ci.org/scoutapp/scout_signalfx_ruby.svg?branch=master)](https://travis-ci.org/scoutapp/scout_signalfx_ruby)
+
+Bring key health metrics for your Ruby on Rails app(s) into [SignalFx](https://signalfx.com/) with the `scout_signalfx` gem. The gem extends the [Scout](https://scoutapp.com) Ruby gem, which gathers detailed performance on every web request, and sends those metrics direct to SignalFx.
+
+A [Scout](https://scoutapp.com) account isn't required, but it certainly makes performance investigations more fun.
+
+![signalfx dash](https://s3-us-west-1.amazonaws.com/scout-blog/scout_signalfx/signalfx_dash.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scout_signalfx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scout_signalfx
+
+## Configuration
+
+__Add a `config/initializers/scout_signalfx.rb` file to your Rails app:__
+
+```ruby
+SIGNAL_FX_CLIENT = SignalFx.new("[SIGNAL_FX_TOKEN]")
+ScoutSignalfx.configure(SIGNAL_FX_CLIENT)
+```
+
+Your SignalFx API access token can be obtained from the SignalFx organization you want to report data into.
+
+__Add a `config/scout_apm.yml` file to your Rails app:__
+
+```yaml
+common: &defaults
+  monitor: true
+
+development:
+  <<: *defaults
+  monitor: false # set to true to test in your development environment
+
+production:
+  <<: *defaults
+```
+
+_This step isn't required if you're an existing Scout customer._
+
+[See the Scout docs](http://help.apm.scoutapp.com/#ruby-agent) for advanced configuration instructions.
+
+The Scout gem auto-magically instruments your controller-actions. There's no more steps!
+
+## Metric Schema
+
+The following metrics are reported once per-minute:
+
+* web.duration_ms
+* web.count
+* web.errors_count
+
+Each metric has the following dimensions:
+
+* app - The name of the app
+* host - The hostname of the running app
+* transaction - The name of the transaction. For example, `UsersController#index` becomes `users.index` in SignalFx.
+
+## Tests
+
+```ruby
+rake
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/scoutapp/scout_signalfx_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"
+require 'rake/testtask'
+
+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_signalfx"
+
+# 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_signalfx.rb

@@ -0,0 +1,14 @@
+module ScoutSignalfx
+  # Takes a +SignalFxClient+ and configures the ScoutApm SignalFx Payload Plugin.
+  def self.configure(signalfx_client)
+    @@signalfx_client ||= signalfx_client
+    ScoutApm::Extensions::Config.add_periodic_callback(ScoutSignalfx::PeriodicCallback.new)
+  end
+
+  def self.signalfx_client
+    @@signalfx_client
+  end
+end
+
+require "scout_signalfx/version"
+require "scout_signalfx/periodic_callback"

data/lib/scout_signalfx/periodic_callback.rb

@@ -0,0 +1,86 @@
+module ScoutSignalfx
+  # This is ran after each reporting period (once per-minute).
+  class PeriodicCallback
+    def call(reporting_period, metadata)
+      @reporting_period = reporting_period
+      @metadata = metadata
+
+      return if controller_metrics.empty?
+      ScoutSignalfx.signalfx_client.send(
+        gauges: guages,
+        counters: counters,
+      )
+    end
+
+    private
+
+    def metrics
+      @reporting_period.metrics_payload
+    end
+
+    # The time associated w/the metrics
+    def timestamp
+      Time.at(@metadata[:agent_time].to_i)
+    end
+
+    def timestamp_ms
+      timestamp.to_i*1000
+    end
+
+    def transaction_name
+      metrics.keys.first.metric_name
+    end
+
+    # Renames Scout metric names to a more SignalFx-ish format. 
+    # Ex: Controllers/users/index => users.index
+    def signalfx_transaction_name(transaction_name)
+      @signalfx_transaction_name ||= transaction_name.sub!("Controller/",'').gsub("/",".")
+    end
+
+    def controller_metrics
+      @controller_metrics ||= metrics.select { |meta,metric| meta.type == 'Controller' }
+    end
+
+    def controller_error_metrics
+      @controller_error_metrics ||= metrics.select { |meta,metric| meta.type == 'Errors' && meta.name =~ /\AController/ }
+    end
+
+    def guages
+      controller_metrics.map do |meta,metric|
+        {
+          metric: 'web.duration_ms',
+          value: (metric.total_call_time / metric.call_count.to_f)*1000,
+          timestamp: timestamp_ms,
+          dimensions: dimensions_for_metric_name(meta.metric_name)
+        }
+      end
+    end
+
+    def counters
+      controller_metrics.map do |meta,metric|
+          {
+            metric: 'web.count',
+            value: metric.call_count,
+            timestamp: timestamp_ms,
+            dimensions: dimensions_for_metric_name(meta.metric_name)
+          }
+      end + controller_error_metrics.map do |meta,metric|
+        {
+          metric: 'web.errors.count',
+          value: metric.call_count,
+          timestamp: timestamp_ms,
+          dimensions: dimensions_for_metric_name(meta.name)
+        }
+      end
+    end
+
+    def dimensions_for_metric_name(metric_name)
+      [
+        {key: 'host', value: ScoutApm::Agent.instance.context.environment.hostname}, 
+        {key: 'transaction', value: signalfx_transaction_name(metric_name)},
+        {key: 'app', value: ScoutApm::Agent.instance.context.config.value('name')}
+      ]
+    end
+
+  end
+end

data/lib/scout_signalfx/version.rb

@@ -0,0 +1,3 @@
+module ScoutSignalfx
+  VERSION = "1.0.0"
+end

data/scout_signalfx.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scout_signalfx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scout_signalfx"
+  spec.version       = ScoutSignalfx::VERSION
+  spec.authors       = ["Derek Haynes"]
+  spec.email         = ["derek.haynes@gmail.com"]
+
+  spec.summary       = "Reports app performance metrics gathered via Scout to SignalFx"
+  spec.homepage      = "https://github.com/scoutapp/scout_signalfx_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_development_dependency "fakeweb", ["~> 1.3"]
+
+  spec.add_runtime_dependency "scout_apm", "~> 2.4.11"
+  spec.add_runtime_dependency "signalfx"
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: scout_signalfx
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Derek Haynes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-29 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: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: signalfx
+  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_signalfx.rb
+- lib/scout_signalfx/periodic_callback.rb
+- lib/scout_signalfx/version.rb
+- scout_signalfx.gemspec
+homepage: https://github.com/scoutapp/scout_signalfx_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 metrics gathered via Scout to SignalFx
+test_files: []