Skip to content

feat(demo): open tmux log pane automatically #130

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

Draft
maxgio92 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(demo): open tmux log pane automatically #130

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
5 changes: 5 additions & 0 deletions demo/basic/demo.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ DEMO_APP="./demo-app"
XCOVER="${SCRIPT_DIR}/../../xcover"
SLEEP="${SLEEP:-2}"

# shellcheck source=../lib/log-pane.sh
source "${SCRIPT_DIR}/../lib/log-pane.sh"

function cleanup() {
teardown_log_pane
${XCOVER} stop 2>/dev/null || true
pkill -f "${XCOVER} run" 2>/dev/null || true
rm -f $DEMO_APP
Expand All @@ -25,6 +29,7 @@ function main() {
exit 1
fi

setup_log_pane kernel
clear
runCmd "# === xcover: Functional Test Coverage Profiler ==="
runCmd "# Profile coverage without instrumenting your binaries!"
Expand Down
5 changes: 5 additions & 0 deletions demo/debugfile/demo.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ DEBUG_FILE="./demo-app.debug"
XCOVER="${SCRIPT_DIR}/../../xcover"
SLEEP="${SLEEP:-2}"

# shellcheck source=../lib/log-pane.sh
source "${SCRIPT_DIR}/../lib/log-pane.sh"

function cleanup() {
teardown_log_pane
${XCOVER} stop 2>/dev/null || true
pkill -f "${XCOVER} run" 2>/dev/null || true
rm -f $DEMO_APP $DEBUG_FILE
Expand All @@ -28,6 +32,7 @@ function main() {
exit 1
fi

setup_log_pane kernel
clear
runCmd "# === xcover: Coverage with a separate debug file ==="
runCmd "# Strip the binary for production. Keep the debug file for profiling."
Expand Down
30 changes: 30 additions & 0 deletions demo/lib/log-pane.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#!/bin/bash
# log-pane.sh — tmux log pane helper for xcover demos.
#
# Usage:
# source "$(dirname "${BASH_SOURCE[0]}")/../lib/log-pane.sh"
#
# setup_log_pane kernel # tail /sys/kernel/debug/tracing/trace_pipe
# setup_log_pane userspace # tail ~/.bpftime/runtime.log
#
# Call teardown_log_pane in your cleanup() function.

LOG_PANE=""

function setup_log_pane() {
[ -z "${TMUX:-}" ] && return
local mode="${1:-kernel}"
local log_cmd
if [ "$mode" = "userspace" ]; then
log_cmd="tail -f ~/.bpftime/runtime.log"
else
log_cmd="cat /sys/kernel/debug/tracing/trace_pipe"
fi
LOG_PANE=$(tmux split-window -h -P -F "#{pane_id}" "$log_cmd")
tmux select-pane -L
}

function teardown_log_pane() {
[ -n "${LOG_PANE:-}" ] && tmux kill-pane -t "$LOG_PANE" 2>/dev/null || true
LOG_PANE=""
}
5 changes: 5 additions & 0 deletions demo/stripped/demo.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ DEMO_APP="./demo-app"
XCOVER="${SCRIPT_DIR}/../../xcover"
SLEEP="${SLEEP:-2}"

# shellcheck source=../lib/log-pane.sh
source "${SCRIPT_DIR}/../lib/log-pane.sh"

function cleanup() {
teardown_log_pane
${XCOVER} stop 2>/dev/null || true
pkill -f "${XCOVER} run" 2>/dev/null || true
rm -f $DEMO_APP
Expand All @@ -26,6 +30,7 @@ function main() {
exit 1
fi

setup_log_pane kernel
clear
runCmd "# === xcover: Coverage on stripped binaries ==="
runCmd "# No source instrumentation. No debug info. Just the binary."
Expand Down
Loading