rmetrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8187a0d18303e564b37fc084176ed47ec676abb2
+  data.tar.gz: ee98db5d1119d48ec55f813487a43a5a8e3665df
+SHA512:
+  metadata.gz: b637b2549b882f5a5d1cd6fa5ce8933d01dd633e4aadf55dd4acd634337194c81c3a022375a1ef6651afd4f15411089baeabecbc88c166587b166cad065bf4b5
+  data.tar.gz: f544bb9fb70d3eb34be5c57e1f550d6e2ecc0a59c3c744c1c35686566d4d5c02956bd892f8d958ea0d2ee6ba477cf67114ef67bfd0b46a7d79abbfc28de13579

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/config/
+/.coveralls.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 2.3.3
+
+script: bundle exec rake test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at guircasimiro@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'activesupport'
+gem 'coveralls', require: false
+gem 'influxdb'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    rmetrics (0.1.0)
+      activesupport (~> 5.1)
+      influxdb (~> 0.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    docile (1.3.1)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    influxdb (0.6.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (10.4.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.16.3)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  coveralls
+  influxdb
+  minitest (~> 5.11)
+  rake (~> 10.0)
+  rmetrics!
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Guilherme Casimiro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Rmetrics
+
+Rmetrics is a gem that relies on ActiveSupport to get all metrics in your Rails application, such as: ActionController, ActiveView, ActiveRecord, ActionMailer, ActiveSupport, ActiveJob, ActionCable and ActiveStorage
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rmetrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rmetrics
+
+## Usage
+
+To start get all the metrics you want, you have to call Rmetrics.setup inside a file in config/initializers/rmetrics.rb.
+One example of how you should setup rmetrics is below:
+
+```ruby
+Rmetrics.setup do |config|
+  config.action_controller = ['start_processing.action_controller',
+                              'process_action.action_controller',
+                              'redirect_to.action_controller']
+  config.active_view = ['render_template.action_view',
+                        'render_partial.action_view']
+  config.active_record = ['instantiation.active_record',
+                          'sql.active_record']
+  config.action_mailer = ['receive.action_mailer']
+  config.active_support = ['cache_read.active_support']
+  config.active_job = ['enqueue_at.active_job']
+  config.action_cable = ['perform_action.action_cable']
+  config.active_storage = ['service_upload.active_storage']
+  config.db_config = { username: ENV['INFLUX_USERNAME'],
+                       password: ENV['INFLUX_PASSWORD'],
+                       database: ENV['INFLUX_DATABASE'],
+                       host: ENV['INFLUX_HOST'],
+                       port: ENV['INFLUX_PORT'], retry: 10 }
+end
+```
+
+After that, you have to subscribe to all Action or Active you want, one example is given below:
+
+```ruby
+events = Rmetrics::Events.new
+events.controller_subscribe_events
+events.record_subscribe_events
+events.view_subscribe_events
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chiligumdev/rmetrics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rmetrics project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/chiligumdev/rmetrics/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*/test_*.rb']
+  t.verbose = true
+end
+
+task :console do
+  exec 'irb -r rmetrics -I ./lib'
+end
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task test_with_coveralls: [:spec, :features, 'coveralls:push']
+
+desc 'Run tests'
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rmetrics'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rmetrics.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'rmetrics/influx'
+require 'rmetrics/events'
+require 'yaml'
+
+# lib/rmetrics.rb
+module Rmetrics
+  # rubocop:disable Style/ClassVars
+  # Defines what kind of metric should catch inside ActionController
+  mattr_accessor :action_controller
+  @@action_controller = ['start_processing.action_controller']
+
+  # Defines what kind of metric should catch inside ActiveView
+  mattr_accessor :active_view
+  @@active_view = []
+
+  # Defines what kind of metric should catch inside ActiveRecord
+  mattr_accessor :active_record
+  @@active_record = ['sql.active_record']
+
+  # Defines what kind of metric should catch inside ActionMailer
+  mattr_accessor :action_mailer
+  @@action_mailer = []
+
+  # Defines what kind of metric should catch inside ActiveSupport
+  mattr_accessor :active_support
+  @@active_support = []
+
+  # Defines what kind of metric should catch inside ActiveJob
+  mattr_accessor :active_job
+  @@active_job = []
+
+  # Defines what kind of metric should catch inside ActionCable
+  mattr_accessor :action_cable
+  @@action_cable = []
+
+  # Defines what kind of metric should catch inside ActiveStorage
+  mattr_accessor :active_storage
+  @@active_storage = []
+
+  mattr_accessor :db_config
+  @@db_config = { database: 'metrics' }
+  # rubocop:enable Style/ClassVars
+
+  def self.setup
+    yield self
+  end
+end

data/lib/rmetrics/events.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Rmetrics
+  # Handles action events across rails
+  class Events
+    attr_reader :db_client
+
+    def initialize
+      @db_client = Rmetrics::Influx.new(Rmetrics.db_config)
+    end
+
+    def notification_subscription(action_name)
+      ActiveSupport::Notifications.subscribe(action_name) do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        @db_client.write_data(action_name, event)
+      end
+    end
+
+    def controller_subscribe_events
+      Rmetrics.action_controller.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+
+    def view_subscribe_events
+      Rmetrics.active_view.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+
+    def record_subscribe_events
+      Rmetrics.active_record.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+
+    def mailer_subscribe_events
+      Rmetrics.action_mailer.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+
+    def support_subscribe_events
+      Rmetrics.active_support.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+
+    def job_subscribe_events
+      Rmetrics.active_job.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+
+    def cable_subscribe_events
+      Rmetrics.action_cable.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+
+    def storage_subscribe_events
+      Rmetrics.active_storage.each do |action|
+        notification_subscription(action.to_s)
+      end
+    end
+  end
+end

data/lib/rmetrics/influx.rb

@@ -0,0 +1,48 @@
+require 'influxdb'
+
+module Rmetrics
+  # Handles the comunnication to Influx DB
+  class Influx
+    def initialize(options = {})
+      @influx_client = InfluxDB::Client.new(options)
+    end
+
+    def write_data(table, data)
+      @influx_client.write_point(table, organize_event(data))
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def adjust_values(act, payload)
+      payload.each do |key, value|
+        case value
+        when Hash
+          act[:tags].merge!(value.select { |_, v| v.is_a?(String) })
+        when Numeric, Integer
+          act[:values][key.to_sym] = value.to_f
+        when String, TrueClass, FalseClass
+          act[:values][key.to_sym] = value
+        when Symbol
+          act[:values][key.to_sym] = value.to_s
+        else
+          next
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def organize_event(event)
+      act = {
+        values: {
+          duration: event.duration
+        },
+        tags: {
+          name: event.name
+        }
+      }
+      adjust_values(act, event.payload)
+      act
+    end
+  end
+end

data/lib/rmetrics/version.rb

@@ -0,0 +1,3 @@
+module Rmetrics
+  VERSION = '0.1.0'.freeze
+end

data/rmetrics.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rmetrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rmetrics'
+  spec.version       = Rmetrics::VERSION
+  spec.authors       = ['Guilherme Casimiro']
+  spec.email         = ['guircasimiro@gmail.com']
+  # rubocop:disable Metrics/LineLength
+  spec.summary       = 'Catch and send your rails metrics to your influx database.'
+  spec.description   = 'Catch and send your rails metrics to your influx database.'
+  # rubocop:enable Metrics/LineLength
+  spec.homepage      = 'https://github.com/chiligumdev/rmetrics'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'minitest', '~> 5.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'influxdb', '~> 0.6.0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rmetrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guilherme Casimiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: Catch and send your rails metrics to your influx database.
+email:
+- guircasimiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rmetrics.rb
+- lib/rmetrics/events.rb
+- lib/rmetrics/influx.rb
+- lib/rmetrics/version.rb
+- rmetrics.gemspec
+homepage: https://github.com/chiligumdev/rmetrics
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Catch and send your rails metrics to your influx database.
+test_files: []