SQWareProduction:oracle:bin:sqwora MonitorWithStatspack.ksh

Presentation

Script $gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh :

Monitor ratios with Statspack

Online help

The online help is available for most scripts with the -h option.
Ex: $gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -h
Content of this assistance :

Sourcing sqwora_Global.lib v2024.07 SQWareProduction for Oracle (dbSQWare) ... 

Usage: sqwora_MonitorWithStatspack.ksh [-h] -I <instance> [+ options]

DESCRIPTION
   sqwora_MonitorWithStatspack.ksh Monitor ratios with Statspack
SUPPORT
   Oracle supported versions: 9iR2 <= v <= 11gR2

PARAMETERS
     -I  instance       : Target instance to generation
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -BD   date         : Begin date min of snap (by default: 'trunc(sysdate-1)').
     -ED   date         : End date max of snap (by default: 'sysdate').
     -Pdb  pdb_name     : pdb_name for multitenant.
     -DIR  directory    : Directory to store reports.
     -FRT return_code   : Force return code value on error.
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -Local             : Only extract reports.
     -Dist              : For distant connection to database (change $gvsqw_DbaUser to $gvsqw_DistDbaUser@$ORACLE_SID ).
     -NoDel             : Don't remove local reports.
     -Force             : Bypass version check.
     -NoTrace           : Deactivate trace job (and upload log) in SQWareRepository.
     -NoUpLoadLog       : Deactivate upload log in SQWareRepository.
     -Locale    locale  : Force Locale for help display (fr,en).
     -NoMail            : Deactivate sendmail on error to pmexpdba@gmail.com (by default, send on error).

Error management

Errors passing arguments

This type of message is generated:

Lack instance parameter, Usage: sqwora_MonitorWithStatspack.ksh [-h] -I <instance> [+ options]
For full help : sqwora_MonitorWithStatspack.ksh -h

If you are connecting through a terminal, no mail will be sent and you will have more this kind of message:

Not sending mail because you are in connected mode !!!
Lack instance parameter

If you are not connected to a terminal, the error message appears and is sent by mail to the address contained in the variable $gvsqw_GlobalMail (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_oracle : " (See help customize this variable).

Execution errors

Whether you are or not connected to a terminal, the error message appears and an email containing a summary of treatment errors is sent to the address contained in the variable $gvsqw_Mail_oracle (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_oracle : " (See help customize this variable).

Usage examples

Sourcing sqwora_Global.lib v2024.07 SQWareProduction for Oracle (dbSQWare) ... 

#Standard help for script sqwora_MonitorWithStatspack.ksh:

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -h
#Display online help for this script

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -Locale en -h
#Display online help for this script with forcing of the 'en' locale (by default locale managed by $gvsqw_Locale)

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -s
#Display usage examples for this script

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID
#Generate monitoring workLoad based on Statspack reports

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -BD 'trunc(sysdate)' -ED 'sysdate-(1/24*4)'  
#Generate wkl between today, 00h00 and now-4hours

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -Dist
#Generate monitoring workLoad based on Statspack with distant connection on non-local instance $ORACLE_SID
#You need to register credentials to use for distant connection to the instance (user and so on) in file $gvsqw_DistPasswdFile

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -Force
#Bypass version check

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -Pdb <pdb_name> 
#Specify pugable database name <pdb_name> for multitenant environnements

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -DIR <directory_name> -NoDel -NoTrace -NoUpLoadLog -Local
#Audit with Statspack : store reports in <directory_name> on localhost, and disable trace job and upload log in SQWareRepository

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com'
#Add the mail list to the default address managed by the variable gvsqw_GlobalMail

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -SendReport
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -NoMail
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_OraBin/sqwora_MonitorWithStatspack.ksh -I $ORACLE_SID -FRT <NumericValue>
#Force return code to '<NumericValue>' on error (if no error, "exit 0!")
#You can also force return code of this script on all your
#environnement if you set the variable: $gvsqw_ForcedReturnCodeScript_sqwora_Monitor_Statpack=<NumericValue>
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg