yabeda-rails 0.2.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33b19f37d8fc8d0ee84bed04a0f13658901ab18ac5e1d1c9db5db5f8fdea981d
-  data.tar.gz: 3a6007be6f1e141264d05a0966cb5e43db5f0849b382122b88758f6b64337fa6
+  metadata.gz: 7c4f9d9b4773c74b1ec6227a70b8799f817ce4d5e053b368e6136fb82a51df4f
+  data.tar.gz: 9353bc44438ce046037fb9a459fbd95395a56e01349fa3fba4c35deaac02a262
 SHA512:
-  metadata.gz: ae3d4bb58b49bff48dc3d49638f26ee24b7371689e82918fb0a5666c4f82e109e74922973add0bfac6f6b78f4c6c5a4abf834b78b764461c014e13c55f902cff
-  data.tar.gz: 99ada92e2f220c78e4051d92a1b3bd0fad9c39414c4a24d5959ce9c199e3e6aede953f18d2c9f6f3cb27ff2e98f169bea0bb356043e97e155b10091527bbd669
+  metadata.gz: be508869519495bf6ed889ab9fcd2285299d8d791e32d77835c0e3a073be5351055c24f831bca665a9683f76c9036969cb58021afe0ac530e1a1268309f6240f
+  data.tar.gz: cada1bfb298d4a29322375d16719c1d52c95944b42434260be1cca6a8b6d4c7db2bb73e95a9e49118188ba6f1a58d0701806be6e63b0de5aec350ece877f2ce8

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,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.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
+
+ - 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

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

@@ -47,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

@@ -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:
@@ -11,10 +15,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.2.0"
+    VERSION = "0.7.1"
   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", "~> 0.2"
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        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.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Extensible metrics for monitoring Ruby on Rails application