[debug] Refactor debug module
Use `$PS4` debugging prompt to generate timestamps, instead of GNU `date`. This also keeps timestamps and respective command together, something that `paste` could not guarantee given some commands may have multiple lines. The prompt timestamp has a precision of 6 decimals. The `printf "%12.9f\n"` instruction with 9 decimals was kept to keep producing "the **SAME** output". This could be replaced to `printf "%12.6f\n"` to make the output smaller. Also, only the first line of commands with multiple lines are saved, to keep the output format backwards-compatible. Closes #84
This commit is contained in:
parent
40ef228286
commit
f812c1bb6a
2 changed files with 13 additions and 56 deletions
|
@ -12,16 +12,8 @@ Notes
|
||||||
-----
|
-----
|
||||||
|
|
||||||
The `trace-zim` command will not alter your current dotfiles.
|
The `trace-zim` command will not alter your current dotfiles.
|
||||||
It will copy your environment to a temporary directory, launch zsh
|
It will copy your environment to a temporary directory, launch zsh
|
||||||
within that environment, and output logs.
|
within that environment, and output logs.
|
||||||
|
|
||||||
This will provide a ztrace.tar.gz archive, which should be attached
|
This will provide a ztrace.tar.gz archive, which should be attached
|
||||||
to any bug reports if you need help with an issue that you don't understand.
|
to any bug reports if you need help with an issue that you don't understand.
|
||||||
|
|
||||||
|
|
||||||
Requires `gdate` and `gsed` on Mac/BSD systems.
|
|
||||||
|
|
||||||
Note: it is very likely that this can be done on these systems without GNU utils,
|
|
||||||
but I don't use Mac/BSD anywhere.
|
|
||||||
If someone who does use these platforms can provide me with a PR that produces
|
|
||||||
the **SAME** output for Mac/BSD, I would be happy to PR.
|
|
||||||
|
|
|
@ -48,53 +48,25 @@ else
|
||||||
cp -R ${ZDOTDIR:-${HOME}}/.zim /tmp/ztrace/
|
cp -R ${ZDOTDIR:-${HOME}}/.zim /tmp/ztrace/
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# trace code to add to modified .zshrc
|
# create a modified .zshrc to produce a trace log
|
||||||
if [[ ${OSTYPE} == linux-gnu ]]; then
|
cat <<EOF >! /tmp/ztrace/.zshrc
|
||||||
read -d '' tracetop << EOF || true
|
|
||||||
###################
|
###################
|
||||||
# zim trace start #
|
# zim trace start #
|
||||||
###################
|
###################
|
||||||
exec 3>&2 2> >(tee /tmp/ztrace/sample-time.\$\$.log |
|
PS4=$'%D{%s%6.}-_-'
|
||||||
sed -u 's/^.*$/now/' |
|
exec 3>&2 2>/tmp/ztrace/sample-time.$$.log
|
||||||
date -f - +%s.%N >/tmp/ztrace/sample-time.\$\$.tim)
|
|
||||||
zmodload zsh/zprof
|
zmodload zsh/zprof
|
||||||
set -x
|
setopt xtrace prompt_subst
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
# we need gnu-utils to do this, so we must check for darwin/bsd.
|
cat /tmp/ztrace/.zshrc.orig >>! /tmp/ztrace/.zshrc
|
||||||
# if these platforms, we need to call gsed and gdate explicitly.
|
|
||||||
elif [[ ${OSTYPE} == (darwin*|*bsd*) ]]; then
|
|
||||||
if (( ${+commands[gdate]} && ${+commands[gsed]} )); then
|
|
||||||
read -d '' tracetop << EOF || true
|
|
||||||
###################
|
|
||||||
# zim trace start #
|
|
||||||
###################
|
|
||||||
exec 3>&2 2> >(tee /tmp/ztrace/sample-time.\$\$.log |
|
|
||||||
gsed -u 's/^.*$/now/' |
|
|
||||||
gdate -f - +%s.%N >/tmp/ztrace/sample-time.\$\$.tim)
|
|
||||||
zmodload zsh/zprof
|
|
||||||
set -x
|
|
||||||
EOF
|
|
||||||
else
|
|
||||||
print "debug module requires both gnu-sed (gsed) and gnu-date (gdate).
|
|
||||||
Please install these with brew before attempting to trace."
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
print "your system, ${OSTYPE}, is an unknown system.
|
|
||||||
Please create an issue at:
|
|
||||||
https://github.com/Eriner/zim/issues
|
|
||||||
Include the following output in your report:
|
|
||||||
${OSTYPE} - $(uname -mosr)"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
read -d '' tracebot << EOF || true
|
cat <<EOF >>! /tmp/ztrace/.zshrc
|
||||||
#################
|
#################
|
||||||
# zim trace end #
|
# zim trace end #
|
||||||
#################
|
#################
|
||||||
|
|
||||||
set +x
|
unsetopt xtrace
|
||||||
zprof >! /tmp/ztrace/zprof
|
zprof >! /tmp/ztrace/zprof
|
||||||
#non-linux systems have weird fd; also, no real need to redirect back
|
#non-linux systems have weird fd; also, no real need to redirect back
|
||||||
#prompt is (practically speaking) non-interactive, fd exists only for that process
|
#prompt is (practically speaking) non-interactive, fd exists only for that process
|
||||||
|
@ -103,20 +75,13 @@ zprof >! /tmp/ztrace/zprof
|
||||||
#exec 2>&3 3>&-
|
#exec 2>&3 3>&-
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
# create a modified .zshrc to produce a trace log
|
|
||||||
origzshrc=$(</tmp/ztrace/.zshrc.orig)
|
|
||||||
print "${tracetop}\n${origzshrc}\n${tracebot}" >! /tmp/ztrace/.zshrc
|
|
||||||
|
|
||||||
# clean up the vars now that we are done with them.
|
|
||||||
unset origzshrc tracetop tracebot
|
|
||||||
|
|
||||||
print "\nSpawning zsh and producing trace...\n\n"
|
print "\nSpawning zsh and producing trace...\n\n"
|
||||||
ZDOTDIR=/tmp/ztrace zsh -ic 'exit'
|
ZDOTDIR=/tmp/ztrace zsh -ic 'exit'
|
||||||
print "Trace complete.
|
print "Trace complete.
|
||||||
Parsing logs to a nicer format; this may take some time..."
|
Parsing logs to a nicer format; this may take some time..."
|
||||||
|
|
||||||
# this is ugly thing makes it pretty...
|
# this is ugly thing makes it pretty...
|
||||||
paste <( while read tim; do crt=000000000$((${tim//.}-10#0$last)); printf "%12.9f\n" ${crt:0:${#crt}-9}.${crt:${#crt}-9}; last=${tim//.}; done < /tmp/ztrace/sample-time.(*).tim; ) /tmp/ztrace/sample-time.(*).log > /tmp/ztrace/ztrace.log
|
while read line; do if [[ ${line} =~ '^[0-9]+-_-' ]]; then crt=000000$((${line%%-_-*}-10#0$last)); printf "%12.9f %s\n" ${crt:0:${#crt}-6}.${crt:${#crt}-6} ${line#*-_-}; last=${line%%-_-*}; fi; done < /tmp/ztrace/sample-time.(*).log > /tmp/ztrace/ztrace.log
|
||||||
print "Parsing complete!"
|
print "Parsing complete!"
|
||||||
|
|
||||||
# safe to remove old, unneeded environment files
|
# safe to remove old, unneeded environment files
|
||||||
|
@ -130,7 +95,7 @@ rm -f /tmp/ztrace/.zcompdump*
|
||||||
|
|
||||||
print "Archiving trace logs...\n"
|
print "Archiving trace logs...\n"
|
||||||
|
|
||||||
tar -cf /tmp/ztrace.tar.gz /tmp/ztrace/
|
tar -czf /tmp/ztrace.tar.gz /tmp/ztrace/
|
||||||
|
|
||||||
print "Archive complete!\n
|
print "Archive complete!\n
|
||||||
Trace by with execution time available at:
|
Trace by with execution time available at:
|
||||||
|
|
Loading…
Reference in a new issue