From cc899b83306912b9ce006161dadb1618c78a0c4c Mon Sep 17 00:00:00 2001
From: wpuziewicz <35240389+wpuziewicz@users.noreply.github.com>
Date: Mon, 8 Apr 2024 11:31:41 -0500
Subject: [PATCH] feat: Update `oracle` docs, readme and help regarding
 `STATSPACK` collection. (#394)

Update docs, readme and help regarding STATSPACK collection.
---
 docs/user_guide/oracle/collection_scripts.md |  5 ++++-
 scripts/collector/oracle/README.txt          | 14 ++++++++++++--
 scripts/collector/oracle/collect-data.sh     |  7 +++++--
 3 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/docs/user_guide/oracle/collection_scripts.md b/docs/user_guide/oracle/collection_scripts.md
index b038c18b..12e45cab 100644
--- a/docs/user_guide/oracle/collection_scripts.md
+++ b/docs/user_guide/oracle/collection_scripts.md
@@ -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:
diff --git a/scripts/collector/oracle/README.txt b/scripts/collector/oracle/README.txt
index 1150c3a4..a8816ac4 100644
--- a/scripts/collector/oracle/README.txt
+++ b/scripts/collector/oracle/README.txt
@@ -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:
    
@@ -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:
         
diff --git a/scripts/collector/oracle/collect-data.sh b/scripts/collector/oracle/collect-data.sh
index 2f8ebd11..7bc1f84e 100755
--- a/scripts/collector/oracle/collect-data.sh
+++ b/scripts/collector/oracle/collect-data.sh
@@ -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:"