yabeda-prometheus 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3853e35a99555c0cba4020b448c677d49209b0dfde07d7852a075ef032c844bb
+  data.tar.gz: 7fd7ba53e5d5c3d5c59ffaa371819867bbe09bd363cfc5adcc747584bc21a721
+SHA512:
+  metadata.gz: e50aeccdde88032fa4347fe79dc94f276b4d1681288d02ed90ac2246dceab796ae24c9a3201b287eba8fed157c7a11d379aac79c30dd268b8df78f57a18a9b44
+  data.tar.gz: b20bc4cd6cee5fc905e2bd8597cb046e778064b4cbc2f0c0802a7a8777a5d003bdbd5cfe2ff7622f6ef6d6d91c2289c5c5ed26cd6ab4e3aef38024bedfcc9763

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+---
+require:
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+  - "Gemfile"
+  - "spec/**/*"
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Allow to use let!
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yabeda.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug", platform: :mri
+
+  gem "rubocop"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Novikov
+
+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,73 @@
+# Yabeda::[Prometheus]
+
+Adapter for easy exporting your collected evil metrics from your application to the [Prometheus]!
+
+## One more? Why not X?
+
+ - https://github.com/discourse/prometheus_exporter – built on assumption that various processes (web, jobs, etc) are able to communicate between them on single machine. But in containerized environments all your processes on different “machines”!
+ - https://github.com/getqujing/prome – actually inspired this all these gems but seems abandoned and lacks extensibility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda'
+# Then add monitoring system adapter, e.g.:
+# gem 'yabeda-prometheus'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+ 1. Exporting from running web servers:
+
+    Place following in your `config.ru` _before_ running your application:
+
+    ```ruby
+    use Yabeda::Prometheus::Exporter
+    ```
+
+    Metrics will be available on `/metrics` path.
+
+ 2. Run web-server from long-running processes (delayed jobs, …):
+
+    ```ruby
+    Yabeda::Prometheus::Exporter.start_metrics_server!
+    ```
+
+    WEBrick will be launched in separate thread and will serve metrics on `/metrics` path.
+
+    See [yabeda-sidekiq] for example.
+
+    Listening address is configured via `PROMETHEUS_EXPORTER_BIND` env variable (default is `0.0.0.0`).
+
+    Port is configured by `PROMETHEUS_EXPORTER_PORT` or `PORT` variables (default is `9310`).
+
+ 3. Use push gateway for short living things (rake tasks, cron jobs, …):
+
+    ```ruby
+    Yabeda::Prometheus.push_gateway.add(Yabeda::Prometheus.registry)
+    ```
+
+    Address of push gateway is configured with `PROMETHEUS_PUSH_GATEWAY` env variable.
+
+## 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/yabeda-rb/yabeda-prometheus.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Prometheus]: https://prometheus.io/ "Open-source monitoring solution"
+[yabeda-sidekiq]: https://github.com/yabeda-rb/yabeda-sidekiq

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yabeda"
+
+# 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.
+
+require "pry"
+Pry.start

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/yabeda/prometheus.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "yabeda/prometheus/version"
+require "yabeda/prometheus/adapter"
+require "yabeda/prometheus/exporter"
+
+module Yabeda
+  module Prometheus
+    class << self
+      def registry
+        ::Prometheus::Client.registry
+      end
+
+      def push_gateway
+        @push_gateway ||= begin
+          ::Prometheus::Client::Push.new(
+            ENV.fetch("PROMETHEUS_JOB_NAME", "yabeda"),
+            nil,
+            ENV.fetch("PROMETHEUS_PUSH_GATEWAY", "http://localhost:9091"),
+          ).tap do |gateway|
+            http = gateway.instance_variable_get(:@http)
+            http.open_timeout = 5
+            http.read_timeout = 5
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/prometheus/adapter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "prometheus/client"
+require "yabeda/base_adapter"
+
+require_relative "./counter_wrapper"
+require_relative "./gauge_wrapper"
+
+module Yabeda
+  class Prometheus::Adapter < BaseAdapter
+    def registry
+      @registry ||= ::Prometheus::Client.registry
+    end
+
+    def register_counter!(metric)
+      validate_metric!(metric)
+      registry.register(Prometheus::CounterWrapper.new(metric))
+    end
+
+    def perform_counter_increment!(*)
+      # Do nothing. Prometheus will read current value from evil metric
+    end
+
+    def register_gauge!(metric)
+      validate_metric!(metric)
+      registry.register(Prometheus::GaugeWrapper.new(metric))
+    end
+
+    def perform_gauge_set!(*)
+      # Do nothing. Prometheus will read current value from evil metric
+    end
+
+    def register_histogram!(metric)
+      validate_metric!(metric)
+      buckets = metric.buckets || ::Prometheus::Client::Histogram::DEFAULT_BUCKETS
+      registry.histogram(build_name(metric), metric.comment, {}, buckets)
+    end
+
+    def perform_histogram_measure!(metric, tags, value)
+      registry.get(build_name(metric)).observe(tags, value)
+    end
+
+    def build_name(metric)
+      [metric.group, metric.name, metric.unit].compact.join("_").to_sym
+    end
+
+    def validate_metric!(metric)
+      return if metric.comment
+
+      raise ArgumentError, "Prometheus require metrics to have comments"
+    end
+
+    Yabeda.register_adapter(:prometheus, new)
+  end
+end

