Skip to content

Update documentation to add clarity about when to use AWR/ASH vs STATSPACK #484

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update documentation to add clarity about when to use AWR/ASH vs STATSPACK #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd355fd
Update documentation to add clarity about when to use AWR/ASH vs STAT…
wpuziewicz Feb 20, 2025
2ead8d1
Merge branch 'main' into oracle_doc_update
wpuziewicz Apr 2, 2025
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
19 changes: 12 additions & 7 deletions docs/user_guide/shell_scripts/oracle/collection_scripts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,11 @@ The grant_wrapper script will grant privileges required and will output a list o

Launch the collection script: (Note that the parameter names have changed from earlier versions of the collector)

- NOTE: If this is an Oracle RAC and/or PDB environment you just need to run it once per database. No need to run in each PDB or in each Oracle RAC instance.
- If you are licensed for the Oracle Tuning and Diagnostics packs, pass the parameter UseDiagnostics to use the AWR data.
- If you are NOT licensed for the Oracle Tuning and Diagnostics packs, pass the parameter NoDiagnostics to exclude the AWR data. The script will attempt to use STATSPACK data if available.
- NOTES:
- If this is an Oracle RAC and/or PDB environment you just need to run it once per database. No need to run in each PDB or in each Oracle RAC instance.
- If you are licensed for the Oracle Diagnostic pack, specify AWR for the --statsSrc parameter.
- If you are NOT licensed for the Oracle Diagnostics pack, specify STATSPACK for the --statsSrc parameter.
- If you do not want to collect performance data, specife NONE for the --statsSrc parameter. This will block the ability to provide sizing and pricing estimates.

- Parameters
```
Expand All @@ -94,7 +96,9 @@ 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. When using STATSPACK, see note about --statsWindow parameter below.
--statsSrc Required. Must be one of AWR, STATSPACK, NONE.
When using STATSPACK, see note about --statsWindow parameter below.
When using AWR, ensure you are licensed for the Oracle Diagnostics Pack.
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.
Expand All @@ -108,7 +112,7 @@ Launch the collection script: (Note that the parameter names have changed from e
```


To use the licensed Oracle Tuning and Diagnostics pack data:
To use the licensed Oracle Diagnostic pack AWR/ASH data:

```shell
./collect-data.sh --connectionStr {user}/{password}@//{db host}:{listener port}/{service name} --statsSrc AWR
Expand All @@ -123,7 +127,7 @@ or
```

OR
To avoid using the licensed Oracle Tuning and Diagnostics pack data:
To use performance data from STATSPACK collection:

```shell
./collect-data.sh --connectionStr {user}/{password}@//{db hosti}:{listener port}/{service name} --statsSrc STATSPACK
Expand All @@ -146,12 +150,13 @@ or

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

To use the licensed Oracle Diagnostic pack AWR/ASH data:
```shell
./collect-data.sh --connectionStr '/ as sysdba' --statsSrc AWR
```

OR
To avoid using the licensed Oracle Tuning and Diagnostics pack data:
To use performance data from STATSPACK collection:

```shell
./collect-data.sh --connectionStr '/ as sysdba' --statsSrc STATSPACK
Expand Down
11 changes: 10 additions & 1 deletion scripts/collector/oracle/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ for analysis by Database Migration Assessment.
which
zip or gzip

d) Performance Statistics
-------------------------
This utility can collect database performance information from either the AWR/ASH views, or from STATSPACK.
Use of the AWR/ASH views requires that you have a license from Oracle for the Diagnostics Pack.
Note that the AWR/ASH tables and views are installed and enabled by default on Enterprise versions of Oracle,
so their existance is not necessarily indicative of a license.
If you are unsure of your license status, use STATSPACK for performance data collection.

2. Preparation
--------------
Expand Down Expand Up @@ -100,7 +107,9 @@ for analysis by Database Migration Assessment.
--collectionUserPass Database password.
}
Performance statistics source
--statsSrc Required. Must be one of AWR, STATSPACK, NONE. When using STATSPACK, see note about --statsWindow parameter below.
--statsSrc Required. Must be one of AWR, STATSPACK, NONE.
When using STATSPACK, see note about --statsWindow parameter below.
When using AWR, ensure you are licensed for the Oracle Diagnostics Pack.
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.
Expand Down
Loading