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

Jump to bottom

ZRFE-907: Add warning on -a option #103

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

ZRFE-907: Add warning on -a option #103

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3b0d6f
Add warning on -j option
zmcommand Jan 31, 2022
5755249
Fix: I had the wrong switch. It wasn't -j it was -a that we need to w…
zmcommand Feb 1, 2022
c57b743
Fix typo
ronstra-synacor Jan 4, 2023
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
55 changes: 55 additions & 0 deletions .idea/workspace.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

79 changes: 49 additions & 30 deletions src/libexec/zmdiaglog
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ use Zimbra::Mon::Zmstat;
use Digest::MD5;

use vars qw(
$VERSION $PID_FILE $DEFAULT_DEST $DLOGDIR $JMAP $JAVA $JINFO $DEFAULT_TIMEOUT
$HAVE_GCORE $HAVE_PSTACK $HAVE_LSOF $HAVE_DMESG $LOG_FILE $ZMSTAT_CONF
$ZMDUMPENV $ZMLOCALCONFIG $ZMPROV $ZMHOSTNAME $SU $HAVE_NETSTAT $HAVE_MYSQL $ZMMYTOP $ZMINNOTOP $HAVE_NETWORK
$VERSION $PID_FILE $DEFAULT_DEST $DLOGDIR $JMAP $JAVA $JINFO $DEFAULT_TIMEOUT
$HAVE_GCORE $HAVE_PSTACK $HAVE_LSOF $HAVE_DMESG $LOG_FILE $ZMSTAT_CONF
$ZMDUMPENV $ZMLOCALCONFIG $ZMPROV $ZMHOSTNAME $SU $HAVE_NETSTAT $HAVE_MYSQL $ZMMYTOP $ZMINNOTOP $HAVE_NETWORK
);

my $isMac = isMac();
Expand All @@ -41,7 +41,7 @@ chomp( $ZMHOSTNAME = qx(/opt/zimbra/bin/zmhostname) );
my $zimbra_tmp_directory = "/opt/zimbra/data/tmp";
if ( -f "/opt/zimbra/bin/zmlocalconfig" ) {
$zimbra_tmp_directory =
qx(/opt/zimbra/bin/zmlocalconfig -x -s -m nokey zimbra_tmp_directory);
qx(/opt/zimbra/bin/zmlocalconfig -x -s -m nokey zimbra_tmp_directory);
chomp($zimbra_tmp_directory);
}

