Skip to main content

Unix process tree search

Project description

Travis CI Codecov Upload Python Package Pypi version Downloads Python versions Licence

pgtree

Unix process hierachy tree display for specific processes (kind of mixed pgrep + pstree)

pgtree is also able to send signal to found processes and all their children

The purpose is to have the tool working out of the box on any Unix box, using the default OS python installed, without installing anything else. The code must be compatible with python 2.x + 3.x

Should work on any Unix that can execute :

# /usr/bin/pgrep 
# /usr/bin/ps -e -o pid,ppid,stime,user,ucomm,args

if pgrep command not available (AIX), pgtree uses built-in pgrep (-f -i -x -u <user> supported).

Tested on various versions of RedHat / CentOS / Ubuntu / Debian / Suse / MacOS / Solaris / AIX including old versions

(uses -o comm on Solaris)

Installation

FYI, the pgtree/pgtree.py is standalone and can be directly copied/used anywhere without any installation.

installation using pip:

# pip install pgtree

installation using setup.py, root install in /usr/local/bin:

# ./setup.py install

installation using setup.py, user install in ~/.local/bin:

# ./setup.py install --prefix=~/.local

Usage

# pgtree -h
    usage: pgtree.py [-Iya] [-C <when>] [-O <psfield>] [-c|-k|-K] [-p <pid1>,...|<pgrep args>]

    -I : use -o uid instead of -o user for ps command
         (if uid/user mapping is broken ps command can be stuck)
    -c : display processes and children only 
    -k : kill -TERM processes and children
    -K : kill -KILL processes and children
    -y : do not ask for confirmation to kill
    -C : color preference : y/yes/always or n/no/never (default auto)
    -w : tty wrap text : y/yes or n/no (default y)
    -a : use ascii characters
    -O <psfield> : display <psfield> instead of 'stime' in output
                   <psfield> must be valid with ps -o <psfield> command

    by default display full process hierarchy (parents + children of selected processes)

    -p <pids> : select processes pids to display hierarchy (default 1)
    <pgrep args> : use pgrep to select processes (see pgrep -h)

    found pids are prefixed with ▶

Examples

show all parents and children of processes matching bash

# pgtree bash

show processes matching bash and their children

# pgtree -c bash

kill all sh processes of user joknarf and their children

#pgtree -k -u joknarf -x sh

Demo

output

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pgtree-1.0.19.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

pgtree-1.0.19-py2.py3-none-any.whl (13.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pgtree-1.0.19.tar.gz.

File metadata

  • Download URL: pgtree-1.0.19.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for pgtree-1.0.19.tar.gz
Algorithm Hash digest
SHA256 a6211b88038f301760927f6ff1f88b4af9084deaa3dfd0b690e66b79c1b86f4c
MD5 8060ed9d3daab075f8e9f12eb3b38652
BLAKE2b-256 8248f6b06067e31b32c9e749904186d5cf65d1dbbe76f42f1107a7d7a3c236db

See more details on using hashes here.

File details

Details for the file pgtree-1.0.19-py2.py3-none-any.whl.

File metadata

  • Download URL: pgtree-1.0.19-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for pgtree-1.0.19-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 62cf9e85ebc0607c29b577b13f13e6f46fee82284efbac3c1a720c0c32814975
MD5 a1fc1b85e029a4ccec2a6ba607c4d073
BLAKE2b-256 047df12c33cf098e76ef5bb23e0b76d111fbc0a4a56c2aa87ad1d4601166d43c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page