yabeda-rails 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95166b3713d896663737aaf5fb6c485df43557d946c510f957fb3ab42e3e0d38
-  data.tar.gz: 0a8c2b72c450564b8fad46c1ac67c9895f342366d36d967611f576bd63275cea
+  metadata.gz: e922a45967dbc75c255c7bf6453e796e13157be68ba0c0c6813e8eb80633db8f
+  data.tar.gz: f4bf58df8b7a6904f40a4e47c7fdeab0756ffbab4f59910e90dab01f77e47886
 SHA512:
-  metadata.gz: 512a1d39088979606534b7de183e26aeed5aa2b7d4f2394b8b21cfb0b9ceec0735e35d34ef7a3a8a738468f4fc72d28a1825604f143a00b88e2649bcfd5b44dd
-  data.tar.gz: cc4b86dab98e360b4d5b481a593533f60f0d5af3d70a0acda3f45935968097eef02fef32ec6b65e57bc260a0d3d7f34561b2584f3f0a001da238e182b7bfd285
+  metadata.gz: 256b563227886fadd1def58675cd7160e2ffadd8b1b7dd0951bdc203b7a3c0f97e298fde9640c4006187e9a202db8267498a8d2185a3f0b4100f77782555aa94
+  data.tar.gz: 62c3b89bf1fd7f7bb48a5bfeddd63f1d9cf86540db6b49d80075b00b94116471db59d6c7577554e4aff84f8063eacb094839c6789264cb380a6d0f585022cf1f

data/.github/workflows/lint.yml

@@ -15,10 +15,10 @@ jobs:
     name: RuboCop
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.1"
+          ruby-version: "3.4"
           bundler-cache: true
       - name: Lint Ruby code with RuboCop
         run: |

data/.github/workflows/{build-release.yml → release.yml}

@@ -1,4 +1,4 @@
-name: Build and release gem to RubyGems
+name: Build and release gem
 
 on:
   push:
@@ -8,13 +8,17 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      packages: write
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         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
+          ruby-version: "3.4"
       - name: "Extract data from tag: version, message, body"
         id: tag
         run: |
@@ -75,8 +79,8 @@ jobs:
           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: Configure RubyGems Credentials
+        uses: rubygems/configure-rubygems-credentials@main
       - 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

@@ -14,40 +14,34 @@ jobs:
     # 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
+    continue-on-error: ${{ matrix.optional || false }}
     strategy:
       fail-fast: false
       matrix:
         include:
-          - ruby:  "3.1"
+          - ruby: "head"
             rails: "HEAD"
-          - ruby:  "3.0"
+            optional: true
+          - ruby:  "3.4"
+            rails: "8.0"
+          - ruby:  "3.3"
+            rails: "7.2"
+          - ruby:  "3.2"
+            rails: "7.1"
+          - ruby:  "3.1"
             rails: "7.0"
-          - ruby:  "2.7"
+          - ruby:  "3.0"
             rails: "6.1"
-          - ruby:  "2.6"
+          - ruby:  "2.7"
             rails: "6.0"
-          - ruby:  "2.5"
-            rails: "5.2"
-    container:
-      image: ruby:${{ matrix.ruby }}
-      env:
-        CI: true
-        RAILS_VERSION: ${{ matrix.rails }}
+    env:
+      CI: true
+      RAILS_VERSION: ${{ matrix.rails }}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
         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
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Run RSpec
         run: bundle exec rspec

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
 - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -5,6 +5,25 @@ 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.10.0 - 2025-09-09
