Module: LinuxStat::ProcessInfo
- Defined in:
- lib/linux_stat/process_info.rb
Overview
Shows various information about a process that is either running, sleeping, idle or a zombie. Most methods can take a PID, but some uses polling to calculate something, they can accept options instead of arguments. Consult the documentation on the specific methods for more details on that.
Class Method Summary collapse
-
.cmdline(pid = $$) ⇒ Object
cmdline(pid = $$).
-
.command_name(pid = $$) ⇒ Object
command_name(pid = $$) Not to be confused with process_name It just splits the cmdline to show the command name.
-
.cpu_stat(pid: $$, sleep: ticks_to_ms_t5) ⇒ Object
cpu_stat(pid: $$, sleep: 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5).
-
.cpu_time(pid = $$) ⇒ Object
def cpu_times_i(pid = $$).
-
.cpu_times(pid = $$) ⇒ Object
def cpu_times(pid = $$).
-
.cpu_usage(pid: $$, sleep: ticks_to_ms_t5) ⇒ Object
cpu_usage(pid: $$, sleep: 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5).
-
.gid(pid = $$) ⇒ Object
gid(pid = $$).
-
.last_executed_cpu(pid = $$) ⇒ Object
last_executed_cpu(pid = $$).
-
.mem_stat(pid = $$) ⇒ Object
mem_stat(pid = $$).
-
.memory(pid = $$) ⇒ Object
memory(pid = $$).
-
.nice(pid = $$) ⇒ Object
nice(pid = $$) Returns the nice of the process.
-
.nproc(pid = $$) ⇒ Object
(also: count_cpu)
nproc(pid = $$) Returns the cpu allocated to the process.
-
.owner(pid = $$) ⇒ Object
owner(pid = $$).
-
.process_name(pid = $$) ⇒ Object
process_name(pid = $$) It shows the filename of the command Sometimes the filename is stripped.
-
.resident_memory(pid = $$) ⇒ Object
resident_memory(pid = $$).
-
.running_time(pid = $$) ⇒ Object
running_time(pid = $$).
-
.shared_memory(pid = $$) ⇒ Object
shared_memory(pid = $$).
-
.start_time(pid = $$) ⇒ Object
start_time(pid = $$).
-
.start_time_epoch(pid = $$) ⇒ Object
start_time_epoch(pid = $$).
-
.state(pid = $$) ⇒ Object
state(pid = $$) Returns the state of the process as a frozen String.
-
.thread_usage(pid: $$, sleep: ticks_to_ms_t5) ⇒ Object
thread_usage(pid: $$, sleep: 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5).
-
.threads(pid = $$) ⇒ Object
threads(pid = $$).
-
.total_io(pid = $$) ⇒ Object
total_io(pid = $$).
-
.uid(pid = $$) ⇒ Object
uid(pid = $$).
-
.virtual_memory(pid = $$) ⇒ Object
virtual_memory(pid = $$).
Class Method Details
.cmdline(pid = $$) ⇒ Object
cmdline(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the total command of the process.
The output is String. For example:
LinuxStat::ProcessInfo.cmdline
"ruby -r linux_stat -e p LinuxStat::ProcessInfo.cmdline"
If the info isn’t available it will return an empty frozen String.
61 62 63 64 65 66 67 68 |
# File 'lib/linux_stat/process_info.rb', line 61 def cmdline(pid = $$) file = "/proc/#{pid}/cmdline".freeze return ''.freeze unless File.readable?(file) _cmdline = IO.read(file) _cmdline.gsub!(?\u0000, ?\s) _cmdline.tap(&:strip!) end |
.command_name(pid = $$) ⇒ Object
command_name(pid = $$)
Not to be confused with process_name It just splits the cmdline to show the command name
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the total command name of the process.
The output is String. For example:
LinuxStat::ProcessInfo.command_name
"ruby"
If the info isn’t available it will return an empty frozen String.
87 88 89 90 91 92 93 |
# File 'lib/linux_stat/process_info.rb', line 87 def command_name(pid = $$) # Do note that the /proc/ppid/comm may not contain the full name # It's limited by TASK_COMM_LEN (16) characters c = cmdline(pid).split[0] return ''.freeze unless c File.split(c)[-1] end |
.cpu_stat(pid: $$, sleep: ticks_to_ms_t5) ⇒ Object
cpu_stat(pid: $$, sleep: 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5)
Where pid is the process ID and sleep time is the interval between measurements.
By default it is the id of the current process ($$), and sleep is LinuxStat::Sysconf.sc_clk_tck
The smallest amount of available sleep time is 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5.
-
Note 1:
-
Do note that the sleep time can slow down your application.
-
And it’s only needed for the cpu usage calculation.
It retuns the CPU usage, threads, and the last executed CPU in Hash.
For example:
LinuxStat::ProcessInfo.cpu_stat
=> {:cpu_usage=>0.0, :threads=>1, :last_executed_cpu=>1}
But if the info isn’t available, it will return an empty Hash.
The :cpu_usage is in percentage. It’s also divided with the number of CPU.
:cpu_usage for example, will return 25.0 if the CPU count is 4, and the process is using 100% of a thread / core.
A value of 100.0 indicates it is using 100% processing power available to the system.
The :threads returns the number of threads for the process. The value is a Integer.
-
Note 2:
-
If you just need the CPU usage run LinuxStat::ProcessInfo.cpu_usage(pid = $$)
-
If you just need the threads run LinuxStat::ProcessInfo.threads(pid = $$)
-
If you just need the last executed CPU run LinuxStat::ProcessInfo.last_executed_cpu(pid = $$)
-
Running this method is slower and it opens multiple files at once
Only use this method if you need all of the data at once, in such case, it’s more efficient to use this method.
The :last_executed_cpu also returns an Integer indicating the last executed cpu of the process.
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/linux_stat/process_info.rb', line 280 def cpu_stat(pid: $$, sleep: ticks_to_ms_t5) ticks = get_ticks stat = LinuxStat::ProcFS.ps_stat(pid) uptime = LS::ProcFS.uptime_f return {} unless uptime && !stat.empty? utime, stime, starttime = *stat.values_at(10, 11, 18).map(&:to_f) uptime *= ticks total_time = utime + stime idle1 = uptime - starttime - total_time sleep(sleep) stat = LinuxStat::ProcFS.ps_stat(pid) uptime = LS::ProcFS.uptime_f return {} unless uptime && !stat.empty? utime2, stime2, starttime2 = *stat.values_at(10, 11, 18).map(&:to_f) uptime *= ticks total_time2 = utime2 + stime2 idle2 = uptime - starttime2 - total_time2 totald = idle2.+(total_time2).-(idle1 + total_time) cpu_u = totald.-(idle2 - idle1).fdiv(totald).abs.*(100)./(LinuxStat::CPU.count) { cpu_usage: cpu_u > 100 ? 100.0 : cpu_u.round(2), threads: stat[17].to_i, last_executed_cpu: stat[36].to_i } end |
.cpu_time(pid = $$) ⇒ Object
def cpu_times_i(pid = $$)
Shows the CPU time used by the process.
The return value is a Float. But if the info isn’t available, it will return nil.
621 622 623 |
# File 'lib/linux_stat/process_info.rb', line 621 def cpu_time(pid = $$) LinuxStat::ProcFS.ps_times(pid) end |
.cpu_times(pid = $$) ⇒ Object
def cpu_times(pid = $$)
Shows the CPU time used by the process.
The return value is a Hash formatted like this:
LS::ProcessInfo.cpu_times($$)
=> {:hour=>0, :minute=>39, :second=>12, :jiffy=>0.42}
But if the info isn’t available, it will return an empty Hash..
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 |
# File 'lib/linux_stat/process_info.rb', line 636 def cpu_times(pid = $$) v = LinuxStat::ProcFS.ps_times(pid) return {} unless v v_i = v.to_i hour = v_i / 3600 min = v_i % 3600 / 60 sec = v_i % 60 jiffy = v.-(v_i) * 100 { hour: hour, minute: min, second: sec, jiffy: jiffy.to_i } end |
.cpu_usage(pid: $$, sleep: ticks_to_ms_t5) ⇒ Object
cpu_usage(pid: $$, sleep: 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5)
Where pid is the process ID and sleep time is the interval between measurements.
By default it is the id of the current process ($$), and sleep is 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5
The smallest amount of available sleep time is LinuxStat::Sysconf.sc_clk_tck.
It retuns the CPU usage as Float.
For example:
LinuxStat::ProcessInfo.cpu_usage
=> 10.0
10.0 means it’s using 10% of the total processing power of the system.
The value is divided with the configured number of CPU and not online CPU.
A value of 100.0 indicates it is using 100% processing power available to the system.
But if the info isn’t available, it will return nil.
This method is more efficient than running LinuxStat::ProcessInfo.cpu_stat()
340 341 342 343 344 345 346 |
# File 'lib/linux_stat/process_info.rb', line 340 def cpu_usage(pid: $$, sleep: ticks_to_ms_t5) u = cpu_usage_thread(pid, sleep) return nil unless u u /= LinuxStat::CPU.count u > 100 ? 100.0 : u.round(2) end |
.gid(pid = $$) ⇒ Object
gid(pid = $$)
returns the GIDs of the process as an Hash containing the following data:
:real, :effective, :saved_set, :filesystem_uid
If the info isn’t available or the argument passed doesn’t exist as a process ID, it will return an empty Hash.
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 |
# File 'lib/linux_stat/process_info.rb', line 450 def gid(pid = $$) file = "/proc/#{pid}/status".freeze return nil unless File.readable?(file) data = IO.foreach(file.freeze).find { |x| x[/Gid.*\d*/] }.split.drop(1) { real: data[0].to_i, effective: data[1].to_i, saved_set: data[2].to_i, filesystem_uid: data[3].to_i } end |
.last_executed_cpu(pid = $$) ⇒ Object
last_executed_cpu(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the last executed CPU in Integer.
For example:
LinuxStat::ProcessInfo.last_executed_cpu
=> 2
But if the info isn’t available, it will return nil.
This method is way more efficient than running LinuxStat::ProcessInfo.cpu_stat()
416 417 418 |
# File 'lib/linux_stat/process_info.rb', line 416 def last_executed_cpu(pid = $$) LinuxStat::ProcFS.ps_stat(pid)[35] end |
.mem_stat(pid = $$) ⇒ Object
mem_stat(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the memory, virtual memory, and resident memory of the process.
All values are in kilobytes.
The output is a Hash. For example:
LinuxStat::ProcessInfo.mem_stat
{:memory=>8515.584, :virtual_memory=>79781.888, :resident_memory=>13955.072}
-
Note:
-
If you need only memory usage of a process, run LinuxStat::ProcessInfo.memory(pid)
-
If you need only virtual memory for a process, run LinuxStat::ProcessInfo.virtual_memory(pid)
-
If you need only resident memory of a process, run LinuxStat::ProcessInfo.resident_memory(pid)
This method opens opens multiple files.
But if you need all of the info, then running this method once is efficient.
If the info isn’t available it will return an empty Hash.
151 152 153 |
# File 'lib/linux_stat/process_info.rb', line 151 def mem_stat(pid = $$) LinuxStat::ProcFS.statm(pid) end |
.memory(pid = $$) ⇒ Object
memory(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the memory of the process. The value is in kilobytes.
The output is an Integer. For example:
LinuxStat::ProcessInfo.memory
8523.776
If the info isn’t available it will return nil.
171 172 173 |
# File 'lib/linux_stat/process_info.rb', line 171 def memory(pid = $$) LinuxStat::ProcFS.statm_memory(pid) &.fdiv(1000) end |
.nice(pid = $$) ⇒ Object
nice(pid = $$)
Returns the nice of the process
The output value is an Integer ranging from -20 to 19
-20 means the process has high priority, and 19 means the process has low priority
If the info isn’t available or the argument passed doesn’t exist as a process ID, it will return nil.
580 581 582 |
# File 'lib/linux_stat/process_info.rb', line 580 def nice(pid = $$) LinuxStat::ProcFS.ps_stat(pid)[15] end |
.nproc(pid = $$) ⇒ Object Also known as: count_cpu
nproc(pid = $$)
Returns the cpu allocated to the process.
The output value is an Integer.
For example:
$ taskset -c 0 irb
irb(main):001:0> require 'linux_stat'
=> true
irb(main):002:0> LinuxStat::ProcessInfo.nproc
=> 1
irb(main):003:0> LinuxStat::ProcessInfo.nproc 11562
=> 3
irb(main):004:0> LinuxStat::ProcessInfo.nproc 12513
=> 4
If the info isn’t available or the argument passed doesn’t exist as a process ID, it will return nil.
610 611 612 |
# File 'lib/linux_stat/process_info.rb', line 610 def nproc(pid = $$) LinuxStat::Nproc.count_cpu_for_pid(pid) end |
.owner(pid = $$) ⇒ Object
owner(pid = $$)
Returns the owner of the process But if the status is not available, it will return an empty frozen String.
471 472 473 474 475 476 477 478 479 480 |
# File 'lib/linux_stat/process_info.rb', line 471 def owner(pid = $$) file = "/proc/#{pid}/status".freeze return ''.freeze unless File.readable?(file) gid = IO.foreach(file.freeze).find { |x| x[/Gid.*\d*/] }.split.drop(1)[2].to_i LinuxStat::User.username_by_gid(gid) end |
.process_name(pid = $$) ⇒ Object
process_name(pid = $$)
It shows the filename of the command Sometimes the filename is stripped
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the total command name of the process.
The output is String. For example:
LinuxStat::ProcessInfo.process_name
"ruby"
If the info isn’t available it will return an empty frozen String.
112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/linux_stat/process_info.rb', line 112 def process_name(pid = $$) file = "/proc/#{pid}/stat".freeze return command_name unless File.readable?(file) name = IO.read(file).split(/(\(.*\))/) &.[](1) &.[](1..-2) if name && name.length > 0 && name.length < 15 name else command_name end end |
.resident_memory(pid = $$) ⇒ Object
resident_memory(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the resident memory for the process.
The value is in kilobytes.
The output is an Integer. For example:
LinuxStat::ProcessInfo.resident_memory
=> 13996.032
If the info isn’t available it will return nil.
213 214 215 |
# File 'lib/linux_stat/process_info.rb', line 213 def resident_memory(pid = $$) LinuxStat::ProcFS.statm_resident(pid) &.fdiv(1000) end |
.running_time(pid = $$) ⇒ Object
running_time(pid = $$)
Returns the time (in seconds, as Float) the process is running for.
For example:
LinuxStat::ProcessInfo.running_time 14183
=> 1947.61
It always rounds the float number upto 2 decimal places
If the info isn’t available or the argument passed doesn’t exist as a process ID, it will return nil.
542 543 544 545 546 547 |
# File 'lib/linux_stat/process_info.rb', line 542 def running_time(pid = $$) uptime = LS::ProcFS.uptime_f stat = LinuxStat::ProcFS.ps_stat(pid)[18] return nil unless uptime && stat uptime.-(stat.to_f / get_ticks).round(2) end |
.shared_memory(pid = $$) ⇒ Object
shared_memory(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the shared memory for the process.
The value is in kilobytes.
The output is an Integer. For example:
LinuxStat::ProcessInfo.shared_memory
=> 13996.032
If the info isn’t available it will return nil.
234 235 236 |
# File 'lib/linux_stat/process_info.rb', line 234 def shared_memory(pid = $$) LinuxStat::ProcFS.statm_shared(pid) &.fdiv(1000) end |
.start_time(pid = $$) ⇒ Object
start_time(pid = $$)
Returns the time (as Time object) the process was started.
For example:
LinuxStat::ProcessInfo.start_time 14183
=> 2020-12-16 13:31:43 +0000
If the info isn’t available or the argument passed doesn’t exist as a process ID, it will return nil.
The timezone returned based on current TZ. Thus the timezone could be affected by changing the ENV variable.
Don’t trust the timezone returned by the time.
521 522 523 524 525 526 527 |
# File 'lib/linux_stat/process_info.rb', line 521 def start_time(pid = $$) # Getting two Time objects and dealing with floating point numbers # Just to make sure the time goes monotonically _ste = start_time_epoch(pid) return nil unless _ste Time.at(_ste) end |
.start_time_epoch(pid = $$) ⇒ Object
start_time_epoch(pid = $$)
Returns the epoch time (as Integer) the process was started.
For example:
LinuxStat::ProcessInfo.start_time_epoch 526
=> 1608097744
If the info isn’t available or the argument passed doesn’t exist as a process ID, it will return nil.
493 494 495 496 497 498 499 500 501 502 503 |
# File 'lib/linux_stat/process_info.rb', line 493 def start_time_epoch(pid = $$) uptime = LS::ProcFS.uptime_f stat = LinuxStat::ProcFS.ps_stat(pid)[18] return nil unless uptime && stat st = stat.to_f / get_ticks # Getting two Time objects and dealing with floating point numbers # Just to make sure the time goes monotonically unless the clock changes Time.now.-(uptime - st).to_i end |
.state(pid = $$) ⇒ Object
state(pid = $$)
Returns the state of the process as a frozen String
-
A process could have multiple states:
-
S => Sleeping
-
R => Running
-
I => Idle
-
Z => Zombie
It returns any one of them.
If the info isn’t available or the argument passed doesn’t exist as a process ID, it will return an empty String.
567 568 569 |
# File 'lib/linux_stat/process_info.rb', line 567 def state(pid = $$) LinuxStat::ProcFS.ps_state(pid) end |
.thread_usage(pid: $$, sleep: ticks_to_ms_t5) ⇒ Object
thread_usage(pid: $$, sleep: 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5)
Where pid is the process ID and sleep time is the interval between measurements.
By default it is the id of the current process ($$), and sleep is 1.0 / LinuxStat::Sysconf.sc_clk_tck * 5
The smallest amount of available sleep time is LinuxStat::Sysconf.sc_clk_tck.
It retuns the per core CPU usage as Float.
For example:
LinuxStat::ProcessInfo.core_usage
=> 200.0
A value of 100.0 indicates it is using 100% processing power of a core.
The value could be 0 to (100 * the number of CPU threads (including hyperthreading) in the system)
But if the info isn’t available, it will return nil.
370 371 372 373 374 375 376 |
# File 'lib/linux_stat/process_info.rb', line 370 def thread_usage(pid: $$, sleep: ticks_to_ms_t5) u = cpu_usage_thread(pid, sleep) return nil unless u cpu_count_t100 = LinuxStat::CPU.count * 100 u > cpu_count_t100 ? cpu_count_t100 : u.round(2) end |
.threads(pid = $$) ⇒ Object
threads(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the threads for the current process in Integer.
For example:
LinuxStat::ProcessInfo.threads
=> 2
But if the info isn’t available, it will return nil.
This method is way more efficient than running LinuxStat::ProcessInfo.cpu_stat()
395 396 397 |
# File 'lib/linux_stat/process_info.rb', line 395 def threads(pid = $$) LinuxStat::ProcFS.ps_stat(pid)[16] end |
.total_io(pid = $$) ⇒ Object
total_io(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the total read/write caused by a process.
The output is Hash.
For example:
LinuxStat::ProcessInfo.total_io
{:read_bytes=>0, :write_bytes=>0}
The output is only based on the total disk IO the process has done.
If the info isn’t available it will return an empty Hash.
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/linux_stat/process_info.rb', line 30 def total_io(pid = $$) return {} unless File.readable?("/proc/#{pid}/io".freeze) out = {} IO.readlines("/proc/#{pid}/io".freeze).each { |x| x.strip! if x[/^(read|write)_bytes:\s*\d*$/] splitted = x.split out.store(splitted[0].split(?:)[0].to_sym, splitted[-1].to_i) end } out end |
.uid(pid = $$) ⇒ Object
uid(pid = $$)
returns the UIDs of the process as an Array of Integers.
If the info isn’t available it returns an empty Array.
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 |
# File 'lib/linux_stat/process_info.rb', line 426 def uid(pid = $$) file = "/proc/#{pid}/status".freeze return nil unless File.readable?(file) data = IO.foreach(file.freeze).find { |x| x[/Uid.*\d*/] }.to_s.split.drop(1) { real: data[0].to_i, effective: data[1].to_i, saved_set: data[2].to_i, filesystem_uid: data[3].to_i } end |
.virtual_memory(pid = $$) ⇒ Object
virtual_memory(pid = $$)
Where pid is the process ID.
By default it is the id of the current process ($$)
It retuns the virtual memory for the process.
The value is in kilobytes.
The output is an Integer. For example:
LinuxStat::ProcessInfo.virtual_memory
79781.888
If the info isn’t available it will return nil.
192 193 194 |
# File 'lib/linux_stat/process_info.rb', line 192 def virtual_memory(pid = $$) LinuxStat::ProcFS.statm_virtual(pid) &.fdiv(1000) end |