queue_time_statsd_reporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e73d90ae676131dc0338cb19404ae2b881e371ecae260c57b38c503d701acd4
+  data.tar.gz: aaa81e0511ff2f3dea5859305aa5b194935916603cb194cc79652e9637bbf737
+SHA512:
+  metadata.gz: 93b5f24e469f18668c75429eeebacf076ca9c17e38a803f80abf4d97ed7157c24b432dbf42e63f0e0bcbfb1bc194aefb07019dc76b283e37086e59b4d8880de1
+  data.tar.gz: bfb5021815fdc4e18bbe72b4aceed2863b2add65e131eb9f567b60d15cf3f00b4b11568dfb57036253214cd8905dc673e1ca38124afe5b8d307a0e0e9289c7dd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in queue_time_statsd_reporter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    queue_time_statsd_reporter (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rack (2.0.6)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  queue_time_statsd_reporter!
+  rack (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop (~> 0.9)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Will Jessop
+
+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,91 @@
+# QueueTimeStatsdReporter
+
+QueueTimeStatsdReporter reports to Datadog the time a request spends queued before hitting your Rails/Rack application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'queue_time_statsd_reporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install queue_time_statsd_reporter
+
+## Usage
+
+In your web server, configure the X-Request-Start header, eg. for Nginx:
+
+```
+location @app {
+  proxy_set_header X-Request-Start "t=${msec}";
+}
+```
+
+Next in Rails create an initialiser containing the code:
+
+```ruby
+metric_name = "mycorp.widgetsapp.queue_time"
+tags = ["env:#{Rails.env}"]
+Rails.application.middleware.unshift QueueTimeStatsdReporter, my_statsd_object, metric_name, tags
+```
+
+where `my_statsd_object` is an object, perhaps a proxy for your statsd implementation, that has a method with signature:
+
+```ruby
+gauge(metric, value, tags=[])
+```
+
+When a request is received QueueTimeStatsdReporter will report the time spent queueing by calling the guage method with:
+
+- metric: The string metric name, eg. "mycorp.widgetsapp.queue_time"
+- value: the time spent queued in seconds
+- tags: any tags passed into the middleware initialiser
+
+### Bringing it all together
+
+For instance, if you're reporting to Datadog your object might look something like:
+
+```ruby
+class MyDatadogClass
+  def initialize(endpoint = Datadog::Statsd.new(ENV.fetch("STATS_HOST", "localhost"), 8125))
+    @endpoint = endpoint
+  end
+
+  def gauge(metric, value, tags=[], sample_rate=1)
+    @endpoint.gauge(metric, value, tags: tags, sample_rate: sample_rate)
+  end
+end
+```
+
+and your initialiser:
+
+```ruby
+Rails.application.middleware.unshift QueueTimeStatsdReporter, MyDatadogClass.new, "mycorp.widgetsapp.queue_time", ["env:#{Rails.env}", "infra:aws"]
+```
+
+You can use this middleware outside of Rails too.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubytune/queue_time_statsd_reporter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Authors
+
+* @wjessop, will@willj.net

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "queue_time_statsd_reporter"
+
+# 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(__FILE__)

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/queue_time_statsd_reporter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "queue_time_statsd_reporter/version"
+
+class QueueTimeStatsdReporter
+  def initialize(app, statsd, metric_name, tags = [])
+    @app = app
+    @statsd = statsd
+    @metric_name = metric_name
+    @tags = tags
+  end
+
+  def call(env)
+    report_queue_time(env)
+    @app.call(env)
+  end
+
+  private
+
+  def report_queue_time(env)
+    return nil unless env.has_key?("HTTP_X_REQUEST_START")
+    @statsd.gauge(
+      @metric_name,
+      seconds_since_request_start(env["HTTP_X_REQUEST_START"]),
+      tags=@tags
+    )
+  end
+
+  def seconds_since_request_start(header)
+    Float((Time.now - request_start_time_from_header(header)))
+  end
+
+  # The header will be in the format t=1525393793.115
+  def request_start_time_from_header(header_string)
+    Float(header_string.strip[2..-1])
+  end
+end

data/lib/queue_time_statsd_reporter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class QueueTimeStatsdReporter
+  VERSION = "1.0.0"
+end

data/queue_time_statsd_reporter.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "queue_time_statsd_reporter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "queue_time_statsd_reporter"
+  spec.version       = QueueTimeStatsdReporter::VERSION
+  spec.authors       = ["Will Jessop"]
+  spec.email         = ["will@willj.net"]
+
+  spec.summary       = %q{Log HTTP request queue time to statsd}
+  spec.description   = %q{Log HTTP request queue time to statsd when the HTTP_X_REQUEST_START is set.}
+  spec.homepage      = "https://github.com/rubytune/queue_time_statsd_reporter"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack", "~> 2.0"
+  spec.add_development_dependency "timecop", "~> 0.9"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: queue_time_statsd_reporter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Will Jessop
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Log HTTP request queue time to statsd when the HTTP_X_REQUEST_START is
+  set.
+email:
+- will@willj.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/queue_time_statsd_reporter.rb
+- lib/queue_time_statsd_reporter/version.rb
+- queue_time_statsd_reporter.gemspec
+homepage: https://github.com/rubytune/queue_time_statsd_reporter
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Log HTTP request queue time to statsd
+test_files: []