virtop 0.0.9 → 0.0.10

data/bin/virtop

@@ -78,6 +78,7 @@ begin
 	Ncurses.noecho
 	Ncurses.halfdelay( 10 )
 
+	# Default sorting by first column (domain name).
 	sortBy = 0
 
 	while( true )
@@ -86,25 +87,23 @@ begin
 		n.intrflush( false )
 		n.keypad( true )
 
-		info = c.node_get_info
-
+		# Add topmost meta information lines to ncurses screen.
 		n.addstr(
 			c.hostname.upcase +
 			"\n" +
-			' cores ' + info.cores.to_s +
-			' cpus '  + info.cpus.to_s +
-			' mhz '   + info.mhz.to_s +
-			' arch '  + info.model.to_s +
+			' cores ' + c.cores +
+			' cpus ' + c.cpus +
+			' ghz ' + c.ghz +
+			' arch ' + c.arch +
 			"\n" +
-			' mem '   + info.memory.to_s +
-			' nodes ' + info.nodes.to_s +
-			' sockets ' + info.sockets.to_s +
-			' threads ' + info.threads.to_s +
+			' mem ' + c.mem +
+			' free ' + c.memfree +
 			"\n" +
-			' version ' + c.libversion.to_s +
+			' version ' + c.version +
 			"\n\n"
 		)
 
+		# Initialize table (columns).
 		t = Table.new(
 			'NAME',
 			'STATE',
@@ -114,6 +113,7 @@ begin
 			'CPU_TIME'
 		)
 
+		# Add information of each domain to table.
 		c.domains.each do |d|
 			t.add_row(
 				d.name,
@@ -125,16 +125,22 @@ begin
 			)
 		end
 
+		# Sort table by chosen column.
 		t.sort_by( sortBy )
 
+		# Convert table to array of padded strings and add them to ncurses
+		# screen.
 		t.format.each do |line|
 			n.addstr( line )
 		end
 
+		# Wait for single char user input.
 		char = n.getch
 		case( char )
+			# Key '1' till '6'
 			when 49..54
 				sortBy = char - 49
+			# Key 'q'
 			when 113
 				raise( LetsExit )
 		end

data/lib/libvirt/connect.rb

@@ -1,6 +1,7 @@
 # Extend Libvirt::Connect with a method which returns all available domains as
-# an array.
+# an array and several methods to access the host info more easily.
 class Libvirt::Connect
+	# Returns array of domain objects.
 	def domains
 		ret = Array.new
 
@@ -12,4 +13,46 @@ class Libvirt::Connect
 
 		ret
 	end
+
+	# Returns number of cores as string.
+	def cores
+		self.node_get_info.cores.to_s
+	end
+
+	# Returns number of CPUs as string.
+	def cpus
+		self.node_get_info.cpus.to_s
+	end
+
+	# Returns clock speed in GHz.
+	def ghz
+		"%.2f" % ( self.node_get_info.mhz / 1000.0 )
+	end
+
+	# Returns CPU architecture.
+	def arch
+		self.node_get_info.model
+	end
+
+	# Returns total memory in mebibytes as string.
+	def mem
+		( self.node_get_info.memory / 1024 ).to_s + 'M'
+	end
+
+	# Returns memory which is not allocated to virtual machines in mebibytes as
+	# string.
+	def memfree
+		memUsed = 0
+
+		self.domains.each do |domain|
+			memUsed += domain.info.memory
+		end
+
+		( ( self.node_get_info.memory - memUsed ) / 1024 ).to_s + 'M'
+	end
+
+	# Returns the libvirt version number.
+	def version
+		self.libversion.to_s
+	end
 end

data/lib/libvirt/domain.rb

@@ -1,10 +1,12 @@
 # Extend Libvirt::Domain with different methods for human readable display of
 # the domain state.
 class Libvirt::Domain
+	# Default string representation of domain object is the domain's name.
 	def to_s
 		self.name
 	end
 
+	# Return state as string symbol.
 	def state
 		case( self.info.state )
 			when 1
@@ -16,18 +18,23 @@ class Libvirt::Domain
 		end
 	end
 
+	# Return current memory assignment in mebibytes as string.
 	def mem
 		( self.info.memory / 1024 ).to_s + "M"
 	end
 
+	# Return maximum memory assignment in mebibytes as string.
 	def mem_max
 		( self.info.max_mem / 1024 ).to_s + "M"
 	end
 
+	# Return the number of assigned virtual CPUs as string.
 	def cpu_num
 		self.info.nr_virt_cpu.to_s
 	end
 
+	# Return time the virtual domain's CPU was scheduled as string formatted
+	# d-hh:mm:ss.
 	def cpu_time
 		t = self.info.cpu_time / 10**9
 

data/lib/virtop.rb

@@ -1,7 +1,7 @@
 require( 'libvirt' )
 
 module Virtop
-	VERSION = '0.0.9'
+	VERSION = '0.0.10'
 end
 
 $:.unshift( File.dirname( __FILE__ ) )

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: virtop
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - henning mueller
@@ -44,11 +44,11 @@ extra_rdoc_files: []
 
 files: 
 - bin/virtop
-- lib/libvirt/connect.rb
-- lib/libvirt/domain.rb
-- lib/virtop.rb
-- lib/virtop/table.rb
 - lib/virtop/letsexit.rb
+- lib/virtop/table.rb
+- lib/virtop.rb
+- lib/libvirt/domain.rb
+- lib/libvirt/connect.rb
 - README.rdoc
 has_rdoc: true
 homepage: