Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plug loading time telemetry #190

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add plug loading time telemetry #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ When not currently active, execute the following:
```zsh
rm -rf "${XDG_DATA_HOME:-$HOME/.local/share}/zap"
```
## TROUBLESHOOTING
If you are attempting to troubleshoot slow shell loading that may be due to slow plugins, add `export zap_print_times=1` to your zshrc file before you call `plug` and it will print out the load time for each plugin or sourced file.

## Notes

Expand Down
37 changes: 36 additions & 1 deletion zap.zsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,36 @@ fpath+="$ZAP_DIR/completion"

function plug() {

function print_elapsed() {
if [[ -v zap_print_times && $timer ]]; then
local now=$(date +%s%3)
local d_ms=$(($now-$timer))
local d_s=$((d_ms / 1000))
local ms=$((d_ms % 1000))
local s=$((d_s % 60))
local m=$(((d_s / 60) % 60))
local h=$((d_s / 3600))

if ((h > 0)); then
elapsed=${h}h${m}m
elif ((m > 0)); then
elapsed=${m}m${s}s
elif ((s >= 10)); then
elapsed=${s}.$((ms / 100))s
elif ((s > 0)); then
elapsed=${s}.$((ms / 10))s
else
elapsed=${ms}ms
fi
if [[ -v plugin_name ]]; then
echo "Loading $plugin_name, Execution time: $elapsed"
else
echo "Loading $plugin_absolute, Execution time: $elapsed"
fi
unset timer
fi
}

function _try_source() {
if [[ "$plugin_name" == "*" ]]; then
# Treat * as a glob pattern
Expand All @@ -27,6 +57,10 @@ function plug() {
fi
}

# Start timer for tracking execution time
typeset -g timer=$(date +%s%3)


# If the absolute is a directory then source as a local plugin
pushd -q "$ZAP_DIR"
local plugin_absolute="${1:A}"
Expand All @@ -42,6 +76,7 @@ function plug() {
# If the basename directory exists, then local source only
if [ -d "${plugin_absolute:h}" ]; then
[[ -f "${plugin_absolute}" ]] && source "${plugin_absolute}"
print_elapsed
return
fi

Expand All @@ -61,7 +96,7 @@ function plug() {
git -C "$plugin_dir" pull --unshallow > /dev/null 2>&1
git -C "$plugin_dir" checkout "$git_ref" > /dev/null 2>&1 || { echo "❌ Failed to checkout $git_ref"; return 13 }
}
_try_source && { ZAP_INSTALLED_PLUGINS+="$plugin_name" && return 0 } || echo "❌ $plugin_name not activated" && return 1
_try_source && print_elapsed && { ZAP_INSTALLED_PLUGINS+="$plugin_name" && return 0 } || echo "❌ $plugin_name not activated" && return 1
}

function _pull() {
Expand Down