+
+### Added
+
+- Add Passenger server to auto register list [@mabrikan][] in [#28](https://github.com/yabeda-rb/yabeda-rails/pull/28)
+- Allow defining default_tags only for rails group [@magec][] in [#30](https://github.com/yabeda-rb/yabeda-rails/pull/30)
+- Ability to customize the bucket sizing for histograms [@skateman][] in [#32](https://github.com/yabeda-rb/yabeda-rails/pull/32)
+- Ability to ignore certain controller#actions [@zzip][] in [#33](https://github.com/yabeda-rb/yabeda-rails/pull/33)
+
+## 0.9.0 - 2023-08-03
+
+### Added
+
+- Ability to switch controller name case in `controller` tag between `:snake` and `:camel` case. [@lewispb][] in [#26](https://github.com/yabeda-rb/yabeda-rails/pull/26)
+
+## Changed
+
+- Minimal Ruby version increased to 2.5. [@Envek][]
+
 ## 0.8.1 - 2022-06-06
 
 ### Fixed
@@ -85,3 +104,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 [@liaden]: https://github.com/liaden "Joel Johnson"
 [@lautis]: https://github.com/lautis "Ville Lautanala"
 [@dks17]: https://github.com/dks17 "Konstantin"
+[@lewispb]: https://github.com/lewispb "Lewis Buckley"
+[@mabrikan]: https://github.com/mabrikan "Musaed Albrikan"
+[@magec]: https://github.com/magec "Jose Fernández"
+[@skateman]: https://github.com/skateman "Halász Dávid"
+[@zzip]: https://github.com/zzip "Dale Hofkens"

data/Gemfile

@@ -7,7 +7,7 @@ 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")
+rails_version = ENV.fetch("RAILS_VERSION", "~> 8.0")
 case rails_version
 when "HEAD"
   git "https://github.com/rails/rails.git" do

data/README.md

@@ -76,6 +76,15 @@ 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)
 
+## Configuration
+
+Configuration is handled by [anyway_config] gem. With it you can load settings from environment variables (upcased and prefixed with `YABEDA_RAILS_`), YAML files, and other sources. See [anyway_config] docs for details.
+
+| Config key             | Type    | Default | Description                                                                                                                                           |
+| ---------------------- | ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `apdex_target`         | integer | nil     | Tolerable time for Apdex in seconds, exposed as gauge if set.                                                                                         |
+| `controller_name_case` | symbol  | :snake  | Defines whether controller name is reported in camel case (:camel) or snake case (:snake).                                                            |
+| `ignore_actions`       | array   | []      | array of controller#action strings that should be ignored, controller should be in camel case, example `['HealthCheck::HealthCheckController#index']` |
 
 ## Development
 

data/lib/yabeda/rails/config.rb

@@ -4,10 +4,14 @@ require "anyway"
 
 module Yabeda
   module Rails
+    # yabeda-rails configuration
     class Config < ::Anyway::Config
       config_name :yabeda_rails
 
       attr_config :apdex_target
+      attr_config :buckets
+      attr_config controller_name_case: :snake
+      attr_config ignore_actions: []
     end
   end
 end

data/lib/yabeda/rails/event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Rails
+    # ActiveSupport Event with added logic for Yabeda tags formatting
+    class Event < ActiveSupport::Notifications::Event
+      def labels
+        @labels ||= begin
+          labels = {
+            controller: controller,
+            action: action,
+            status: status,
+            format: format,
+            method: method,
+          }
+          labels.merge(payload.slice(*(Yabeda.default_tags.keys + Yabeda.rails.default_tags.keys) - labels.keys))
+        end
+      end
+
+      def duration
+        ms2s super
+      end
+
+      def view_runtime
+        ms2s payload[:view_runtime]
+      end
+
+      def db_runtime
+        ms2s payload[:db_runtime]
+      end
+
+      def controller_action
+        "#{payload[:controller]}##{payload[:action]}"
+      end
+
+      private
+
+      def controller
+        case Yabeda::Rails.config.controller_name_case
+        when :camel
+          payload[:controller]
+        else
+          payload[:params]["controller"]
+        end
+      end
+
+      def action
+        payload[:action]
+      end
+
+      def status
+        if payload[:status].nil? && payload[:exception].present?
+          ActionDispatch::ExceptionWrapper.status_code_for_exception(payload[:exception].first)
+        else
+          payload[:status]
+        end
+      end
+
+      def format
+        payload[:format]
+      end
+
+      def method
+        payload[:method].downcase
+      end
+
+      def ms2s(milliseconds)
+        (milliseconds.to_f / 1000).round(3)
+      end
+    end
+  end
+end

data/lib/yabeda/rails/railtie.rb

@@ -19,8 +19,12 @@ module Yabeda
         ::Rails.const_defined?("Unicorn::Launcher")
       end
 
+      def passenger_server?
+        ::Rails.const_defined?("PhusionPassenger")
+      end
+
       initializer "yabeda-rails.metrics" do
-        ::Yabeda::Rails.install! if rails_server? || puma_server? || unicorn_server?
+        ::Yabeda::Rails.install! if rails_server? || puma_server? || unicorn_server? || passenger_server?
       end
     end
   end

data/lib/yabeda/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Rails
-    VERSION = "0.8.1"
+    VERSION = "0.10.0"
   end
 end

data/lib/yabeda/rails.rb

@@ -5,6 +5,7 @@ require "active_support"
 require "rails/railtie"
 require "yabeda/rails/railtie"
 require "yabeda/rails/config"
+require "yabeda/rails/event"
 
 module Yabeda
   # Minimal set of Rails-specific metrics for using with Yabeda
@@ -27,7 +28,8 @@ module Yabeda
       # rubocop: disable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
       def install!
         Yabeda.configure do
-          config = Config.new
+          config = ::Yabeda::Rails.config
+          buckets = config.buckets || LONG_RUNNING_REQUEST_BUCKETS
 
           group :rails
 
@@ -36,14 +38,14 @@ module Yabeda
 
           histogram :request_duration, tags: %i[controller action status format method],
                                        unit: :seconds,
-                                       buckets: LONG_RUNNING_REQUEST_BUCKETS,
+                                       buckets: buckets,
                                        comment: "A histogram of the response latency."
 
-          histogram :view_runtime, unit: :seconds, buckets: LONG_RUNNING_REQUEST_BUCKETS,
+          histogram :view_runtime, unit: :seconds, buckets: buckets,
                                    comment: "A histogram of the view rendering time.",
                                    tags: %i[controller action status format method]
 
-          histogram :db_runtime, unit: :seconds, buckets: LONG_RUNNING_REQUEST_BUCKETS,
+          histogram :db_runtime, unit: :seconds, buckets: buckets,
                                  comment: "A histogram of the activerecord execution time.",
                                  tags: %i[controller action status format method]
 
@@ -54,39 +56,25 @@ module Yabeda
           end
 
           ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
-            event = ActiveSupport::Notifications::Event.new(*args)
-            labels = {
-              controller: event.payload[:params]["controller"],
-              action: event.payload[:params]["action"],
-              status: Yabeda::Rails.event_status_code(event),
-              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))
-            rails_view_runtime.measure(labels, Yabeda::Rails.ms2s(event.payload[:view_runtime]))
-            rails_db_runtime.measure(labels, Yabeda::Rails.ms2s(event.payload[:db_runtime]))
+            event = Yabeda::Rails::Event.new(*args)
+
+            next if event.controller_action.in?(config.ignore_actions)
+
+            rails_requests_total.increment(event.labels)
+            rails_request_duration.measure(event.labels, event.duration)
+            rails_view_runtime.measure(event.labels, event.view_runtime)
+            rails_db_runtime.measure(event.labels, event.db_runtime)
 
             Yabeda::Rails.controller_handlers.each do |handler|
-              handler.call(event, labels)
+              handler.call(event, event.labels)
             end
           end
         end
       end
       # rubocop: enable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
 
-      def ms2s(milliseconds)
-        (milliseconds.to_f / 1000).round(3)
-      end
-
-      def event_status_code(event)
-        if event.payload[:status].nil? && event.payload[:exception].present?
-          ActionDispatch::ExceptionWrapper.status_code_for_exception(event.payload[:exception].first)
-        else
-          event.payload[:status]
-        end
+      def config
+        @config ||= Config.new
       end
     end
   end

data/yabeda-rails.gemspec

@@ -22,7 +22,7 @@ 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.required_ruby_version = ">= 2.5"
 
   spec.add_dependency "activesupport"
   spec.add_dependency "anyway_config", ">= 1.3", "< 3"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Andrey Novikov
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,8 +120,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build-release.yml"
 - ".github/workflows/lint.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -136,6 +135,7 @@ files:
 - bin/setup
 - lib/yabeda/rails.rb
 - lib/yabeda/rails/config.rb
+- lib/yabeda/rails/event.rb
 - lib/yabeda/rails/railtie.rb
 - lib/yabeda/rails/version.rb
 - yabeda-rails-logo.png
@@ -144,7 +144,6 @@ homepage: https://github.com/yabeda-rb/yabeda-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -152,15 +151,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Extensible metrics for monitoring Ruby on Rails application
 test_files: []