alacrity-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d1deb83151619090305c93c971b07df5b0d2145
+  data.tar.gz: ba981ea6ea88638b648bfcc5a9707b32ae1b500c
+SHA512:
+  metadata.gz: df2ef698abaf8b5ecabd244df82f438593134f95226bea65cf109fecb2b6013ac831d81b48ffdbdc45529bb6147fc951511be5644953089d4719cd1ad3d9eee4
+  data.tar.gz: 66861c9368055e355c1ff16239771226f05215b7af098c23c2c528efdca48e9805895df8109adce30d711ffd9603ddee639d7878c955f191e1112e9d6598990a

data/LICENSE

@@ -0,0 +1 @@
+Copyright 2016 Alacrity, LLC

data/README.markdown

@@ -0,0 +1,34 @@
+# Overview
+
+## Alacrity Rails
+
+The alacrity-rails gem collects runtime data from your Ruby on Rails app.
+
+## Compatibility
+
+The alacrity-rails gem officially supports Ruby 2.0+.
+
+It will work automatically with Rails 4 and up.
+
+## Installation
+
+1. Sign up for an account on https://www.alacrityapp.com
+2. Add the `alacrity-rails` gem to your `Gemfile`
+
+   ```
+   gem 'alacrity-rails', group: :production
+   ```
+
+3. Set the ALACRITY_API_TOKEN in your app's environment
+4. Deploy with the gem installed
+5. You'll begin seeing data on https://alacrityapp.com shortly after your site receives traffic.
+
+## Server Configuration Overrides
+
+### ALACRITY_API_TOKEN
+
+You can find this on the settings page for your app on https://alacrityapp.com
+
+### ALACRITY_ENVIRONMENT
+
+By default Alacrity will use `Rails.env` to determine the server environment. You can override this to any string value (like `staging`).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  require "appraisal/task"
+  Appraisal::Task.new
+  task default: :appraisal
+else
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new
+  task default: :spec
+end

data/lib/alacrity-rails.rb

@@ -0,0 +1,22 @@
+if defined?(Rake)
+  require 'rake'
+  Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
+end
+
+module AlacrityRails
+  autoload :Config,           'alacrity-rails/config'
+  autoload :ConnectionTester, 'alacrity-rails/connection_tester'
+  autoload :Client,           'alacrity-rails/client'
+  autoload :Middleware,       'alacrity-rails/middleware'
+  autoload :ServerConfig,     'alacrity-rails/server_config'
+  autoload :VERSION,          'alacrity-rails/version'
+
+  module Transaction
+    autoload :Base,           'alacrity-rails/transaction/base'
+    autoload :ConnectionTest, 'alacrity-rails/transaction/connection_test'
+    autoload :ServerStartup,  'alacrity-rails/transaction/server_startup'
+    autoload :WebTransaction, 'alacrity-rails/transaction/web_transaction'
+  end
+end
+
+require 'alacrity-rails/railtie'

data/lib/alacrity-rails/client.rb

@@ -0,0 +1,50 @@
+module AlacrityRails
+  class Client
+
+    def self.open_transaction(env)
+      new_transaction!(env)
+    end
+
+    def self.store_request_metrics(started_at, ended_at, data)
+      transaction.store_request_metrics(started_at, ended_at, data)
+    end
+
+    def self.store_database_metrics(started_at, ended_at, data)
+      transaction.store_database_metrics(started_at, ended_at, data)
+    end
+
+    def self.close_transaction!
+      this_transaction = transaction
+      Thread.new { transmit(this_transaction) }
+    ensure
+      cleanup
+    end
+
+    def self.log_server_startup
+      Thread.new {
+        transmit(AlacrityRails::Transaction::ServerStartup.new)
+      }
+    end
+
+    def self.transaction
+      Thread.current[:alacrity_transaction]
+    end
+
+    def self.cleanup
+      Thread.current[:alacrity_transaction] = nil
+    end
+
+    def self.transmit(transactable)
+      Net::HTTP.start(*transactable.net_http_start_arguments) do |http|
+        http.request(transactable.post_request)
+      end
+    end
+
+    private
+
+    def self.new_transaction!(env)
+      Thread.current[:alacrity_transaction] = Transaction::WebTransaction.new(env)
+    end
+
+  end
+end

data/lib/alacrity-rails/config.rb

