regrapher-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63958aba1bfbdfe0634f655ba8ac7cba003eb9ab
+  data.tar.gz: 1ecb126ed1237c35678019a8659145575a790c87
+SHA512:
+  metadata.gz: 3033f2eae4a61f0dd9af70d500ca4dc9576ca72b73226fceb19de3eb2a03f966ba9e9e6e181cec2f66234747a3776961b4f5dbeec10107304038e7aaa40f6f52
+  data.tar.gz: fe8e1da98f436860480c81501cdd783d3ed6a57b00abbf5a10f522e84961657aae53f65d632e8ffa9c16c878554eaaa825865ea30bf35453fb87649634d1cff2

data/README.md

@@ -0,0 +1,5 @@
+Regrapher Rails
+======================
+
+Provides convenience logger to print events and metric values in the Regrapher format.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/regrapher/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates callback hooks for metrics logging in config/initializers/regrapher.rb.
+
+Example:
+    rails generate regrapher
+
+    This will create:
+        config/initializers/regrapher.rb

data/lib/generators/regrapher/regrapher_generator.rb

@@ -0,0 +1,7 @@
+class RegrapherGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    copy_file 'regrapher_initializer.rb', 'config/initializers/regrapher.rb'
+  end
+end

data/lib/generators/regrapher/templates/regrapher_initializer.rb

@@ -0,0 +1,43 @@
+#
+# emit metrics on active record events
+#
+ActiveSupport.on_load(:active_record) do
+  before_create do |r|
+    Regrapher.client.increment("record.created.#{r.class.table_name}")
+    true
+  end
+  before_destroy do |r|
+    Regrapher.client.increment("record.destroyed.#{r.class.table_name}")
+    true
+  end
+  before_update do |r|
+    Regrapher.client.increment("record.updated.#{r.class.table_name}")
+    true
+  end
+end
+
+#
+# emit metrics on authentication events
+#
+if defined?(Warden)
+  Warden::Manager.after_authentication do |r|
+    Regrapher.client.increment("auth.sign_in.#{r.class.table_name}")
+  end
+  Warden::Manager.before_logout do |r|
+    Regrapher.client.increment("auth.sign_out.#{r.class.table_name}")
+  end
+end
+
+#
+# emit metrics on action processing events
+#
+ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |name, started, finished, unique_id, data|
+  next unless data[:status] || data[:exception]
+
+  Regrapher.client.gauge("#{name}.runtime.view", data[:view_runtime].to_f)
+  Regrapher.client.gauge("#{name}.runtime.db", data[:db_runtime].to_f)
+  Regrapher.client.gauge("#{name}.runtime.total", (finished - started) * 1000.0)
+
+  status = data[:status] || Rack::Utils.status_code(ActionDispatch::ExceptionWrapper.rescue_responses[data[:exception][0]])
+  Regrapher.client.increment("#{name}.status.#{status}")
+end

data/lib/regrapher-rails.rb

@@ -0,0 +1 @@
+require 'regrapher'

data/lib/regrapher/rails/version.rb

@@ -0,0 +1,5 @@
+module Regrapher
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require 'regrapher-rails'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered     = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order            = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: regrapher-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramsay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: regrapher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Provides convenience logger to format events and metric values in the
+  regrapher format
+email:
+- ramzi.salah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/generators/regrapher/USAGE
+- lib/generators/regrapher/regrapher_generator.rb
+- lib/generators/regrapher/templates/regrapher_initializer.rb
+- lib/regrapher-rails.rb
+- lib/regrapher/rails/version.rb
+- spec/examples.txt
+- spec/spec_helper.rb
+homepage: http://github.com/regrapher/regrapher-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Regrapher logger for Rails applications
+test_files:
+- spec/examples.txt
+- spec/spec_helper.rb