meeseeks 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239577cae2742ede49f2120ac5f0be611872f7827c1f72b97583da59d9b84da0
-  data.tar.gz: e21ff55141f6ad7e29113516a3c0660bbc981653ced9cdc4aea429f25f987322
+  metadata.gz: c2797830d0c41af4fb2ce0dd7cf70c935da9fa17c1c02e065ba21693e57ebc83
+  data.tar.gz: 126582c74053256339b37584423e0a02976629b78ee8ca4031cd7c45ff790a5e
 SHA512:
-  metadata.gz: e2e068041a6a6ff27150dd5673f09926757c05ad3f33c9b1e1cded25a440533c63c0df32960a3863cfe4c0ab1bba170bb61d17590c342d35aeb1918661b61d46
-  data.tar.gz: 9a6f0cc519fb5abd30c5b20d91386b37ebf4bf609f9189cbd9f97ff83c51ccbbaf52e692ddc3cb6b7e6f0991536fbecea35fb58dcc3ab9581f805a1f48551c8b
+  metadata.gz: 7ddff6adf34e30e2ef933ed781d070041b2d83c9c3c19d1ad30ea8fc34615f58897310c049b97c7494a3a35cdc7c8d90fb4d2ea2eb4c374d7a96ae0cb6cdad15
+  data.tar.gz: 8ca041a2e5f8c7434f967c11ef2470d6c7389260ffc8de3c746b51c91d5d252958c8ce4142c768bc40be3a579d85a883d63696be64b39a3d6edf37aab03cb034

data/.gitignore

@@ -7,6 +7,5 @@
 /spec/reports/
 /tmp/
 
-# rspec failure tracking
 .rspec_status
 .bash_history

data/.rubocop.yml

@@ -6,3 +6,7 @@ AllCops:
     - Guardfile
 Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -1,5 +1,9 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1
