prometheus_aggregator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93d4677b2b500010a25dc614a0d0e539f6440c37e756555fbe0b432716253ea9
+  data.tar.gz: daa57b4c30c284887e2ace5a4159c0c2792c199e7d2accfaef66379ad519ab6b
+SHA512:
+  metadata.gz: 3095f13baacd9c31432239547d1e6334219512c2f5affdb9de96fd8a8bf6d2395efdf99b02dbe70c94080ce212602d4babe54cf6272eb2a731b85ec2596931dc
+  data.tar.gz: 30c432202d312b10e1f5347ae6d705699b8dc3fb5d51ab5a796ad8669cd562da3fc096812b222abb5d9340261e7293c47cc798f039c4ec4ce35ba182d7c419c9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+    - tmp/**/*
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 250
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/LineLength:
+  Max: 80
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - dependabot-core.gemspec
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': ()
+    '%I': ()
+    '%w': ()
+    '%W': ()

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dependabot
+
+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,15 @@
+# `prometheus_aggregator`
+
+A Ruby client for https://github.com/peterbourgon/prometheus-aggregator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prometheus_aggregator'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/prometheus_aggregator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "logger"
+require "prometheus_aggregator/version"
+
+module PrometheusAggregator
+  class << self
+    attr_accessor :logger
+  end
+
+  @logger = Logger.new(STDOUT)
+end

data/lib/prometheus_aggregator/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "prometheus_aggregator/exporter"
+
+module PrometheusAggregator
+  class Client
+    DEFAULT_BUCKETS = [0.01, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10].freeze
+
+    def initialize(host, port, opts = {})
+      @default_labels = opts.delete(:default_labels) || {}
+      @exporter = Exporter.new(host, port, opts)
+    end
+
+    def counter(name:, value:, help:, labels: {})
+      @exporter.enqueue(
+        type: "counter",
+        name: name,
+        value: value,
+        help: help,
+        labels: @default_labels.dup.merge(labels)
+      )
+    end
+
+    def histogram(name:, value:, help:, buckets: DEFAULT_BUCKETS, labels: {})
+      @exporter.enqueue(
+        type: "histogram",
+        name: name,
+        value: value,
+        help: help,
+        buckets: buckets,
+        labels: @default_labels.dup.merge(labels)
+      )
+    end
+
+    def stop
+      @exporter.stop
+    end
+  end
+end

data/lib/prometheus_aggregator/exporter.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "json"
+require "socket"
+require "net_tcp_client"
+require "prometheus_aggregator"
+
+module PrometheusAggregator
+  class Exporter
+    CONNECTION_RETRY_INTERVAL = 1.0
+    QUEUE_CAPACITY = 100
+    LOOP_INTERVAL = 0.01
+    STALENESS_THRESHOLD = 5.0
+
+    def initialize(host, port, opts = {})
+      @host = host
+      @port = port
+      @ssl_params = opts[:ssl_params]
+      @staleness_threshold = opts[:staleness_threshold] || STALENESS_THRESHOLD
+      @connection_retry_interval =
+        opts[:connection_retry_interval] || CONNECTION_RETRY_INTERVAL
+      @registered = {}
+
+      @stop = false
+      @pid = nil
+      @mutex = Mutex.new
+      @queue = []
+    end
+
+    def enqueue(record)
+      @mutex.synchronize do
+        if Process.pid != @pid
+          PrometheusAggregator.logger.info("Pid mismatch, spawning new thread")
+          @thread&.kill
+          @thread = nil
+        end
+
+        if @thread.nil?
+          @thread = Thread.new { write_loop }
+          @pid = Process.pid
+        end
+
+        @queue << [Time.now, record]
+        @queue.shift while @queue.length > QUEUE_CAPACITY
+      end
+    end
+
+    def backlog
+      @queue.length
+    end
+
+    def stop
+      @stop = true
+    end
+
+    private
+
+    def write_loop
+      loop do
+        break if @stop
+
+        connect unless connection_ok?
+        unless connection_ok?
+          PrometheusAggregator.logger.warn(
+            "Not connected to prometheus agggregator (#{@host}:#{@port})"
+          )
+
+          sleep(@connection_retry_interval)
+          next
+        end
+
+        event = @mutex.synchronize do
+          @queue.shift while !@queue.empty? && stale?(@queue.first)
+          @queue.shift
+        end
+
+        if event.nil?
+          sleep(LOOP_INTERVAL)
+          next
+        end
+
+        record = event[1]
+        register(record)
+        emit_value(record)
+      end
+    end
+
+    def stale?(record)
+      record[0] < Time.now - @staleness_threshold
+    end
+
+    def connection_ok?
+      !@socket.nil? && @socket.alive?
+    end
+
+    def connect
+      @registered = {}
+
+      @socket&.close
+
+      @socket = Net::TCPClient.new(
+        server: "#{@host}:#{@port}",
+        ssl: @ssl_params,
+        connect_timeout: 3.0,
+        write_timeout: 3.0,
+        read_timeout: 3.0,
+        connect_retry_count: 0
+      )
+    rescue Net::TCPClient::ConnectionFailure => err
+      PrometheusAggregator.logger.debug(err)
+      @socket&.close
+      @socket = nil
+    end
+
+    def register(record)
+      declaration = record.reject { |k| k == :value }
+      json_declaration = JSON.fast_generate(declaration)
+      return if @registered[json_declaration]
+
+      send_line(json_declaration)
+      @registered[json_declaration] = true
+    end
+
+    def emit_value(record)
+      send_line(JSON.fast_generate(record.slice(:name, :value, :labels)))
+    end
+
+    def send_line(line)
+      @socket.write(line + "\n")
+    rescue Net::TCPClient::ConnectionFailure => err
+      PrometheusAggregator.logger.debug(err)
+      @socket&.close
+      @socket = nil
+    end
+  end
+end

