user-tools/trackrun

   1 #!/bin/bash
   2
   3 set -e
   4 set -o pipefail
   5 set -u
   6
   7
   8 true <<'EOF'
   9
  10 =pod
  11
  12 =head1 NAME
  13
  14 trackrun - Record when the given command was started and ended and expose to it in environment variables
  15
  16 =head1 SYNOPSIS
  17
  18 trackrun [<OPTIONS>] [--] <COMMAND> [<ARGS>]
  19
  20 =head1 OPTIONS
  21
  22 =over 4
  23
  24 =item -f, --full-command
  25
  26 =item -b, --command-basename (default)
  27
  28 =item -n, --name NAME
  29
  30 =item -e, --env-var ENV
  31
  32 =back
  33
  34 =head1 DESCRIPTION
  35
  36 It records when it starts COMMAND and when it ends, identifying COMMAND either by one of 4 options:
  37 (1) Full command line including ARGS.
  38 (2) Only the command name, COMMAND.
  39 (3) By the name given by the user in NAME.
  40 (4) By the environment variable given by name ENV.
  41
  42 Set B<TRACKRUN_LAST_STARTED> and B<TRACKRUN_LAST_ENDED> environments for COMMAND to the ISO 8601 representation
  43 of the date and time when COMMAND was last started and ended respectively.
  44 Set B<TRACKRUN_LAST_STATUS> to the status COMMAND last exited with.
  45 Those are left empty if no data yet.
  46
  47 =head1 FILES
  48
  49 Store tracking data in F<~/.trackrun> directory.
  50
  51 =head1 ENVIRONMENT
  52
  53 =over 4
  54
  55 =item TRACKRUN_LAST_STARTED
  56
  57 =item TRACKRUN_LAST_ENDED
  58
  59 =item TRACKRUN_LAST_STATUS
  60
  61 =back
  62
  63 =head1 LIMITATIONS
  64
  65 Trackrun does not do locking. You may take care of it if you need using flock(1), cronrun(1), or similar.
  66
  67 =cut
  68
  69 EOF
  70
  71
  72 cmd_id=''
  73 cmd_id_by=basename
  74
  75
  76 while [ $# -gt 0 ]
  77 do
  78         case "$1" in
  79         --help)
  80                 pod2text "$0"
  81                 exit 0;;
  82         -f|--full-command)
  83                 cmd_id_by=full
  84                 ;;
  85         -b|--command-basename)
  86                 cmd_id_by=basename
  87                 ;;
  88         -n|--name)
  89                 cmd_id_by=name
  90                 shift
  91                 cmd_id=$1
  92                 ;;
  93         -e|--env-var)
  94                 cmd_id_by=env
  95                 shift
  96                 cmd_id=${!1}
  97                 ;;
  98         --)
  99                 shift
 100                 break;;
 101         -*)
 102                 echo "$0: unknown option: $1" >&1
 103                 exit -1;;
 104         *)
 105                 break;;
 106         esac
 107         shift
 108 done
 109
 110
 111 if [ $# = 0 ]
 112 then
 113         pod2text "$0" >&2
 114         exit -1
 115 fi
 116
 117
 118 declare -a cmd_args=("$@")
 119
 120
 121 if [ -z "$cmd_id" ]
 122 then
 123         case "$cmd_id_by" in
 124         full)
 125                 cmd_id=${cmd_args[*]}
 126                 ;;
 127         basename)
 128                 cmd_id=`basename "${cmd_args[0]}"`
 129                 ;;
 130         esac
 131 fi
 132
 133
 134 track_dir=~/.trackrun
 135 cmd_id_hash=`printf %s "$cmd_id" | md5sum | cut -c 1-32`
 136 track_file=$track_dir/$cmd_id_hash
 137
 138 lookup()
 139 {
 140         # lookup A B C
 141         # return the C-th field of the first line in stdin of which A-th field is B
 142         awk -F $'\t' -v field_num="$1" -v field_val="$2" -v field_ret="$3" \
 143                 '{if($field_num == field_val){ print $field_ret; exit; }}'
 144 }
 145
 146 mkdir -p "$track_dir"
 147 export TRACKRUN_LAST_STARTED=`tac "$track_file" 2>/dev/null | lookup 1 start 2`
 148 export TRACKRUN_LAST_ENDED=`tac "$track_file" 2>/dev/null | lookup 1 end 2`
 149 export TRACKRUN_LAST_STATUS=`tac "$track_file" 2>/dev/null | lookup 1 end 3`
 150
 151 record()
 152 {
 153         printf "%s\t%(%FT%T%z)T\t%s\t%s\n" "$1" -1 "${2:-}" "${cmd_args[*]}" >> "$track_file"
 154 }
 155
 156 record start
 157
 158 {
 159         exec -- setsid ${cmd_args[@]}
 160         exit 127
 161 } &
 162
 163 child_pid=$!
 164 signal_handler() { interrupted=yes; }
 165 trap signal_handler INT
 166 while true
 167 do
 168         interrupted=''
 169         set +e
 170         wait $child_pid
 171         exit_code=$?
 172         set -e
 173         if [ $interrupted ]
 174         then
 175                 exit_code=''
 176                 kill -s INT $child_pid || true
 177         else
 178                 break
 179         fi
 180 done
 181
 182 record end $exit_code
 183
 184 exit $exit_code