meeseeks 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dd446516cf1e5211bd4ae590deadda04210f795535a407fef054456cfc85ea6
-  data.tar.gz: 83a44feecd92a141eeaa63e5415866cf3ffe6f7b036960bdf8286b0f76845987
+  metadata.gz: f8a0a151c08bf506a173bb9de62e082287bfd445e3fa472c418d95e5db737703
+  data.tar.gz: 380a26f7598ba2ad6cdb8860235957a65527dd34c13e68fe7f00b3764fdd42c7
 SHA512:
-  metadata.gz: 8db6c9f2ba9e71eb67d31b7c413f0266ac9bc6563560b3513bfc29b9166c25549ab98b8f5a32130f9405dfb48f442ddac46ff297f7381f1ebf209fc9247c6ddf
-  data.tar.gz: 693eaa5ca21a5ccc3398668f814bf0a64c2b12145e0b811e2510008adabde1b4e473baafd29f196051d94237b7e9d793910068e9e6fc25bcfdfd5a33e0e6204e
+  metadata.gz: 96f1db2392ebebc6e843ee117fdfa80ad1aedb4194eaa2834cb36be3b54b80bac16925f048ede997ff6a6ba2c7c23a56c21afd4499ed63040617fe0b061a12a7
+  data.tar.gz: 5a487c1c8c8167ed5af4b87aca6e2f18a22e74fb179b49781d3447f33d408d391689538027cf980ccca3e38666f23446d52fdf4ee135dbc34ac1ed1e6327e0a3

data/.gitignore

@@ -10,3 +10,4 @@
 .rspec_status
 .bash_history
 test-env.sh
+TODO.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    meeseeks (0.1.4)
+    meeseeks (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -7,6 +7,7 @@
 
 ⚠️ Do not use in production ⚠️
 
+
 ## Usage
 
 Asynchronously submit metrics to a Circonus HTTPTrap:
@@ -36,35 +37,73 @@ and use the singleton (to the same effect as the example above):
 Meeseeks.instance.record('group', 'metric', 22.02)
 ```
 
+
 ### Meeseeks statistics
 
-Meeseeks will instrument itself on Circonus. Look for these metrics:
+Meeseeks will instrument itself on Circonus (these metrics will be added to each
+batch submitted to Circonus, so for `max_batch_size: 100` we will really submit
+104 metrics each time). Look for these metrics:
 
 - ``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?)
+- ``meeseeks`submit_count`` (how many requests to Circonus did this meeseeks instance do?)
+
+
+### Debugging
+
+We tried to make Meeseeks inspectable:
+
+```ruby
+# Basic stats
+> Meeseeks.stats
+=> {
+     "queue_size": 0,
+     "harvester": {
+       "cycle_count": 7,
+       "running": true
+     },
+     "http_trap": {
+       "submit_count": 7,
+       "last_submit_at": "2018-10-19 10:42:35 +0000"
+     }
+   }
+
+# You can even dive into the requests to Circonus, and the responses
+# received (including bodies):
+> Meeseeks.http_trap.last.request
+=> #<Net::HTTP::Put PUT>
+> Meeseeks.http_trap.last.response
+=> #<Net::HTTPOK 200 OK readbody=true>
+
+```
+
 
 ## Development
 
 After checking out the repo, run `make build` - you need only docker on your machine, no ruby, rvm, or any of that.
 
+
 ### 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/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/coup-mobility/meeseeks/blob/master/CODE_OF_CONDUCT.md).

data/lib/meeseeks/harvester.rb

@@ -17,6 +17,13 @@ module Meeseeks
       @lock = Mutex.new
     end
 
+    def stats
+      {
+        cycle_count: @cycle_count,
+        running: running?
+      }
+    end
+
     def start
       @continue = true
       return if @thread&.alive?
@@ -61,15 +68,15 @@ module Meeseeks
         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?
+          # to Circonus at all 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?
+        break if @queue.empty?
       end
     end
 
@@ -90,7 +97,7 @@ module Meeseeks
       { 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('submit_count', submit_count))
         stats[:meeseeks].merge!(Payload.for('cycle_count', @cycle_count))
       end
     end

data/lib/meeseeks/http_trap.rb

@@ -3,6 +3,7 @@
 require 'net/http'
 require 'json'
 
+# See https://login.circonus.com/resources/docs/user/Data/CheckTypes/HTTPTrap.html
 module Meeseeks
   class HTTPTrap
     attr_reader :last, :submit_count
@@ -22,6 +23,13 @@ module Meeseeks
       JSON.parse res.body
     end
 
+    def stats
+      {
+        submit_count: @submit_count,
+        last_submit_at: @last&.time
+      }
+    end
+
     private
 
     def request(measurements)

data/lib/meeseeks/meeseeks.rb

@@ -44,6 +44,14 @@ module Meeseeks
       false
     end
 
+    def stats
+      {
+        queue_size: @queue.size,
+        harvester: @harvester.stats,
+        http_trap: @http_trap.stats
+      }
+    end
+
     private
 
     def create_http_trap

data/lib/meeseeks/payload.rb

@@ -14,9 +14,9 @@ module Meeseeks
     def self.for(metric, value, time = DateTime.now)
       {
         metric.to_s => {
-          '_ts'    => time.to_datetime.strftime('%Q'),
+          '_ts'    => time.to_datetime.strftime('%Q').to_i,
           '_value' => value,
-          '_type'  => 'i'
+          '_type'  => 'n'
         }
       }
     end

data/lib/meeseeks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meeseeks
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler