redis_prometheus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 795f9ada93c54358d409d12e704065f0ae71d37b
-  data.tar.gz: 4e0154742b837495bcab118e66fe21252cd1a570
+  metadata.gz: 8c59cb7c47a04172276fc269cdf8cd17e63d5fef
+  data.tar.gz: 5bd10eab113ec3cbbd302c9dea510441c4232b0c
 SHA512:
-  metadata.gz: b3123cdcec1254735a8122aa9859daccb43711f3e775f996ad4deb5c5e80cf8e1c4d6ba525801fe0d8a1b2bacfab26c65caedd884e596770b1d1a8a1454e3d0c
-  data.tar.gz: 6117e961ddcebd2d6440075951e6883816d99be6a71b40cccfa139326bc7015ce0bd5de4fa0f76d861332354577e1c4543ef044975b1f65238915fcad253c5b6
+  metadata.gz: f04986c69d9d712b68f7e8c00751db1950ee95bedfebcfc76b96e6586cb16e18d8a08256b0da6fb05601d8422d942a8046a7fb39d0653a3c8a029816cf83fb32
+  data.tar.gz: c11775bca497be85a7271945fb5b3e83cf6a4d5c0aa030130ac7af7e14f0c5850054abc13cad9ae5d2364e6d17e08efc713aaf8a26e0e4a339c902339643942b

data/README.md

@@ -1,8 +1,8 @@
 # RedisPrometheus
 
-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/redis_prometheus`. To experiment with that code, run `bin/console` for an interactive prompt.
+After realising all the current gem solutions for Rails + Prometheus only report stats for the current process (meaning your stats will differ on every scrape), we wrote this gem that uses Redis as a shared data store.
 
-TODO: Delete this and the text above, and describe your gem
+**IMPORTANT:** This gem has no tests yet and is brand new, it was written for our internal needs and has been open-sourced under the MIT licence, but it DEFINITELY comes with zero warranty at all, including that it will either work and won't open your site up to hackers!
 
 ## Installation
 
@@ -14,15 +14,36 @@ gem 'redis_prometheus'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install redis_prometheus
+```
+$ gem install redis_prometheus
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+You then need to configure two ENVironment variables (because we play nicely with 12 Factor Apps) outside of your app or in a `.env` file if you use Foreman/etc:
+
+```
+REDIS_PROMETHEUS_SERVICE=...
+REDIS_PROMETHEUS_TOKEN=...
+```
+
+The `REDIS_PROMETHEUS_TOKEN` is just appended to the `/metrics` URL that this gem responds on, so if you set it as 123, you should configure Prometheus to scrape /metrics/123. This is in lieu of authentication, just to make the URL a little harder to guess.
+
+The `REDIS_PROMETHEUS_SERVICE` is just a label for this application, so if you have multiple applications reporting in to the same Prometheus you can separate them.
+
+If you have any paths that you want to ignore stats for, you can set them in `config/application.rb` like this:
+
+```
+config.redis_prometheus.ignored_urls += %w{/status /ping}
+```
+
+After that, configure Prometheus to scrape your URL and it will automatically report a Histogram of response times with URLs, any UUIDs in the URL will be replaced with a token so they share a URL.
 
 ## Development
 

data/lib/redis_prometheus/middleware.rb

@@ -29,7 +29,7 @@ module RedisPrometheus
       headers = {}
       response = ""
 
-      keys = Redis.current.keys("http_request_duration_seconds_bucket:*")
+      keys = Redis.current.keys("http_request_duration_seconds_bucket/#{ENV["REDIS_PROMETHEUS_SERVICE"]}:*")
       values = Redis.current.mget(keys)
       response << "# TYPE http_request_duration_seconds_bucket histogram\n"
       response << "# HELP http_request_duration_seconds_bucket The HTTP response duration of the Rack application.\n"
@@ -53,17 +53,17 @@ module RedisPrometheus
 
       response << "# TYPE http_request_requests_counter counter\n"
       response << "# HELP http_request_requests_counter The total number of HTTP requests handled by the Rack application.\n"
-      requests = Redis.current.get("http_request_requests_counter") || 0
+      requests = Redis.current.get("http_request_requests_counter/#{ENV["REDIS_PROMETHEUS_SERVICE"]}") || 0
       response << "http_request_requests_counter{service=\"#{ENV["REDIS_PROMETHEUS_SERVICE"]}\"} #{requests.to_f}\n"
 
       response << "# TYPE http_request_client_errors_counter counter\n"
       response << "# HELP http_request_client_errors_counter The total number of HTTP errors return by the Rack application.\n"
-      requests = Redis.current.get("http_request_client_errors_counter") || 0
+      requests = Redis.current.get("http_request_client_errors_counter/#{ENV["REDIS_PROMETHEUS_SERVICE"]}") || 0
       response << "http_request_client_errors_counter{service=\"#{ENV["REDIS_PROMETHEUS_SERVICE"]}\"} #{requests.to_f}\n"
 
       response << "# TYPE http_request_server_errors_counter counter\n"
       response << "# HELP http_request_server_errors_counter The total number of HTTP errors return by the Rack application.\n"
-      requests = Redis.current.get("http_request_server_errors_counter") || 0
+      requests = Redis.current.get("http_request_server_errors_counter/#{ENV["REDIS_PROMETHEUS_SERVICE"]}") || 0
       response << "http_request_server_errors_counter{service=\"#{ENV["REDIS_PROMETHEUS_SERVICE"]}\"} #{requests.to_f}\n"
 
       headers['Content-Encoding'] = "gzip"
@@ -82,13 +82,13 @@ module RedisPrometheus
       url.gsub!(%r{[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}}i, "{uuid}")
 
       bucket = duration_to_bucket(duration)
-      Redis.current.incr("http_request_duration_seconds_bucket:url=#{url}:le=#{bucket}")
-      Redis.current.incr("http_request_requests_counter")
+      Redis.current.incr("http_request_duration_seconds_bucket/#{ENV["REDIS_PROMETHEUS_SERVICE"]}:url=#{url}:le=#{bucket}")
+      Redis.current.incr("http_request_requests_counter/#{ENV["REDIS_PROMETHEUS_SERVICE"]}")
       if code.to_i >= 400 && code.to_i <= 499
-        Redis.current.incr("http_request_client_errors_counter")
+        Redis.current.incr("http_request_client_errors_counter/#{ENV["REDIS_PROMETHEUS_SERVICE"]}")
       end
       if code.to_i >= 500 && code.to_i <= 599
-        Redis.current.incr("http_request_server_errors_counter")
+        Redis.current.incr("http_request_server_errors_counter/#{ENV["REDIS_PROMETHEUS_SERVICE"]}")
       end
     end
 

data/lib/redis_prometheus/version.rb

@@ -1,3 +1,3 @@
 module RedisPrometheus
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_prometheus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler