prometheus_exporter 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2b09dff4a49846230b74243135fcacc1d88b440b04b69e76cf4dce76bd3eaa90
-  data.tar.gz: fb48d9cecb4d0ed600c00c8c8265ec88f4ab8b0e81369adf08eaee478895c337
+SHA1:
+  metadata.gz: 405a56b4f80812423e624398bc135af0ba955af9
+  data.tar.gz: 597a3f4587b851f436dafc8687a85c97373e5e06
 SHA512:
-  metadata.gz: 777e3913f7fd24cd455af42e6ac1d73b98ef6a803189c43443f2d3d517bf4aa540b3be994d99afbb5060bc83ff83ed42be2037217b14522d848918891d64cb1c
-  data.tar.gz: bcbde54a95042c01a80e297ca6096444574d9e8c1d17027759469e51f4ff36b8b23cf574f6111034233805546e7f7a73e8cc8922b96f787191b4bdb345e8dbfa
+  metadata.gz: d2a19111517b005751654f0084e66300cc6e2c70207c1529ced65d84031b19aa90f218daf71e10624653c976213833e4bc88551371f21e627410fef6b8e9355e
+  data.tar.gz: 1c94b5f7d8606c0384211faeaf91e2595e154cbef85013764e7de3d0bda39c966527bd153696b8aa48418ade3c7507dccdb2104156a399638d706da9457bdadf

data/README.md

@@ -20,6 +20,10 @@ Or install it yourself as:
 
     $ gem install prometheus_exporter
 
+## Can I have some pretty pictures please? 
+
+Sure, check out: [Instrumenting Rails with Prometheus](https://samsaffron.com/archive/2018/02/02/instrumenting-rails-with-prometheus)
+
 ## Usage
 
 ### Single process mode
@@ -199,13 +203,36 @@ bundle exec prometheus_exporter -a person_collector.rb
 
 ```
 
+#### Global metrics in a custom type collector
+
+Custom type collectors are the ideal place to collect global metrics, such as user/article counts and connection counts. The custom type collector runs in the collector which usually runs in the prometheus exporter process. 
+
+Out-of-the-box we try to keep the prometheus exporter as lean as possible, we do not load all the Rails dependencies so you will not have access to your models. You can always ensure it is loaded in your custom type collector with:
+
+```
+unless defined? Rails
+  require File.expand_path("../../config/environment", __FILE__)
+end
+```
+
+Then you can collect the metrics you need on demand:
+
+```
+def metrics 
+  user_count_gague = PrometheusExporter::Metric::Gauge.new('user_count', 'number of users in the app')
+  user_count_gague.observe User.count
+  [user_count_gauge]
+end
+```
+
+The metrics endpoint is called whenever prometheus calls the `/metrics` HTTP endpoint, it may make sense to introduce some caching so database calls are only performed once every N seconds. [lru_redux](https://github.com/SamSaffron/lru_redux) is the perfect gem for that kind of job as you can `LruRedux::TTL::Cache` which will automatically expire after N seconds. 
+
+
 ### Multi process mode with custom collector
 
 You can opt for custom collector logic in a multi process environment.
 
-This allows you better control over the amount of data transported over HTTP and also allow you to introduce custom logic into your centralized collector.
-
-The standard collector ships "help", "type" and "name" for every metric, in some cases you may want to avoid sending all that data.
+This allows you to completely replace the collector logic.
 
 First, define a custom collector, it is critical you inherit off `PrometheusExporter::Server::Collector`, also it is critical you have custom implementations for #process and #prometheus_metrics_text
 
@@ -241,7 +268,7 @@ end
 Next, launch the exporter process:
 
 ```bash
-% bin/prometheus_exporter 12345 --collector examples/custom_collector.rb
+% bin/prometheus_exporter --collector examples/custom_collector.rb
 ```
 
 In your application ship it the metrics you want:
@@ -274,7 +301,7 @@ thing2 12
 
 ## Transport concerns
 
-Prometheus Exporter handles transport using a simple HTTP protocol. In multi process mode we avoid needing a large number of HTTP request by using chunked encoding to send metrics. This means that a single HTTP channel can deliver 100s or even 1000s of metrics over a single HTTP session to the `/send-metrics` endpoint.
+Prometheus Exporter handles transport using a simple HTTP protocol. In multi process mode we avoid needing a large number of HTTP request by using chunked encoding to send metrics. This means that a single HTTP channel can deliver 100s or even 1000s of metrics over a single HTTP session to the `/send-metrics` endpoint. All calls to `send` and `send_json` on the PrometheusExporter::Client class are **non-blocking** and batched. 
 
 The `/bench` directory has simple benchmark it is able to send through 10k messages in 500ms.
 

data/lib/prometheus_exporter/server/collector.rb

@@ -56,6 +56,12 @@ module PrometheusExporter::Server
       end
     end
 
+    def register_metric(metric)
+      @mutex.synchronize do
+        @metrics[metric.name] = metric
+      end
+    end
+
     protected
 
     def register_metric_unsafe(obj)

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Prometheus Exporter