Copyright	(c) 2022 Tim Emiola
License	BSD3
Maintainer	Tim Emiola <adetokunbo@emio.la>
Safe Haskell	Safe-Inferred
Language	Haskell2010

System.MemInfo.Proc

Contents

Combine process memory metrics
Parse process memory metrics
Parse /proc/<pid>/exe
Parse /proc/<pid>/status

Description

This module provides types that model data from files in the Linux proc filesystem that track memory usage, combinators for parsing the files contents, and for grouping the results.

Synopsis

data MemUsage = MemUsage {
- muShared :: !Int
- muPrivate :: !Int
- muCount :: !Int
- muSwap :: !Int
}
amass :: Ord a => Bool -> [(a, ProcUsage)] -> Map a MemUsage
data ProcUsage = ProcUsage {
- puPrivate :: !Int
- puShared :: !Int
- puSharedHuge :: !Int
- puSwap :: !Int
- puMemId :: !Int
}
parseFromSmap :: Text -> ProcUsage
parseFromStatm :: KernelVersion -> Text -> Maybe ProcUsage
data ExeInfo = ExeInfo {
- eiTarget :: !Text
- eiOriginal :: !Text
- eiDeleted :: !Bool
}
parseExeInfo :: Text -> ExeInfo
parseStatusInfo :: Text -> Either BadStatus StatusInfo
data StatusInfo = StatusInfo {
- siName :: !Text
- siParent :: !ProcessID
}
data BadStatus
- = NoCmd
- | NoParent

Combine process memory metrics

data MemUsage Source #

Represents the measured memory usage of a program

Constructors

MemUsage
Fields muShared :: !Int the total shared memory in use muPrivate :: !Int the total private memory in use muCount :: !Int the number of processes running as the program muSwap :: !Int the total swap memory in use

Instances

Instances details

Show MemUsage Source #
Instance details Defined in System.MemInfo.Proc Methods showsPrec :: Int -> MemUsage -> ShowS # show :: MemUsage -> String # showList :: [MemUsage] -> ShowS #
Eq MemUsage Source #
Instance details Defined in System.MemInfo.Proc Methods (==) :: MemUsage -> MemUsage -> Bool # (/=) :: MemUsage -> MemUsage -> Bool #

amass :: Ord a => Bool -> [(a, ProcUsage)] -> Map a MemUsage Source #

Combine ProcUsage, grouping them by the effective program name

Parse process memory metrics

data ProcUsage Source #

Represents the memory metrics for a single process

Constructors

ProcUsage
Fields puPrivate :: !Int puShared :: !Int puSharedHuge :: !Int puSwap :: !Int puMemId :: !Int

Instances

Instances details

Show ProcUsage Source #
Instance details Defined in System.MemInfo.Proc Methods showsPrec :: Int -> ProcUsage -> ShowS # show :: ProcUsage -> String # showList :: [ProcUsage] -> ShowS #
Eq ProcUsage Source #
Instance details Defined in System.MemInfo.Proc Methods (==) :: ProcUsage -> ProcUsage -> Bool # (/=) :: ProcUsage -> ProcUsage -> Bool #

parseFromSmap :: Text -> ProcUsage Source #

Parse ProcUsage from the contents of /proc/<pid>/smap

parseFromStatm :: KernelVersion -> Text -> Maybe ProcUsage Source #

Parse ProcUsage from the contents of /proc/<pid>/statm

Parse /proc/<pid>/exe

data ExeInfo Source #

Represents the information about a process obtained from /proc/<pid>/exe

Constructors

ExeInfo
Fields eiTarget :: !Text the path that the link /proc/<pid>/exe resolves to eiOriginal :: !Text a sanitized form of eiTarget; it removes the (deleted) suffix eiDeleted :: !Bool does eiTarget end with (deleted)?

Instances

Instances details

Generic ExeInfo Source #
Instance details Defined in System.MemInfo.Proc Associated Types type Rep ExeInfo :: Type -> Type # Methods from :: ExeInfo -> Rep ExeInfo x # to :: Rep ExeInfo x -> ExeInfo #
Show ExeInfo Source #
Instance details Defined in System.MemInfo.Proc Methods showsPrec :: Int -> ExeInfo -> ShowS # show :: ExeInfo -> String # showList :: [ExeInfo] -> ShowS #
Eq ExeInfo Source #
Instance details Defined in System.MemInfo.Proc Methods (==) :: ExeInfo -> ExeInfo -> Bool # (/=) :: ExeInfo -> ExeInfo -> Bool #
Validity ExeInfo Source #
Instance details Defined in System.MemInfo.Proc Methods validate :: ExeInfo -> Validation #
type Rep ExeInfo Source #
Instance details Defined in System.MemInfo.Proc type Rep ExeInfo = D1 ('MetaData "ExeInfo" "System.MemInfo.Proc" "mem-info-0.3.0.0-7EhepxXcovz8rKbAxS2unK" 'False) (C1 ('MetaCons "ExeInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "eiTarget") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "eiOriginal") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "eiDeleted") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))

parseExeInfo :: Text -> ExeInfo Source #

Parses the target of /proc/<pid>/exe into a ExeInfo

Parse /proc/<pid>/status

parseStatusInfo :: Text -> Either BadStatus StatusInfo Source #

Parses the content of /proc/<pid>/status into a StatusInfo

data StatusInfo Source #

Represents the information about a process obtained from procpid/status

Constructors

StatusInfo
Fields siName :: !Text siParent :: !ProcessID

Instances

Instances details

Generic StatusInfo Source #
Instance details Defined in System.MemInfo.Proc Associated Types type Rep StatusInfo :: Type -> Type # Methods from :: StatusInfo -> Rep StatusInfo x # to :: Rep StatusInfo x -> StatusInfo #
Show StatusInfo Source #
Instance details Defined in System.MemInfo.Proc Methods showsPrec :: Int -> StatusInfo -> ShowS # show :: StatusInfo -> String # showList :: [StatusInfo] -> ShowS #
Eq StatusInfo Source #
Instance details Defined in System.MemInfo.Proc Methods (==) :: StatusInfo -> StatusInfo -> Bool # (/=) :: StatusInfo -> StatusInfo -> Bool #
Validity StatusInfo Source #
Instance details Defined in System.MemInfo.Proc Methods validate :: StatusInfo -> Validation #
type Rep StatusInfo Source #
Instance details Defined in System.MemInfo.Proc type Rep StatusInfo = D1 ('MetaData "StatusInfo" "System.MemInfo.Proc" "mem-info-0.3.0.0-7EhepxXcovz8rKbAxS2unK" 'False) (C1 ('MetaCons "StatusInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "siName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "siParent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProcessID)))

data BadStatus Source #

Indicates why parseStatusInfo failed

Constructors

NoCmd
NoParent

Instances

Instances details

Show BadStatus Source #
Instance details Defined in System.MemInfo.Proc Methods showsPrec :: Int -> BadStatus -> ShowS # show :: BadStatus -> String # showList :: [BadStatus] -> ShowS #
Eq BadStatus Source #
Instance details Defined in System.MemInfo.Proc Methods (==) :: BadStatus -> BadStatus -> Bool # (/=) :: BadStatus -> BadStatus -> Bool #