Skip to content

Commit

Permalink
feat: Update oracle docs, readme and help regarding STATSPACK col…
Browse files Browse the repository at this point in the history
…lection. (#394)

Update docs, readme and help regarding STATSPACK collection.
  • Loading branch information
wpuziewicz authored Apr 8, 2024
1 parent c8d3c20 commit cc899b8
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
5 changes: 4 additions & 1 deletion docs/user_guide/oracle/collection_scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,12 @@ Launch the collection script: (Note that the parameter names have changed from e
--collectionUserPass Database password
}
Performance statistics source
--statsSrc Required. Must be one of AWR, STATSPACK, NONE
--statsSrc Required. Must be one of AWR, STATSPACK, NONE. When using STATSPACK, see note about --statsWindow parameter below.
Performance statistics window
--statsWindow Optional. Number of days of performance stats to collect. Must be one of 7, 30. Default is 30.
NOTE: IF STATSPACK HAS LESS THAN 30 DAYS OF COLLECTION DATA, SET THIS PARAMETER TO 7 TO LIMIT TO 1 WEEK OF COLLECTION.
IF STATSPACK HAS BEEN ACTIVATED SPECIFICALLY FOR DMA COLLECTION, ENSURE THERE ARE AT LEAST 8
CALENDAR DAYS OF COLLECTION BEFORE RUNNING THE DMA COLLECTOR.
NOTE: If using an Oracle auto-login wallet, specify the tns alias as the connection string:
Expand Down
14 changes: 12 additions & 2 deletions scripts/collector/oracle/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,12 @@ for analysis by Database Migration Assessment.
--collectionUserPass Database password.
}
Performance statistics source
--statsSrc Required. Must be one of AWR, STATSPACK, NONE.

--statsSrc Required. Must be one of AWR, STATSPACK, NONE. When using STATSPACK, see note about --statsWindow parameter below.
Performance statistics window
--statsWindow Optional. Number of days of performance stats to collect. Must be one of 7, 30. Default is 30.
NOTE: IF STATSPACK HAS LESS THAN 30 DAYS OF COLLECTION DATA, SET THIS PARAMETER TO 7 TO LIMIT TO 1 WEEK OF COLLECTION.
IF STATSPACK HAS BEEN ACTIVATED SPECIFICALLY FOR DMA COLLECTION, ENSURE THERE ARE AT LEAST 8
CALENDAR DAYS OF COLLECTION BEFORE RUNNING THE DMA COLLECTOR.

Examples:

Expand All @@ -117,6 +121,12 @@ for analysis by Database Migration Assessment.
./collect-data.sh --collectionUserName {user} --collectionUserPass {password} --hostName {db host} --port {listener port} --databaseService {service name} --statsSrc STATSPACK


If Statspack has less than 30 days of data, limit collection to the last 7 days using the paramter --statsWindow:

./collect-data.sh --connectionStr MyUser/MyPassword@//dbhost.company.com:1521/MyDbName.company.com --statsSrc STATSPACK --statsWindow 7
or
./collect-data.sh --collectionUserName MyUser --collectionUserPass MyPassword --hostName dbhost.company.com --port 1521 --databaseService MyDbName.company.com --statsSrc STATSPACK --statsWindow 7


Collections can be run as SYS if needed by setting ORACLE_SID and running on the database host:

Expand Down
7 changes: 5 additions & 2 deletions scripts/collector/oracle/collect-data.sh
Original file line number Diff line number Diff line change
Expand Up @@ -294,10 +294,13 @@ echo " --collectionUserName Database user name"
echo " --collectionUserPass Database password"
echo " }"
echo " Performance statistics source"
echo " --statsSrc Required. Must be one of AWR, STATSPACK, NONE"
echo
echo " --statsSrc Required. Must be one of AWR, STATSPACK, NONE. When using STATSPACK, see note about --statsWindow parameter below."
echo ""
echo " Performance statistics window"
echo " --statsWindow Optional. Number of days of performance stats to collect. Must be one of 7, 30. Default is 30."
echo " NOTE: IF STATSPACK HAS LESS THAN 30 DAYS OF COLLECTION DATA, SET THIS PARAMETER TO 7 TO LIMIT TO 1 WEEK OF COLLECTION."
echo " IF STATSPACK HAS BEEN ACTIVATED SPECIFICALLY FOR DMA COLLECTION, ENSURE THERE ARE AT LEAST 8"
echo " CALENDAR DAYS OF COLLECTION BEFORE RUNNING THE DMA COLLECTOR."
echo
echo
echo " Example:"
Expand Down

0 comments on commit cc899b8

Please sign in to comment.