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

[CLI][techsupport] Add NOOP option for commands that did not have that option #1445

Merged
merged 5 commits into from
Feb 25, 2021
Merged

[CLI][techsupport] Add NOOP option for commands that did not have that option #1445

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
98f27b1
add NOOP option for save_proc and docker cp commands
smaheshm Feb 18, 2021
afdc363
formatting change as per comments
smaheshm Feb 19, 2021
4a67fb7
add NOOP for platform info, and fix a bug
smaheshm Feb 19, 2021
d01a7d8
update as per comments
smaheshm Feb 22, 2021
7261f43
fix the start time
smaheshm Feb 23, 2021
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
175 changes: 102 additions & 73 deletions scripts/generate_dump
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,7 @@ save_cmd() {
# This is required if $cmd has quoted strings that should be bunched
# as one argument, e.g. vtysh -c "COMMAND HERE" needs to have
# "COMMAND HERE" bunched together as 1 arg to vtysh -c
if $do_gzip
then
if $do_gzip; then
tarpath="${tarpath}.gz"
filepath="${filepath}.gz"
local cmds="$cmd 2>&1 | gzip -c > '${filepath}'"
Expand Down Expand Up @@ -214,6 +213,71 @@ save_cmd_all_ns() {
fi
}

###############################################################################
# Copies a given file from a specified docker to the given target location
# default (host) namespace in single ASIC platform
# Globals:
# None
# Arguments:
# docker: docker name
# filename: the filename to copy
# destination: destination filename
# Returns:
# None
###############################################################################
copy_from_docker() {
local start_t=$(date +%s%3N)
local end_t=0
local docker=$1
local filename=$2
local dstpath=$3
local timeout_cmd="timeout --foreground ${TIMEOUT_MIN}m"

if $NOOP; then
echo "${timeout_cmd} sudo docker exec -i ${docker} touch ${filename}"
echo "${timeout_cmd} sudo docker cp ${docker}:${filename} ${dstpath}"
else
eval "${timeout_cmd} sudo docker exec -i ${docker} touch ${filename}"
if [ $? -ne 0 ]; then
echo "Command: $cmd timedout after ${TIMEOUT_MIN} minutes."
fi
eval "${timeout_cmd} sudo docker cp ${docker}:${filename} ${dstpath}"
if [ $? -ne 0 ]; then
echo "Command: $cmd timedout after ${TIMEOUT_MIN} minutes."
fi
fi
end_t=$(date +%s%3N)
echo "[ copy_from_docker:${docker}:${filename} ] : $(($end_t-$start_t)) msec" \
>> $TECHSUPPORT_TIME_INFO
}

###############################################################################
# Copies a given file from a specified docker to the given target location
# default (host) namespace in single ASIC platform
# Globals:
# NUM_ASICS
# Arguments:
# docker: docker name
# filename: the filename to copy
# destination: destination filename
# Returns:
# None
###############################################################################
copy_from_masic_docker() {
local docker=$1
local filename=$2
local dstpath=$3

if [[ ("$NUM_ASICS" > 1) ]]; then
for (( i=0; i<$NUM_ASICS; i++ ))
do
copy_from_docker "$docker$i" "$filename" "$dstpath.$i"
done
else
copy_from_docker "$docker" "$filename" "$dstpath"
fi
}

###############################################################################
# Returns namespace option to be used with vtysh commmand, based on the ASIC ID.
# Returns empty string if no ASIC ID is provided
Expand All @@ -232,6 +296,7 @@ get_vtysh_namespace() {
else
ns=" -n ${asic_id}"
fi
echo "$ns"
}

###############################################################################
Expand Down Expand Up @@ -493,17 +558,27 @@ save_redis_info() {
# RM
# BASE
# TARFILE
# NOOP
# Arguments:
# *procfiles: variable-length list of proc file paths to save
# Returns:
# None
###############################################################################
save_proc() {
local procfiles="$@"
$MKDIR $V -p $TARDIR/proc \
&& (for f in $procfiles; do ( [ -e $f ] && $CP $V -r $f $TARDIR/proc ) || echo "$f not found" > $TARDIR/$f; done) \
&& $TAR $V -rhf $TARFILE -C $DUMPDIR --mode=+rw $BASE/proc \
&& $RM $V -rf $TARDIR/proc
$MKDIR $V -p $TARDIR/proc
for f in $procfiles
do
if $NOOP; then
if [ -e $f ]; then
echo "$CP $V -r $f $TARDIR/proc"
fi
else
( [ -e $f ] && $CP $V -r $f $TARDIR/proc ) || echo "$f not found" > $TARDIR/$f
fi
done
$TAR $V -rhf $TARFILE -C $DUMPDIR --mode=+rw $BASE/proc
$RM $V -rf $TARDIR/proc
}

###############################################################################
Expand Down Expand Up @@ -544,41 +619,6 @@ save_saidump() {
fi
}

###############################################################################
# Runs a 'show platform' command, append the output to 'filename' and add to the incrementally built tar.
# Globals:
# LOGDIR
# BASE
# MKDIR
# TAR
# TARFILE
# DUMPDIR
# V
# RM
# Arguments:
# type: the type of platform information
# filename: the filename to save the output as in $BASE/dump
# Returns:
# None
###############################################################################
save_platform() {
local start_t=$(date +%s%3N)
local end_t=0
local type="$1"
local filename=$2
local filepath="${LOGDIR}/$filename"
local tarpath="${BASE}/dump/$filename"
[ ! -d $LOGDIR ] && $MKDIR $V -p $LOGDIR

eval "show platform $type" &>> "$filepath"
echo $'\r' >> "$filepath"

($TAR $V -uhf $TARFILE -C $DUMPDIR "$tarpath" \
|| abort "${ERROR_TAR_FAILED}" "tar append operation failed. Aborting to prevent data loss.")
end_t=$(date +%s%3N)
echo "[ save_platform:$type ] : $(($end_t-$start_t)) msec" >> $TECHSUPPORT_TIME_INFO
}

###############################################################################
# Save platform related info
# Globals:
Expand All @@ -589,11 +629,11 @@ save_platform() {
# None
###############################################################################
save_platform_info() {
save_platform "syseeprom" "platform"
save_platform "psustatus" "platform"
save_platform "ssdhealth" "platform"
save_platform "temperature" "platform"
save_platform "fan" "platform"
save_cmd "show platform syseeprom" "syseeprom"
save_cmd "show platform psustatus" "psustatus"
save_cmd "show platform ssdhealth" "ssdhealth"
save_cmd "show platform temperature" "temperature"
save_cmd "show platform fan" "fan"
}

###############################################################################
Expand Down Expand Up @@ -800,6 +840,9 @@ collect_broadcom() {
save_bcmcmd_all_ns "\"mirror dest show\"" "mirror.dest.summary"
save_bcmcmd_all_ns "\"port *\"" "port.summary"
save_bcmcmd_all_ns "\"d chg my_station_tcam\"" "mystation.tcam.summary"

copy_from_masic_docker "syncd" "/var/log/diagrun.log" "/var/log/diagrun.log"
copy_from_masic_docker "syncd" "/var/log/bcm_diag_post" "/var/log/bcm_diag_post"
}

###############################################################################
Expand Down Expand Up @@ -859,22 +902,26 @@ save_log_files() {
###############################################################################
# Save warmboot files
# Globals:
# TARDIR, TARFILE, TAR, DUMPDIR, TECHSUPPORT_TIME_INFO
# TARDIR, TARFILE, TAR, DUMPDIR, TECHSUPPORT_TIME_INFO, NOOP
# Arguments:
# None
# Returns:
# None
###############################################################################
save_warmboot_files() {
# Copy the warmboot files
mkdir -p $TARDIR
$CP $V -rf /host/warmboot $TARDIR

start_t=$(date +%s%3N)
($TAR $V --warning=no-file-removed -rhf $TARFILE -C $DUMPDIR --mode=+rw \
$BASE/warmboot \
|| abort "${ERROR_TAR_FAILED}" "Tar append operation failed. Aborting for safety.") \
&& $RM $V -rf $TARDIR
if $NOOP; then
echo "$CP $V -rf /host/warmboot $TARDIR"
else
mkdir -p $TARDIR
$CP $V -rf /host/warmboot $TARDIR

start_t=$(date +%s%3N)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line needs to be out of the condition to be used for calculating the time.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another question is if we need to log the time of the output generation for noop case. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not needed, adding it to be consistent with other commands.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line needs to be out of the condition to be used for calculating the time.

😬

($TAR $V --warning=no-file-removed -rhf $TARFILE -C $DUMPDIR --mode=+rw \
$BASE/warmboot \
|| abort "${ERROR_TAR_FAILED}" "Tar append operation failed. Aborting for safety.") \
&& $RM $V -rf $TARDIR
fi
end_t=$(date +%s%3N)
echo "[ Warm-boot Files ] : $(($end_t-$start_t)) msec" >> $TECHSUPPORT_TIME_INFO
}
Expand Down Expand Up @@ -1122,24 +1169,6 @@ main() {
end_t=$(date +%s%3N)
echo "[ TAR /etc Files ] : $(($end_t-$start_t)) msec" >> $TECHSUPPORT_TIME_INFO

if [ "$asic" = "broadcom" ]; then
if [[ ("$NUM_ASICS" > 1) ]]; then
for (( i=0; i<$NUM_ASICS; i++ ))
do
sudo docker exec -i syncd$i touch /var/log/diagrun.log
sudo docker exec -i syncd$i touch /var/log/bcm_diag_post

sudo docker cp syncd$i:/var/log/diagrun.log /var/log/diagrun.log.$i
sudo docker cp syncd$i:/var/log/bcm_diag_post /var/log/bcm_diag_post.$i
done
else
sudo docker exec -i syncd touch /var/log/diagrun.log
sudo docker exec -i syncd touch /var/log/bcm_diag_post

sudo docker cp syncd:/var/log/diagrun.log /var/log/diagrun.log
sudo docker cp syncd:/var/log/bcm_diag_post /var/log/bcm_diag_post
fi
fi
save_log_files
save_warmboot_files
save_crash_files
Expand Down