yabeda-rails 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dbf65d3d54b48f0ed4140e72734407e1cd67babb934c797e3f2dd65e7e6c177
-  data.tar.gz: 6c186927d6d13ee387751cddd625c29d03ec974c2d80cf72d16ea3c0a971cd6f
+  metadata.gz: 107b2a512068172c19c08b18dc0f452d9ee1794c4894979b1a88c459a8dcf5c5
+  data.tar.gz: 686e32000199bc29bb8096d09aa336b4cf67d9cfe789e44b91653467caee5524
 SHA512:
-  metadata.gz: 4795bd4a4c82f002f2ef6d6b3620ce8ae4e5bb92a7d81da3117153bf7f2f2e6fbbeb28bab45572d5efaeea11aa4690eef6ecc594980d3f2dbf282588dceb1b37
-  data.tar.gz: 4b20c62e48cf0ba9be1726efe214f990ff3f2d319ed2bb75d24fafe95d03d9672c60d89cff30df7774b8cec191459f8186738cc8755d456cae4d3b2bbf8d5ca7
+  metadata.gz: f59dd373f43b40e47b03cecef02ad47ce8fdcf49661430fddf003007f60d69895a26e538d23bd829e664aaa27145789f2a934ed401d6c593ca314ff3271d65d2
+  data.tar.gz: 6de6d25b29ef13f07f9a1e008999577c18891ceaede127a99ac541235442ed72f3b74316e6f7b16950169fd5309e6d1fcc86cf2b4999106ff08a46349db27e0b

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/lint.yml

@@ -0,0 +1,25 @@
+name: Lint
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  rubocop:
+    # Skip running tests for local pull requests (use push event instead), run only for foreign ones
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+          bundler-cache: true
+      - name: Lint Ruby code with RuboCop
+        run: |
+          bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  test:
+    name: 'Rails ${{ matrix.rails }} × Ruby ${{ matrix.ruby }}'
+    # Skip running tests for local pull requests (use push event instead), run only for foreign ones
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby:  "3.1"
+            rails: "HEAD"
+          - ruby:  "3.0"
+            rails: "7.0"
+          - ruby:  "2.7"
+            rails: "6.1"
+          - ruby:  "2.6"
+            rails: "6.0"
+          - ruby:  "2.5"
+            rails: "5.2"
+    container:
+      image: ruby:${{ matrix.ruby }}
+      env:
+        CI: true
+        RAILS_VERSION: ${{ matrix.rails }}
+    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 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
 
@@ -44,3 +41,5 @@ Style/TrailingCommaInHashLiteral:
   Enabled: true
   EnforcedStyleForMultiline: consistent_comma
 
+Bundler/DuplicatedGem:
+  Enabled: false

data/CHANGELOG.md

@@ -5,6 +5,28 @@ 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.8.0 - 2022-05-30
+
+### Added
+
+- Add ability to expose custom Apdex target value for later use in graphs/alerts. [@Envek][] in [#18](https://github.com/yabeda-rb/yabeda-rails/pull/18)
+
+### Changed
+
+- Reduce number of dependencies by depending only on railties instead of the whole Ruby on Rails. [@lautis][] in [#23](https://github.com/yabeda-rb/yabeda-rails/pull/23).
+
+## 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
@@ -52,3 +74,7 @@ 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.
+
+[@Envek]: https://github.com/Envek "Andrey Novikov"
+[@liaden]: https://github.com/liaden "Joel Johnson"
+[@lautis]: https://github.com/lautis "Ville Lautanala"

data/Gemfile

@@ -7,10 +7,27 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in yabeda-rails.gemspec
 gemspec
 
+rails_version = ENV.fetch("RAILS_VERSION", "~> 7.0")
+case rails_version
+when "HEAD"
+  git "https://github.com/rails/rails.git" do
+    gem "rails"
+    gem "activesupport"
+    gem "railties"
+  end
+else
+  rails_version = "~> #{rails_version}.0" if rails_version.match?(/^\d+\.\d+$/)
+  gem "rails", rails_version
+  gem "activesupport", rails_version
+  gem "railties", rails_version
+end
+
 group :development, :test do
-  gem "pry"
-  gem "pry-byebug", platform: :mri
+  gem "yabeda", "~> 0.11" # Test helpers
+  gem "rspec-rails"
+
+  gem "debug"
 
-  gem "rubocop"
+  gem "rubocop", "~> 1.8"
   gem "rubocop-rspec"
 end

data/README.md

@@ -1,4 +1,4 @@
-# Yabeda::[Rails]
+# ![Yabeda::Rails](./yabeda-rails-logo.png)
 
 Built-in metrics for out-of-the box [Rails] applications monitoring.
 
@@ -83,6 +83,38 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "anyway"
+
+module Yabeda
+  module Rails
+    class Config < ::Anyway::Config
+      config_name :yabeda_rails
+
+      attr_config :apdex_target
+    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,7 +12,7 @@ module Yabeda
       end
 
       def puma_server?
-        ::Rails.const_defined?('Puma::CLI')
+        ::Rails.const_defined?("Puma::CLI")
       end
 
       def unicorn_server?

data/lib/yabeda/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Rails
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/yabeda/rails.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require "yabeda"
+require "active_support"
+require "rails/railtie"
 require "yabeda/rails/railtie"
+require "yabeda/rails/config"
 
 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,8 +23,12 @@ 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
+          config = Config.new
+
           group :rails
 
           counter   :requests_total,   comment: "A counter of the total number of HTTP requests rails processed.",
@@ -39,6 +47,12 @@ module Yabeda
                                  comment: "A histogram of the activerecord execution time.",
                                  tags: %i[controller action status format method]
 
+          if config.apdex_target
+            gauge :apdex_target, unit: :seconds,
+                                 comment: "Tolerable time for Apdex (T value: maximum duration of satisfactory request)"
+            collect { rails_apdex_target.set({}, config.apdex_target) }
+          end
+
           ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
             event = ActiveSupport::Notifications::Event.new(*args)
             labels = {
@@ -47,7 +61,8 @@ module Yabeda
               status: event.payload[:status],
               format: event.payload[:format],
               method: event.payload[:method].downcase,
-            }.merge!(event.payload.slice(*Yabeda.default_tags.keys))
+            }
+            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 +75,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/yabeda-rails.gemspec

@@ -22,8 +22,12 @@ 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.4"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "anyway_config", ">= 1.3", "< 3"
+  spec.add_dependency "railties"
   spec.add_dependency "yabeda", "~> 0.8"
-  spec.add_dependency "rails"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,31 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yabeda
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,10 +121,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -99,8 +135,10 @@ files:
 - bin/console
 - bin/setup
 - lib/yabeda/rails.rb
+- lib/yabeda/rails/config.rb
 - lib/yabeda/rails/railtie.rb
 - lib/yabeda/rails/version.rb
+- yabeda-rails-logo.png
 - yabeda-rails.gemspec
 homepage: https://github.com/yabeda-rb/yabeda-rails
 licenses:
@@ -114,14 +152,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.1.2
+rubygems_version: 3.1.6
 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.7.1
-before_install: gem install bundler -v 2.0