yabeda-rails 0.1.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6080838a84371c2f8b813d8f2e613f15dbdddeb2c4281b63eff6368a26aae0
-  data.tar.gz: bba458511569e406752c603e5d897415227dac7edb84c58ae80148c88beaa352
+  metadata.gz: 17430310dde26c291834ba76e124506f4cd913578d18f6fbb9c8a1caa2967776
+  data.tar.gz: f978a2034421966bd6e8dcc38f2e1f2ab644c3cb3627c6bf94a73f5cd46fee00
 SHA512:
-  metadata.gz: 3df4bbd07f750e0d32d6b84a894ac74c130fc64844dce69bd8ad9b3e445f7ca61972308528ebadd78d4a0b67198199b203e7b9b881f37ef0d8baae06baac2fb4
-  data.tar.gz: 41dd0f1141cd22e182b2e0c4461a712aa1ecb9de97d233b4b03d726345c93c82cb863c1b1752525d05d4e0195d1d3486a0bd9f43c5567eb7ae9fd824407fcf40
+  metadata.gz: 62b667631fad16ce7b6436109e14484509c8c54e3bd41a4c744fdabc62f34b22b9a86bc861c6df369d1ce74f2eee6d8ebb4c7dbd89971b48d7feb16892e92a13
+  data.tar.gz: 40adc80e926e70ba662b1c9fd6f32872a35a689fa127993037ee3e5b5272325c4d9a2fa25433dc17b6a225f60ecaab333661b7e5555e7d6fdf78e459466454fe

data/CHANGELOG.md

@@ -5,6 +5,29 @@ 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.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
+
+ - Configure Yabeda after application initialization as since 0.4.0 Yabeda requires to call configuration logic explicitly. @Envek
+
+## 0.2.0 - 2020-01-14
+
+### Changed
+
+ - Added `tags` option to metric declarations for compatibility with yabeda and yabeda-prometheus 0.2. @Envek
 
 ## 0.1.2 - 2019-01-19
 

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 you don't need this gem metrics, but `yabeda-rails` also will automatically configure Yabeda in your Rails application.
+
+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,6 +57,26 @@ 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.

data/lib/yabeda/rails.rb

@@ -23,13 +23,21 @@ module Yabeda
         Yabeda.configure do
           group :rails
 
-          counter   :requests_total, comment: "A counter of the total number of HTTP requests rails processed."
-          histogram :request_duration, unit: :seconds, buckets: LONG_RUNNING_REQUEST_BUCKETS,
+          counter   :requests_total,   comment: "A counter of the total number of HTTP requests rails processed.",
+                                       tags: %i[controller action status format method]
+
+          histogram :request_duration, tags: %i[controller action status format method],
+                                       unit: :seconds,
+                                       buckets: LONG_RUNNING_REQUEST_BUCKETS,
                                        comment: "A histogram of the response latency."
+
           histogram :view_runtime, unit: :seconds, buckets: LONG_RUNNING_REQUEST_BUCKETS,
-                                   comment: "A histogram of the view rendering time."
+                                   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,
-                                 comment: "A histogram of the activerecord execution time."
+                                 comment: "A histogram of the activerecord execution time.",
+                                 tags: %i[controller action status format method]
 
           ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
             event = ActiveSupport::Notifications::Event.new(*args)
@@ -39,7 +47,7 @@ module Yabeda
               status: event.payload[:status],
               format: event.payload[:format],
               method: event.payload[:method].downcase,
-            }
+            }.merge!(event.payload.slice(*Yabeda.default_tags.keys))
 
             rails_requests_total.increment(labels)
             rails_request_duration.measure(labels, Yabeda::Rails.ms2s(event.duration))

data/lib/yabeda/rails/railtie.rb

@@ -3,12 +3,6 @@
 module Yabeda
   module Rails
     class Railtie < ::Rails::Railtie # :nodoc:
-      config.after_initialize do
-        next unless rails_server? || puma_server?
-
-        ::Yabeda::Rails.install!
-      end
-
       def rails_server?
         ::Rails.const_defined?(:Server)
       end
@@ -16,6 +10,15 @@ module Yabeda
       def puma_server?
         ::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? || unicorn_server?
+        Yabeda.configure! unless Yabeda.already_configured?
+      end
     end
   end
 end

data/lib/yabeda/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Rails
-    VERSION = "0.1.2"
+    VERSION = "0.6.0"
   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.add_dependency "yabeda"
+  spec.add_dependency "yabeda", "~> 0.4"
   spec.add_dependency "rails"
 
   spec.add_development_dependency "bundler", "~> 1.16"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-19 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Extensible metrics for monitoring Ruby on Rails application