sdp_health_check.sh.man.txt #2

  • //
  • guest/
  • perforce_software/
  • sdp/
  • dev/
  • doc/
  • gen/
  • sdp_health_check.sh.man.txt
  • View
  • Commits
  • Open Download .zip Download (2 KB)
USAGE for sdp_health_check.sh v1.9.0:

sdp_health_check.sh

   or

sdp_health_check.sh -h|-man

DESCRIPTION:

	This script does a health check of the SDP. It generates a
	report log, which can be emailed to support@perforce.com.
	It identifies SDP instances and reports on general SDP health.

	It must be run as the OS user who owns the /p4/common/bin
	directory.  This should be the user account which runs the
	p4d process, and which owns the /p4/common/bin directory
	(often 'perforce' or 'p4admin').

	Characteristics of this script:
	* It is always safe to run.  It does only analysis and reporting.
	* It does only fast checks, and has no interactive prompts.
	  Some log files are captured such as checkpoint.log, but not
	  potentially large ones such as the p4d server log.
	* It requires no command line arguments.
	* It works for any and all UNIX/Linux SDP version since 2007.
 
	Assumptions:
	* The SDP has always used /p4/common/bin/p4_vars as the shell
	  environment file.  This is consistent across all SDP versions.

OPTIONS:
 -D     Set extreme debugging verbosity.

HELP OPTIONS:
 -h	Display short help message
 -man	Display man-style help message

EXAMPLES:
	This script is typically called with no arguments.

LOGGING:
	This script generates a log file and also displays it to stdout at the
	end of processing.  By default, the log is:
	
	/tmp/sdp_health_check.<datestamp>.log

	or

	/tmp/sdp_health_check.log

	The exception is usage errors, which result an error being sent to
	stderr followed usage info on stdout, followed by an immediate exit.

EXIT CODES:
	An exit code of 0 indicates no errors or warnings were encountered.

# Change User Description Committed
#7 31557 C. Thomas Tyler Updated generated script man pages.
#6 31064 C. Thomas Tyler Updated generated script man pages.
#5 30912 C. Thomas Tyler Updated generated script man pages.
#4 30384 C. Thomas Tyler Updated generated script man pages.
#3 30291 C. Thomas Tyler Updated generated script man pages.
#2 30030 C. Thomas Tyler Updated generated script man pages.
#1 29844 C. Thomas Tyler Added sdp_health_check to SDP package.

Updated docs in Guide and Release Notes to reflect this change.

Added more docs for this in the SDP Guide.

#review-29845 @vkanczes