pl-heartbeat

Table of Contents

• Abstract
• Synopsis
• Run
  • Using PyPI
  • Using docker run
• Examples
  • Display DateTime Information
  • Display CPU Information
  • Display Memory Information
  • Display System Information every 15 seconds for 1 minute

Abstract

heartbeat is a simple app that periodically displays system information.

Synopsis

python heartbeat.py                                             \
    [-v <level>] [--verbosity <level>]                          \
    [--infoType <typeSystemInfo>]                               \
    [--beatInterval <secondsWait>]                              \
    [--lifetime <secondsLive>]                                  \
    [--version]                                                 \
    [--man]                                                     \
    [--meta]                                                    \
    /tmp

Run

This plugin can be run in two modes: natively as a python package or as a containerized docker image.

Using PyPI

To run from PyPI, simply do a

pip install heartbeat

and run with

heartbeat.py --beatInterval 5 --lifetime 50 /tmp

to specify system information to be displayed, simply do

heartbeat.py --infoType CPU         \
             --beatInterval 5       \
             --lifetime 50          \
                  /tmp

Using docker run

To run using docker, prefix all calls with

docker run --rm                                     \
    fnndsc/pl-heartbeat heartbeat.py

Examples

Display DateTime Information

docker run --rm                                     \
    fnndsc/pl-heartbeat heartbeat.py                \
    --infoType datetime                             \
    /tmp

Display CPU Information

docker run --rm                                     \
    fnndsc/pl-heartbeat heartbeat.py                \
    --infoType cpu                                  \
    /tmp

Display Memory Information

docker run --rm                                     \
    fnndsc/pl-heartbeat heartbeat.py                \
    --infoType memory                               \
    /tmp

Display System Information every 15 seconds for 1 minute

docker run --rm                                     \
    fnndsc/pl-heartbeat heartbeat.py                \
    --infoType datetime                             \
    --beatInterval 15                               \
     --lifetime 60                                  \
    /tmp