nexaas-queue_time 0.3.0 → 0.4.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87997f283ea190bbdcba83290a11d23dbc446db1a11c32d48b51d8b3bc110219
-  data.tar.gz: 57746b20d94c1ddd326b405906ba6dfc887089cb3f43c66d89e6d9131beec209
+  metadata.gz: 2699d2c676058c63f554ece97e6814a0f612eb4cc42f77f677b7653d2f4907d6
+  data.tar.gz: d2e6f76b7c61c3efb14374025b24dbb8f2c6bec9c84411cad0dac312be890d0c
 SHA512:
-  metadata.gz: ecb3f250ee9abb4caa347d1209e2696f89b4d2e4a977d11a5dd109d007d861ee8f0739d1792e693c213ce0487026974b3e0fccfab7705ec52d4f046112a59d63
-  data.tar.gz: 16467b32806ef5813cf070d4efe9d86171022caab30c2ecbd407e694ec0e24f1df8352f386172106785976b204d9ae954b921d52da38e43aebf28ebe7c598a10
+  metadata.gz: 0170f983fcac8522f0dd255a740b5221f77e7ca0c4c592c08a4ce9efcce8803da7766e85049d4a657634fdfafa4939c5fb83d180ecd91e6a7e23a494fe605188
+  data.tar.gz: 50fa088ed9abeb91150fe7299c545f6980a1b13a11b1b46af1f697827cedac1317fe57822a42f8caa1c247fc34cff44e66405f17b41dfb396cea25ffd3040594

data/README.md

@@ -1,9 +1,6 @@
 [![Build Status](https://travis-ci.org/myfreecomm/nexaas-queue_time.svg?branch=master)](https://travis-ci.org/myfreecomm/nexaas-queue_time)
 # Nexaas::QueueTime
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nexaas/queue_time`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -23,7 +20,32 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Rails initialization
+Add this gem to the Middleware stack before `Rack::Runtime`, like this:
+
+```ruby
+require "nexaas/queue_time/middleware"
+config.middleware.insert_before Rack::Runtime, Nexaas::QueueTime::Middleware
+```
+You can place it in `config/application.rb` or in a specific environment file, such as `config/environments/production.rb`
+
+This code can also be placed in an initializer file, such as `config/initializers/middlewares.rb`:
+```ruby
+Rails.env.on(:any) do |config|
+  require "nexaas/queue_time/middleware"
+  config.middleware.insert_before Rack::Runtime, Nexaas::QueueTime::Middleware
+end
+```
+
+### Header requirement
+For the gem to work, someone **must** set the header `X-Request-Start` with the format `t=timestamp`, where `timestamp` is the UNIX timestamp.
+This someone could be a load balancer, reverse proxy or router. Heroku already does that for you automatically.
+
+### DogStatsD
+
+After calculating the `queue_time`, this gem sends it to a [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/) server via [UDS](https://en.wikipedia.org/wiki/Unix_domain_socket).
+
+Without the _DogStatsD_ agent this gem is pretty much useless.
 
 ## Development
 
@@ -33,7 +55,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nexaas-queue_time.
+Bug reports and pull requests are welcome on GitHub at https://github.com/myfreecomm/nexaas-queue_time.
 
 ## License
 

data/bin/sidekiq_metric_collector

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nexaas/queue_time/sidekiq'
+
+loop do
+  Nexaas::QueueTime::Sidekiq.measure_latency
+  sleep 10
+end

data/lib/nexaas/queue_time/dogstatsd.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'datadog/statsd'
+
+module Nexaas
+  module QueueTime
+    class DogStatsd
+      # By default, Datadog::Statsd opens a UDP connection with a given host and port.
+      # Instead, we are giving it a socket path so it communicates with the statsd server via UDS.
+      #
+      # This approach is easier to setup in containerized environments since all it requires
+      # is the path to the socket file instead of the host address.
+      #
+      # UDS also performs better than UDP,
+      # although the app would need to receive huge traffic to actually feel the difference.
+      def self.timing(metric_name, metric, options = {})
+        Datadog::Statsd.open(nil, nil, socket_path: '/var/run/datadog/dsd.socket') do |statsd|
+          statsd.timing(metric_name, metric, options)
+        end
+      end
+    end
+  end
+end

data/lib/nexaas/queue_time/middleware.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'datadog/statsd'
+require 'nexaas/queue_time/dogstatsd'
 
 module Nexaas
   module QueueTime
     # This middleware calculates the time a request has been waiting
-    #   in the queue before being served by the application server.
+    # in the queue before being served by the application server.
     #
     # It requires the header `X_REQUEST_START`. This header contains
-    #   the timestamp of when the request first apperead in the stack.
+    # the timestamp of when the request first apperead in the stack.
     # This header is usually set by a LoadBalancer, Reverse Proxy or Router.
     #
-    # The format of the header **must** match:
-    #   `t=TIMESTAMP`, where TIMESTAMP is the unix timestamp.
+    # The format of the header *must* match:
+    # `t=TIMESTAMP`, where TIMESTAMP is the unix timestamp.
     # This format is supported by APMs such as New Relic and Scout
     class Middleware
       METRIC_NAME = 'request.queue_time'
@@ -34,7 +34,7 @@ module Nexaas
         if request_start_header && request_start_header =~ HEADER_FORMAT_PATTERN
           left_queue_at = Time.now.to_f
           metric = calculate_queue_time_in_ms(left_queue_at, request_start_header)
-          send_metric(metric)
+          DogStatsd.timing(METRIC_NAME, metric.to_i, sample_rate: 1)
         end
 
         @app.call(env)
@@ -50,20 +50,6 @@ module Nexaas
       def extract_timestamp(entered_queue)
         entered_queue.delete('t=')
       end
-
-      # By default, Datadog::Statsd opens a UDP connection with a given host and port.
-      # Instead, we are giving it a socket path so it communicates with the statsd server via UDS.
-      #
-      # This approach is easier to setup in containerized environments since all it requires
-      # is the path to the socket file instead of the host address.
-      #
-      # UDS also performs better than UDP,
-      # although the app would need to receive huge traffic to actually feel the difference.
-      def send_metric(metric)
-        Datadog::Statsd.open(nil, nil, socket_path: '/var/run/datadog/dsd.socket') do |statsd|
-          statsd.timing(METRIC_NAME, metric.to_i, sample_rate: 1)
-        end
-      end
     end
   end
 end

data/lib/nexaas/queue_time/sidekiq.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'nexaas/queue_time/dogstatsd'
+require 'sidekiq/api'
+
+module Nexaas
+  module QueueTime
+    # Measures the latency for all Sidekiq queues
+    # and send it to Datadog.
+    class Sidekiq
+      METRIC_NAME = 'sidekiq.queue.latency'
+
+      def self.measure_latency
+        ::Sidekiq::Queue.all.each do |queue|
+          latency_in_ms = (queue.latency * 1000).ceil
+          opts = {
+            sample_rate: 1,
+            tags: { queue_name: queue.name }
+          }
+          DogStatsd.timing(METRIC_NAME, latency_in_ms, opts)
+        end
+      end
+    end
+  end
+end

data/lib/nexaas/queue_time/version.rb

@@ -1,5 +1,5 @@
 module Nexaas
   module QueueTime
-    VERSION = '0.3.0'
+    VERSION = '0.4.0-rc1'
   end
 end

data/nexaas-queue_time.gemspec

@@ -13,13 +13,17 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://nexaas.com"
   spec.license       = "MIT"
 
+  spec.metadata      = {
+    "source_code_uri" => "https://github.com/myfreecomm/nexaas-queue_time"
+  }
+
   # 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.bindir        = "bin"
+  spec.executables   << 'sidekiq_metric_collector'
   spec.require_paths = ["lib"]
 
   spec.add_dependency "dogstatsd-ruby", "~> 4.3"
@@ -27,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sidekiq", "~> 4"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-queue_time
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0.pre.rc1
 platform: ruby
 authors:
 - Lucas Mansur
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +111,8 @@ dependencies:
 description: 
 email:
 - lucas.mansur2@gmail.com
-executables: []
+executables:
+- sidekiq_metric_collector
 extensions: []
 extra_rdoc_files: []
 files:
@@ -111,14 +126,18 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/sidekiq_metric_collector
 - lib/nexaas/queue_time.rb
+- lib/nexaas/queue_time/dogstatsd.rb
 - lib/nexaas/queue_time/middleware.rb
+- lib/nexaas/queue_time/sidekiq.rb
 - lib/nexaas/queue_time/version.rb
 - nexaas-queue_time.gemspec
 homepage: https://nexaas.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/myfreecomm/nexaas-queue_time
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -130,9 +149,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: