instrumental_tools 1.0.0 → 1.1.3

data/TEST.md

@@ -7,3 +7,21 @@ bundle exec kitchen verify
 ```
 
 to test installation and setup procedures for the `instrumental_tools` command. You must have [Vagrant](https://www.vagrantup.com/) installed; currently the KitchenCI integration is setup to use [VMWare Fusion](http://www.vmware.com/products/fusion) and the [VMWare Fusion Vagrant provider](https://www.vagrantup.com/vmware); you can configure a separate provider for your specific setup by change the `provider` flag in the `.kitchen.yml` file for your particular setup.
+
+## Windows
+
+Ensure you have the `winrm` vagrant plugin installed.
+
+```
+vagrant plugin install vagrant-winrm
+```
+
+
+To ensure you have a Windows Vagrant image, perform the following steps in a separate directory to build a Windows evaluation image:
+
+```
+git clone https://github.com/boxcutter/windows.git
+cd windows
+make virtualbox/eval-win2012r2-standard
+vagrant box add windows-2012r2 ./box/virtualbox/eval-win2012r2-standard-nocm-1.0.4.box
+```

data/bin/instrument_server

@@ -27,19 +27,28 @@ def require_api_key(options, parser)
   end
 end
 
+def coerce_path(path)
+  if File::ALT_SEPARATOR
+    File.join(*path.split(File::ALT_SEPARATOR))
+  else
+    path
+  end
+end
+
 
 cur_directory         = Dir.pwd
 home_directory        = Dir.home rescue nil
 script_location       = File.expand_path(File.dirname(__FILE__))
 tmp_dir               = Dir.tmpdir
 script_data_directory = [cur_directory, home_directory, script_location, tmp_dir].compact.detect { |dir| File.writable?(dir) }
+windows               = RUBY_PLATFORM =~ /(mswin|win32|mingw)/i
 
 default_script_directory = File.join(script_data_directory, '.instrumental_scripts')
 default_command          = :foreground
 
 options = {
   :collector       => 'collector.instrumentalapp.com',
-  :port            => '8000',
+  :port            => '8001',
   :hostname        => Socket.gethostname,
   :pid_location    => File.join(script_data_directory, 'instrument_server.pid'),
   :log_location    => File.join(script_data_directory, 'instrument_server.log'),
@@ -63,13 +72,13 @@ Default command: #{default_command.to_s}
   end
 
   opts.on('-f', '--config-file PATH', "Config file with location of your API key (default #{options[:config_file]})") do |path|
-    options[:config_file] = path
+    options[:config_file] = coerce_path(path)
   end
 
   opts.on('-c', '--collector COLLECTOR[:PORT]', "Collector (default #{options[:collector]}:#{options[:port]})") do |collector|
-    address, port = collector.split(':')
+    address, port       = collector.split(':')
     options[:collector] = address
-    options[:port] = port if port
+    options[:port]      = port if port
   end
 
   opts.on('-H', '--hostname HOSTNAME', "Hostname to report as (default #{options[:hostname]})") do |hostname|
@@ -77,11 +86,11 @@ Default command: #{default_command.to_s}
   end
 
   opts.on('-p', '--pid LOCATION', "Where daemon PID file is located (default #{options[:pid_location]})") do |pid_location|
-    options[:pid_location] = pid_location
+    options[:pid_location] = coerce_path(pid_location)
   end
 
   opts.on('-l', '--log LOCATION', "Where to put the instrument_server log file (default #{options[:log_location]})") do |log_location|
-    options[:log_location] = log_location
+    options[:log_location] = coerce_path(log_location)
   end
 
   opts.on('-r', '--report-interval INTERVAL_IN_SECONDS', "How often to report metrics to Instrumental (default #{options[:report_interval]})") do |interval|
@@ -93,15 +102,17 @@ Default command: #{default_command.to_s}
   end
 
   opts.on('-s', '--script-location PATH_TO_DIRECTORY', "Directory where local scripts for custom metrics are located (default #{options[:script_location]})") do |path|
-    options[:script_location] = path
+    options[:script_location] = coerce_path(path)
   end
 
-  opts.on('-u', '--user USER_TO_RUN_AS', "User to run instrument_server as. You must have permissions to drop privileges to this user.") do |u|
-    options[:user] = u
+  if !windows
+    opts.on('-u', '--user USER_TO_RUN_AS', "User to run instrument_server as. You must have permissions to drop privileges to this user.") do |u|
+      options[:user] = u
+    end
   end
 
   opts.on('-t', '--temp-dir TEMP_DIRECTORY', "Where to store temporary files (default #{options[:tmp_location]})") do |t|
-    options[:tmp_location] = t
+    options[:tmp_location] = coerce_path(t)
   end
 
   opts.on('--debug', "Print all sent metrics to the log") do
@@ -112,11 +123,16 @@ Default command: #{default_command.to_s}
     puts opts
     exit
   end
+
+  opts.on('-v', '--version', 'Display version') do
+    puts "instrument_server: #{Instrumental::Tools::VERSION}"
+    exit 0
+  end
 end
 
 option_parser.parse!
 
-if options[:user]
+if options[:user] && !windows
   desired_uid = Etc.getpwnam(options[:user]).uid
   Process::Sys.setuid(desired_uid)
   if desired_uid && desired_uid != 0
@@ -171,11 +187,11 @@ if options[:enable_scripts]
     raise "The directory #{options[:script_location]} does not exist."
   end
 
-  stat = File::Stat.new(File.expand_path(options[:script_location]))
-
-  if !stat.owned? || ((stat.mode & 0xFFF) ^ 0O700) != 0
+  stat         = File::Stat.new(File.expand_path(options[:script_location]))
+  correct_mode = windows || ((stat.mode & 0xFFF) ^ 0O700) === 0
+  unless stat.owned? && correct_mode
     uid      = Process.uid
-    username = Etc.getpwuid(uid).name
+    username = Etc.getpwuid(uid).try(:name)
     raise "The directory #{options[:script_location]} is writable/readable by others. Please ensure it is only writable / readable by user/uid #{username}/#{uid}"
   end
 

data/chef/.kitchen.yml

@@ -1,16 +1,25 @@
 ---
 driver:
   name: vagrant
-  provider: vmware_fusion
+  synced_folders:
+    - ["../", "/tools-root"]
+  customize:
+    memory: 2048
 
 provisioner:
   name: chef_solo
+  chef_omnibus_url: "https://raw.githubusercontent.com/expectedbehavior/instrumental_tools/master/chef/omnibus.sh"
 
 platforms:
   - name: ubuntu-12.04
   - name: centos-6.6
+  - name: "d11wtq/gentoo"
+  - name: "windows-2012r2"
 
 suites:
   - name: default
     run_list: ["instrumental_tools"]
     attributes:
+      instrumental:
+        use_local: true
+        local_path: "/tools-root/"

data/chef/instrumental_tools/attributes/default.rb

@@ -1,2 +1,29 @@
-default[:instrumental] = {}
-default[:instrumental][:api_key] = nil
+default[:instrumental]                   = {}
+default[:instrumental][:api_key]         = nil
+
+default[:instrumental][:version]         = "1.1.2"
+default[:instrumental][:repo]            = "https://s3.amazonaws.com/instrumental-tools"
+
+default[:instrumental][:curl_path]       = "/usr/bin/curl"
+default[:instrumental][:wget_path]       = "/usr/bin/wget"
+
+default[:instrumental][:dest_init_file]  = "/etc/init.d/instrument_server"
+
+default[:instrumental][:enable_scripts]  = false
+
+
+if node[:platform_family] == "windows"
+  default[:instrumental][:destination_dir] = "C:\\Program Files (x86)\\Instrumental Tools"
+  default[:instrumental][:config_file]     = "C:\\Program Files (x86)\\Instrumental Tools\\etc\\instrumental.yml"
+  default[:instrumental][:script_dir]      = "C:\\Program Files (x86)\\Instrumental Tools\\scripts"
+else
+  default[:instrumental][:destination_dir] = "/opt/instrumental-tools/"
+  default[:instrumental][:config_file]     = "/etc/instrumental.yml"
+  default[:instrumental][:script_dir]      = "/opt/instrumental-tools/.scripts"
+  default[:instrumental][:pid_file]        = "/opt/instrumental-tools/instrument_server.pid"
+  default[:instrumental][:log_file]        = "/opt/instrumental-tools/instrument_server.log"
+  default[:instrumental][:user]            = "nobody"
+end
+
+default[:instrumental][:use_local]       = false
+default[:instrumental][:local_path]      = nil

data/chef/instrumental_tools/recipes/default.rb

@@ -1,21 +1,192 @@
-packagecloud_repo "expectedbehavior/instrumental" do
-  case node["platform_family"]
-  when "debian"
-    type "deb"
-  when "rhel"
-    type "rpm"
+supported_platforms = %w{debian rhel fedora arch gentoo slackware suse}
+version   = node["instrumental"]["version"]
+arch      = case node["kernel"]["machine"]
+            when "i386"
+              "x86"
+            else
+              node["kernel"]["machine"]
+            end
+pkg_arch  = case node["kernel"]["machine"]
+            when "x86_64"
+              "amd64"
+            else
+              node["kernel"]["machine"]
+            end
+file_name = case node["platform_family"]
+            when "osx"
+              "instrumental-tools_%s_osx.tar.gz" % version
+            when "debian"
+              "instrumental-tools_%s_%s.deb" % [version, pkg_arch]
+            when "rhel", "fedora"
+              "instrumental-tools_%s_%s.rpm" % [version, pkg_arch]
+            when "windows"
+              "instrumental-tools_%s_win32.exe" % version
+            else
+              "instrumental-tools_%s_linux-%s.tar.gz" % [version, arch]
+            end
+
+local_path          = ::File.join(node[:instrumental][:local_path], file_name)
+dest_dir            = node[:instrumental][:destination_dir]
+conf_file           = node[:instrumental][:config_file]
+remote_name         = "%s/%s/%s" % [node[:instrumental][:repo], version, file_name]
+package_destination = ::File.join(dest_dir, file_name)
+
+case node["platform_family"]
+when "debian", "rhel", "fedora"
+  if node[:instrumental][:use_local]
+    package "instrumental-tools" do
+      action :install
+      source local_path
+      provider node["platform_family"] == "debian" ? Chef::Provider::Package::Dpkg : Chef::Provider::Package::Yum
+    end
+  else
+    packagecloud_repo "expectedbehavior/instrumental" do
+      case node["platform_family"]
+      when "debian"
+        type "deb"
+      when "rhel", "fedora"
+        type "rpm"
+      end
+    end
+
+    package "instrumental-tools" do
+      action :upgrade
+      version node["instrumental"]["version"]
+    end
   end
-end
 
-package "instrumental-tools" do
-  action :upgrade
-end
+  template conf_file do
+    source "instrumental.yml.erb"
+    mode   "0440"
+    owner  "nobody"
+    variables(
+      :api_key => node[:instrumental][:api_key]
+    )
+  end
+
+  template node["instrumental"]["dest_init_file"] do
+    source "instrument_server.erb"
+    mode "0755"
+    owner "nobody"
+    variables(
+      :dest_dir       => dest_dir,
+      :config_file    => conf_file,
+      :enable_scripts => !!node[:instrumental][:enable_scripts],
+      :script_dir     => node[:instrumental][:script_dir],
+      :log_file       => node[:instrumental][:log_file],
+      :pid_file       => node[:instrumental][:pid_file],
+      :user           => node[:instrumental][:user]
+    )
+  end
+
+  service "instrument_server" do
+    action :restart
+  end
+
+when "arch", "gentoo", "slackware", "suse", "osx"
+
+  local_path = "%s/%s" % [dest_dir, file_name]
+
+  directory dest_dir do
+    owner "nobody"
+    action :create
+    recursive true
+  end
 
-template "/etc/instrumental.yml" do
-  source "instrumental.yml.erb"
-  mode   "0440"
-  owner  "nobody"
-  variables(
-    :api_key => node[:instrumental][:api_key]
-  )
+
+  if node[:instrumental][:use_local]
+    execute "copy_instrumental_tools_package" do
+      command "cp %s %s" % [local_path, package_destination]
+      cwd dest_dir
+      user "nobody"
+    end
+  else
+    remote_file package_destination do
+      source remote_name
+      user "nobody"
+    end
+  end
+
+  execute "untar_instrumental_tools_package" do
+    command "tar --strip-components=3 -zxvf %s" % file_name
+    user "nobody"
+    cwd dest_dir
+    only_if { ::File.exists?(local_path) }
+  end
+
+  template node["instrumental"]["dest_init_file"] do
+    source "instrument_server.erb"
+    mode "0755"
+    owner "nobody"
+    variables(
+      :dest_dir       => dest_dir,
+      :config_file    => conf_file,
+      :enable_scripts => !!node[:instrumental][:enable_scripts],
+      :script_dir     => node[:instrumental][:script_dir],
+      :log_file       => node[:instrumental][:log_file],
+      :pid_file       => node[:instrumental][:pid_file],
+      :user           => node[:instrumental][:user]
+    )
+  end
+
+  template conf_file do
+    source "instrumental.yml.erb"
+    mode   "0440"
+    owner  "nobody"
+    variables(
+      :api_key => node[:instrumental][:api_key]
+    )
+  end
+
+  service "instrument_server" do
+    action [:enable, :start]
+    status_command "pgrep instrument_server"
+    supports :restart => true, :reload => true, :status => false
+  end
+when "windows"
+
+  directory dest_dir do
+    action :create
+    recursive true
+  end
+
+  if node[:instrumental][:enable_scripts]
+    directory node[:instrumental][:script_dir] do
+      action :create
+      recursive true
+    end
+  end
+
+  extra_args = if node[:instrumental][:enable_scripts]
+                 '/SD "%s" /E' % node[:instrumental][:script_dir]
+               else
+                 ""
+               end
+
+  if node[:instrumental][:use_local]
+    execute "install-tools" do
+      command 'call "%s" %s /S /D=%s' % [local_path, extra_args, dest_dir]
+    end
+  else
+    remote_file package_destination do
+      source remote_name
+      action :create
+    end
+    execute "install-tools" do
+      command 'call "%s" %s /S /D=%s' % [package_destination, extra_args, dest_dir]
+    end
+  end
+
+  template conf_file do
+    source "instrumental.yml.erb"
+    variables(
+      :api_key => node[:instrumental][:api_key]
+    )
+  end
+
+  service "Instrument Server" do
+    action [:enable, :start]
+  end
+else
+  Chef::Log.warn("The platform %s is not supported, instrumental_tools will not be installed" % node["platform_family"])
 end

data/chef/instrumental_tools/templates/default/instrument_server.erb

@@ -0,0 +1,46 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          instrument_server
+# Required-Start:    $all
+# Required-Stop:     $all
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Start instrument_server at boot to provide system metrics
+# Description:       Report system level metrics to the Instrumental service (https://instrumentalapp.com/)
+### END INIT INFO
+
+set -e
+
+DIRECTORY="<%= @dest_dir %>"
+CONFIG_FILE="<%= @config_file %>"
+TMPDIR=$DIRECTORY
+PID="<%= @pid_file %>"
+LOG="<%= @log_file %>"
+SCRIPT_LOCATION="<%= @script_dir %>"
+USER_TO_RUN_AS="<%= @user %>"
+ARGS="-f ${CONFIG_FILE} -p ${PID} -l ${LOG} -s ${SCRIPT_LOCATION} -u ${USER_TO_RUN_AS} -t ${TMPDIR} <%= '-e' if @enable_scripts %>"
+PROCESS="${DIRECTORY}instrument_server ${ARGS}"
+
+case "$1" in
+  start)
+    $PROCESS start
+    ;;
+  stop)
+    $PROCESS stop
+    ;;
+  restart)
+    $PROCESS restart
+    ;;
+  status)
+    $PROCESS status
+    ;;
+  force-reload)
+    $PROCESS stop && $PROCESS clean && $PROCESS start
+    ;;
+  *)
+    echo "Usage: /etc/init.d/instrumental-tools {start|stop|restart|status}"
+    exit 1
+    ;;
+esac
+
+exit 0