procenv is a simple command-line utility, written in C and licensed
under the GPL, that dumps all attributes of the environment in which it
runs, in well-structured plain ASCII, JSON (YAML), XML or CSV.
Note:
If you find anything missing from the
procenvoutput, please either raise an issue or send a patch :)
When you first read what this tool does, you tend to think, "Huh?", or "Why would anyone want a tool like that?" or "How is that useful?"
Here are a few examples to help explain. procenv can help...
-
To learn about the Unix/Linux environment
For example, compare these output files:
$ procenv > /tmp/1 $ sudo procenv > /tmp/2 $ nohup procenv >/tmp/3 &
-
To debug weird CI failures
Even scratched your head wondering why your code works perfectly on your local machine, but explodes in flames in your CI system?
Maybe you've had to hack your build to run a bunch of shell commands like the following to help your debug wtf is going wrong?:
echo "INFO: environment variables" env echo "INFO: mounts" mount echo "INFO: time" date echo "INFO: umask" umask echo "INFO: locale" locale
Look familiar? There is a simpler way: just run
procenvin your CI, run it locally anddiff(1)the output! -
To compare build environments
When you run
make checkas part of theprocenvbuild, theprocenvbinary runs. This is useful because if you can access the build logs for a particular build system, you can see the environment of that build system by looking at the procenv logs.Note: See the results section for links to some common build environments.
-
To compare systems
More generally, just run procenv on two systems and
diff(1)the output to see what's different (different O/S versions, different distro versions, different Unix variants). -
To learn about the packaging environment:
These commands show interesting details of compiler and libc used to build the package:
$ procenv --compiler $ procenv --libc
-
To see what changes for a process on each run
Every new process creates gets a new process ID. But what else changes?
$ diff <(procenv) <(procenv)
Since procenv can re-exec itself, you can do sneaky things like run
procenv before the init daemon runs on your system! But wait, init systems
like systemd run as PID 1 I hear you cry! Correct, but using a command like
the following, you can run procenv as PID 1, which will dump it's output and
then launch systemd as the same PID and boot the system as normal!
init=/usr/bin/procenv PROCENV_FILE=/dev/ttyS0 PROCENV_EXEC="/sbin/init --foo-bar --baz"
Note: Further details about this and more examples are listed in the manual page,
procenv(1).
procenv runs on the following operating systems:
It unashamedly emulates a number of existing system utilities as it is
attempting to be all-encompassing: I wrote it with the aim of being able to
dump "everything" that a process may care about by simply running a single
program (by default). Also, the line of demarcation between "process",
"program" and "system" is slightly blurry in some aspects. For example
sysconf(3) variables could arguably be considered system attributes, but
procenv shows these too since they are obviously meant to be queryable by
applications.
To install the snap package:
$ sudo snap install procenvNote: Alternatively, you can build your own snap.
-
Enable EPEL repository.
-
Install:
$ sudo dnf -y install procenv
$ sudo apt -y install procenv$ sudo dnf -y install procenvTo install the binary package:
$ sudo pkg -y install procenvTo install the port:
$ cd /usr/ports/sysutils/procenv
$ sudo make install cleanNote: See also the build document.
$ sudo emerge sys-process/procenvInstall via MacPorts:
$ sudo port install procenv$ sudo zypper install -y procenv$ git clone https://github.com/jamesodhunt/procenv
$ cd procenv
$ snapcraft-
Install dependencies
Platform Usage Required? Dependency Rationale common build yes GCC or Clang compiler For building the code common build yes GNU Autoconf For configuring the source package common build yes GNU Autoconf Archive For configuring the source package common build yes GNU Automake For generating makefiles common build yes GNU Make For building the code common build yes pkgconf/pkg-configFor configuring build dependencies common test optional Check For running unit tests common test optional Expat For validating XML output common test optional GNU Groff For checking man page documentation Linux build optional libapparmordevelopment packageFor AppArmor details Linux build optional libcapdevelopment packageFor capabilities details Linux build optional libnumadevelopment packageFor NUMA memory details Linux build optional libselinuxdevelopment packageFor SELinux details BSD build optional libsysinfopackage or portFor general memory details Note:
The definitive list of dependenciese can always be seen by looking at the GitHub Actions workflow file here:
-
Checkout the source code:
$ git clone https://github.com/jamesodhunt/procenv $ cd procenv -
Configure and build:
$ autoreconf -fi && ./configure $ make && make check && sudo make install
Note:
For BSD systems, replace
makewithgmakeabove to ensure you run using GNU Make (BSD make will hang at the test stage!)
procenv is extremely useful for learning about the environment
software builds in. Often, such systems disallow login, but do allow
access to log files. Handily, when you build procenv, it runs a battery of
tests and also runs itself. This means that the build environment gets
captured in the build logs themselves.
Select a link below and drill down to the build log to see the procenv
output:
If you distro does not yet provide a procenv package, binary
packages for RHEL, Fedora, CentOS, SLES, and Arch Linux are available
from here:
Click on your icon for your distro and follow the instructions.
Note that these packages are "bleeding edge" (generated directly from the GitHub repository).
- https://semaphoreci.com/jamesodhunt/procenv
(Click "Passed", "Job #", then "
make check" to see output).
Can you help port procenv to other platforms (AIX, HP-UX, Solaris, ...), or
can you give me access to new platforms? If so, please get in contact or take
a look at the porting document.
See http://ifdeflinux.blogspot.com/2012/10/procenv-and-process-environment.html
procenv was written by James Hunt [email protected].
