Module katja_vmstats_metrics

The katja_vmstats_metrics module implements all available metrics.

Copyright © 2014-2016 Daniel Kempkens

Version: 0.8.2

Authors: Daniel Kempkens (daniel@kempkens.io).

Description

The katja_vmstats_metrics module implements all available metrics.

Function Index

all_message_queues/0Returns the (summed) size of all message queues at the local node.
context_switches/0Returns the total number of context switches since the system started.
error_logger_message_queue/0Returns the size of the error_logger message queue at the local node.
ets_count/0Returns the number of ETS tables currently existing at the local node.
ets_limit/0Returns the maximum number of ETS tables allowed.
ets_size/1Returns the number of objects inserted in the table.
ets_size_total/0Returns the total number of objects inserted into all tables.
ets_utilization/0Returns the ETS table utilization (number between 0 and 1) at the local node.
exact_reductions_last_call/0Returns the exact number of reductions performed since the last call to this function.
exact_reductions_total/0Returns the exact total number of reductions performed at he local node.
garbage_collection_runs/0Returns the total number of garbage collector runs.
garbage_collection_words_reclaimed/0Returns the total number of words reclaimed by the garbage collector.
heap_size/1Returns the size in words of youngest heap generation of the process.
io_in/0Returns the total number of bytes received through ports.
io_out/0Returns the total number of bytes output to ports.
links/1Returns the number of processes or ports to which the process has a link.
loaded_modules/0Returns the number of currently loaded modules at the local node.
memory_atoms/0The total amount of memory currently used for atoms.
memory_binaries/0The total amount of memory currently used for binaries.
memory_ets/0The total amount of memory currently used for ETS tables.
memory_process/1Size of the process in bytes.
memory_processes/0The total amount of memory currently used by the Erlang processes.
memory_system/0The total amount of memory currently allocated by the emulator that is not directly related to any Erlang process.
memory_total/0The total amount of memory currently allocated.
message_queue/1Returns the size of the message queue of the process identified by Pid.
monitors/1Returns the number of monitors that are active for the process.
port_count/0Returns the number of ports currently existing at the local node.
port_limit/0Returns the maximum number of simultaneously existing ports at the local node.
port_utilization/0Returns the port utilization (number between 0 and 1) at the local node.
process_count/0Returns the number of processes currently existing at the local node.
process_limit/0Returns the maximum number of simultaneously existing processes at the local node.
process_utilization/0Returns the process utilization (number between 0 and 1) at the local node.
reductions_last_call/0Returns the number of reductions (minus reductions performed in current time slices of currently scheduled processes) performed since the last call to this function.
reductions_process/1Returns the number of reductions executed by the process.
reductions_total/0Returns the total number of reductions (minus reductions performed in current time slices of currently scheduled processes) performed at he local node.
registered_processes/0Returns the numer of registered processes.
run_queue/0Returns the total length of the run queues, that is, the number of processes that are ready to run on all available run queues.
socket_recv_package_count/1Returns the number of packets received by Socket.
socket_recv_size/1Returns the number of bytes received by Socket.
socket_send_package_count/1Returns the number of packets sent by Socket.
socket_send_size/1Returns the number of bytes sent from Socket.
stack_size/1Return the stack size of the process in words.

Function Details

all_message_queues/0

all_message_queues() -> non_neg_integer()

Returns the (summed) size of all message queues at the local node.

context_switches/0

context_switches() -> non_neg_integer()

Returns the total number of context switches since the system started.

error_logger_message_queue/0

error_logger_message_queue() -> non_neg_integer()

Returns the size of the error_logger message queue at the local node.

ets_count/0

ets_count() -> pos_integer()

Returns the number of ETS tables currently existing at the local node.

ets_limit/0

ets_limit() -> pos_integer()

Returns the maximum number of ETS tables allowed.
On older R16 releases ets_limit falls back to reading the ERL_MAX_ETS_TABLES environment variable or defaults to 1400.

ets_size/1

ets_size(Tab::ets:tab()) -> non_neg_integer()

Returns the number of objects inserted in the table.

ets_size_total/0

ets_size_total() -> non_neg_integer()

Returns the total number of objects inserted into all tables.

ets_utilization/0

ets_utilization() -> float()

Returns the ETS table utilization (number between 0 and 1) at the local node.

exact_reductions_last_call/0

exact_reductions_last_call() -> pos_integer()

Returns the exact number of reductions performed since the last call to this function.
Using this method and exact_reductions_total/0 at the same time will cause weird/wrong results.
This method is more expensive than reductions_last_call/0.

exact_reductions_total/0

exact_reductions_total() -> pos_integer()

