threez/ruby-vmstat

View on GitHub
lib/vmstat/memory.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Vmstat
  # Gathered memory data snapshot.
  # @attr [Fixnum] pagesize
  #   The page size of the memory in bytes.
  # @attr [Fixnum] wired
  #   The number of wired pages in the system.
  # @attr [Fixnum] active
  #   The number of active pages in the system.
  # @attr [Fixnum] inactive
  #   The number of inactive pages in the system.
  # @attr [Fixnum] free
  #   The number of free pages in the system.
  # @attr [Fixnum] pageins
  #   The number of pageins.
  # @attr [Fixnum] pageouts
  #   The number of pageouts.
  class Memory < Struct.new(:pagesize, :wired, :active, :inactive, :free,
                            :pageins, :pageouts)
    # Calculate the wired bytes based of the wired pages.
    # @return [Fixnum] wired bytes
    def wired_bytes
      wired * pagesize
    end

    # Calculate the active bytes based of the active pages.
    # @return [Fixnum] active bytes
    def active_bytes
      active * pagesize
    end

    # Calculate the inactive bytes based of the inactive pages.
    # @return [Fixnum] inactive bytes
    def inactive_bytes
      inactive * pagesize
    end

    # Calculate the free bytes based of the free pages.
    # @return [Fixnum] free bytes
    def free_bytes
      free * pagesize
    end

    # Calculate the total bytes based of all pages
    # @return [Fixnum] total bytes
    def total_bytes
      (wired + active + inactive + free) * pagesize
    end
  end

  # @attr [Fixnum] available
  #   The estimated available memory (linux)
  #   See: https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=34e431b0ae398fc54ea69ff85ec700722c9da773
  class LinuxMemory < Memory
    attr_accessor :available

    # Calculate the available bytes based of the active pages.
    # @return [Fixnum] active bytes
    def available_bytes
      available * pagesize
    end
  end
end