data/lib/yabeda/prometheus/counter_wrapper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "./metric_wrapper"
+
+module Yabeda
+  class Prometheus::CounterWrapper < Prometheus::MetricWrapper
+    def type
+      :counter
+    end
+
+    def increment(labels = {}, by = 1)
+      metric.increment(labels, by: by)
+    end
+  end
+end

data/lib/yabeda/prometheus/exporter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "prometheus/middleware/exporter"
+
+module Yabeda
+  module Prometheus
+    class Exporter < ::Prometheus::Middleware::Exporter
+      class << self
+        def start_metrics_server!
+          Thread.new do
+            default_port = ENV.fetch("PORT", 9310)
+            Rack::Handler::WEBrick.run(
+              rack_app,
+              Host: ENV["PROMETHEUS_EXPORTER_BIND"] || "0.0.0.0",
+              Port: ENV.fetch("PROMETHEUS_EXPORTER_PORT", default_port),
+              AccessLog: [],
+            )
+          end
+        end
+
+        protected
+
+        def rack_app(exporter = self)
+          Rack::Builder.new do
+            use Rack::CommonLogger
+            use Rack::ShowExceptions
+            use exporter, registry: Yabeda::Prometheus.registry
+            run ->(_env) do
+              [404, { "Content-Type" => "text/plain" }, ["Not Found\n"]]
+            end
+          end
+        end
+      end
+
+      def call(env)
+        if env["REQUEST_PATH"].start_with?(path)
+          Yabeda.collectors.each(&:call)
+        end
+        super
+      end
+    end
+  end
+end

data/lib/yabeda/prometheus/gauge_wrapper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "./metric_wrapper"
+
+module Yabeda
+  class Prometheus::GaugeWrapper < Prometheus::MetricWrapper
+    def type
+      :gauge
+    end
+
+    def set(labels, value)
+      unless value.is_a?(Numeric)
+        raise ArgumentError, 'value must be a number'
+      end
+
+      metric.set(labels, value)
+    end
+  end
+end

data/lib/yabeda/prometheus/metric_wrapper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "prometheus/client/metric"
+
+module Yabeda
+  class Prometheus::MetricWrapper < ::Prometheus::Client::Metric
+    attr_reader :metric
+
+    def initialize(metric, base_labels = {})
+      @metric = metric
+
+      @validator = ::Prometheus::Client::LabelSetValidator.new
+      @base_labels = base_labels
+
+      validate_name(self.name)
+      validate_docstring(self.docstring)
+      @validator.valid?(base_labels)
+    end
+
+    def name
+      @name ||=
+        [metric.group, metric.name, metric.unit].compact.join("_").to_sym
+    end
+
+    def docstring
+      metric.comment
+    end
+
+    def get(labels = {})
+      @validator.valid?(labels)
+
+      metric.get(labels)
+    end
+
+    def values
+      metric.values
+    end
+  end
+end

data/lib/yabeda/prometheus/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Prometheus
+    VERSION = "0.1.2"
+  end
+end

data/yabeda-prometheus.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yabeda/prometheus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yabeda-prometheus"
+  spec.version       = Yabeda::Prometheus::VERSION
+  spec.authors       = ["Andrey Novikov"]
+  spec.email         = ["envek@envek.name"]
+
+  spec.summary       = "Extensible Prometheus exporter for your application"
+  spec.homepage      = "https://github.com/yabeda-rb/yabeda-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_dependency "yabeda"
+  spec.add_dependency "prometheus-client"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-prometheus
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: 
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/prometheus.rb
+- lib/yabeda/prometheus/adapter.rb
+- lib/yabeda/prometheus/counter_wrapper.rb
+- lib/yabeda/prometheus/exporter.rb
+- lib/yabeda/prometheus/gauge_wrapper.rb
+- lib/yabeda/prometheus/metric_wrapper.rb
+- lib/yabeda/prometheus/version.rb
+- yabeda-prometheus.gemspec
+homepage: https://github.com/yabeda-rb/yabeda-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.7.6
+signing_key: 
+specification_version: 4
+summary: Extensible Prometheus exporter for your application
+test_files: []