vagrant-timer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f26c5ad314f09f36ad9a022a7982720e2bae87c1
+  data.tar.gz: ed75e493ca05c451310c95d652cf2f03151e2092
+SHA512:
+  metadata.gz: 6db17b40c14b0123eccfb270a1121dc1c42ddeb7625e32b9360f4fd0056a3b1a9a2240f1714ab5e6d0068fed0792edb239fb6024b29350d7395d4b83a9d173e5
+  data.tar.gz: 5ee00c2074273b55edef6f943655e54b9027c57d68a2e6099f9d0130b790e4683df18b058ed66c10e7afe2545eaa504137a5a580aebb35eb670125b0335326e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-timer", path: "."
+end

data/README.md

@@ -0,0 +1,72 @@
+# VagrantTimer
+
+The `vagrant-timer` vagrant plugin allows you to capture diagnostic logging
+about the duration that various vagrant actions take, and save them to a file
+for later analysis.
+
+Each line of the log file is a JSON object with the following keys:
+
+<dl>
+    <dt>box</dt>
+    <dd>The name of the base vagrant box being run</dd>
+
+    <dt>action_name</dt>
+    <dd>
+        The hook being executed. Documented
+        <a href="https://www.vagrantup.com/docs/plugins/action-hooks.html">by Vagrant</a>
+    </dd>
+
+    <dt>initialized_at</dt>
+    <dd>ISO 8601 timestame recording the time that the hook was initialized</dd>
+
+    <dt>started_at</dt>
+    <dd>ISO 8601 timestame recording the time that the hook was called</dd>
+
+    <dt>ended_at</dt>
+    <dd>ISO 8601 timestame recording the time that the hook call ended</dd>
+
+    <dt>init_duration</dt>
+    <dd>Duration in seconds from the time the hook was initialized to when it was called</dd>
+
+    <dt>call_duration</dt>
+    <dd>Duration in seconds from the start of the hook call to the end of the hook call</dd>
+</dl>
+
+## Installation
+
+Run `vagrant plugin install vagrant-timer`
+
+## Usage
+
+Set the environment variable `VAGRANT_TIMER_LOG` to a filename to record the
+durations of all executed vagrant actions. The log messages will be appended
+to the specified file. If the variable is unset, no messages will be logged.
+
+## 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 run this plugin locally, use `bundle exec vagrant <some command>`. This will use the
+local `Vagrantfile` in the current repository. To install the plugin in your
+local vagrant environment without publishing to [rubygems.org](https://rubygems.org),
+do the following:
+
+``` sh
+$ rake build
+$ bundle cache --all
+$ cp pkg/*.gem vendor/cache
+$ mv vendor/cache vendor/gems
+$ gem generate_index -d vendor
+$ vagrant plugin install vagrant-timer --plugin-source=file://$(pwd)/vendor
+```
+
+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/edx/vagrant-timer.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

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/vagrant/timer/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Timer
+    VERSION = "0.1.0"
+  end
+end

data/lib/vagrant/timer.rb

@@ -0,0 +1,72 @@
+require "vagrant/timer/version"
+
+require "vagrant"
+
+module Vagrant
+    module Timer
+        class Plugin < Vagrant.plugin("2")
+            name "vagrant-timer"
+            description <<-DESC
+            A plugin to capture timing information from a vagrant run.
+            Set the environment variable VAGRANT_TIMER_LOG to the file to
+            log timing data to.
+            DESC
+
+            action_hook("timer") do |hook|
+                hook.prepend(Middleware)
+            end
+        end
+
+        class Middleware
+            @@previous_action_name = nil
+
+            def initialize(app, env)
+                @init_time = Time.now.utc
+
+                @app = app
+            end
+
+            def call(env)
+                @start_call = Time.now.utc
+                @app.call(env)
+                @end_call = Time.now.utc
+
+                env_obj = env[:env]
+                vagrantfile = env_obj && env_obj.vagrantfile
+                config = vagrantfile && vagrantfile.config
+                vm = config && config.vm
+                box = vm && vm.box
+
+                event = {
+                    :ruby_version    => RUBY_VERSION,
+                    :platform        => RUBY_PLATFORM,
+                    :vagrant_version => Vagrant::VERSION,
+                    :box             => box,
+                    :action_name     => env[:action_name],
+                    :initialized_at  => @init_time,
+                    :started_at      => @start_call,
+                    :ended_at        => @end_call,
+                    :init_duration   => @start_call - @init_time,
+                    :call_duration   => @end_call - @start_call,
+                }
+
+                if !@@previous_action_name.nil?
+                    event[:previous_action_name] = @@previous_action_name
+                    event[:since_previous_action] = @init_time - @@previous_action_end
+                end
+
+                if !ENV['VAGRANT_TIMER_LOG'].nil?
+                    begin
+                        File.open(ENV['VAGRANT_TIMER_LOG'], 'a') do |file|
+                            file.write(event.to_json + "\n")
+                        end
+                    rescue SystemCallError => err
+                        puts "Unable to log event to #{ENV['VAGRANT_TIMER_LOG']}: #{err}"
+                    end
+                end
+                @@previous_action_name = env[:action_name]
+                @@previous_action_end = @end_call
+            end
+        end
+    end
+end

data/vagrant-timer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant/timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-timer"
+  spec.version       = Vagrant::Timer::VERSION
+  spec.authors       = ["Calen Pennington"]
+  spec.email         = ["cale@edx.org"]
+
+  spec.summary       = "Vagrant plugin to dump timing information about commands"
+  spec.homepage      = "https://github.com/edx/vagrant-timer"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-timer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calen Pennington
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-11 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email:
+- cale@edx.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vagrant/timer.rb
+- lib/vagrant/timer/version.rb
+- vagrant-timer.gemspec
+homepage: https://github.com/edx/vagrant-timer
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin to dump timing information about commands
+test_files: []