What Gets Archived?
Also included in the archive are (in order):
- custom notes, if provided (see Adding Archive Notes, below)
- the date/time that the script started
- the working directory
- the directory containing the script
- archive version (i.e., Log::Reproducible version)
- Perl-related info (version, path to perl,
@INC
, and module versions) - Git repository info, if applicable (see Git Repo Info, below)
- environmental variables and their values (
%ENV
) - the exit code
- the date/time that the script finished
- elapsed time
For example, running the script sample.pl
would result in an archive file named rlog-sample.pl-YYYYMMDD.HHMMSS
.
If it was run as perl bin/sample.pl -a 1 -b 2 -c 3 OTHER ARGUMENTS
, the contents of the archive file would look something like:
---
- COMMAND: sample.pl -a 1 -b 2 -c 3 OTHER ARGUMENTS
- NOTE: ~
- STARTED: at HH:MM:SS on weekday month day, year
- WORKING DIR: /path/to/working/dir
- SCRIPT DIR:
ABSOLUTE: /path/to/working/dir/bin
RELATIVE: bin
- ARCHIVE VERSION: Log::Reproducible 0.12.1
- PERL:
- VERSION: v5.20.0
- PATH: /path/to/bin/perl
- INC:
- /path/to/perl/lib
- /path/to/another/perl/lib
- MODULES:
- Some::Module 0.12
- Another::Module 43.08
- ENV:
PATH: /usr/local/bin:/paths/to/more/bins
...
_system_name: OSX
_system_version: 10.9
################################################################################
###### IF EXIT CODE IS MISSING, SCRIPT WAS CANCELLED OR IS STILL RUNNING! ######
################## TYPICALLY: 0 == SUCCESS AND 255 == FAILURE ##################
################################################################################
- EXITCODE: 0
- FINISHED: at HH:MM:SS on weekday month day, year
- ELAPSED: HH:MM:SS