Returns the exact total number of reductions performed at he local node.
Using this method and exact_reductions_last_call/0 at the same time will cause weird/wrong results.
This method is more expensive than reductions_total/0.

garbage_collection_runs/0

garbage_collection_runs() -> non_neg_integer()

Returns the total number of garbage collector runs.

garbage_collection_words_reclaimed/0

garbage_collection_words_reclaimed() -> non_neg_integer()

Returns the total number of words reclaimed by the garbage collector.

heap_size/1

heap_size(Pid::atom() | pid()) -> pos_integer()

Returns the size in words of youngest heap generation of the process. This generation currently include the stack of the process.
If Pid is an atom(), it will assume that it's the name of a registered process.

io_in/0

io_in() -> non_neg_integer()

Returns the total number of bytes received through ports.

io_out/0

io_out() -> non_neg_integer()

Returns the total number of bytes output to ports.

links/1

links(Pid::atom() | pid()) -> non_neg_integer()

Returns the number of processes or ports to which the process has a link. If Pid is an atom(), it will assume that it's the name of a registered process.

loaded_modules/0

loaded_modules() -> pos_integer()

Returns the number of currently loaded modules at the local node.

memory_atoms/0

memory_atoms() -> pos_integer()

The total amount of memory currently used for atoms.

memory_binaries/0

memory_binaries() -> pos_integer()

The total amount of memory currently used for binaries.

memory_ets/0

memory_ets() -> pos_integer()

The total amount of memory currently used for ETS tables.

memory_process/1

memory_process(Pid::atom() | pid()) -> non_neg_integer()

Size of the process in bytes. This includes call stack, heap and internal structures. If Pid is an atom(), it will assume that it's the name of a registered process.

memory_processes/0

memory_processes() -> pos_integer()

The total amount of memory currently used by the Erlang processes.

memory_system/0

memory_system() -> pos_integer()

The total amount of memory currently allocated by the emulator that is not directly related to any Erlang process.

memory_total/0

memory_total() -> pos_integer()

The total amount of memory currently allocated.

message_queue/1

message_queue(Pid::atom() | pid()) -> non_neg_integer()

Returns the size of the message queue of the process identified by Pid. If Pid is an atom(), it will assume that it's the name of a registered process.

monitors/1

monitors(Pid::atom() | pid()) -> non_neg_integer()

Returns the number of monitors that are active for the process. If Pid is an atom(), it will assume that it's the name of a registered process.

port_count/0

port_count() -> pos_integer()

Returns the number of ports currently existing at the local node.

port_limit/0

port_limit() -> pos_integer()

Returns the maximum number of simultaneously existing ports at the local node.

port_utilization/0

port_utilization() -> float()

Returns the port utilization (number between 0 and 1) at the local node.

process_count/0

process_count() -> pos_integer()

Returns the number of processes currently existing at the local node.

process_limit/0

process_limit() -> pos_integer()

Returns the maximum number of simultaneously existing processes at the local node.

process_utilization/0

process_utilization() -> float()

Returns the process utilization (number between 0 and 1) at the local node.

reductions_last_call/0

reductions_last_call() -> pos_integer()

Returns the number of reductions (minus reductions performed in current time slices of currently scheduled processes) performed since the last call to this function.
Using this method and reductions_total/0 at the same time will cause weird/wrong results.

reductions_process/1

reductions_process(Pid::atom() | pid()) -> pos_integer()

Returns the number of reductions executed by the process.
If Pid is an atom(), it will assume that it's the name of a registered process.

reductions_total/0

reductions_total() -> pos_integer()

Returns the total number of reductions (minus reductions performed in current time slices of currently scheduled processes) performed at he local node.
Using this method and reductions_last_call/0 at the same time will cause weird/wrong results.

registered_processes/0

registered_processes() -> pos_integer()

Returns the numer of registered processes.

run_queue/0

run_queue() -> non_neg_integer()

Returns the total length of the run queues, that is, the number of processes that are ready to run on all available run queues.

socket_recv_package_count/1

socket_recv_package_count(Socket::inet:socket()) -> non_neg_integer()

Returns the number of packets received by Socket.

socket_recv_size/1

socket_recv_size(Socket::inet:socket()) -> non_neg_integer()

Returns the number of bytes received by Socket.

socket_send_package_count/1

socket_send_package_count(Socket::inet:socket()) -> non_neg_integer()

Returns the number of packets sent by Socket.

socket_send_size/1

socket_send_size(Socket::inet:socket()) -> non_neg_integer()

Returns the number of bytes sent from Socket.

stack_size/1

stack_size(Pid::atom() | pid()) -> pos_integer()

Return the stack size of the process in words.
If Pid is an atom(), it will assume that it's the name of a registered process.


Generated by EDoc