@@ -0,0 +1,16 @@
+module AlacrityRails::Config
+  extend self
+
+  def self.api_token
+    @api_token ||= ENV['ALACRITY_API_TOKEN']
+  end
+  attr_writer :api_token
+
+  def self.enabled?
+    api_token.present?
+  end
+
+  def self.collector_host
+    @collector_host ||= ENV['ALACRITY_COLLECTOR_HOST'] || 'https://collector-api.alacrityapp.com'
+  end
+end

data/lib/alacrity-rails/connection_tester.rb

@@ -0,0 +1,55 @@
+module AlacrityRails
+  class ConnectionTester
+    def self.run; new.run end
+
+    def run
+      if Config.api_token.blank?
+        puts missing_api_token_message
+      else
+        response = Client.transmit(Transaction::ConnectionTest.new)
+
+        if response.code == '200'
+          puts success_message
+        else
+          puts bad_response_message(JSON.parse(response.body)['message'])
+        end
+      end
+
+      puts assistance_message
+    end
+
+    private
+
+    def missing_api_token_message
+      %<
+        Your API token could not be found in the configuration. You can find it on https://alacrityapp.com.
+
+          Then add it to your server's environment as `ALACRITY_API_TOKEN`
+
+          OR
+
+          Set it manually with an initializer (config/alacrity.rb)
+            AlacrityRails::Config.api_token = 'your token'>
+    end
+
+    def bad_response_message(server_message)
+      %<
+        Oh no! Its seems like we have a problem!
+
+          #{server_message}>
+    end
+
+    def success_message
+      %<
+        Everything looks good!
+
+        You should see data on https://alacrityapp.com shortly after your app receives traffic.>
+    end
+
+    def assistance_message
+      %<
+        If you need assistance or have any questions, send an email to support@alacrityapp.com or tweet @alacrityapp and we'll help you out!
+      >
+    end
+  end
+end

data/lib/alacrity-rails/middleware.rb

@@ -0,0 +1,10 @@
+module AlacrityRails
+  class Middleware < Struct.new(:app)
+    def call(env)
+      Client.open_transaction(env)
+      response = app.call(env)
+      Client.close_transaction!
+      response
+    end
+  end
+end

data/lib/alacrity-rails/railtie.rb

@@ -0,0 +1,19 @@
+module AlacrityRails
+  class Railtie < ::Rails::Railtie
+    initializer 'alacrity' do |config|
+      if Config.enabled?
+        Client.log_server_startup
+
+        config.middleware.insert_before 0, AlacrityRails::Middleware
+      end
+
+      ActiveSupport::Notifications.subscribe 'sql.active_record' do |name, started, finished, unique_id, data|
+        AlacrityRails::Client.store_database_metrics(started, finished, data)
+      end
+
+      ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |name, started, finished, unique_id, data|
+        AlacrityRails::Client.store_request_metrics(started, finished, data)
+      end
+    end
+  end
+end

data/lib/alacrity-rails/server_config.rb

@@ -0,0 +1,25 @@
+module AlacrityRails::ServerConfig
+  extend self
+
+  def rails_version
+    @rails_version ||= Rails.version
+  end
+
+  def environment
+    @environment ||= ENV['ALACRITY_ENVIRONMENT'] || Rails.env
+  end
+
+  def client_identifier
+    @client_identifier ||= "alacrity-rails-#{AlacrityRails::VERSION}"
+  end
+
+  def as_json
+    {
+      client_identifier: client_identifier,
+      command: File.split($0).last,
+      environment: environment,
+      rails_version: rails_version,
+      ruby_version: RUBY_VERSION
+    }
+  end
+end

data/lib/alacrity-rails/transaction/base.rb

@@ -0,0 +1,29 @@
+module AlacrityRails::Transaction
+  class Base
+    def post_request
+      Net::HTTP::Post.new(endpoint, {
+        "Authorization" => authorization_header_value,
+        "Content-Type" => "application/json"
+      }).tap { |request| request.body = to_json }
+    end
+
+    def self.net_http_start_arguments
+      @net_http_start_arguments ||= [endpoint.host, endpoint.port, use_ssl: endpoint.scheme == 'https']
+    end
+    def net_http_start_arguments; self.class.net_http_start_arguments end
+
+    def self.endpoint
+      raise 'Must implement'
+    end
+    def endpoint; self.class.endpoint end
+
+    def self.authorization_header_value
+      @authorization_header_value ||= ActionController::HttpAuthentication::Token.encode_credentials(AlacrityRails::Config.api_token)
+    end
+    def authorization_header_value; self.class.authorization_header_value end
+
+    def to_json
+      @to_json ||= super.to_json
+    end
+  end
+end

