metrician 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f701346245b51fe548783e261ce5008a756a91d2
+  data.tar.gz: a56ba24445cd0d7f966d5c7550669d89b262da39
+SHA512:
+  metadata.gz: a8619514f46e56e53a3839615eb779f156ec48a28e4ec318dd4e85b679977f1226cf834cd633b8e932921c7f2f0ecb8bf9f13ca141f83a09240c7a1c90cd4928
+  data.tar.gz: 43d19679b4ff15db9c5000f3157290390d57fd2a7c16f87673c55e92b0924cbdf41284039796afdea81ab3dba8be5e02f0017279574148d629b56966d10496d5

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/support/database.yml
+/.byebug_history
+
+# rspec failure tracking
+.rspec_status
+
+# stupid editor tricks
+*~
+\#*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,65 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
+
+
+################
+# Code Metrics #
+################
+Metrics/BlockLength:
+  Exclude:
+    - 'test/schema.rb'
+    - '*.gemspec'
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 140
+
+Metrics/MethodLength:
+  Max: 10
+  CountComments: false
+
+
+###############
+# Style Rules #
+###############
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+# ¯\_(ツ)_/¯
+# ʕノ•ᴥ•ʔノ ︵ ┻━┻
+# ( ͡° ͜ʖ ͡°)
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-06-05 17:04:34 -0400 using RuboCop version 0.48.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 35
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 27
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 13

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,36 @@
+sudo: false
+language: ruby
+before_install: gem install bundler -v 1.14.1
+
+rvm:
+  - 2.1.5
+  - 2.2.3
+  - 2.3.0
+  - 2.4.0
+
+gemfile:
+  - gemfiles/Gemfile.4.2.sidekiq-4
+  - gemfiles/Gemfile.5.0.pg
+
+matrix:
+  exclude:
+    - gemfile: gemfiles/Gemfile.5.0.pg
+      rvm: 2.1.5
+
+before_script:
+  - psql -c 'create database metrician_test;' -U postgres
+  - mysql -e 'create database IF NOT EXISTS metrician_test;'
+
+cache: bundler
+
+notifications:
+  email:
+    - developers@expectedbehavior.com
+
+script: bundle exec rake current_rspec
+
+services:
+  - mysql
+  - postgresql
+  - redis-server
+  - memcached

data/Gemfile

@@ -0,0 +1 @@
+gemfiles/Gemfile.4.2.sidekiq-4

data/METRICS.MD

@@ -0,0 +1,48 @@
+# Metrics you can expect to report in a vanilla Rails app
+
+### `GET /users`
+
+* `active_record.users.find`
+* `database.sql`
+* `database.sql.select`
+* `web.request`
+* `web.request.users_controller.index.get`
+* `web.request.middleware`
+* `web.request.idle`
+* `web.response_size`
+* `web.response_size.users_controller.index.get`
+
+*You may also see another instance of `database.sql` and an instance of `database.sql.other` if the table schema is loaded.*
+
+*In development mode, you can expect to record one each of the following **per asset** on the page because they are served by Rack*
+
+* `web.request`
+* `web.request.assets`
+* `web.request.middleware`
+* `web.request.idle`
+* `web.response_size`
+* `web.response_size.assets`
+
+
+### `PATCH /redis`
+
+Assuming we have a form for setting a redis value, and a controller that looks like this:
+
+```ruby
+class RedisController < ApplicationController
+  def show
+    @value = $redis.get("foo")
+  end
+
+  def update
+    $redis.set("foo", params[:value])
+    redirect_to(redis_path)
+  end
+end
+```
+
+In addition to request metrics similar to those described above, we can expect the following redis-specific metrics to be recorded:
+
+* `redis.set` - during the update
+* `redis.get` - during the redirect/show
+

data/README.md

