yabeda-rails 0.1.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61cf4aa1c51939cf818ad3333aa18146c13905bbf4cf106b40e87a351fe0c3b9
-  data.tar.gz: f18e2d6896b0fba6d1df1fb9818d3b38241a0435ebf75482ffb4ea1a631c3842
+  metadata.gz: 7dbf65d3d54b48f0ed4140e72734407e1cd67babb934c797e3f2dd65e7e6c177
+  data.tar.gz: 6c186927d6d13ee387751cddd625c29d03ec974c2d80cf72d16ea3c0a971cd6f
 SHA512:
-  metadata.gz: 5a579fff0e19c4d43db8b957aebeffdf9eaa313a954a7942965219aecc81735b677061f7d2b03eac7b922a7d03176a7f6fcc831765acd9859550a820467d6ac7
-  data.tar.gz: 760f14baec9e99021b40b43a571ea49e15f10867ad01d3c17cd44b5c169f4258ed8c82c2db94489d70484af97b8cda8873574952354275d32cf24a61c1fb2e43
+  metadata.gz: 4795bd4a4c82f002f2ef6d6b3620ce8ae4e5bb92a7d81da3117153bf7f2f2e6fbbeb28bab45572d5efaeea11aa4690eef6ecc594980d3f2dbf282588dceb1b37
+  data.tar.gz: 4b20c62e48cf0ba9be1726efe214f990ff3f2d319ed2bb75d24fafe95d03d9672c60d89cff30df7774b8cec191459f8186738cc8755d456cae4d3b2bbf8d5ca7

data/.travis.yml

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

data/CHANGELOG.md

@@ -5,6 +5,35 @@ 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.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
+
+ - 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 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,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

@@ -11,10 +11,12 @@ module Yabeda
         ::Rails.const_defined?('Puma::CLI')
       end
 
-      config.after_initialize do
-        next unless rails_server? || puma_server?
+      def unicorn_server?
+        ::Rails.const_defined?("Unicorn::Launcher")
+      end
 
-        ::Yabeda::Rails.install!
+      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.1.3"
+    VERSION = "0.7.0"
   end
 end

data/yabeda-rails.gemspec

@@ -22,10 +22,10 @@ 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.8"
   spec.add_dependency "rails"
 
-  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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2020-08-21 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.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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     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
@@ -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