yabeda-rails 0.4.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac9beead9964f1586249a58f318146802587bfc75879535602276f8ad251266a
-  data.tar.gz: 880a1219134f862512056785c5b6ed0bc03f50b8a688ca6489f1097a8986b42d
+  metadata.gz: e5a74f3febe6bcdda7d43527a9b9acb71434e58f2abc5518b2a68c609541bf89
+  data.tar.gz: f223f9a5df2d1a224e77cec0a9e09357eaeccf0532f5a6c4b8859c82ed4ab909
 SHA512:
-  metadata.gz: 8e3866ea3c189ccd8c8387b004c93191146a404334a3b39dac8ae4a09e888acf240e8e938003689ab712c4a29c3d589d6f6d957fef0c2c93004cfd76a7c71150
-  data.tar.gz: 9c1483ceb2c14d6f645678a2e73b0ae43a3a4d0eecf4c7c758586e0ca14999c5f4045fec1fb3bc6fe29c069846a9b96e5ccf068f1d511be1b9cecc77187ec23f
+  metadata.gz: 8d2cf3ed506addf2aabcd6bebeaf77fdc80d29ea091a2f8f4d9ef550e3bc74e33a9a4faad6e82ec3ea7f280311a80860f985a6f971fcaa1847b86e7d5907bc95
+  data.tar.gz: de1ebbcfbfc3e9423a9033b1080426dd0466e665a9485dd13bc5df4bc60b982c049f156ec8499b38cbca3e26a0ffec2dba571b7f252ee7e7daf299e1ff81070c

data/.github/workflows/build-release.yml

@@ -0,0 +1,82 @@
+name: Build and release gem to RubyGems
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: "Extract data from tag: version, message, body"
+        id: tag
+        run: |
+          git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
+          echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
+          echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
+          BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
+          # Extract changelog entries between this and previous version headers
+          escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
+          changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
+          # Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
+          BODY="${BODY}"$'\n'"${changelog}"
+          BODY="${BODY//'%'/'%25'}"
+          BODY="${BODY//$'\n'/'%0A'}"
+          BODY="${BODY//$'\r'/'%0D'}"
+          echo "::set-output name=body::$BODY"
+          # Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
+          if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
+            echo ::set-output name=prerelease::true
+          fi
+      - name: Build gem
+        run: gem build
+      - name: Calculate checksums
+        run: sha256sum yabeda-rails-${{ steps.tag.outputs.version }}.gem > SHA256SUM
+      - name: Check version
+        run: ls -l yabeda-rails-${{ steps.tag.outputs.version }}.gem
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ steps.tag.outputs.subject }}
+          body: ${{ steps.tag.outputs.body }}
+          draft: false
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: yabeda-rails-${{ steps.tag.outputs.version }}.gem
+          asset_name: yabeda-rails-${{ steps.tag.outputs.version }}.gem
+          asset_content_type: application/x-tar
+      - name: Upload checksums as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: SHA256SUM
+          asset_name: SHA256SUM
+          asset_content_type: text/plain
+      - name: Publish to GitHub packages
+        env:
+          GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gem push yabeda-rails-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
+        run: |
+          gem push yabeda-rails-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: Run tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  test:
+    name: "Run tests"
+    if: "! contains(toJSON(github.event.commits.latest.message), '[ci skip]')"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 3.0
+          - ruby: 2.7
+          - ruby: 2.6
+          - ruby: 2.5
+    container:
+      image: ruby:${{ matrix.ruby }}
+      env:
+        CI: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+            bundle-${{ matrix.ruby }}-
+      - name: Upgrade Bundler to 2.0 (for older Rubies)
+        run: gem install bundler -v '~> 2.0'
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+          bundle update
+      - name: Run Rubocop
+        run: bundle exec rubocop
+      - name: Run RSpec
+        run: bundle exec rspec

data/.rubocop.yml

@@ -3,16 +3,13 @@ require:
 - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Metrics/BlockLength:
   Exclude:
   - "Gemfile"
   - "spec/**/*"
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/CHANGELOG.md

