Adding process monitor to metrics

.dialyzer_ignore.exs

@@ -1,3 +1,4 @@
 [
-  {"lib/observer_web/macros.ex", :unknown_function}
+  {"lib/observer_web/macros.ex", :unknown_function},
+  {"lib/observer_web/monitor/process_port.ex", :pattern_match}
 ]

lib/observer_web/application.ex

@@ -13,6 +13,7 @@ defmodule ObserverWeb.Application do
       [
         Observer.Web.Telemetry,
         ObserverWeb.Tracer.Server,
+        ObserverWeb.Monitor.ProcessPort,
         {Phoenix.PubSub, [name: ObserverWeb.PubSub]}
       ] ++ telemetry_servers()
 

lib/observer_web/apps/port.ex

@@ -5,31 +5,42 @@ defmodule ObserverWeb.Apps.Port do
 
   alias ObserverWeb.Rpc
 
+  @type t :: %{
+          name: charlist() | String.t(),
+          id: non_neg_integer(),
+          connected: pid(),
+          os_pid: non_neg_integer() | :undefined,
+          memory: non_neg_integer()
+        }
+
+  defstruct [:name, :id, :connected, :os_pid, :memory]
+
   @doc """
   Return port information
 
   ## Examples
 
     iex> alias ObserverWeb.Observer.Port
     ...> [h | _] = :erlang.ports()
-    ...> assert %{connected: _, id: _, name: _, os_pid: _} = Port.info(h)
+    ...> assert %{connected: _, id: _, name: _, os_pid: _, memory: _} = Port.info(h)
     ...> assert :undefined = Port.info(nil)
     ...> assert :undefined = Port.info("")
   """
-  @spec info(atom(), port()) ::
-          :undefined | %{connected: any(), id: any(), name: any(), os_pid: any()}
+  @spec info(node :: atom(), port :: port()) :: :undefined | ObserverWeb.Apps.Port.t()
   def info(node \\ Node.self(), port)
 
   def info(node, port) when is_port(port) do
-    case Rpc.call(node, :erlang, :port_info, [port], :infinity) do
-      data when is_list(data) ->
-        %{
-          name: Keyword.get(data, :name, 0),
-          id: Keyword.get(data, :id, 0),
-          connected: Keyword.get(data, :connected, 0),
-          os_pid: Keyword.get(data, :os_pid, 0)
-        }
-
+    with data <- Rpc.call(node, :erlang, :port_info, [port], :infinity),
+         true <- is_list(data),
+         {:memory, memory} <- Rpc.call(node, :erlang, :port_info, [port, :memory], :infinity) do
+      %__MODULE__{
+        name: Keyword.get(data, :name, 0),
+        id: Keyword.get(data, :id, 0),
+        connected: Keyword.get(data, :connected, 0),
+        os_pid: Keyword.get(data, :os_pid, 0),
+        memory: memory
+      }
+    else
       _ ->
         :undefined
     end

lib/observer_web/apps/process.ex

@@ -11,6 +11,54 @@ defmodule ObserverWeb.Apps.Process do
 
   @default_get_state_timeout 100
 
+  @type t :: %{
+          pid: pid(),
+          registered_name: atom() | nil,
+          priority: :low | :normal | :high | :max,
+          trap_exit: boolean(),
+          message_queue_len: non_neg_integer(),
+          error_handler: module() | :none,
+          relations: %{
+            group_leader: pid() | nil,
+            ancestors: [pid()],
+            links: [pid()] | nil,
+            monitored_by: [pid()] | nil,
+            monitors: [pid() | {module(), term()}] | nil
+          },
+          memory: %{
+            total: non_neg_integer(),
+            stack_and_heap: non_neg_integer(),
+            heap_size: non_neg_integer(),
+            stack_size: non_neg_integer(),
+            gc_min_heap_size: non_neg_integer(),
+            gc_full_sweep_after: non_neg_integer()
+          },
+          meta: %{
+            init: String.t(),
+            current: String.t(),
+            status: :running | :waiting | :exiting | :garbage_collecting | :suspended | :runnable,
+            class: :supervisor | :application | :unknown | atom()
+          },
+          state: String.t(),
+          dictionary: keyword() | nil,
+          phx_lv_socket: Phoenix.LiveView.Socket.t() | nil
+        }
+
+  defstruct [
+    :pid,
+    :registered_name,
+    :priority,
+    :trap_exit,
+    :message_queue_len,
+    :error_handler,
+    :relations,
+    :memory,
+    :meta,
+    :state,
+    :dictionary,
+    :phx_lv_socket
+  ]
+
   @process_full [
     :registered_name,
     :priority,
@@ -36,7 +84,8 @@ defmodule ObserverWeb.Apps.Process do
   @doc """
   Creates a complete overview of process stats based on the given `pid`.
   """
-  @spec info(pid :: pid(), timeout :: non_neg_integer()) :: :undefined | map
+  @spec info(pid :: pid(), timeout :: non_neg_integer()) ::
+          :undefined | ObserverWeb.Apps.Process.t()
   def info(pid, timeout \\ @default_get_state_timeout) do
     process_info(pid, @process_full, &structure_full/3, timeout)
   end
@@ -119,7 +168,7 @@ defmodule ObserverWeb.Apps.Process do
         end
       end
 
-    %{
+    %__MODULE__{
       pid: pid,
       registered_name: Keyword.get(data, :registered_name, nil),
       priority: Keyword.get(data, :priority, :normal),

lib/observer_web/monitor.ex

@@ -0,0 +1,35 @@
+defmodule ObserverWeb.Monitor do
+  @moduledoc """
+  This module will provide process/port monitor context
+  """
+
+  alias ObserverWeb.Monitor.ProcessPort
+
+  ### ==========================================================================
+  ### Public functions
+  ### ==========================================================================
+
+  @doc """
+  Starts monitoring a process/port memory usage
+  """
+  @spec start_id_monitor(pid_or_port :: pid() | port()) ::
+          {:ok, ObserverWeb.Monitor.ProcessPort.t()}
+  def start_id_monitor(pid_or_port), do: ProcessPort.start_id_monitor(pid_or_port)
+
+  @doc """
+  Stops monitoring a process/port memory usage
+  """
+  @spec stop_id_monitor(pid_or_port :: pid() | port()) :: :ok
+  def stop_id_monitor(pid_or_port), do: ProcessPort.stop_id_monitor(pid_or_port)
+
+  @doc """
+  Checks if memory monitoring is enabled for a process/port
+  """
+  @spec id_info(pid_or_port :: pid() | port()) ::
+          {:ok, ObserverWeb.Monitor.ProcessPort.t()} | {:error, :not_found | :rescued}
+  def id_info(pid_or_port), do: ProcessPort.id_info(pid_or_port)
+
+  ### ==========================================================================
+  ### Private functions
+  ### ==========================================================================
+end