prometheus_reporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df4a4042a47ad2b5b0308c03754b85e747a40c21
+  data.tar.gz: '088e89c9d7735eebfa3ffd6a0b41017fcc292937'
+SHA512:
+  metadata.gz: 4e4a88947ef124cfacd3639dd72747075a612eeb68d33e03d34d754ab4bc44ffa2663ed3a057e775bf10a2cf6ba63b98fa37d553f50467284d4d073532478390
+  data.tar.gz: 1de01a6cb0e01149796bb821ab149cf58b7861b7420abd023ac4959520b494cb2ffbc7a7e2c0a530899b24825da8b6c2a212f2d02978a079feb634daba217a07

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+coverage/

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--order rand
+--format doc
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - 'describe'
+    - 'context'
+    - 'let'

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+dist: trusty
+
+rvm:
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 (2018-01-11)
+
+The very first version released.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Oleksii Kuznietsov (@nattfodd)
+
+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,85 @@
+[![Gem Version](https://badge.fury.io/rb/prometheus_reporter.svg)](https://badge.fury.io/rb/prometheus_reporter)
+[![Build Status](https://travis-ci.org/nattfodd/prometheus_reporter.svg?branch=master)](https://travis-ci.org/nattfodd/prometheus_reporter)
+[![Dependency Status](https://gemnasium.com/nattfodd/prometheus_reporter.svg)](https://gemnasium.com/nattfodd/prometheus_reporter)
+[![Maintainability Status](https://img.shields.io/codeclimate/maintainability/nattfodd/prometheus_reporter.svg)](https://codeclimate.com/github/nattfodd/prometheus_reporter)
+
+## Prometheus Reporter
+`prometheus_reporter` helps you to generate [Prometheus](https://prometheus.io) metric reports using its [text format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-format-details). Official client helps you to monitor internal web-server guts, while `prometheus_reporter` can help you representing any data you want.
+
+### Overview
+```ruby
+require 'prometheus_reporter'
+
+f = PrometheusReporter::TextFormatter.new
+f.entry(:my_metric, value: 144, labels: { source: 'api', module: 'chat' })
+f.to_s
+# => 'my_metric{souce="api",module="chat"} 144'
+```
+
+## Installation
+Installation is pretty standard:
+```bash
+$ gem install prometheus_reporter
+```
+or using `Gemfile`:
+```ruby
+gem 'prometheus_reporter', '~> 1.0'
+```
+## Configuration
+
+You may want to have metric keys application prefix to distinguish those metrics
+from metric keys reported by other applications.
+
+By default, `prefix` isn't used.
+
+```ruby
+PrometheusReporter.configure do |config|
+  config.prefix = 'my_web_app'
+end
+
+f = PrometheusReporter::TextFormatter.new
+f.entry(:emails_count, value: 567)
+f.to_s # => "my_web_app_emails_count 567\n"
+```
+
+You can overwrite it passing another prefix to a new `TextFormatter` instance:
+
+```ruby
+f = PrometheusReporter::TextFormatter.new(prefix: 'facebook_clone')
+f.entry(:emails_count, value: 987)
+f.to_s # => "facebook_clone_emails_count 987\n"
+```
+
+## Usage
+
+### Creating text report for Prometheus:
+
+```ruby
+require 'prometheus_reporter'
+
+f = PrometheusReporter::TextFormatter.new
+f.help(:emails_today, 'Events created from the beginning of the day')
+f.type(:emails_today, :counter)
+f.entry(:emails_today,
+        value: 10,
+        labels: { type: 'notify_for_inactivity' },
+        timestamp: Time.now.to_i)
+f.entry(:emails_today,
+        value: 18,
+        labels: { type: 'registration_confirmation' },
+        timestamp: Time.now.to_i)
+f.to_s
+```
+
+Produces the following output:
+
+```
+# HELP facebook_clone_emails_today Amount of emails sent from the beginning of the day
+# TYPE facebook_clone_emails_today counter
+facebook_clone_emails_today{type="notify_for_inactivity"} 10 1515681885
+facebook_clone_emails_today{type="registration_confirmation"} 18 1515681886
+```
+
+## Usefull links
+- Official Prometheus [ruby client](https://github.com/prometheus/client_ruby)
+- [Prometheus](https://github.com/prometheus) itself

data/lib/prometheus_reporter/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PrometheusReporter
+  module Configuration
+    CONFIG_KEYS = %i[prefix].freeze
+
+    def config
+      @config ||= OpenStruct.new
+    end
+
+    def configure
+      yield(config)
+      config.to_h.each_key do |key|
+        raise(UnknownConfig, key) unless CONFIG_KEYS.include?(key)
+      end
+    end
+  end
+end

data/lib/prometheus_reporter/errors.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module PrometheusReporter
+  class BaseError < StandardError; end
+
+  class UnknownConfig < BaseError
+    def initialize(key)
+      @key = key
+    end
+
+    def message
+      "Unknown configuration option: #{@key}"
+    end
+  end
+
+  class MissingMetricValue < BaseError
+    def intialize(key)
+      @key = key
+    end
+
+    def message
+      "Missing value for #{@key} metric"
+    end
+  end
+
+  class UnknownMetricType < BaseError
+    def initialize(key_type)
+      @type = key_type
+    end
+
+    def message
+      "Unknown key type: #{@type}. "\
+        "Valid ones: #{TextFormatter::TYPES.join(', ')}"
+    end
+  end
+
+  class TypeAlreadySpecified < BaseError
+    def initialize(key)
+      @key = key
+    end
+
+    def message
+      "Can't overwrite type for the #{@key} metric (type is already specified)"
+    end
+  end
+
+  class HelpAlreadySpecified < BaseError
+    def initialize(key)
+      @key = key
+    end
+
+    def message
+      "Can't overwrite help for the #{@key} metric (help is already specified)"
+    end
+  end
+end

data/lib/prometheus_reporter/text_formatter.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module PrometheusReporter
+  class TextFormatter
+    TYPES      = %i[counter gauge histogram summary untyped].freeze
+    LABELESS   = :labeless
+    HELP_TOKEN = :help
+    TYPE_TOKEN = :type
+    DEFAULTS   = { HELP_TOKEN => nil, TYPE_TOKEN => nil }.freeze
+    TOKENS     = [HELP_TOKEN, TYPE_TOKEN].freeze
+    SEPARATOR  = "\n"
+
+    def initialize(prefix: PrometheusReporter.config.prefix)
+      @data = {}
+      @prefix = prefix
+    end
+
+    def help(key, description)
+      set_token_value!(HELP_TOKEN, key, description)
+    end
+
+    def type(key, type)
+      type = type.downcase.to_sym
+      raise(UnknownMetricType, type) unless TYPES.include?(type)
+
+      set_token_value!(TYPE_TOKEN, key, type)
+    end
+
+    def entry(key, value:, labels: {}, timestamp: nil)
+      @data[prefixed(key)] ||= DEFAULTS.dup
+
+      label_key = labels.any? ? labels : LABELESS
+      entry_data =
+        {
+          value:     value,
+          timestamp: timestamp
+        }.compact
+
+      @data[prefixed(key)][label_key] = entry_data
+    end
+
+    def to_s
+      metrics_data = []
+
+      @data.each do |prometheus_key_name, prometheus_key_values|
+        prometheus_key_values = prometheus_key_values.compact
+        validate_data!(prometheus_key_name, prometheus_key_values)
+        metrics_data << metric_entry(prometheus_key_name, prometheus_key_values)
+      end
+
+      metrics_data.join(SEPARATOR)
+    end
+
+    private
+
+    def set_token_value!(token, key, value)
+      prefixed_key = prefixed(key)
+      @data[prefixed_key] ||= DEFAULTS.dup
+
+      if @data[prefixed_key][token]
+        err_class = "PrometheusReporter::#{token.capitalize}AlreadySpecified"
+        raise(Object.const_get(err_class), key)
+      end
+
+      @data[prefixed_key][token] = value
+    end
+
+    def prefixed(key)
+      @prefix ? "#{@prefix}_#{key}" : key
+    end
+
+    def validate_data!(key_name, key_data)
+      return if TOKENS.include?(key_name)
+      return if key_data.any? { |k, _| k.is_a?(Hash) || k == LABELESS }
+
+      raise(MissingMetricValue, key_name)
+    end
+
+    def metric_entry(prometheus_key_name, prometheus_key_values)
+      metric_lines = []
+      prometheus_key_values.each do |label_or_token, value|
+        metric_lines << text_entry(prometheus_key_name, label_or_token, value)
+      end
+      (metric_lines << nil).join(SEPARATOR)
+    end
+
+    def text_entry(prometheus_key_name, label_or_token, value)
+      case label_or_token
+      when HELP_TOKEN
+        "# HELP #{prometheus_key_name} #{value}"
+      when TYPE_TOKEN
+        "# TYPE #{prometheus_key_name} #{value}"
+      else
+        entry_to_string(prometheus_key_name, label_or_token, value)
+      end
+    end
+
+    def entry_to_string(prometheus_key_name, label_or_token, value_hash)
+      entry = "#{prometheus_key_name}#{labels_to_str(label_or_token)} "\
+              "#{value_hash[:value]}"
+      entry += " #{value_hash[:timestamp]}" if value_hash[:timestamp]
+      entry
+    end
+
+    def labels_to_str(label_or_token)
+      return if label_or_token == LABELESS || label_or_token.empty?
+
+      labels_str =
+        label_or_token.map do |l_name, l_value|
+          "#{l_name}=\"#{l_value}\""
+        end.join(',')
+
+      "{#{labels_str}}"
+    end
+  end
+end

data/lib/prometheus_reporter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PrometheusReporter
+  VERSION = '1.0.0'
+end

data/lib/prometheus_reporter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+require_relative 'prometheus_reporter/errors'
+require_relative 'prometheus_reporter/configuration'
+
+module PrometheusReporter
+  extend Configuration
+end
+
+require_relative 'prometheus_reporter/version'
+require_relative 'prometheus_reporter/text_formatter'

data/prometheus_reporter.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/prometheus_reporter/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'prometheus_reporter'
+  s.version  = PrometheusReporter::VERSION
+  s.summary  = 'Generates & parses prometheus text reporting format'
+  s.authors  = ['Oleksii Kuznietsov (nattfodd)']
+  s.email    = ['nattfodd.pp.ua@gmail.com']
+  s.homepage = 'https://github.com/nattfodd/prometheus_reporter'
+  s.licenses = ['MIT']
+  s.files    = `git ls-files -z`.split("\x0")
+                                .reject do |f|
+                                  f.match(%r{^(test|spec|features)/})
+                                end
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.required_ruby_version = '~> 2.4'
+
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'pry', '~> 0.11'
+  s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'rubocop', '~> 0.52'
+  s.add_development_dependency 'simplecov', '~> 0.15'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: prometheus_reporter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Oleksii Kuznietsov (nattfodd)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 
+email:
+- nattfodd.pp.ua@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENCE
+- README.md
+- lib/prometheus_reporter.rb
+- lib/prometheus_reporter/configuration.rb
+- lib/prometheus_reporter/errors.rb
+- lib/prometheus_reporter/text_formatter.rb
+- lib/prometheus_reporter/version.rb
+- prometheus_reporter.gemspec
+homepage: https://github.com/nattfodd/prometheus_reporter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+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: Generates & parses prometheus text reporting format
+test_files: []