post_remote_log 1.6.3

data/README.rdoc

@@ -0,0 +1,31 @@
+= PostRemoteLog
+
+Author::    Samuel Williams (http://www.oriontransfer.co.nz/)
+Copyright:: Copyright (C) 2009 Samuel Williams
+License::   GPLv3
+
+PostRemoteLog installs a binary tool "post-remote-log" which collects data about the machine it is being run on, and sends it via XMLRPC or SMTP. It is useful in a system administration scenario when you want to measure statistics over a large number of machines. For example, you can use it as part of login and logout scripts to record when users are logging in and logging out. Additionally, this could record the time it took to log in, and then this could be measured as a performance statistic when deciding to upgrade servers, etc.
+
+Another usage is for recording faults. For example, QuotaCheck.app can hook into post-remote-log to send a notification when a user bypasses the low quota warning. This means that you have a record of the warning, and when the user comes to complain about corrupt files (because the file was saved without enough free space on the users home directory), you can simply tell them to go away and free up space.
+
+PostRemoteLog is very simple and all behavior is controlled using a configuration file. This configuration file specifies how to send the log file and all other details. Here is an example of how to send a log file:
+
+	$ echo "The user has logged in ($seconds)" > post-remote-log "User Event"
+	$ echo "The user has logged out" > post-remote-log "User Event"
+
+The configuration file used by default is <tt>/etc/post-remote-log.yaml</tt> but can be specified using <tt>-c</tt> option.
+
+	$ echo "The user has logged out" > post-remote-log -c specific-config.yaml "User Event"
+
+The command also integrates directly with <tt>daemon-exec</tt>. Ensure that rexec is installed before using this option.
+
+	$ echo "The user has logged out" > post-remote-log -d -c specific-config.yaml "User Event"
+
+This command will relaunch itself using <tt>daemon-exec</tt> which allows the command to run seemlessly in the event of a network outage. The main use for this is when post-remote-log is used in login and logout scripts, which shouldn't be delayed if the network is slow.
+
+Included with this package is a basic rack backend which can be used to aggregate the XMLRPC messages into a directory. This can be used for testing and evaluation. However, there is a web interface under development which stores information in a database.
+
+To use the simple backend, you need to install thin:
+
+	$ sudo gem install thin
+	$ post-remote-log-server

data/bin/post-remote-log

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+if ARGV.delete("-d")
+	exec("daemon-exec", "--stdin", "--", $0, *ARGV)
+end
+
+require 'post_remote_log'
+require 'post_remote_log/simple_xml'
+require 'post_remote_log/methods/xmlrpc'
+require 'post_remote_log/methods/email'
+
+require 'yaml'
+
+OPTIONS = {
+	:config => "/etc/post-remote-log.conf"
+}
+
+ARGV.options do |o|
+	script_name = File.basename($0)
+
+	o.set_summary_indent("\t")
+	o.banner = "Usage: #{script_name} [options] [classification] < log-data.txt"
+	o.define_head "Copyright (c) 2010 Samuel Williams <http://www.oriontransfer.co.nz/>."
+
+	o.on("-c config.yaml", String, "Configuration file; defaults to #{OPTIONS[:config]}") do |path|
+		OPTIONS[:config] = path
+	end
+
+	o.on("-d", "Run in background as a daemon. Requires daemon-exec.") do
+		# This option is handled above.
+	end
+end.parse!
+
+# Load the configuration
+if File.exists?(OPTIONS[:config])
+	$config = YAML::load(File.read(OPTIONS[:config])).symbolize_keys
+	$config[:classification] ||= "Generic Log"
+else
+	$stderr.puts "Error: Could not load configuration file #{OPTIONS[:config]}!"
+	raise
+end
+
+# Read the log information from stdin:
+report = $stdin.read.strip
+$stdin.close
+
+if report.size == 0
+	$stderr.puts "Error: No report supplied, exiting!"
+	exit(1)
+end
+
+# Build a set of important values which will be logged:
+$values = {
+	:classification => ARGV[0] || $config[:classification],
+	:uptime => `uptime`.strip,
+	:system => `uname -a`.strip,
+	:hostname => `hostname`.strip,
+	:address => `ifconfig`.match(/[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}/i)[0],
+	:user => `whoami`.strip,
+	:report => report
+}
+
+$methods = {
+	:xmlrpc => PostRemoteLog::Methods::XMLRPC,
+	:email => PostRemoteLog::Methods::Email
+}
+
+$config[:methods].values.each do |config|
+	begin
+		next if config[:disabled] == true
+
+		method = $methods[config[:method].to_sym]
+
+		method.send(config, $values)
+	rescue => ex
+		puts ex.to_s
+		puts ex.backtrace
+	end
+end

data/bin/post-remote-log-server

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rack'
+require 'thin'
+
+require 'post_remote_log'
+require 'post_remote_log/server'
+
+
+OPTIONS = {
+	:host => "0.0.0.0",
+	:port => "9080",
+	:dump_path => File.join(Dir.pwd, "logs")
+}
+
+Thin::Server.start(OPTIONS[:host], OPTIONS[:port], PostRemoteLog::Server.new(OPTIONS))

data/lib/post_remote_log.rb

@@ -0,0 +1,16 @@
+# Copyright (c) 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'post_remote_log/extensions'

data/lib/post_remote_log/extensions.rb

@@ -0,0 +1,28 @@
+
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module HashExtensions
+  def symbolize_keys
+    inject({}) do |acc, (k,v)|
+      key = String === k ? k.to_sym : k
+      value = Hash === v ? v.symbolize_keys : v
+      acc[key] = value
+      acc
+    end
+  end
+end
+
+Hash.send(:include, HashExtensions)

data/lib/post_remote_log/methods/email.rb

@@ -0,0 +1,101 @@
+# Copyright (c) 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'post_remote_log/xml'
+require 'net/smtp'
+require 'digest'
+
+module PostRemoteLog
+	module Methods
+
+		class Email
+			def self.send(config, values)
+				message = PostRemoteLog.build_xml_message(values)
+
+				email = StringIO.new
+				marker = Digest::MD5.hexdigest(Time.now.to_s)
+
+				from = "#{values[:user]}@#{values[:hostname]}"
+				to = config[:to]
+
+				email.puts "From: #{from}"
+				email.puts "To: #{to}"
+				email.puts "Subject: Remote Log: #{values[:classification]}"
+				email.puts "MIME-Version: 1.0"
+				email.puts "Content-Type: multipart/mixed; boundary=#{marker}"
+				email.puts
+				email.puts "--#{marker}"
+				email.puts "Content-Type: text/plain"
+				email.puts "Content-Transfer-Encoding: 8bit"
+				email.puts
+				email.puts "A remote log was created and sent at #{Time.now.to_s}. Here are the details:"
+				
+				[:classification, :user, :uptime, :system, :hostname, :address].each do |key|
+					email.puts "\t#{key}: #{values[key]}"
+				end
+				
+				email.puts
+				
+				email.puts values[:report]
+				
+				email.puts
+				email.puts
+				email.puts "--#{marker}"
+				email.puts "Content-Type: text/xml; name=\"remote_log.xml\""
+				email.puts "Content-Transfer-Encoding:base64"
+				email.puts "Content-Disposition: attachment; filename=\"remote_log.xml\""
+				email.puts
+				
+				email.puts [message.string].pack("m")
+				
+				email.puts
+				email.puts "--#{marker}"
+				email.puts "Content-Type: text/plain; name=\"report.txt\""
+				email.puts "Content-Transfer-Encoding:base64"
+				email.puts "Content-Disposition: attachment; filename=\"report.txt\""
+				email.puts
+				
+				email.puts [values[:report]].pack("m")
+				
+				email.puts "--#{marker}--"
+
+				smtp = Net::SMTP.new(config[:host], config[:port])
+				
+				begin
+					if config[:tls]
+						unless smtp.respond_to? :enable_starttls
+							raise ArgumentError.new("STARTTLS is not supported by this version of Ruby.")
+						end
+						
+						context = Net::SMTP.default_ssl_context
+						context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+						
+						smtp.enable_starttls(context)
+					end
+					
+					smtp.start(values[:hostname], config[:user], config[:pass], config[:auth])
+					
+					smtp.sendmail(email.string, from, [to])
+					
+					$stderr.puts "Remote log created successfully."
+				ensure
+					smtp.finish
+				end
+			end
+		end
+
+	end
+end
+

data/lib/post_remote_log/methods/xmlrpc.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'post_remote_log/xml'
+require 'net/http'
+
+module PostRemoteLog
+	module Methods
+
+		class XMLRPC
+			def self.send(config, values)
+				message = PostRemoteLog.build_xml_message(values)
+
+				Net::HTTP.start(config[:host], config[:port]) do |http|
+					response = http.post(config[:path], message.string, {"Content-Type" => "text/xml"})
+
+					unless (200...300).include?(response.code.to_i)
+						$stderr.puts "Could not create remote log record..."
+
+						$stderr.puts "Code: #{response.code}" 
+						$stderr.puts "Message: #{response.message}"
+						$stderr.puts "Body:\n #{response.body}"
+					else
+						$stderr.puts "Remote log created successfully."
+					end
+				end
+			end
+		end
+
+	end
+end

data/lib/post_remote_log/server.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'fileutils'
+require 'time'
+
+module PostRemoteLog
+	
+	class Server
+		def initialize(config = {})
+			@dump_dir = config[:dump_path]
+			
+			$stderr.puts "Dumping data to #{@dump_dir}"
+			FileUtils.mkdir_p(@dump_dir)
+		end
+		
+		def call(env)
+			request = Rack::Request.new(env)
+			
+			if request.post?
+				data = request.body().read()
+				
+				now = Time.now
+				file_name = "#{now.strftime('%Y%m%d_%H%M%S')}_#{now.usec}.xml"
+				full_path = File.join(@dump_dir, file_name)
+				
+				$stderr.puts "Writing data to #{file_name}..."
+				
+				File.open(full_path, "w") { |f| f.write(data) }
+			end
+			
+			return [200, {}, []]
+		end
+	end
+	
+end

data/lib/post_remote_log/simple_xml.rb

@@ -0,0 +1,52 @@
+# Copyright (c) 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'stringio'
+
+module PostRemoteLog
+	
+	# Very simple XML builder to minimize dependencies:
+	class SimpleXMLBuilder < StringIO
+	  X = {"<" => "&lt;", ">" => "&gt;"}
+  
+	  def initialize
+	    super
+    
+	    @level = 0
+	  end
+  
+	  def instruct!
+	    self.puts '<?xml version="1.0" encoding="UTF-8"?>'
+	  end
+  
+	  def value(name, value)
+	    value.gsub!(/<|>/) { |s| X[s] }
+	    self.puts tab +  "<#{name}>" + value.to_s + "</#{name}>"
+	  end
+  
+	  def tag(name, &block)
+	    self.puts tab + "<#{name}>"
+	    @level += 1
+	    yield
+	    @level -= 1
+	    self.puts tab + "</#{name}>"
+	  end
+  
+	  protected
+	  def tab
+	    ("\t" * @level)
+	  end
+	end
+end

data/lib/post_remote_log/version.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module PostRemoteLog
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 6
+    TINY  = 3
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/post_remote_log/xml.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module PostRemoteLog
+	
+	# Builds an XML formatted message from the supplied values
+	def self.build_xml_message (values)
+		message = SimpleXMLBuilder.new
+
+		message.instruct!
+
+		message.tag("remote_log") do
+			[:classification, :uptime, :system, :hostname, :address, :report].each do |key|
+				message.value key.to_s, values[key]
+			end
+		end
+
+		return message
+	end
+
+	
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: post_remote_log
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 6
+  - 3
+  version: 1.6.3
+platform: ruby
+authors: 
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-13 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rexec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+executables: 
+- post-remote-log
+- post-remote-log-server
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/post_remote_log/extensions.rb
+- lib/post_remote_log/methods/email.rb
+- lib/post_remote_log/methods/xmlrpc.rb
+- lib/post_remote_log/server.rb
+- lib/post_remote_log/simple_xml.rb
+- lib/post_remote_log/version.rb
+- lib/post_remote_log/xml.rb
+- lib/post_remote_log.rb
+- bin/post-remote-log
+- bin/post-remote-log-server
+- README.rdoc
+has_rdoc: true
+homepage: http://www.oriontransfer.co.nz/software/post-remote-log
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: A simple messaging system built on top of Ruby, designed for system administration.
+test_files: []
+