Expand All @@ -51,8 +51,8 @@ if ( !-d $zimbra_tmp_directory ) {

$DEFAULT_DEST = "$zimbra_tmp_directory";
$DLOGDIR = "zmdiaglog-$ZMHOSTNAME."
. strftime( "%Y%m%d-%H%M%S", localtime() ) . "."
. $$;
. strftime( "%Y%m%d-%H%M%S", localtime() ) . "."
. $$;
$DEFAULT_TIMEOUT = 120;
$PID_FILE = '/opt/zimbra/log/zmmailboxd_java.pid';
$JMAP = '/opt/zimbra/common/bin/jmap';
Expand Down Expand Up @@ -89,7 +89,7 @@ sub logmsg($) {
sub get_java_version() {
my $version = "UNKNOWN";
open( JAVA, "$JAVA -version 2>&1 |" )
|| die "Cannot determine java version: $!";
|| die "Cannot determine java version: $!";
my $version_line = <JAVA>;
if ( $version_line =~ /"13\.0/ ) {
$version = "13.0";
Expand Down Expand Up @@ -117,6 +117,7 @@ sub get_java_version() {
}

sub save_heap_info($$$$) {

my ( $version, $destination, $pid, $timeout ) = @_;
my $histo_cmd;
my $dump_cmd;
Expand All @@ -128,7 +129,7 @@ sub save_heap_info($$$$) {
logmsg "Retrieving JVM $version heap histogram\n";
exec_with_timeout( " '$histo_cmd' > heap.histo 2>&1", $timeout );
logmsg "Saving JVM $version heapdump\n";
my $success = system("bash -c $dump_cmd ");
my $success = system("bash -c $dump_cmd ");
my $dumped = -f "$dump_file";
$dumped && $success;
}
Expand Down Expand Up @@ -184,7 +185,7 @@ sub get_pid() {
if ( !$pid ) {
eval {
open( PS, "ps -ef | grep [j]etty.xml | awk '{ print \$2 }' |" )
|| die $!;
|| die $!;
$pid = <PS>;
chomp($pid);
chomp($pid);
Expand Down Expand Up @@ -294,17 +295,17 @@ sub run() {
my %options = ('t' => $DEFAULT_TIMEOUT);
my $opt_result =
GetOptions (\%options,
't=i',
'd:s',
'h' => sub{ usage( \*STDERR ); exit 0; },
'j', 'a', 'c', 'z', 'Z',
'' => sub{ print "Error: '-' must be followed by a valid option.\n";
usage( \*STDERR );
exit 1; },
'<>' => sub{ warn("Error: unexpected argument(s): @_\n");
usage( \*STDERR );
exit 1; }
);
't=i',
'd:s',
'h' => sub{ usage( \*STDERR ); exit 0; },
'j', 'a', 'c', 'z', 'Z',
'' => sub{ print "Error: '-' must be followed by a valid option.\n";
usage( \*STDERR );
exit 1; },
'<>' => sub{ warn("Error: unexpected argument(s): @_\n");
usage( \*STDERR );
exit 1; }
);

die "Error: Timeout must be greater than 0.\n" unless $options{t} > 0;
$options{d} = $DEFAULT_DEST if ( $options{d} eq "" );
Expand All @@ -325,6 +326,24 @@ sub run() {
exit 1;
}

if ( $options{a} ) {
print "!!WARNING: In most cases, the -a option is not needed.\n";
print "This option can slow down the server significantly, make the server less stable, and create a very large file.\n";
print "Only using -a if Zimbra support has explicitly asked for a heap dump.\n";
ronstra-synacor marked this conversation as resolved.
Show resolved Hide resolved
print "Do you still wish to perform a heap dump? (Y/N)\n";
chomp(my $input = <STDIN>);
if($input =~ m/^[Y]$/i) {
print "Continuing with -j option."
} elsif ($input =~ m/^[N]$/i) {
print "Exiting. Please remove the -a from your command.\n";
exit 1;
} else {
print "Invalid option.\n";
exit 1;
}
}


my $destination = "$options{d}/$DLOGDIR";
$destination = File::Spec->rel2abs($destination);
my $timeout = $options{t};
Expand All @@ -339,14 +358,14 @@ sub run() {
{
local $> = $uid;
print STDERR "$destination is not writable by user zimbra\n" and exit 1
if !-w $destination;
if !-w $destination;
}

chdir($destination);

my $mailboxd_pid = get_pid();
logmsg "No '-a' argument, skipping heap/coredump collection.\n"
if ( !$options{a} );
if ( !$options{a} );
logmsg "Saving diagnostic logging output to: $destination\n";

my $JAVA_VERSION = get_java_version();
Expand Down Expand Up @@ -514,11 +533,11 @@ sub run() {
system("/opt/zimbra/libexec/zmjavawatch > zmjavawatch.log 2>&1");
}
my $dumped =
save_heap_info( $JAVA_VERSION, $destination, $mailboxd_pid, $timeout )
if ( $options{a} );
save_heap_info( $JAVA_VERSION, $destination, $mailboxd_pid, $timeout )
if ( $options{a} );

save_jvm_core( $JAVA_VERSION, $mailboxd_pid )
if ( $options{c} || ( !$dumped && $options{a} ) );
if ( $options{c} || ( !$dumped && $options{a} ) );

logmsg "Heap dump processing complete. It is now safe to restart mailboxd.\n";
}
Expand Down Expand Up @@ -707,7 +726,7 @@ sub run() {
my ( $zuid, $zgid ) = ( getpwnam($zuser) )[ 2, 3 ];
chown $zuid, $zgid, "$destination/stats/$yesterday_stats_dir";
cp $_, "$destination/stats/$yesterday_stats_dir"
for glob("/opt/zimbra/zmstat/$yesterday_stats_dir/*");
for glob("/opt/zimbra/zmstat/$yesterday_stats_dir/*");
}

my $systemlogfile = "/var/log/messages";
Expand Down Expand Up @@ -741,7 +760,7 @@ sub run() {
$timeout );

logmsg
"\n *** Diagnostics collection done. Data stored in $destination/.\n\n";
"\n *** Diagnostics collection done. Data stored in $destination/.\n\n";

chomp( my $dirname = qx(pwd) );
chomp( $dirname = qx(basename $dirname) );
Expand All @@ -751,12 +770,12 @@ sub run() {
$LOG_FILE = "$destination/$LOG_FILE";
chdir('..');
my $rc = 0xffff &
system("nice -n 19 /bin/tar jcf $destination.$ext $dirname >> $LOG_FILE 2>&1");
system("nice -n 19 /bin/tar jcf $destination.$ext $dirname >> $LOG_FILE 2>&1");
if ( ( $rc == 0 ) && ( -e "$destination.$ext" ) ) {
logmsg "bzip2 archive created\n";
logmsg "Computing MD5 digest\n";
open(my $fh, "<", "$destination.$ext")
or die "cannot open file for reading";
or die "cannot open file for reading";
my $ctx = Digest::MD5->new;
$ctx->addfile($fh);
my $md5 = $ctx->hexdigest;
Expand All @@ -768,7 +787,7 @@ sub run() {
}
else {
logmsg
"An error occurred creating $destination.$ext. Leaving data collection directory intact.\n";
"An error occurred creating $destination.$ext. Leaving data collection directory intact.\n";
logmsg "$0 run complete\n";
}
}
Expand Down