tracebin 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17c8dde3ccebe028e63049fd73713fb0ff8e3643
+  data.tar.gz: eb14462756f92fb25fd81ab7968eeef96e9eac58
+SHA512:
+  metadata.gz: 5a6b4a64ce5c7bae23d18a31e92f3602cfa0681358316a7095f1f67c818c86168c9e2f0e5eb3c8403313a88273a8d09c485c9a2b33543b467ebc8369057a207b
+  data.tar.gz: 26a297bb4a17c538ba4424fbce1f7e74b26df173d663e17ce74c322954241a19e29f3307d136f283c3d8cf1d0f40590e66e55f94acaed83ffe193c6cdcb10c32

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

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 tyguillen@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vizsla.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tyler Guillen
+
+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,42 @@
+# Vizsla
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vizsla'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vizsla
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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/aastronautss/vizsla. 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](http://opensource.org/licenses/MIT).
+
+## Notes
+
+### Storage and Reporting Strategy
+
+Multiple threads are storing information in a thread-safe array. Every minute or so, we need to access that array, empty it, and send it to our service. If that data transfer fails (i.e., the response is not successful), that payload is simply re-added to the array and will be transmitted with the next try.

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 "vizsla"
+
+# 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/vizsla/agent.rb

@@ -0,0 +1,87 @@
+require 'logger'
+
+require 'vizsla/subscribers'
+require 'vizsla/health_monitor'
+require 'vizsla/worker_process_monitor'
+require 'vizsla/storage'
+require 'vizsla/reporter'
+
+module Vizsla
+  module Agent
+    class << self
+      attr_accessor :config, :storage, :logger
+
+      def start!
+        logger.info "Starting Vizsla agent..."
+
+        @subscribers = Subscribers.new
+        @health_monitor = HealthMonitor.start
+        @worker_process_monitor = WorkerProcessMonitor.start
+
+        @reporter = Reporter.new(storage, config, logger)
+
+        @reporter.start!
+
+        logger.info "Vizsla agent started!"
+      end
+
+      def stop!
+        logger.info "Shutting down Vizsla agent..."
+
+        @health_monitor.stop!
+        @worker_process_monitor.stop!
+        @reporter.stop!
+
+        @started = false
+
+        logger.info "Vizsla agent stopped!"
+      end
+
+      def started?
+        @started
+      end
+
+      def init_logger
+        if defined? ::Rails
+          @logger = ::Rails.logger
+        else
+          @logger ||= Logger.new(STDOUT)
+          @logger.level = log_level
+        end
+
+        @logger
+      end
+
+      def log_level
+        case config.log_level.downcase
+        when 'debug' then Logger::DEBUG
+        when 'info' then Logger::INFO
+        when 'warn' then Logger::WARN
+        when 'error' then Logger::ERROR
+        when 'fatal' then Logger::FATAL
+        else Logger::INFO
+        end
+      end
+    end
+
+    def self.logger
+      @logger || init_logger
+    end
+
+    def self.storage
+      @storage ||= ::Vizsla::Storage.new
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.reset
+      @config = Config.new
+    end
+
+    def self.configure
+      yield config
+    end
+  end
+end

data/lib/vizsla/background_job_instrumentation/active_job.rb

@@ -0,0 +1,14 @@
+require 'vizsla/background_timer'
+require 'vizsla/puppet_master'
+
+if defined? ::ActiveJob::Base
+  ::ActiveJob::Base.around_perform do |job, block|
+    @vizsla_timer = ::Vizsla::BackgroundTimer.new job.class.name.split('::').last
+    @vizsla_timer.start!
+
+    block.call
+
+    @vizsla_timer.stop!
+    ::Vizsla::PuppetMaster.new(@vizsla_timer).process
+  end
+end

data/lib/vizsla/background_job_instrumentation/resque.rb

@@ -0,0 +1,37 @@
+require 'vizsla/background_timer'
+require 'vizsla/puppet_master'
+
+module Resque
+  module Plugins
+    module VizslaInstrumentation
+      module Job
+        def before_perform_with_vizsla(*args)
+          @vizsla_timer = ::Vizsla::BackgroundTimer.new
+          @vizsla_timer.start!
+
+          yield *args if block_given?
+        end
+
+        def after_perform_with_vizsla(*args)
+          @vizsla_timer.stop!
+          ::Vizsla::PuppetMaster.new(@vizsla_timer, logger: Resque.logger).process
+
+          yield *args if block_given?
+        end
+      end
+    end
+  end
+end
+
+module Vizsla
+  module BackgroundJobInstrumentation
+    module ResqueInstrumentationInstaller
+      def payload_class
+        klass = super
+        klass.instance_eval do
+          extend ::Resque::Plugins::VizslaInstrumentation::Job
+        end
+      end
+    end
+  end
+end

data/lib/vizsla/background_job_instrumentation/sidekiq.rb

@@ -0,0 +1,19 @@
+require 'vizsla/background_timer'
+require 'vizsla/puppet_master'
+
+module Vizsla
+  module BackgroundJobInstrumentation
+    class Sidekiq
+      def call(worker, msg, queue, *args)
+        timer = BackgroundTimer.new worker.class.name.split('::').last
+        timer.start!
+
+        yield
+
+        timer.stop!
+
+        PuppetMaster.new(timer, logger: worker.logger).process
+      end
+    end
+  end
+end

data/lib/vizsla/background_job_instrumentation.rb

@@ -0,0 +1,34 @@
+module Vizsla
+  module BackgroundJobInstrumentation
+    def self.install(inst_name)
+      self.send inst_name
+    end
+
+    private
+
+    def self.sidekiq
+      require 'vizsla/background_job_instrumentation/sidekiq'
+
+      ::Sidekiq.configure_server do |config|
+        config.server_middleware do |chain|
+          chain.add ::Vizsla::BackgroundJobInstrumentation::Sidekiq
+        end
+      end
+    end
+
+    def self.resque
+      require 'vizsla/background_job_instrumentation/resque'
+
+      ::Resque::Job.class_eval do
+        def self.new(*args)
+          super(*args).extend ::Vizsla::BackgroundJobInstrumentation::
+            ResqueInstrumentationInstaller
+        end
+      end
+    end
+
+    def self.active_job
+      require 'vizsla/background_job_instrumentation/active_job'
+    end
+  end
+end

data/lib/vizsla/background_timer.rb

@@ -0,0 +1,9 @@
+require 'vizsla/timer'
+
+module Vizsla
+  class BackgroundTimer < ::Vizsla::Timer
+    def transaction_type
+      'background_job'
+    end
+  end
+end

data/lib/vizsla/config.rb

@@ -0,0 +1,21 @@
+module Vizsla
+  class Config
+    DEFAULTS = {
+      log_level: 'info',
+      host: 'http://localhost:3000',
+      report_path: 'reports',
+      ignored_paths: []
+    }.freeze
+
+    attr_accessor *(DEFAULTS.keys + [:bin_id])
+
+    def initialize(config = {})
+      opts = DEFAULTS.merge config
+      opts.keys.each do |key|
+        if self.respond_to? key
+          self.instance_variable_set "@#{key}", opts[key]
+        end
+      end
+    end
+  end
+end

data/lib/vizsla/events.rb

@@ -0,0 +1,67 @@
+require 'vizsla/helpers'
+
+module Vizsla
+  class Event
+    include Vizsla::Helpers
+
+    attr_reader :event
+
+    def initialize(event)
+      @event = event
+    end
+
+    def recorder_type
+      event[0]
+    end
+
+    def valid?
+      true
+    end
+
+    def data_hash
+      {
+        event_type: type,
+        start: event[1],
+        stop: event[2],
+        duration: to_milliseconds(event[2] - event[1]),
+        data: event.last
+      }
+    end
+  end
+
+  class SQLEvent < Event
+    def valid?
+      event.last[:name] != "SCHEMA"
+    end
+
+    private
+
+    def type
+      :sql
+    end
+  end
+
+  class ControllerEvent < Event
+    private
+
+    def type
+      :controller_action
+    end
+  end
+
+  class ViewEvent < Event
+    private
+
+    def type
+      :view
+    end
+  end
+
+  class SinatraEvent < Event
+    private
+
+    def type
+      :route
+    end
+  end
+end

data/lib/vizsla/health_monitor.rb

@@ -0,0 +1,24 @@
+require 'vizsla/system_health_sample'
+require 'vizsla/puppet_master'
+require 'concurrent'
+
+module Vizsla
+  class HealthMonitor
+    class << self
+      def start
+        @task = Concurrent::TimerTask.new(execution_interval: 10) do
+          health = SystemHealthSample.new
+          PuppetMaster.new(health).process
+        end
+
+        @task.execute
+
+        self
+      end
+
+      def stop!
+        @task.shutdown
+      end
+    end
+  end
+end

data/lib/vizsla/helpers.rb

@@ -0,0 +1,7 @@
+module Vizsla
+  module Helpers
+    def to_milliseconds(time)
+      time.to_f * 1000
+    end
+  end
+end

data/lib/vizsla/logger.rb

@@ -0,0 +1,55 @@
+module Vizsla
+  class RequestLogger
+    def initialize(logger_override = nil)
+      @logger_override = logger_override
+    end
+
+    def display_payload(payload)
+      output = '=' * 50 + "\n"
+
+      str_append_hash output, payload
+
+      output += '=' * 50
+
+      log output
+    end
+
+    def str_append_hash(str, hsh, bumper = '')
+      hsh.keys.each do |key|
+        if hsh[key].is_a? Hash
+          str << "#{bumper}#{key}:\n"
+          str_append_hash str, hsh[key], bumper + '  '
+        elsif hsh[key].is_a? Array
+          str << "#{bumper}#{key}:\n"
+          hsh[key].each do |ele|
+            if ele.is_a? Hash
+              str_append_hash str, ele, bumper + '  '
+            else
+              str << "#{bumper}#{ele}"
+            end
+          end
+        else
+          str << "#{bumper}#{key}: #{hsh[key]}\n"
+        end
+      end
+
+      str
+    end
+
+    private
+
+    def rails_app?
+      defined? ::Rails
+    end
+
+    def log(text)
+      if !@logger_override.nil?
+        @logger_override.info text
+      elsif rails_app?
+        Rails.logger.debug text
+      else
+        puts text
+      end
+    end
+  end
+end

data/lib/vizsla/middleware.rb

@@ -0,0 +1,51 @@
+require 'vizsla/timer'
+require 'vizsla/puppet_master'
+
+module Vizsla
+  class Middleware
+    attr_reader :config
+
+    def initialize(app)
+      @app = app
+      @config = Vizsla::Agent.config
+
+      Vizsla::Agent.start! unless Vizsla::Agent.started?
+    end
+
+    def call(env)
+      dup.__call(env)
+    end
+
+    def __call(env)
+      path = env['REQUEST_PATH']
+      ignored_paths = config.ignored_paths.map { |root| %r{^#{root}} }
+
+      if ignored_paths.any? { |root| !!root.match(path) }
+        @app.call env
+      else
+        timer = Timer.new
+        timer.start!
+
+        status, headers, response = @app.call(env)
+
+        timer.transaction_name = fetch_endpoint_name env
+
+        timer.stop!
+
+        PuppetMaster.new(timer).process
+
+        [status, headers, response]
+      end
+    end
+
+    private
+
+    def fetch_endpoint_name(env)
+      if controller = env['action_controller.instance']
+        "#{controller.class}##{controller.params['action']}"
+      else
+        'RackTransaction'
+      end
+    end
+  end
+end

data/lib/vizsla/patches/action_view_layout.rb

@@ -0,0 +1,34 @@
+::ActionView::TemplateRenderer.class_eval do
+  alias_method :render_with_layout_without_tracebin, :render_with_layout
+
+  def render_with_layout(path, locals, *args, &block)
+    layout = nil
+
+    if path
+      if method(:find_layout).arity == 3
+        layout = find_layout(path, locals.keys, [formats.first])
+      else
+        layout = find_layout(path, locals.keys)
+      end
+    end
+
+    if layout
+      start_time = Time.now
+      render_with_layout_without_tracebin(path, locals, *args, &block)
+      end_time = Time.new
+
+      event_data = [
+        'render_layout.action_view',
+        start_time,
+        end_time,
+        {
+          identifier: layout.identifier
+        }
+      ]
+
+      ::Vizsla::Patches.handle_event :action_view_layout, event_data
+    else
+      render_with_layout_without_tracebin(path, locals, *args, &block)
+    end
+  end
+end