@@ -5,6 +5,36 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 0.7.2 - 2021-03-15
+
+### Fixed
+
+- Fix undesirable overwrite of metric tags when global `default_tag` is declared with one of tag names that are being used by yabeda-rails, like `controller`. [@liaden] in [#19](https://github.com/yabeda-rb/yabeda-rails/pull/19)
+
+## 0.7.1 - 2020-10-02
+
+### Changed
+
+ - Explicitly require previously removed railtie to fix case when it doesn't get required in `yabeda` gem (if `yabeda` is required before `rails`). See [yabeda-rb/yabeda#15](https://github.com/yabeda-rb/yabeda/issues/15). @Envek
+
+## 0.7.0 - 2020-08-21
+
+### Removed
+
+ - Railtie to configure Yabeda – it is moved into Yabeda itself. Increase required Yabeda version to keep behavior for users who require only `yabeda-rails` in their Gemfiles. @Envek
+
+## 0.6.0 - 2020-08-06
+
+### Added
+
+ - Ability to add default/custom tags to metrics from controllers. @raivil in [#13](https://github.com/yabeda-rb/yabeda-rails/pull/13)
+
+## 0.5.0 - 2020-03-27
+
+### Added
+
+ - Support for Unicorn application server. @vast in [#9](https://github.com/yabeda-rb/yabeda-rails/pull/9)
+
 ## 0.4.0 - 2020-01-28
 
 ### Changed
@@ -34,3 +64,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
  - Initial release of evil-metrics-rails gem. @Envek
 
    Basic metrics for request durations by controller, action, status, format, and method. ActiveRecord and ActionView timings.
+
+[@liaden]: https://github.com/liaden "Joel Johnson"

data/Gemfile

@@ -11,6 +11,6 @@ group :development, :test do
   gem "pry"
   gem "pry-byebug", platform: :mri
 
-  gem "rubocop"
+  gem "rubocop", "~> 1.8"
   gem "rubocop-rspec"
 end

data/README.md

@@ -1,8 +1,10 @@
 # Yabeda::[Rails]
 
-Built-in metrics for out-of-the box [Rails] applications monitoring 
+Built-in metrics for out-of-the box [Rails] applications monitoring.
 
-if your monitoring system already collects Rails metrics (e.g. NewRelic) then you don't need this gem.
+If your monitoring system already collects Rails metrics (e.g. NewRelic) then most probably you don't need this gem.
+
+Sample Grafana dashboard ID: [11668](https://grafana.com/grafana/dashboards/11668)
 
 ## Installation
 
@@ -20,7 +22,7 @@ And then execute:
 
 ### Registering metrics on server process start
 
-Currently, yabeda-rails automatically registers rails metrics when a server is started via `rails server` or `puma -C config/puma.rb`. However, other application servers or launching via `rackup` aren't supported at the moment.
+Currently, yabeda-rails automatically registers rails metrics when a server is started via `rails server`, `puma -C config/puma.rb` or `unicorn -c`. However, other application servers or launching via `rackup` aren't supported at the moment.
 
 A possible workaround is to detect server process and manually activate yabeda-rails in an initializer:
 
@@ -32,7 +34,7 @@ if your_app_server_process? # Your logic here
 end
 ```
 
-You always can add support for your app server to [lib/yabeda/rails/railtie.rb](). Pull Requests are always welcome!
+You always can add support for your app server to [lib/yabeda/rails/railtie.rb](lib/yabeda/rails/railtie.rb). Pull Requests are always welcome!
 
 
 ## Metrics
@@ -55,12 +57,64 @@ You always can add support for your app server to [lib/yabeda/rails/railtie.rb](
     end
     ```
 
+## Custom tags
+
+You can add additional tags to the existing metrics by adding custom payload to your controller.
+
+```ruby
+# This block is optional but some adapters (like Prometheus) requires that all tags should be declared in advance
+Yabeda.configure do
+  default_tag :importance, nil
+end
+
+class ApplicationController < ActionController::Base
+  def append_info_to_payload(payload)
+    super
+    payload[:importance] = extract_importance(params)
+  end
+end
+```
+`append_info_to_payload` is a method from [ActionController::Instrumentation](https://api.rubyonrails.org/classes/ActionController/Instrumentation.html#method-i-append_info_to_payload)
+
+
 ## 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).
 
+### Releasing
+
+ 1. Bump version number in `lib/yabeda/rails/version.rb`
+
+    In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::Rails::VERSION).to_s`
+
+ 2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+ 3. Make a commit:
+
+    ```sh
+    git add lib/yabeda/rails/version.rb CHANGELOG.md
+    version=$(ruby -r ./lib/yabeda/rails/version.rb -e "puts Gem::Version.new(Yabeda::Rails::VERSION)")
+    git commit --message="${version}: " --edit
+    ```
+
+ 4. Create annotated tag:
+
+    ```sh
+    git tag v${version} --annotate --message="${version}: " --edit --sign
+    ```
+
+ 5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+ 6. Push it:
+
+    ```sh
+    git push --follow-tags
+    ```
+
+ 7. You're done!
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-rails.

data/lib/yabeda/rails.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require "yabeda"
+require "rails"
 require "yabeda/rails/railtie"
 
 module Yabeda
+  # Minimal set of Rails-specific metrics for using with Yabeda
   module Rails
     LONG_RUNNING_REQUEST_BUCKETS = [
       0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard
@@ -19,6 +21,8 @@ module Yabeda
         controller_handlers << block
       end
 
+      # Declare metrics and install event handlers for collecting themya
+      # rubocop: disable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
       def install!
         Yabeda.configure do
           group :rails
@@ -48,6 +52,7 @@ module Yabeda
               format: event.payload[:format],
               method: event.payload[:method].downcase,
             }
+            labels.merge!(event.payload.slice(*Yabeda.default_tags.keys - labels.keys))
 
             rails_requests_total.increment(labels)
             rails_request_duration.measure(labels, Yabeda::Rails.ms2s(event.duration))
@@ -60,9 +65,10 @@ module Yabeda
           end
         end
       end
+      # rubocop: enable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
 
-      def ms2s(ms)
-        (ms.to_f / 1000).round(3)
+      def ms2s(milliseconds)
+        (milliseconds.to_f / 1000).round(3)
       end
     end
   end

data/lib/yabeda/rails/railtie.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Explicitly require yabeda's railtie in case if its require was skipped there.
+# See https://github.com/yabeda-rb/yabeda/issues/15
+require "yabeda/railtie"
+
 module Yabeda
   module Rails
     class Railtie < ::Rails::Railtie # :nodoc:
@@ -8,12 +12,15 @@ module Yabeda
       end
 
       def puma_server?
-        ::Rails.const_defined?('Puma::CLI')
+        ::Rails.const_defined?("Puma::CLI")
+      end
+
+      def unicorn_server?
+        ::Rails.const_defined?("Unicorn::Launcher")
       end
 
-      config.after_initialize do
-        ::Yabeda::Rails.install! if rails_server? || puma_server?
-        Yabeda.configure! unless Yabeda.already_configured?
+      initializer "yabeda-rails.metrics" do
+        ::Yabeda::Rails.install! if rails_server? || puma_server? || unicorn_server?
       end
     end
   end

data/lib/yabeda/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Rails
-    VERSION = "0.4.0"
+    VERSION = "0.7.2"
   end
 end

data/yabeda-rails.gemspec

@@ -22,10 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "yabeda", "~> 0.4"
+  spec.required_ruby_version = ">= 2.4"
+
   spec.add_dependency "rails"
+  spec.add_dependency "yabeda", "~> 0.8"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yabeda
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: yabeda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
@@ -87,10 +87,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -114,14 +115,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Extensible metrics for monitoring Ruby on Rails application

data/.travis.yml

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