redis_prometheus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 795f9ada93c54358d409d12e704065f0ae71d37b
+  data.tar.gz: 4e0154742b837495bcab118e66fe21252cd1a570
+SHA512:
+  metadata.gz: b3123cdcec1254735a8122aa9859daccb43711f3e775f996ad4deb5c5e80cf8e1c4d6ba525801fe0d8a1b2bacfab26c65caedd884e596770b1d1a8a1454e3d0c
+  data.tar.gz: 6117e961ddcebd2d6440075951e6883816d99be6a71b40cccfa139326bc7015ce0bd5de4fa0f76d861332354577e1c4543ef044975b1f65238915fcad253c5b6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis_prometheus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andy Jeffries
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_prometheus'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_prometheus
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andyjeffries/redis_prometheus.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_prometheus"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis_prometheus/middleware.rb

@@ -0,0 +1,124 @@
+require 'benchmark'
+
+module RedisPrometheus
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      if env["PATH_INFO"] == "/metrics/#{ENV["REDIS_PROMETHEUS_TOKEN"]}"
+        results(env)
+      else
+        trace(env) do
+          @app.call(env)
+        end
+      end
+    end
+
+    protected
+
+    def trace(env)
+      response = nil
+      duration = Benchmark.realtime { response = yield }
+      record(env, response.first.to_s, duration)
+      response
+    end
+
+    def results(env)
+      headers = {}
+      response = ""
+
+      keys = Redis.current.keys("http_request_duration_seconds_bucket:*")
+      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"
+      keys.each_with_index do |key, i|
+        key_parts = key.split(":")
+        key_parts.shift
+
+        data = {}
+        key_parts.each do |p|
+          k,v = p.split("=")
+          data[k.to_sym] = v
+        end
+        data[:service] = ENV["REDIS_PROMETHEUS_SERVICE"]
+
+        next if Rails.application.config.redis_prometheus.ignored_urls.include?(data[:url])
+
+        response << "http_request_duration_seconds_bucket{"
+        response << data.map {|k,v| "#{k}=\"#{v}\""}.join(",")
+        response << "} #{values[i].to_f}\n"
+      end
+
+      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
+      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
+      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
+      response << "http_request_server_errors_counter{service=\"#{ENV["REDIS_PROMETHEUS_SERVICE"]}\"} #{requests.to_f}\n"
+
+      headers['Content-Encoding'] = "gzip"
+      headers['Content-Type'] = "text/plain"
+      gzip = Zlib::GzipWriter.new(StringIO.new)
+      gzip << response
+      compressed_response = gzip.close.string
+
+      [200, headers, [compressed_response]]
+    end
+
+    def record(env, code, duration)
+      url = "#{env["SCRIPT_NAME"]}#{env["PATH_INFO"]}"
+      return if Rails.application.config.redis_prometheus.ignored_urls.include?(url)
+
+      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")
+      if code.to_i >= 400 && code.to_i <= 499
+        Redis.current.incr("http_request_client_errors_counter")
+      end
+      if code.to_i >= 500 && code.to_i <= 599
+        Redis.current.incr("http_request_server_errors_counter")
+      end
+    end
+
+    def duration_to_bucket(duration)
+      return case
+      when duration <= 0.005
+        "0.005"
+      when duration <= 0.01
+        "0.01"
+      when duration <= 0.025
+        "0.025"
+      when duration <= 0.05
+        "0.05"
+      when duration <= 0.1
+        "0.1"
+      when duration <= 0.25
+        "0.25"
+      when duration <= 0.5
+        "0.5"
+      when duration <= 1
+        "1"
+      when duration <= 2.5
+        "2.5"
+      when duration <= 5
+        "5"
+      when duration <= 10
+        "10"
+      else
+        "+Inf"
+      end
+    end
+  end
+end

data/lib/redis_prometheus/railtie.rb

@@ -0,0 +1,8 @@
+class Railtie < Rails::Railtie
+  config.redis_prometheus = ActiveSupport::OrderedOptions.new
+  config.redis_prometheus.ignored_urls = ["/metrics/#{ENV["REDIS_PROMETHEUS_TOKEN"]}"]
+
+  initializer "redis_prometheus.configure_rails_initialization" do |app|
+    app.middleware.insert_before 0, RedisPrometheus::Middleware
+  end
+end

data/lib/redis_prometheus/version.rb

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

data/lib/redis_prometheus.rb

@@ -0,0 +1,7 @@
+require "redis_prometheus/middleware"
+require "redis_prometheus/railtie"
+require "redis_prometheus/version"
+
+module RedisPrometheus
+  # Your code goes here...
+end

data/redis_prometheus.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_prometheus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_prometheus"
+  spec.version       = RedisPrometheus::VERSION
+  spec.authors       = ["Andy Jeffries"]
+  spec.email         = ["andy@andyjeffries.co.uk"]
+
+  spec.summary       = %q{Capture and serve rack statistics for Prometheus in Redis}
+  spec.description   = %q{In order to ensure all your statistics are served to Prometheus across multiple machines/pods/instances/containers, store the details in Redis}
+  spec.homepage      = "https://github.com/civo/redis_prometheus"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: redis_prometheus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Jeffries
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: In order to ensure all your statistics are served to Prometheus across
+  multiple machines/pods/instances/containers, store the details in Redis
+email:
+- andy@andyjeffries.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis_prometheus.rb
+- lib/redis_prometheus/middleware.rb
+- lib/redis_prometheus/railtie.rb
+- lib/redis_prometheus/version.rb
+- redis_prometheus.gemspec
+homepage: https://github.com/civo/redis_prometheus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Capture and serve rack statistics for Prometheus in Redis
+test_files: []