+sudo: required
+dist: trusty
+group: edge
+services:
+  - docker
+before_script:
+- make build
+script:
+- make test

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    meeseeks (0.1.0)
+    meeseeks (0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     ffi (1.9.25)
     formatador (0.2.5)
     guard (2.14.2)
@@ -32,7 +34,9 @@ GEM
     guard-rubocop (1.3.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
+    hirb (0.7.3)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -79,6 +83,15 @@ GEM
     ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
     thor (0.20.0)
     unicode-display_width (1.4.0)
 
@@ -93,6 +106,8 @@ DEPENDENCIES
   meeseeks!
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov (~> 0.15)
+  simplecov-console (~> 0.4)
 
 BUNDLED WITH
    1.16.4

data/Makefile

@@ -27,7 +27,7 @@ bundle:
 	docker-compose run meeseeks bash -l -c "bundle check || bundle install"
 
 console: bundle
-	docker-compose run meeseeks bash -l -c "bundle exec bin/console"
+	docker-compose exec meeseeks bash -l -c "bundle exec bin/console" || docker-compose run meeseeks bash -l -c "bundle exec bin/console"
 
 guard-down:
 	docker-compose -p meeseeks-guard down --remove-orphans
@@ -45,7 +45,7 @@ guard-shell:
 	docker-compose -p meeseeks-guard run meeseeks bash -c "(bundle check || bundle install) && bash"
 
 rubocop:
-	docker-compose run meeseeks bash -l -c "bundle exec rubocop -a"
+	docker-compose run meeseeks bash -l -c "(bundle check || bundle install) && bundle exec rubocop -a"
 
 
 test: guard-down guard-up

data/README.md

@@ -1,39 +1,75 @@
-# Meeseeks
+[![Build Status](https://travis-ci.com/coup-mobility/meeseeks.svg?branch=master)](https://travis-ci.com/coup-mobility/meeseeks) [![Maintainability](https://api.codeclimate.com/v1/badges/3b8aad1633758b0723bc/maintainability)](https://codeclimate.com/github/coup-mobility/meeseeks/maintainability)
+
+![](meeseeks.png)
+> Meeseeks are creatures who are created to serve a singular purpose for which they will go to any length to fulfill. After they serve their purpose, they expire and vanish into the air. [[1](http://rickandmorty.wikia.com/wiki/Mr._Meeseeks)]
 
-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/meeseeks`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Meeseeks
 
-TODO: Delete this and the text above, and describe your gem
+⚠️ Do not use in production ⚠️
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Asynchronously submit metrics to a Circonus HTTPTrap:
 
 ```ruby
-gem 'meeseeks'
+> m = Meeseeks::Meeseeks.new(
+  data_submission_url: 'https://api.circonus.com/module/httptrap/2ds89as2-29e3-4155-a54a-4b7261419e11/secret',
+  interval: 60,
+  max_batch_size: 100,
+  max_queue_size: 10_000
+)
+=> #<Meeseeks::Meeseeks:0x00005640e59dd380 … >
+>  m.record('group', 'metric', 22.02)
+=> true
 ```
 
-And then execute:
+You can also configure Meeseeks via environment variables
 
-    $ bundle
+- `MEESEEKS_DATA_SUBMISSION_URL=https://api.circonus.com/module/httptrap/2ds89as2-29e3-4155-a54a-4b7261419e11/secret`
+- `MEESEEKS_INTERVAL=60`
+- `MEESEEKS_MAX_BATCH_SIZE=100`
+- `MEESEEKS_MAX_QUEUE_SIZE=10000`
 
-Or install it yourself as:
+and use the singleton (to the same effect as the example above):
 
-    $ gem install meeseeks
+```ruby
+Meeseeks.instance.record('group', 'metric', 22.02)
+```
 
-## Usage
+### Meeseeks statistics
+
+Meeseeks will instrument itself on Circonus. Look for these metrics:
 
-TODO: Write usage instructions here
+- ``meeseeks`batch_size`` (how many measurements were submitted per request to Circonus?)
+- ``meeseeks`cycle_count`` (how many intervals did this meeseeks instance do?)
+- ``meeseeks`queue_size`` (how many measurements are waiting in the queue to be submitted?)
+- ``meeseeks`request_count`` (how many requests to Circonus did this meeseeks instance do?)
 
 ## 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.
+After checking out the repo, run `make build` - you need only docker on your machine, no ruby, rvm, or any of that.
 
-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).
+### Launch a shell or console
+
+To try it out locally while developing, you can `make shell` to open a shell in a container where the gem's dependencies are installed, and you can use `make console` as an alias for entering `make shell` and `rake console`.
+
+### Run the tests
+
+During development, you can just keep `make guard` running and it will test files as you edit them. You can also run `make test` to run all of the tests.
+
+### Automatically fix rubocop offenses
+
+Run `make rubocop`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jayniz/meeseeks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/coup-mobility/meeseeks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 
-Everyone interacting in the Meeseeks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jayniz/meeseeks/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Meeseeks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coup-mobility/meeseeks/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Acknowledgements
+
+Mr. Meeseeks picture by [Nathan Andrews](https://dribbble.com/shots/2846308-Mr-Meeseeks)

data/docker-compose.yml

@@ -15,5 +15,3 @@ services:
     image: coup-mobility/meeseeks
 volumes:
   meeseeks-bundler-cache:
-  meeseeks-rails-bundler-cache:
-

data/lib/meeseeks/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Meeseeks
+  class Error < StandardError
+  end
+end
+
+require 'meeseeks/errors/invalid_type'

data/lib/meeseeks/errors/invalid_type.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Meeseeks
+  module Errors
+    class InvalidType < Meeseeks::Error
+    end
+  end
+end

data/lib/meeseeks/harvester.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'meeseeks/http_trap'
+
+# Checks a queue in regular intervals and bulk submits measurements
+# to a Circonus HTTPTrap https://login.circonus.com/resources/docs/user/Data/CheckTypes/HTTPTrap.html
+module Meeseeks
+  class Harvester
+    attr_reader :interval, :max_batch_size, :cycle_count
+
+    def initialize(queue:, http_trap:, interval: 60, max_batch_size: 100)
+      @queue = queue
+      @http_trap = http_trap
+      @interval = interval
+      @max_batch_size = max_batch_size
+      @cycle_count = 0
+      @lock = Mutex.new
+    end
+
+    def start
+      @continue = true
+      return if @thread&.alive?
+
+      @thread = Thread.new do
+        loop do
+          sleep(@interval)
+          break unless @continue
+
+          @cycle_count += 1
+          drain
+        end
+      end
+    end
+
+    def stop
+      @continue = false
+    end
+
+    def kill
+      @thread&.kill if @thread&.alive?
+    end
+
+    def running?
+      @thread&.alive?
+    end
+
+    def drain
+      @lock.synchronize do
+        drain_queue_async
+      end
+    end
+
+    private
+
+    def drain_queue_async
+      loop do
+        batch = batch_from_queue
+
+        begin
+          submit(batch)
+        rescue StandardError
+          # TODO: think about whether or not this is a good idea. It's nice to
+          # recover from the occasional HTTP hickup, but when we can't submit
+          # to Circonus for whatever reason, we'll fill up the RAM. Do we want
+          # to implement limited retries here, or do we want to impose a max
+          # length on the queue, or what do we want to do?
+          batch.map { |d| @queue.push(d) }
+        end
+
+        # Even if the batch is empty, we want to submit our own statistics
+        # for this cycle, and that's why we don't break before the submit
+        break if batch.empty?
+      end
+    end
+
+    def batch_from_queue
+      batch = []
+
+      loop do
+        batch << @queue.pop(true)
+        break if @queue.empty? || batch.length >= @max_batch_size - 1
+      rescue ThreadError => e
+        e.message == 'queue empty' ? break : raise
+      end
+
+      batch
+    end
+
+    def meeseeks_stats_payload(batch_size)
+      { meeseeks: {} }.tap do |stats|
+        stats[:meeseeks].merge!(Payload.for('batch_size', batch_size))
+        stats[:meeseeks].merge!(Payload.for('queue_size', @queue.size))
+        stats[:meeseeks].merge!(Payload.for('request_count', submit_count))
+        stats[:meeseeks].merge!(Payload.for('cycle_count', @cycle_count))
+      end
+    end
+
+    def submit_count
+      @http_trap.submit_count
+    end
+
+    def submit(measurements)
+      stats = [meeseeks_stats_payload(measurements.length + 1)]
+      @http_trap.submit(measurements + stats)
+    end
+  end
+end

data/lib/meeseeks/http_trap.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Meeseeks
+  class HTTPTrap
+    attr_reader :last, :submit_count
+
+    def initialize(data_submission_url)
+      @uri = URI.parse(data_submission_url)
+      @submit_count = 0
+    end
+
+    def submit(measurements)
+      req = request(measurements)
+      res = http.request(req)
+
+      @last = OpenStruct.new(time: Time.now, request: req, response: res)
+      @submit_count += 1
+
+      JSON.parse res.body
+    end
+
+    private
+
+    def request(measurements)
+      put.tap do |request|
+        request.body = measurements.map(&:to_json).join("\n")
+      end
+    end
+
+    def http
+      Net::HTTP.new(@uri.host, @uri.port).tap do |http|
+        http.use_ssl = @uri.scheme == 'https'
+      end
+    end
+
+    def put
+      Net::HTTP::Put.new(@uri.path, 'Content-Type' => 'application/json')
+    end
+  end
+end

data/lib/meeseeks/meeseeks.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'meeseeks/error'
+require 'meeseeks/harvester'
+require 'meeseeks/http_trap'
+require 'meeseeks/payload'
+require 'date'
+
+# Allows you to asynchronously send measurements to Circonus. Measurements are
+# stored in a queue and a harvester in a background thread empties the queue
+# in regular intervals and submits data to a Circonus HTTPTrap.
+module Meeseeks
+  class Meeseeks
+    attr_reader :queue, :harvester, :http_trap
+
+    def initialize(data_submission_url: nil,
+                   interval: nil,
+                   max_batch_size: nil,
+                   max_queue_size: nil)
+      @queue = Queue.new
+      @interval = interval || ENV.fetch('MEESEEKS_INTERVAL', 60).to_i
+      @max_queue_size = max_queue_size ||
+                        ENV.fetch('MEESEEKS_MAX_QUEUE_SIZE', 100).to_i
+      @max_batch_size = max_batch_size ||
+                        ENV.fetch('MEESEEKS_MAX_BATCH_SIZE', 1_000).to_i
+      @data_submission_url = data_submission_url ||
+                             ENV.fetch('MEESEEKS_DATA_TRANSMISSION_URL')
+
+      create_http_trap
+      start_harvester
+    end
+
+    def record!(group, metric, value, time = DateTime.now)
+      Payload.validate_type!(value)
+      return false if @queue.size >= @max_queue_size
+
+      @queue.push(Payload.for_group(group, metric, value, time))
+      true
+    end
+
+    def record(group, metric, value, time = DateTime.now)
+      record!(group, metric, value, time)
+    rescue Error
+      false
+    end
+
+    private
+
+    def create_http_trap
+      @http_trap = HTTPTrap.new(@data_submission_url)
+    end
+
+    def start_harvester
+      @harvester = Harvester.new(
+        queue: @queue,
+        http_trap: @http_trap,
+        interval: @interval,
+        max_batch_size: @max_batch_size
+      )
+      @harvester.start
+    end
+  end
+end

data/lib/meeseeks/payload.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'meeseeks/error'
+require 'date'
+
+module Meeseeks
+  module Payload
+    def self.for_group(group, metric, value, time)
+      {
+        group => self.for(metric, value, time)
+      }
+    end
+
+    def self.for(metric, value, time = DateTime.now)
+      {
+        metric.to_s => {
+          '_ts'    => time.to_datetime.strftime('%Q'),
+          '_value' => value,
+          '_type'  => 'i'
+        }
+      }
+    end
+
+    def self.validate_type!(value)
+      return if value.is_a?(String) || value.is_a?(Numeric)
+
+      raise Errors::InvalidType, "#{value.class.name} values are not supported"
+    end
+  end
+end

data/lib/meeseeks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Meeseeks
-  VERSION = '0.1.0'
+  VERSION = '0.1.3'
 end

data/lib/meeseeks.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 require 'meeseeks/version'
+require 'meeseeks/meeseeks'
+require 'forwardable'
 
 module Meeseeks
-  # Your code goes here...
+  extend SingleForwardable
+
+  def self.instance
+    @instance ||= Meeseeks.new
+  end
+
+  def_delegators :instance, *::Meeseeks::Meeseeks.instance_methods(false)
 end

data/meeseeks.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rubocop', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'simplecov-console', '~> 0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meeseeks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Submits measurements to a circonus http trap
 email:
 - jannis.hermanns@joincoup.com
@@ -117,8 +145,15 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/meeseeks.rb
+- lib/meeseeks/error.rb
+- lib/meeseeks/errors/invalid_type.rb
+- lib/meeseeks/harvester.rb
+- lib/meeseeks/http_trap.rb
+- lib/meeseeks/meeseeks.rb
+- lib/meeseeks/payload.rb
 - lib/meeseeks/version.rb
 - meeseeks.gemspec
+- meeseeks.png
 homepage: https://github.com/coup-mobility/meeseeks
 licenses: []
 metadata: {}