greek_fire 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3e6df01ce9446f1f2950a068bf5e621a3528f9f
-  data.tar.gz: 4833d2e726973e3b9f39e00801f5cbfc769ffc06
+  metadata.gz: f9c5085e674c0a4e11ab3237d271e2fe6bbcf21a
+  data.tar.gz: 9fd4d7109fe2db2e9529b41f385bbca83644237e
 SHA512:
-  metadata.gz: a758eff60556c5bfc049bd877c3d4ed1578ea3adf5905e4279f7ce3b611ff75cc05175e836fafe6c2de7b30912dfb703a76e2d5937868362d73f2137422df09d
-  data.tar.gz: 55aaf64df23449f042630a80e88c5340b487c610ad279b053b25d930a77444e49dc99fdbc9237bfe6411c25567b3ee63b3606f1459c11ee94c2d3b3f5496df93
+  metadata.gz: 2ef24b3b4e0b281e4f78ccd1b592cc654af4439805eaf40cfb62fc7811f0fb552f48057abbc09a11964587c67b7584f02bfa07cdfc847862ebb4e8e42918dbb9
+  data.tar.gz: 9c2b7cc1019aa3ee0d393e850960f3abe9d0aea4c5e228a2c2daf87b11ba3f6c573f9e86e02bdef7d05a5bdd90af656c8f931dfb115835d409882d85a569eb28

data/README.md

@@ -1,10 +1,10 @@
 # GreekFire
-Short description and motivation.
+Prometheus metrics for rails.
 
 ## Usage
 How to use my plugin.
 
-## Installation
+### Installation
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -21,8 +21,87 @@ Or install it yourself as:
 $ gem install greek_fire
 ```
 
+### Mount the engine
+
+config/routes.rb:
+```ruby
+mount GreekFire::Engine => '/metrics'
+```
+
+### Add yer metrics
+
+config/initializers/greek_fire.rb:
+```ruby
+
+GreekFire::Gauge.register "a_generic_metric" do
+  GenericModel.where('created_at > ?', Time.zone.now.advance(minutes: -1)).count
+end
+
+GreekFire::Gauge.register "another_generic_metric"
+                         description: "describes the metric",
+                         labels: {:a_label: [1, 2], b_label: "foo"} do | labels |
+  AnotherModel.where('created_at > ?', Time.zone.now.advance(minutes: -1)).count
+end
+
+GreekFire::Gauge.register "sidekiq_job_latency",
+                          description: "How long are jobs enqueued",
+                          labels: { :queue => Proc.new { Sidekiq::Queue.all.map(&:name) }} do | labels |
+  Sidekiq::Queue.new(labels[:queue]).latency
+end
+
+
+GreekFire::Gauge.register "sidekiq_job_count",
+                          description: "How many jobs are enqueued",
+                          labels: { :queue => Proc.new { Sidekiq::Queue.all.map(&:name) }} do | labels |
+  Sidekiq::Queue.new(labels[:queue]).size
+end
+```
+
+## Metrics API
+The api for creating metrics.
+
+Currently only gauge type metrics are supported, but other metrics are a PR away!
+
+### Gauges
+```
+module GreekFire
+  class Gauge
+    def self.register(name, description:nil, labels:nil, &block)
+      ...
+    end
+  end
+end
+```
+
+To register a Gauge (point in time value) call the above method.
+
+### Labels
+Labels are a hash of label_name to label_value(s).
+A label_value may be a collection of values for the labels, or a Proc that returns a collection of label values.
+
+The cross product of all possible label values are used to call the given block.
+
+For example, a gauge with the following labels:
+```ruby
+{a_label: [1, 2], b_label: Proc.new { ["some", "list"] }, c_label: "c" }
+```
+
+would have it's block called one for each of the following hashes:
+```ruby
+{a_label: 1, b_label: "some", c_label: "c" }
+{a_label: 1, b_label: "list", c_label: "c" }
+{a_label: 2, b_label: "some", c_label: "c" }
+{a_label: 2, b_label: "list", c_label: "c" }
+```
+
+If the label_value is a Proc, the Proc will be called each time metrics are requested.  This should allow you to export metrics across label dimentions that change as your app runs.  In the installation example you can see that the `sidekiq_job_count` and `sidekiq_job_latency` gauges will have a metrics produced for each queue the app is using.
+
 ## Contributing
-Contribution directions go here.
+
+1. Fork
+2. Write tests.
+3. Implement new feature.
+4. Create a PR.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/greek_fire/version.rb

@@ -1,3 +1,3 @@
 module GreekFire
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greek_fire
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - cconstantine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-description: Description of GreekFire.
+description: An easy way to export metrics for Prometheus.
 email:
 - chris@omadahealth.com
 executables: []
@@ -90,7 +90,7 @@ files:
 - lib/greek_fire/engine.rb
 - lib/greek_fire/version.rb
 - lib/tasks/greek_fire_tasks.rake
-homepage: https://google.com
+homepage: https://github.com/omadahealth/greek_fire
 licenses:
 - MIT
 metadata: {}
@@ -113,5 +113,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Summary of GreekFire.
+summary: Prometheus metrics for rails.
 test_files: []