metrics_adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6525fffc00cde5df061ba6ce5621b9db422ddd5d09393b754ce5919b7c536f87
+  data.tar.gz: 0663ee07b6c96170f4b4050e90821b64093ff9fe9e784d14b28c2478139ceda7
+SHA512:
+  metadata.gz: 4ccad7b481311aaa2b2bc79eac01993f466e0a842ca5428d63b87aa53554da2a44148e08f5dec0305b374ee187272d64c21137becf530cde6e85c129fb4c46e4
+  data.tar.gz: 3f6bd8da506014433441d190aed87607800e2bd1d1a21ad2cb2c07bf9bba1b72349980db823fef09d8a38730c8bff39772b5736ef8fda57459ae1e859550315a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tomas D'Stefano
+
+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,89 @@
+# Metrics Adapter
+
+A simple gem that collects application data to send to a metrics service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metrics_adapter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metrics_adapter
+
+## Setup
+
+You can setup the following adapters/services:
+
+1. Mixpanel - https://mixpanel.com/
+2. Keen - https://keen.io/
+
+## Setup Mixpanel
+
+Below we setup Mixpanel service using the slow request tracker:
+
+```ruby
+  # config/initializer/metrics_adapter.rb
+  require 'metrics_adapter/rails'
+
+  GeneralMetrics.configure do |config|
+    config.adapter = :mixpanel
+    config.adapter_options = { secret: 'my-secret' }
+    config.extra_attributes = { app: 'My-App' }
+    config.logger = Rails.logger
+    config.trackers = %i(slow_request)
+    config.thresholds = { slow_request: 1_000 }
+  end
+```
+
+## Setup Keen
+
+Below we setup the Keen service using the slow request tracker:
+
+```ruby
+  # config/initializer/metrics_adapter.rb
+  require 'metrics_adapter/rails'
+
+  GeneralMetrics.configure do |config|
+    config.adapter = :keen
+    config.adapter_options = {
+      project_id: 'my-project-id',
+      write_key: 'my-write-key',
+    }
+    config.extra_attributes = { app: 'My-App' }
+    config.logger = Rails.logger
+    config.trackers = %i(slow_request)
+    config.thresholds = { slow_request: 1_000 }
+  end
+```
+
+## Metrics
+
+For the first version, we support for now, the rails event 'process_action.action_controller'.
+
+We will add more trackers as we go. We can pickup ideas from [rails docs](https://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record)
+
+### Slow request
+
+If the request time is bigger than the slow request threshold, then the event
+will be published by the adapter.
+
+The threshold can be setup by:
+
+```ruby
+    config.thresholds = { slow_request: 1_000 }
+```
+
+This will tell the gem to send metrics only if the request time are greater than
+1 second.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "metrics_adapter"
+
+# 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/metrics_adapter.rb

@@ -0,0 +1,36 @@
+require 'metrics_adapter/version'
+require 'active_support/all'
+
+module MetricsAdapter
+  mattr_accessor :adapter
+  mattr_accessor :logger
+
+  mattr_accessor :adapter_options
+  self.adapter_options = {}
+
+  mattr_accessor :extra_attributes
+  self.extra_attributes = {}
+
+  mattr_accessor :trackers
+  self.trackers = []
+
+  mattr_accessor :thresholds
+  self.thresholds = {}
+
+  mattr_accessor :conditionals
+  self.conditionals = {}
+
+  module Adapters
+    autoload :Mixpanel, 'metrics_adapter/adapters/mixpanel'
+    autoload :Keen, 'metrics_adapter/adapters/keen'
+  end
+
+  module Trackers
+    autoload :Base, 'metrics_adapter/trackers/base'
+    autoload :SlowRequest, 'metrics_adapter/trackers/slow_request'
+  end
+
+  def self.configure(&block)
+    yield self
+  end
+end

data/lib/metrics_adapter/adapters/keen.rb

@@ -0,0 +1,19 @@
+require 'keen'
+
+class MetricsAdapter::Adapters::Keen
+  attr_reader :project_id, :write_key
+
+  def initialize(options)
+    @project_id = options.fetch(:project_id)
+    @write_key = options.fetch(:write_key)
+  end
+
+  def publish(data)
+    name = data.delete(:name)
+
+    ::Keen.project_id = project_id
+    ::Keen.write_key = write_key
+
+    ::Keen.publish(name, data)
+  end
+end

data/lib/metrics_adapter/adapters/mixpanel.rb

@@ -0,0 +1,16 @@
+require 'mixpanel-ruby'
+
+class MetricsAdapter::Adapters::Mixpanel
+  attr_reader :tracker
+
+  def initialize(options)
+    @tracker = ::Mixpanel::Tracker.new(options.fetch(:secret))
+    @logger = ::MetricsAdapter.logger
+  end
+
+  def publish(data)
+    id = data.delete(:id)
+    name = data.delete(:name)
+    tracker.track(id, name, data)
+  end
+end

data/lib/metrics_adapter/rails.rb

@@ -0,0 +1,13 @@
+## Request trackers:
+##   1. Tracks slow request given a threshold
+##
+ActiveSupport::Notifications.subscribe('process_action.action_controller') do |event|
+  trackers = MetricsAdapter.trackers
+  conditional = MetricsAdapter.conditionals[:slow_request]
+
+  if conditional.present? && conditional.call.blank?
+    Rails.logger.info('Metrics Adapter wont publish slow request metric.')
+  else
+    MetricsAdapter::Trackers::SlowRequest.new(event).call if trackers.include?(:slow_request)
+  end
+end

data/lib/metrics_adapter/trackers/base.rb

@@ -0,0 +1,26 @@
+module MetricsAdapter
+  module Trackers
+    class Base
+      attr_reader :adapter,
+                  :event,
+                  :extra_attributes,
+                  :logger,
+                  :metric_name
+
+      def initialize(event)
+        adapter_name = MetricsAdapter.adapter.to_s.classify
+        @adapter = "MetricsAdapter::Adapters::#{adapter_name}".constantize.new(
+          MetricsAdapter.adapter_options
+        )
+        @event = event
+        @extra_attributes = ::MetricsAdapter.extra_attributes
+        @logger = ::MetricsAdapter.logger
+        @metric_name = self.class.name.demodulize.underscore
+      end
+
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/metrics_adapter/trackers/slow_request.rb

@@ -0,0 +1,27 @@
+module MetricsAdapter
+  module Trackers
+    class SlowRequest < Base
+      attr_reader :slow_request_threshold
+
+      def initialize(event)
+        @slow_request_threshold = ::MetricsAdapter.thresholds.fetch(:slow_request)
+        super
+      end
+
+      def call
+        if event.duration > slow_request_threshold
+          data = {
+            id: event.transaction_id,
+            name: metric_name,
+            duration: (event.duration / 1000),
+            method: event.payload[:method].to_s.downcase,
+            cpu_time_in_ms: event.cpu_time,
+            idle_time_in_ms: event.idle_time,
+            path: event.payload[:path]
+          }.merge(extra_attributes)
+          adapter.publish(data)
+        end
+      end
+    end
+  end
+end

data/lib/metrics_adapter/version.rb

@@ -0,0 +1,3 @@
+module MetricsAdapter
+  VERSION = '0.1.0'
+end

data/metrics_adapter.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metrics_adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metrics_adapter'
+  spec.version       = MetricsAdapter::VERSION
+  spec.authors       = ['Form builder developers']
+  spec.email         = ['form-builder-team@digital.justice.gov.uk']
+
+  spec.summary       = %q{A gem that collect application metrics.}
+  spec.description   = %q{Collect custom metrics from your application.}
+  spec.homepage      = 'https://github.com/ministryofjustice/metrics_adapter'
+  spec.license       = 'MIT'
+
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'activesupport'
+  spec.add_dependency 'mixpanel-ruby'
+  spec.add_dependency 'keen'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: metrics_adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Form builder developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixpanel-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: keen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Collect custom metrics from your application.
+email:
+- form-builder-team@digital.justice.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/metrics_adapter.rb
+- lib/metrics_adapter/adapters/keen.rb
+- lib/metrics_adapter/adapters/mixpanel.rb
+- lib/metrics_adapter/rails.rb
+- lib/metrics_adapter/trackers/base.rb
+- lib/metrics_adapter/trackers/slow_request.rb
+- lib/metrics_adapter/version.rb
+- metrics_adapter.gemspec
+homepage: https://github.com/ministryofjustice/metrics_adapter
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A gem that collect application metrics.
+test_files: []