@@ -0,0 +1,77 @@
+# Metrician
+
+Automatically get metrics for [Instrumental](https://instrumentalapp.com) from your Ruby on Rails (RoR) application.
+
+[![Build Status](https://travis-ci.org/Instrumental/metrician.svg?branch=master)](https://travis-ci.org/Instrumental/metrician)
+
+## Automatic Metrics For Ruby
+
+Automatic metrics for commonly used Ruby gems:
+
+* ActiveRecord
+* Redis
+* Memcached
+* Dalli
+* Delayed Job
+* Sidekiq
+* Resque
+* Honeybadger
+
+Request Metrics:
+
+* apdex metrics
+* request time, broken down by controller and action
+* middleware execution time
+* idle time
+* content length
+* web server queue time (for servers that set HTTP_X_QUEUE_START like nginx)
+
+And also you can do generic method tracing.
+
+## Installation
+
+```
+gem install metrician instrumental_agent
+```
+
+Grab your project token from [https://instrumentalapp.com/docs/tokens](https://instrumentalapp.com/docs/tokens) and activate metrician with:
+
+```
+I = Instrumental::Agent.new(PROJECT_TOKEN)
+Metrician.activate(I)
+```
+
+## Configuration
+
+### Rack Middleware
+
+In rails, the middleware will be inserted into your middleware stack automatically. If you control your middleware stack manually in rails, you can load the functionality using the following manual instructions:
+
+In your application.rb file:
+
+```ruby
+# request timing should be first so we get the correct queue time and start the
+# middleware timer
+config.middleware.insert_before("ActionDispatch::Static", "RequestTiming")
+
+# if you want to track content length add the rack middleware
+config.middleware.insert_before("ActionDispatch::Static", "Rack::ContentLength")
+
+# application timing should be last/just before the request is processed
+config.middleware.use("ApplicationTiming")
+```
+
+If you run `rake middleware`, you should see something like:
+
+```shell
+use RequestTiming
+use Rack::ContentLength
+use ActionDispatch::Static
+# etc.
+use ActionDispatch::BestStandardsSupport
+use ApplicationTiming
+run YOUR_APP::Application.routes
+```
+
+Your exception tracking middleware may try to get in first (hey, Honeybadger), so you will have to change the load order in an initializer, because we want to track that as middleware time, too.
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+
+begin
+  require 'gemika/tasks'
+rescue LoadError
+  puts 'Run `gem install gemika` for additional tasks'
+end
+
+# RSpec::Core::RakeTask.new(:spec)
+
+task :default => 'matrix:spec'

data/config/metrician.yaml

@@ -0,0 +1,136 @@
+# A configuration for Metrician that controls the features of our
+# automated metric reporting
+
+---
+
+# "request_timing" settings control the features of the Request Timing Rack Middleware
+:request_timing:
+  # hook into Rack middleware for request timing
+  :enabled: true
+
+  # collect basic request timing for every request
+  :request:
+    :enabled: true
+
+  # report 5xx codes as errors
+  :error:
+    :enabled: true
+
+  # report time between requests in a server process as idle time
+  :idle:
+    :enabled: false
+
+  # report the payload size of requests
+  :response_size:
+    :enabled: false
+
+  # report the amount of time spent on middleware per request
+  :middleware:
+    :enabled: false
+
+  # report the amount of time a request spent queued at the web layer
+  # before hitting Rack
+  :queue_time:
+    :enabled: false
+
+  # report the controller, action, and verb for every request
+  :route_tracking:
+    :enabled: false
+
+  # "apdex" controls the recording of metrics to measure apdex
+  # More here: https://en.wikipedia.org/wiki/Apdex
+  # Note this requires "request" tracking to be enabled
+  :apdex:
+    :enabled: true
+
+    # set the threshold (seconds), above which a request is no longer
+    # considered "sasifactory". The "tolerates" threshold will be
+    # 4x this number.
+    :satisfied_threshold: 2.5
+
+# "database" settings control ActiveRecord metric reporting features
+:database:
+  # hook into ActiveRecord for db call timing
+  :enabled: true
+
+  # collect basic query tracking for every query
+  :query:
+    :enabled: true
+
+  # collect generic sql query information (select, update, insert, etc.)
+  :command:
+    :enabled: false
+
+  # collect query information for specific tables
+  :table:
+    :enabled: false
+
+
+# "external_service" settings control reporting metrics when Net::HTTP
+# is used to make requests
+:external_service:
+  # hook into Net::HTTP to record timing metrics
+  :enabled: true
+
+  # collect basic external request timing information
+  :request:
+    :enabled: true
+
+
+# "jobs" settings control reporting metrics when ruby job systems
+# work through their queues
+:jobs:
+
+  # hook into job system middleware when presence detected
+  :enabled: true
+
+  # record the basic timing of every job
+  :run:
+    :enabled: true
+
+  # record when an error occurs in the a job
+  :error:
+    :enabled: true
+
+  # record metrics for each kind of job that is worked from the queue
+  :job_specific:
+    :enabled: false
+
+# "cache" settings control timing of commands to services often used as
+# application caches like memcached and redis
+:cache:
+
+  # hook into caching libraries
+  :enabled: true
+
+  # record aggregate timing information for all cache commands
+  :command:
+    :enabled: true
+
+  # record the timing of each command as its own metric
+  :command_specific:
+    :enabled: false
+
+
+# "exception" settings control reporting when exceptions are caught
+# by an exception tracker in your application
+:exception:
+
+  # hook into exception tracking libraries
+  :enabled: false
+
+  # report when an exception is raised and caught by an exception tracker
+  :raise:
+    :enabled: true
+
+  # report a metric per exception type raised
+  :exception_specific:
+    :enabled: false
+
+# "method_tracing" settings control hooking into Module and allowing
+# ruby methods to be timed
+:method_tracer:
+
+  # hook into Module with add_metrician_method_tracer added as a base
+  # feature of every ruby object
+  :enabled: true

data/gemfiles/Gemfile.4.2.sidekiq-4

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'rails', '~>4.2.0'
+
+# Differentiated development dependencies
+gem 'mysql2', '= 0.3.17'
+gem 'sidekiq', '~>4.0', require: 'sidekiq/testing'
+gem 'rspec', '~> 3.4'
+
+# Development dependencies
+gem 'instrumental_agent'
+gem 'rake'
+gem 'byebug'
+gem 'gemika'
+gem 'database_cleaner'
+gem 'delayed_job_active_record'
+gem 'resque'
+gem 'redis'
+gem 'memcached'
+gem 'rack-test'
+
+# Gem under test
+gem 'metrician', :path => '..'