promenade 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7705979e8349af87c849139112e61e3a50cb09264e672363d6fdb5d1282da328
-  data.tar.gz: 2d849d1877183ab91baa10195d2035abffc3619692ca62b7285af5d03cab9ca1
+  metadata.gz: 8b4b2246b9bdf2b31727cfb898cf680facfe1bfcd9a6c3393eb7237c4c2ef870
+  data.tar.gz: 64f386aa492f3f953cb80d8de3067e4d2565de9e0d3d9379888596f2d88cd283
 SHA512:
-  metadata.gz: 72e7318b7db15017fd6882889abff0e194ba32a996dda10da4939f3c9de377c9f2c37903926fcb72066a1f311da662d5bd40f64aff0985415839abc114b876b0
-  data.tar.gz: 7f71477ab1237c414dd79f02dee1c6995ffd3afbdbfb25f3d9ec0877b7eec727108aa0425e1297759809f0e3a6a9817567460cdd6fe540977e90e5e5c7803657
+  metadata.gz: 7a7e963d14200c730bfbc8d609ff8571dffae97f136ec5ecf3e567877795d1d8e300c8c9256b905263eb73f422e35b46cf6cae211cbab9edf89675ade9ab1f57
+  data.tar.gz: d2387375708b46e7f9823ba481419cf1f46b0656ce4f3e42485b420635383aaec7953185bdf714f7a4c7ecb4b38edd0a22bd1ca232705876d087a8df05668971

data/.github/workflows/ci.yaml

@@ -0,0 +1,20 @@
+name: CI
+on:
+  push:
+    branches:
+      -master
+  pull_request:
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.6', '2.7', '3.0']
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -8,6 +8,7 @@
 /tmp/
 .rubocop-https*yml
 .sass-cache/
+vendor
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -2,9 +2,17 @@ inherit_from:
   - https://raw.githubusercontent.com/cookpad/guides/master/.rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - vendor/**/.*
 
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
+Rails/RakeEnvironment:
+  Enabled: false
+Rails/EnvironmentVariableAccess:
+  Enabled: false

data/Gemfile

@@ -4,3 +4,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "codecov"
+gem "webrick"

data/Gemfile.lock

@@ -1,108 +1,114 @@
 PATH
   remote: .
   specs:
-    promenade (0.2.1)
+    promenade (0.2.2)
       activesupport
-      prometheus-client-mmap (~> 0.9.3)
+      prometheus-client-mmap (~> 0.12.0)
       rack
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    backports (3.15.0)
-    binding_of_caller (0.8.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    backports (3.21.0)
+    binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
-    climate_control (0.2.0)
-    codecov (0.1.14)
-      json
-      simplecov
-      url
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    debug_inspector (0.0.3)
-    deep-cover (0.7.5)
-      deep-cover-core (= 0.7.5)
+    climate_control (1.0.0)
+    codecov (0.5.2)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    debug_inspector (1.1.0)
+    deep-cover (1.1.0)
+      deep-cover-core (= 1.1.0)
       highline
       thor (>= 0.20.3)
       with_progress
-    deep-cover-core (0.7.5)
+    deep-cover-core (1.1.0)
       backports (>= 3.11.0)
       binding_of_caller
-      parser (>= 2.5, < 2.7)
+      parser (>= 2.5)
       pry
       term-ansicolor
       terminal-table
-    diff-lcs (1.3)
-    docile (1.3.2)
-    highline (2.0.2)
-    i18n (1.6.0)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    highline (2.0.3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
-    method_source (0.9.2)
-    minitest (5.12.0)
-    parallel (1.17.0)
-    parser (2.6.4.1)
-      ast (~> 2.4.0)
-    prometheus-client-mmap (0.9.10)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.7)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    prometheus-client-mmap (0.12.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.15.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.1)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.3.2)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.10.1)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tins (1.21.1)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    url (0.3.2)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    webrick (1.7.0)
     with_progress (1.0.1)
       ruby-progressbar (~> 1.4)
-    zeitwerk (2.1.10)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -113,12 +119,13 @@ DEPENDENCIES
   codecov
   deep-cover
   promenade!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop
   rubocop-performance
   rubocop-rails
   simplecov
+  webrick
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,8 +1,7 @@
 # Promenade
 
