Overview

• module Process
  • module Metrics
    • class General

      General process information.

      • module Linux

        General process information by reading /proc. Used on Linux to avoid spawning ps.
      • module ProcessStatus

        General process information via the process status command (ps). Used on non-Linux platforms (e.g. Darwin)
    • module Host

      Per-host (system-wide) memory metrics. Use Host::Memory for total/used/free and swap; use Process::Metrics::Memory for per-process metrics.

      • class Memory

        Struct for host memory snapshot. All sizes in bytes.

        • class Darwin

          Darwin (macOS) implementation of host memory metrics.
        • module Linux

          Linux host memory: tries cgroup v2, then cgroup v1, then /proc/meminfo.

          • class CgroupV1

            Captures host memory limits and usage from a cgroup v1 filesystem.
          • class CgroupV2

            Captures host memory limits and usage from a cgroup v2 filesystem.
          • class Meminfo

            Captures host memory from Linux /proc/meminfo.
    • class Memory

      Represents memory usage for a process, sizes are in bytes.

      • class Darwin

        Darwin (macOS) implementation of per-process memory metrics using vmmap(1).
      • class Linux

        Linux implementation of per-process memory metrics using /proc/[pid]/smaps or /proc/[pid]/smaps_rollup, and /proc/[pid]/stat for fault counters.
    • class Processor

      Computes interval CPU utilization from cumulative process metrics.

      • class Sample

        An immutable measurement of process CPU usage over an interval.