data/lib/prometheus_aggregator/rack_middleware.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "prometheus_aggregator"
+
+module PrometheusAggregator
+  class RackMiddleware
+    def initialize(app, options = {})
+      @app = app
+      @client = options[:client]
+      raise ArgumentError, ":client option is required" unless @client
+    end
+
+    def call(env)
+      start_time = Time.now
+      response = @app.call(env)
+      duration = Time.now - start_time
+
+      begin
+        @client.counter(
+          name: "http_server_requests_total",
+          help: "The total number of HTTP requests handled by the Rack app",
+          value: 1,
+          labels: labels(env).merge(code: response.first.to_s)
+        )
+
+        @client.histogram(
+          name: "http_server_request_duration_seconds",
+          help: "The HTTP response duration of the Rack application",
+          value: duration,
+          labels: labels(env)
+        )
+      rescue => err # rubocop:disable Style/RescueStandardError
+        # Let's be ultra defensive. Metrics should never break the app.
+        PrometheusAggregator.logger.error("RackMiddleware: #{err}")
+      end
+
+      response
+    end
+
+    def labels(env)
+      {
+        method: env["REQUEST_METHOD"].downcase,
+        path: clean_path(env["PATH_INFO"])
+      }
+    end
+
+    def clean_path(path)
+      path.gsub(%r{/\d+/}, "/:id/").gsub(%r{/\d+$}, "/:id")
+    end
+  end
+end

data/lib/prometheus_aggregator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PrometheusAggregator
+  VERSION = "0.1.0"
+end

data/prometheus_aggregator.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "prometheus_aggregator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "prometheus_aggregator"
+  spec.version       = PrometheusAggregator::VERSION
+  spec.authors       = ["Harry Marr"]
+  spec.email         = ["support@dependabot.com"]
+
+  spec.summary       = "Client for https://github.com/peterbourgon/prometheus-aggregator"
+  spec.homepage      = "https://github.com/dependabot/prometheus-aggregator-ruby"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "net_tcp_client", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "excon", "~> 0.62"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rack", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: prometheus_aggregator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Marr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net_tcp_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: 
+email:
+- support@dependabot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prometheus_aggregator.rb
+- lib/prometheus_aggregator/client.rb
+- lib/prometheus_aggregator/exporter.rb
+- lib/prometheus_aggregator/rack_middleware.rb
+- lib/prometheus_aggregator/version.rb
+- prometheus_aggregator.gemspec
+homepage: https://github.com/dependabot/prometheus-aggregator-ruby
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Client for https://github.com/peterbourgon/prometheus-aggregator
+test_files: []