-[![Build Status](https://travis-ci.org/errm/promenade.svg?branch=master)](https://travis-ci.org/errm/promenade)
+[![CI](https://github.com/errm/promenade/actions/workflows/ci.yaml/badge.svg)](https://github.com/errm/promenade/actions/workflows/ci.yaml)
 [![Gem Version](https://badge.fury.io/rb/promenade.svg)](https://badge.fury.io/rb/promenade)
-[![codecov](https://codecov.io/gh/errm/promenade/branch/master/graph/badge.svg)](https://codecov.io/gh/errm/promenade)
 
 Promenade is a library to simplify instrumenting Ruby applications with Prometheus.
 

data/Rakefile

@@ -5,12 +5,16 @@ require "rubocop/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i(spec rubocop)
+task default: %i(spec rubocop integration)
 
 task :clean do
   sh "rm -rf tmp/promenade"
 end
 
+task integration: :clean do
+  sh "bin/integration_test"
+end
+
 task spec: :clean
 
-task release: :spec
+task release: :default

data/bin/integration_test

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "promenade"
+require "fileutils"
+require "net/http"
+
+def test_http_body(expected)
+  uri = URI("http://localhost:9394/metrics")
+
+  Net::HTTP.start(uri.host, uri.port) do |http|
+    request = Net::HTTP::Get.new uri
+    response = http.request request
+    fail "#{response.body} didn't include #{expected}" unless response.body.split("\n").any?(expected)
+  end
+end
+
+Promenade.setup
+
+pid = Process.spawn "exe/promenade"
+sleep 1
+
+at_exit do
+  Process.kill "SIGTERM", pid
+  Process.waitpid(pid)
+end
+
+Promenade.counter :widgets_created do
+  doc "Records how many widgets are created"
+end
+
+Promenade.metric(:widgets_created).increment({ type: "guinness" })
+test_http_body('widgets_created{type="guinness"} 1')
+
+Promenade.metric(:widgets_created).increment({ type: "john-smiths" })
+test_http_body('widgets_created{type="guinness"} 1')
+test_http_body('widgets_created{type="john-smiths"} 1')
+
+Promenade.histogram :calculator_time_taken do
+  doc "Records how long it takes to do the adding"
+  buckets [0.25, 0.5, 1, 2, 4]
+end
+
+Promenade.metric(:calculator_time_taken).observe({ operation: "addition" }, 0.5)
+Promenade.metric(:calculator_time_taken).observe({ operation: "addition" }, 0.5)
+Promenade.metric(:calculator_time_taken).observe({ operation: "addition" }, 1)
+
+test_http_body('calculator_time_taken_bucket{operation="addition",le="0.25"} 0')
+test_http_body('calculator_time_taken_bucket{operation="addition",le="0.5"} 2')
+test_http_body('calculator_time_taken_bucket{operation="addition",le="1"} 3')
+test_http_body('calculator_time_taken_bucket{operation="addition",le="1"} 3')
+
+exit

data/lib/promenade/kafka/consumer_subscriber.rb

@@ -90,7 +90,7 @@ module Promenade
         Promenade.metric(:kafka_consumer_time_lag).set(labels, time_lag) if time_lag
       end
 
-      def process_batch(event) # rubocop:disable Metrics/AbcSize
+      def process_batch(event)
         labels = get_labels(event)
         offset_lag = event.payload.fetch(:offset_lag)
         messages = event.payload.fetch(:message_count)

data/lib/promenade/version.rb

@@ -1,3 +1,3 @@
 module Promenade
-  VERSION = "0.2.1".freeze
+  VERSION = "0.2.2".freeze
 end

data/promenade.gemspec

@@ -2,7 +2,7 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "promenade/version"
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = "promenade"
   spec.version       = Promenade::VERSION
   spec.authors       = ["Ed Robinson"]
@@ -22,14 +22,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.5", "< 4"
+
   spec.add_dependency "activesupport"
-  spec.add_dependency "prometheus-client-mmap", "~> 0.9.3"
+  spec.add_dependency "prometheus-client-mmap", "~> 0.12.0"
   spec.add_dependency "rack"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "climate_control"
   spec.add_development_dependency "deep-cover"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-performance"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promenade
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ed Robinson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-24 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - edward-robinson@cookpad.com
 executables:
@@ -186,10 +186,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -198,6 +198,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/integration_test
 - bin/setup
 - exe/promenade
 - lib/promenade.rb
@@ -217,7 +218,7 @@ homepage: https://github.com/errm/promenade
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,15 +226,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Promenade makes it simple to instrument Ruby apps for prometheus scraping
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.5
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2