data/lib/alacrity-rails/transaction/connection_test.rb

@@ -0,0 +1,7 @@
+module AlacrityRails::Transaction
+  class ConnectionTest < Base
+    def self.endpoint
+      @endpoint ||= URI("#{AlacrityRails::Config.collector_host}/v1/connection-test")
+    end
+  end
+end

data/lib/alacrity-rails/transaction/server_startup.rb

@@ -0,0 +1,11 @@
+module AlacrityRails::Transaction
+  class ServerStartup < Base
+    def as_json(*args)
+      AlacrityRails::ServerConfig.as_json
+    end
+
+    def self.endpoint
+      @endpoint ||= URI("#{AlacrityRails::Config.collector_host}/v1/server-startups")
+    end
+  end
+end

data/lib/alacrity-rails/transaction/web_transaction.rb

@@ -0,0 +1,55 @@
+module AlacrityRails::Transaction
+  class WebTransaction < Base
+    attr_accessor :url, :middleware_started_at, :controller, :action, :format,
+      :method, :status, :view_runtime, :db_runtime, :framework_elapsed
+
+    def initialize(env={})
+      self.middleware_started_at = Time.now
+      self.url = ["#{env['rack.url_scheme']}://", env['HTTP_HOST'], env['REQUEST_PATH']].compact.join
+    end
+
+    def store_database_metrics(started_at, finished_at, data)
+      sql_queries << {
+        statement_elapsed: ((finished_at - started_at) * 1000).to_i,
+        name: data[:name],
+        sql: data[:sql]
+      }
+    end
+
+    def store_request_metrics(started_at, finished_at, data)
+      self.framework_elapsed = ((finished_at - started_at) * 1000).to_i
+      self.controller = data[:controller]
+      self.action = data[:action]
+      self.format = data[:format]
+      self.method = data[:method]
+      self.status = data[:status]
+      self.view_runtime = data[:view_runtime].try(:to_i)
+      self.db_runtime = data[:db_runtime].try(:to_i)
+    end
+
+    def as_json(*args)
+      {
+        environment: AlacrityRails::ServerConfig.environment,
+        url: url,
+        controller: controller,
+        action: action,
+        middleware_elapsed: ((Time.now - middleware_started_at) * 1000).to_i,
+        framework_elapsed: framework_elapsed,
+        format: format,
+        method: method,
+        status: status,
+        view_runtime: view_runtime,
+        db_runtime: db_runtime,
+        sql_queries: sql_queries
+      }
+    end
+
+    def self.endpoint
+      @endpoint ||= URI("#{AlacrityRails::Config.collector_host}/v1/web-transactions")
+    end
+
+    def sql_queries
+      @sql_queries ||= []
+    end
+  end
+end

data/lib/alacrity-rails/version.rb

@@ -0,0 +1,3 @@
+module AlacrityRails
+  VERSION = '0.0.1'
+end

data/lib/tasks/test_connection.rake

@@ -0,0 +1,8 @@
+namespace :alacrity do
+
+  desc "Verifies your app's ability to communicate with Alacrity"
+  task :test_connection => :environment do
+    AlacrityRails::ConnectionTester.run
+  end
+
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: alacrity-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alacrity, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Rails Agent for the Alacrity Application Health Platform
+email:
+- support@alacrityapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/alacrity-rails.rb
+- lib/alacrity-rails/client.rb
+- lib/alacrity-rails/config.rb
+- lib/alacrity-rails/connection_tester.rb
+- lib/alacrity-rails/middleware.rb
+- lib/alacrity-rails/railtie.rb
+- lib/alacrity-rails/server_config.rb
+- lib/alacrity-rails/transaction/base.rb
+- lib/alacrity-rails/transaction/connection_test.rb
+- lib/alacrity-rails/transaction/server_startup.rb
+- lib/alacrity-rails/transaction/web_transaction.rb
+- lib/alacrity-rails/version.rb
+- lib/tasks/test_connection.rake
+homepage: https://www.alacrityapp.com
+licenses:
+- GPL
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Rails Agent for the Alacrity Application Health Platform
+test_files: []