4.3 Using On-Demand Diagnostic Collections
Run Oracle Trace File Analyzer on demand using tfactl
command-line tool.
- Collecting Diagnostics and Analyzing Logs On-Demand
Thetfactl
command uses a combination of different Oracle Database support tools when it performs analysis. - Viewing System and Cluster Summary
The summary command gives you a real-time report of system and cluster status. - Investigating Logs for Errors
Use Oracle Trace File Analyzer to analyze all of your logs across your cluster to identify recent errors. - Analyzing Logs Using the Oracle Database Support Tools
The Oracle Database support tools bundle is available only when you download Oracle Trace File Analyzer from My Oracle Support note 2550798.1. - Searching Oracle Trace File Analyzer Metadata
You can search all metadata stored in the Oracle Trace File Analyzer index usingtfactl search -showdatatypes|-json [json_details]
. - Oracle Trace File Analyzer Service Request Data Collections (SRDCs)
Oracle Trace File Analyzer Service Request Data Collections (SRDCs) enable you to quickly collect the right diagnostic data. - Diagnostic Upload
Diagnostic upload eliminates the need for different set of commands to upload Oracle ORAchk, Oracle EXAchk, and Oracle Trace File Analyzer diagnostic collections to AHF Service, database, and Oracle Support. - Changing Oracle Grid Infrastructure Trace Levels
Enable trace levels to collect enough diagnostics to diagnose the cause of the problem. - Performing Custom Collections
Use the custom collection options to change the diagnostic collections from the default. - Limit the Maximum Amount of Memory Used by Oracle Trace File Analyzer
You can now limit the amount of memory used by Oracle Trace File Analyzer. - Limit Oracle Trace File Analyzer's CPU Usage
On Linux the CPU usage of Oracle Trace File Analyzer can be limited with the commandahfctl setresourcelimit [-value value]
Parent topic: Collect Diagnostic Data
4.3.1 Collecting Diagnostics and Analyzing Logs On-Demand
The tfactl
command uses a combination of different Oracle Database support tools when it performs analysis.
The tfactl
command enables you to access Oracle Database support tools using common syntax. Using common syntax hides the complexity of the syntax differences between the tools.
Use the Oracle Trace File Analyzer tools to perform analysis and resolve problems.
If you need more help, then use the tfactl
command to collect
diagnostics for Oracle Support.
Oracle Trace File Analyzer does the following:
-
Collects all relevant log data from a time of your choosing.
-
Trims log files to collect only what is necessary for diagnosis.
-
Packages all diagnostics on the node where
tfactl
was run from.
Parent topic: Using On-Demand Diagnostic Collections
4.3.2 Viewing System and Cluster Summary
The summary command gives you a real-time report of system and cluster status.
Syntax
tfactl summary [options]
tfactl summary -help
Parent topic: Using On-Demand Diagnostic Collections
4.3.3 Investigating Logs for Errors
Use Oracle Trace File Analyzer to analyze all of your logs across your cluster to identify recent errors.
Related Topics
Parent topic: Using On-Demand Diagnostic Collections
4.3.4 Analyzing Logs Using the Oracle Database Support Tools
The Oracle Database support tools bundle is available only when you download Oracle Trace File Analyzer from My Oracle Support note 2550798.1.
Oracle Trace File Analyzer with Oracle Database support tools bundle includes the following tools:
Table 4-5 Tools Included in Linux and UNIX
Tool | Description |
---|---|
|
Provides health checks for the Oracle stack. Oracle Autonomous Health Framework installs either Oracle EXAchk for engineered systems or Oracle ORAchk for all non-engineered systems. For more information, see My Oracle Support notes 1070954.1 and 2550798.1. |
|
Collects and archives operating system metrics. These metrics are useful for instance or node evictions and performance Issues. For more information, see My Oracle Support note 301137.1. |
|
Automates and captures database performance diagnostics and session level hang information. For more information, see My Oracle Support note 459694.1. |
|
Provides near real-time database monitoring. For more information, see My Oracle Support note 1500864.1. |
|
Provides summary of events for one or more database or Oracle ASM alert files from all nodes. |
|
Lists all files that Oracle Trace File Analyzer knows about for a given file name pattern across all nodes. |
|
Generates the process stack for the specified processes across all nodes. |
|
Searches for a given string in the alert or trace files with a specified database. |
|
Provides high-level summary of the configuration. |
|
Opens alert or trace files for viewing a given database and file name pattern in the |
|
Runs a tail on an alert or trace files for a given database and file name pattern. |
|
Shows all database and operating system parameters that match a specified pattern. |
|
Sets and unsets multiple Oracle Clusterware trace levels with one command. |
|
Shows the shell history for the |
|
Reports changes in the system setup over a given time period. The report includes database parameters, operating system parameters, and the patches that are applied. |
|
Reports major events from the cluster event log. |
|
Reports warnings and errors in the logs. |
|
Shows disk space usage and purges Automatic Diagnostic Repository (ADR) log and trace files. |
|
Finds processes. |
|
Summarizes |
Table 4-6 Tools Included in Microsoft Windows
Tool | Description |
---|---|
|
Reports major events from the cluster event log. |
|
Reports changes in the system setup over a given time period. The report includes database parameters, operating system parameters, and patches applied. |
|
Lists all files Oracle Trace File Analyzer knows about for a given file name pattern across all nodes. |
|
Reports warnings and errors seen in the logs. |
|
Searches for a given string in the alert or trace files with a specified database. |
|
Shows the shell history for the |
|
Shows disk space usage and purges ADR log and trace files. |
|
Opens alert or trace files for viewing a given database and file name pattern in the |
|
Shows all database and operating system parameters that match a specified pattern. |
|
Provides high-level summary of the configuration. |
|
Finds processes. |
To verify which tools you have installed:
$ tfactl toolstatus
You can run each tool using tfactl
either in command line or shell mode. To run a tool from the command line:
$ tfactl run tool
The following example shows how to use tfactl
in shell mode. Running the command starts tfactl
, connects to the database MyDB, and then runs oratop
:
$ tfactl
tfactl > database MyDB
MyDB tfactl > oratop
Related Topics
Parent topic: Using On-Demand Diagnostic Collections
4.3.5 Searching Oracle Trace File Analyzer Metadata
You can search all metadata stored in the Oracle Trace File Analyzer index
using tfactl search -showdatatypes|-json [json_details]
.
You can search for all events for a particular Oracle Database between certain dates.
tfactl search -json
'{
"data_type":"event",
"content":"oracle",
"database":"rac11g",
"from":"01/20/2017 00:00:00",
"to":"12/20/2018 00:00:00"
}'
tfactl search -json
"{
\"data_type\":\"event\",
\"content\":\"oracle\",
\"database\":\"rac11g\",
\"from\":\"01/20/2017 00:00:00\",
\"to\":\"12/20/2018 00:00:00\"
}"
To list all index events on Linux, AIX, and Solaris systems: tfactl search
-json '{"data_type":"event"}'
To list all index events on Windows systems: tfactl search -json
"{\"data_type\":\"event\"}"
To list all available datatypes: tfactl search -showdatatypes
Parent topic: Using On-Demand Diagnostic Collections
4.3.6 Oracle Trace File Analyzer Service Request Data Collections (SRDCs)
Oracle Trace File Analyzer Service Request Data Collections (SRDCs) enable you to quickly collect the right diagnostic data.
To perform Service Request Data Collections:
$ tfactl diagcollect -srdc srdc_name
Running the command trims and collects all important log files updated in the past
n hours across the whole cluster. The default number of hours for
log collection varies from SRDC to SRDC. You can change the diagcollect
timeframe with the –last n h|d
option.
Oracle Support often asks you to run a Service Request Data Collection (SRDC). The SRDC depends on the type of problem that you experienced. An SRDC is a series of many data gathering instructions aimed at diagnosing your problem. Collecting the SRDC manually can be difficult with many different steps required.
Oracle Trace File Analyzer can run SRDC collections with a single command:
$ tfactl diagcollect
[-srdc srdc_profile]
[–sr sr_number]
[-tag tagname]
[-z filename]
[-last nh|d | -from time -to time | -for date]
[-database database]
Option | Description |
---|---|
|
Specify the SRDC profile. |
|
Use this parameter to create a subdirectory for the resulting collection in the Oracle Trace File Analyzer repository. |
|
Use this parameter to specify an output file name. |
|
Note: If you specify both date and time, then you must enclose both the values in double quotation marks (""). If you specify only the date or the time, then you do not have to enclose the single value in quotation marks. |
|
Specify the name of the database. |
Note:
To upload collections to the SR as part of diag collection:
If you have already set MOS configuration using the tfactl
setupmos
command, then you can use the -sr
option
along with the diag collection command. Note that tfactl setupmos
is supported only in versions earlier than 20.2.
If you have not set MOS configuration using the tfactl
setupmos
command, then set up MOS configuration using the new generic
command, ahfctl setupload -name mos -type https
and follow the
instructions.
For example: tfactl diagcollect -srdc srdc_type –sr
sr_number
To run SRDCs, use one of the Oracle privileged user accounts:
ORACLE_HOME
ownerGRID_HOME
owner
Table 4-7 One Command Service Request Data Collections
Available SRDCs | Type of Problem | Collection Scope | Auto Collection | ||
---|---|---|---|---|---|
|
Oracle Orachk and Oracle Exachk problems (to be run after running with |
Local only |
No |
||
|
Audit Vault Server related files |
Cluster-wide |
No |
||
|
Collect |
Cluster-wide |
No |
||
|
ASM CRS-related problems |
Cluster-wide |
No |
||
|
ASM CRS CELL-related problems |
Cluster-wide |
No |
||
|
Problems with Access Control Lists (ACLs) |
Local only |
No |
||
|
Problems in an Oracle Advanced Queuing environment |
Local only |
No |
||
|
Queue Monitor (QMON) problems |
Local only |
No |
||
|
Notification problems in an Oracle Advanced Queuing environment |
Local only |
No |
||
|
Performance problems in an Oracle Advanced Queuing environment |
Local only |
No |
||
|
Non-purged messages in an Oracle Advanced Queuing environment problems |
Local only |
No |
||
|
Oracle Database storage problems |
Local only |
No |
||
|
Standard information for Oracle Database auditing |
Local only |
No |
||
|
AUM: Checklist of Evidence to Supply (Doc ID 1682741.1) |
Local only |
No |
||
|
Wait Events related to Undo: Checklist of Evidence to Supply (Doc ID 1682723.1) |
Local only |
No |
||
|
Oracle Database Automatic Workload Repository (AWR) space problems |
Local only |
No |
||
|
Bequeath Connection Issues: Checklist of Evidence to Supply (Doc ID 1928047.1) |
Local only |
No |
||
|
Generic Oracle Database corruption |
Local only |
No |
||
|
Data Guard problems including Broker |
Local only |
No |
||
|
Excessive SYSAUX space is used by the Automatic Workload Repository (AWR) |
Local only |
No |
||
|
Datapatch problems |
Local only |
No |
||
|
DDL Errors: Checklist of Evidence to Supply (Doc ID 2383662.1) |
Local only |
No |
||
|
Event Monitor (EMON) problems |
Local only |
No |
||
|
Collect standard information for Advanced Queueing problems using TFA Collector (recommended) or manual steps |
Local only |
No |
||
|
Oracle Data Pump Export ( |
Local only |
No |
||
|
Oracle Automatic Storage Management (Oracle ASM) / Database File System (DBFS) / Direct NFS / Oracle Advanced Cluster File System (Oracle ACFS) problems |
Local only |
No |
||
|
Fast Recovery Area, also known as Flash Recovery Area problems |
Local only |
No |
||
|
Oracle GoldenGate |
Local only |
No |
||
|
Oracle Database hang problems |
Local only |
No |
||
|
Oracle Database performance and hang problems |
Local only |
No |
||
|
Oracle Data Pump Import ( |
Local only |
No |
||
|
Data Pump Import performance problems |
Local only |
No |
||
|
Oracle Database install / upgrade problems |
Local only |
No |
||
|
Oracle Database single instance shutdown problems |
Local only |
No |
||
|
Parameter Files: Checklist of Evidence to Supply (Doc ID 1914153.1) |
Local only |
No |
||
|
Create or maintain partitioned table, subpartitioned table, and index problems |
Local only |
No |
||
|
Slow |
Local only |
No |
||
|
Oracle Database patching problems |
Local only |
No |
||
|
Oracle Database performance problems |
Cluster-wide |
No |
||
|
Oracle Database performance and hang problems on FASaaS environments |
Local only |
No |
||
|
Enterprise Manager compliance related issues |
Local only |
No |
||
|
Oracle Database preupgrade problems |
Local only |
No |
||
|
Generic Process Management and Related Issues: Checklist of Evidence to Supply (Doc ID 2500734.1) |
Local only |
No |
||
|
Oracle RAC-related data collection for Oracle Clusterware and Oracle ASM problems |
Local only |
No |
||
|
Oracle RAC-related data collection for Oracle Database problems |
Local only |
No |
||
|
Oracle RAC-related performance problems |
Cluster-wide | No | ||
|
Oracle Database problems related to Resource Manager |
Local only |
No |
||
|
Recovery Manager (RMAN) problems |
Local only |
No |
||
|
System Change Number (SCN) |
Local only |
No |
||
|
Oracle Database startup or shutdown problems |
Local only |
No |
||
|
Slow DDL: Checklist of Evidence to Supply |
Local only |
No |
||
|
Space Related Wait Events and Performance Issues : Checklist of Evidence to Supply (Doc ID 2560286.1) |
Local only |
No |
||
|
Oracle Spatial export or import problems |
Local only |
No |
||
|
Oracle Spatial installation problems |
Local only |
No |
||
|
Oracle Spatial performance problems |
Local only |
No |
||
|
Oracle Spatial upgrade problems |
Local only |
No |
||
|
Oracle Spatial usage problems |
Local only |
No |
||
|
SQL performance problems |
Local only |
No |
||
|
Oracle Database Configuration Assistant (Oracle DBCA) problems |
Local only |
No |
||
|
Storage structure related diagnosis |
Local only |
No |
||
|
Generic Tablespace and Segment Management: Checklist of Evidence to Supply (Doc ID 2560291.1) |
Local only |
No |
||
|
Transparent Data Encryption (TDE) problems |
Local only |
No |
||
|
Oracle Text problems |
Local only |
No |
||
|
Oracle Text installation problems - 12c. |
Local only |
No |
||
|
Oracle Text version 12.1.0.1 and later upgrade problems |
Local only |
No |
||
|
Oracle Database resource problems |
Local only |
No |
||
|
Collect standard information for Database Vault |
Local only |
No |
||
|
Oracle Database on Microsoft Windows resources: Checklist of Evidence to Supply |
Local only |
No |
||
|
OracleService on Microsoft Windows: Checklist of Evidence to Supply (Doc ID 1918781.1) |
Local only |
No |
||
|
XDB installation or invalid object problems |
Local only |
No |
||
|
XDB installation and invalid object problems |
Local only |
No |
||
|
XDB installation and invalid object problems in 12c and above |
Local only |
No |
||
|
XDB upgrade problems |
Local only |
No |
||
|
Collect trace/log information for Enterprise Manager Management Agent generic problems |
Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager failures during agent patching |
Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager 13c Agent performance problems |
Agent |
No |
||
|
Enterprise Manager Agent SSL configuration issues |
Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager 13c Agent startup problems |
Agent |
No |
||
|
Enterprise Manager 13c Agent unreachable errors or status |
Agent |
No |
||
|
Enterprise Manager 13c Agent upload errors |
Agent |
No |
||
|
Enterprise Manager 13c Agent patch deployment problems |
Oracle Management Service (OMS) and Agent |
No |
||
|
Collecting diagnostic data for Enterprise Manager 13c Agent installation, upgrade, or deployment problems |
Agent |
No |
||
|
Enterprise Manager 13c Agent upgrade, local installation, or patching problems. |
Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager authentication using LDAP provider issues |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager blackout issues |
Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager target discovery or add problems |
Oracle Management Service (OMS) and Agent Agent Oracle Management Service (OMS) and Agent Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager communication information between Oracle Management Service (OMS) and Agent |
Oracle Management Service (OMS) and Agent |
No |
||
|
Database As A Service (DBaaS): Collect trace or log information for failures during DBaaS deployment. |
Oracle Management Service (OMS) and remote DBaaS deployment server |
No |
||
|
Enterprise Manager debug log collection Run |
Oracle Management Service (OMS) or Agent |
No |
||
|
Enterprise Manager Fleet Maintenance Patching problems |
Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager all job related issues |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager general metrics page or threshold problems |
Agent |
No |
||
|
Enterprise Manager incident rules and notification issues |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager Oracle Management Service (OMS) start up failures |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager Oracle Management Service (OMS) crash problems |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager Java heap usage or performance problems |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager Oracle Management Service (OMS) crash, restart or performance problems |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager failures during Oracle Management Service (OMS) patching |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager Oracle Management Service (OMS) SSL configuration issues |
Oracle Management Service (OMS) |
No |
||
|
Enterprise Manager Oracle Management Service (OMS) installation, upgrade, and patching |
Local only |
No |
||
|
Enterprise Manager patch plan creation problems |
Oracle Management Service (OMS) and Agent |
No |
||
|
Oracle Database, Listener, or ASM target is not discovered or detected by the discovery process |
Local only |
No |
||
|
Enterprise Manager tablespace usage metric problems |
Local only (on Enterprise Manager Agent target) |
No |
||
|
Enterprise Manager WebLogic Server (WLS) SSL configuration issues |
Local only |
No |
||
|
Covers cases where the Enterprise Manager Performance Hub is slow in rendering and/or missing information |
Local only |
No |
||
|
Enterprise Manager RAT collection issues |
Target replay/capture database |
No |
||
|
Enterprise Manager credential issues |
Oracle Management Service (OMS) and Agent |
No |
||
|
Enterprise Manager DB plug in issues |
Oracle Management Service (OMS) and/or Agent |
No |
||
|
Enterprise Manager deploying additional Oracle Management Service (OMS) issues |
Oracle Management Service (OMS) |
No |
||
|
Enterpriser Manager Oracle Management Service (OMS) migration/cloning issues |
Oracle Management Service (OMS) |
No |
||
|
Oracle Exalogic full Exalogs data collection information |
Local only |
No |
||
|
Collect Oracle Exadata information |
Local only |
No |
||
|
Oracle Exadata: Storage software service or offload server service problems |
Local only |
No |
||
|
Oracle Exadata: Smart Scan not working problems |
Local only |
No |
||
|
Fallthrough SRDC for Oracle Database error |
Local only |
No |
||
|
Oracle GoldenGate covering both classic and microservices implementations |
Local only |
No |
||
|
Oracle GoldenGate extract/replicate abends problems |
Local only |
No |
||
|
Oracle RAC-related data collection for Oracle Clusterware problems |
Local only |
No |
||
|
Oracle RAC upgrade and patching problems |
Local only |
No |
||
|
Collect traces for the following ORA errors:
|
Local only |
No |
||
|
Other internal Oracle Database errors |
Local only |
No |
||
|
Listener errors: |
Local only |
No |
||
|
Naming service errors: |
Local only |
No |
||
|
|
ORA Errors |
Local only |
Only the following SRDCs:
|
|
|
Open Cursors problems |
Local only |
No |
||
|
|
Local only |
No |
||
|
|
Local only |
No |
||
|
Collect information for troubleshooting
|
Local only |
No |
||
|
Collect information for troubleshooting Control File
block corruption reported by error |
Local only |
No |
||
|
Data Collection for privileges and roles |
Local only |
No |
||
|
Diagnostic data collection for XDB |
Local only |
No |
||
|
Zero Data Loss Recovery Appliance (ZDLRA) problems |
Local only |
No |
For more information about SRDCs, run tfactl diagcollect –srdc -help
.
Note:
When you run thetfactl diagcollect
command to query an
ora-*
error event, for example, tfactl diagcollect -srdc
ora-600
, AHF lists all ora-*
error events without
filtering. This is because of generic event mapping for all ORA-*
error
events in the srdc_dbrac.xml
file.
The types of information that the SRDCs collect varies for each type, for example, the following table lists and describes what the SRDCs collect for each type.
Table 4-8 SRDC collections
Command | What gets collected |
---|---|
|
|
|
|
Oracle Trace File Analyzer prompts you to enter the information required based on the SRDC type.
For example, when you run ORA-4031
SRDC:
$ tfactl diagcollect –srdc ORA-04031
Oracle Trace File Analyzer:
- Prompts to enter event date, time, and database name.
- Scans the system to identify recent events in the system (up to 10).
- Proceeds with diagnostic collection after you choose the relevant event.
- Identifies all the required files.
- Trims all the files where applicable.
- Packages all data in a zip file ready to provide to support.
You can also run an SRDC collection in non-interactive silent mode. Provide all the required parameters up front as follows:
$ tfactl diagcollect –srdc srdc_type -database db -from "date time" -to "date time"
Related Topics
- https://support.oracle.com/rs?type=doc&id=1918781.1
- https://support.oracle.com/rs?type=doc&id=2560291.1
- https://support.oracle.com/rs?type=doc&id=2560286.1
- https://support.oracle.com/rs?type=doc&id=2500734.1
- https://support.oracle.com/rs?type=doc&id=1914153.1
- https://support.oracle.com/rs?type=doc&id=2383662.1
- https://support.oracle.com/rs?type=doc&id=1682741.1
- https://support.oracle.com/rs?type=doc&id=1682723.1
- https://support.oracle.com/rs?type=doc&id=1928047.1
Parent topic: Using On-Demand Diagnostic Collections
4.3.7 Diagnostic Upload
Diagnostic upload eliminates the need for different set of commands to upload Oracle ORAchk, Oracle EXAchk, and Oracle Trace File Analyzer diagnostic collections to AHF Service, database, and Oracle Support.
Diagnostic upload enables you to manage configurations of different types of uploads
in a generic way. Through ahfctl
command-line interface, you use
generic upload commands to set, get, unset, and check configurations. Configurations are
uniquely identified using configuration name so that you can pass the configuration name
in command-line to perform upload and other operations.
AHF synchronizes the configuration automatically across the cluster nodes.
If you find any sync issues, then run the tfactl syncahfconfig -c
command to sync configuration across the cluster nodes.
root
. If you install
AHF as a non-root user, then you cannot benefit from the multiple operating system users
support.
Note:
Currently not supported on Microsoft Windows.Currently, AHF supports HTTP, SQLNET, and SFTP types or protocols, or end points. Following sections list the parameters or arguments supported by different end points while setting the configuration.
HTTP
Set Parameters:
url
, user
, password
,
proxy
, noauth
, https_token
,
header
, secure
, and
storetype
Upload Parameters:
id
, file
, and https_token
SQLNET
Set Parameters:
user
, password
, connectstring
,
and uploadtable
Upload Parameters:
file
SFTP
Set Parameters:
server
, user
, and password
Upload Parameters: (optional) id
and
file
Parameters or arguments Supported by Different Endpoints
Table 4-9 Parameters or Arguments Supported by Different Endpoints
Parameter | Description |
---|---|
|
The target URL to upload files in case of HTTPS type. For example, https://samplehost.com. |
|
The name of the server to which you want to upload files. For example, sftpserver.domain.com. |
|
The user who has the privileges to access the endpoint. For example, upload.user@example.com. |
|
Password of the user. |
|
The URL of the proxy server. For example, www.example.com:80. |
|
The location or target where you want to upload your files to. |
|
The name of the file to upload. |
|
Specify If For example, upload files to PAR, Pre Authenticated URL where no user/password authentication is required. |
|
Any static header values while configuring. For example, set auth tokens while configuring the HTTPS end point. For example, You can also pass dynamic headers at upload time by
passing the For example: |
|
Stores the For example, to set the header: |
|
Specify If |
|
The database connect string to log in to the database where you want to upload files. For example, |
|
Specify the name of the table where you want to upload
files as For example, for uploading Oracle ORAchk collections to the
Collection Manager it is set to |
Example 4-2 Diagnostic Upload Examples To upload files to My Oracle Support
ahfctl setupload -name mos -type https
Enter mos.https.user: user_id
Enter mos.https.password: ########
Enter mos.https.url: https://transport.oracle.com/upload/issue
Upload configuration set for: mos
type: https
user: user_id
password: ########
url: https://transport.oracle.com/upload/issue
ahfctl setupload -name mos -type https -proxy www-proxy.example.com:80
ahfctl setupload -name mos -type https -user user_id -url https://transport.oracle.com/upload/issue -proxy www-proxy.example.com:80
Note:
Instead ofmos
,
you can specify any configuration name of your choice.
- Upload files as part of Oracle Trace File Analyzer diagnostic
collection:
tfactl diagcollect -last 1h -upload mos -id 3-23104325631
- Upload files
standalone:
tfactl upload -name mos -id 3-23104325631 -file /tmp/generated.zip
- Backward compatibility or upload using
-sr
flag withdiagcollcet
command:tfactl diagcollect -last 1h -sr 3-23104325631
Note:
In this case, upload configuration name should be
mos
as internally Oracle Trace File Analyzer looks for this name. It works even if MOS configuration is set using thetfactl setupmos
command in versions earlier than 20.2.
Example 4-3 Uploading a File Using SFTP
ahfctl upload -name sftp1 -file test_sftp_upload.log
Upload for: sftp1
Uploading file using pexpect
sftp> put test_sftp_upload.log
put test_sftp_upload.log
Uploading test_sftp_upload.log to /root/test_sftp_upload.log
test_sftp_upload.log 100% 17 0.0KB/s 00:00
sftp> quit
type: sftp
file: test_sftp_upload.log
Upload completed successfully
Example 4-4 Diagnostic Upload Examples
ahfctl setupload -name mysqlnetconfig -type sqlnet
[root@myserver1]# ahfctl setupload -name mysqlnetconfig -type sqlnet
Enter mysqlnetconfig.sqlnet.user: testuser
Enter mysqlnetconfig.sqlnet.password: ########
Enter mysqlnetconfig.sqlnet.connectstring: (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = testhost)(PORT = 1521))(CONNECT_DATA =(SERVER = DEDICATED)(SERVICE_NAME = testservice)))
Enter mysqlnetconfig.sqlnet.uploadtable: RCA13_DOCS
Upload configuration set for: mysqlnetconfig
type: sqlnet
user: testuser
password: ########
connectstring: (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = testhost)(PORT = 1521))(CONNECT_DATA =(SERVER = DEDICATED)(SERVICE_NAME = testservice)))
uploadtable: RCA13_DOCS
ahfctl setupload -name mysqlnetconfig2 -type sqlnet
-user user_name@example.com
-password
option and therefore
reports:Database upload parameter(s) successfully stored. AHF will not upload collections into the database until the following parameters are also set: ['password', 'connectstring', 'uploadtable']
-user
command option,
ahfctl
does NOT prompt for the other required parameters so you
must explicitly specify them at the command line as follows:
ahfctl setupload -type sqlnet -name orachkcm -user testuser -password -connectstring sqlnet connect string -uploadtable RCA13_DOCS
The -password
command option DOES NOT take any
arguments. When specified, ahfctl
prompts you to provide the
password for the user you specified using the -user
command
option.
AHF.properties
file:ahfctl getupload
# ahfctl getupload
Upload configurations available:
1. mysftpconfig
2. myhttpsconfig
3. mysqlnetconfig
ahfctl getupload -name mysftpconfig
# ahfctl getupload -name mysftpconfig
Upload configuration get for: mysftpconfig
type: sftp
user: testuser1@example.com
password: #########
server: sftphost.example.com
ahfctl getupload -name mysftpconfig -user
[root@myserver1]# ahfctl getupload -name mysftpconfig -user
Upload configuration get for: mysftpconfig
type: sftp
user: testuser1@example.com
ahfctl checkupload -name mysftpconfig
# ahfctl checkupload -name mysftpconfig -type sftp
Upload configuration check for: mysftpconfig
Parameters are configured correctly to upload files to sftp end point mysftpconfig
tfactl upload -name mysftpconfig -id 30676598 -file /tmp/temp.txt
# tfactl upload -name mysftpconfig -id 30676598 -file /tmp/filename.txt
Upload for: mysftpconfig
type: sftp
file: /tmp/filename.txt
id: 30676598
Upload completed successfully.
ahfctl unsetupload -name mysftpconfig -user
# ahfctl unsetupload -name mysftpconfig -user
Upload configuration successfully unset for: mysftpconfig
ahfctl unsetupload -name mysftpconfig -all
# ahfctl unsetupload -name mysftpconfig -all
Upload configuration successfully unset for: mysftpconfig
exachk -showpass -localonly -check BF7AE780E1252F69E0431EC0E50AE447
# exachk -showpass -localonly -check BF7AE780E1252F69E0431EC0E50AE447
Orachk.zip successfully uploaded to RCA13_DOCS table
tfactl
diagcollect
:$ tfactl diagcollect -since 1h -upload mos -id 3-123456789
exachk -showpass -localonly -check BF7AE780E1252F69E0431EC0E50AE447 -db_config_name user_dbconf
# exachk -showpass -localonly -check BF7AE780E1252F69E0431EC0E50AE447 -db_config_name user_dbconf
Orachk.zip successfully uploaded to RCA13_DOCS table
Related Topics
Parent topic: Using On-Demand Diagnostic Collections
4.3.8 Changing Oracle Grid Infrastructure Trace Levels
Enable trace levels to collect enough diagnostics to diagnose the cause of the problem.
Oracle Support asks you to enable certain trace levels when reproducing a problem. You can enable and then disable the trace levels. Use the dbglevel
option to set the trace level. You can find the required trace level settings grouped by problem trace profiles.
To set trace levels:
- tfactl dbglevel
Use thetfactl dbglevel
command to set Oracle Grid Infrastructure trace levels.
Parent topic: Using On-Demand Diagnostic Collections
4.3.8.1 tfactl dbglevel
Use the tfactl dbglevel
command to set Oracle Grid Infrastructure trace levels.
Note:
Thetfactl dbglevel
is set to be deprecated by early 2025. Please ensure to transition away from this feature and adopt an alternative solution before the deprecation deadline.
Syntax
tfactl [run] dbglevel
[ {-set|-unset} profile_name
-dependency [dep1,dep2,...|all]
-dependency_type [type1,type2,type3,...|all]
| {-view|-drop} profile_name
| -lsprofiles
| -lsmodules
| -lscomponents [module_name]
| -lsres
| -create profile_name [ -desc description
| [-includeunset] [-includetrace]
| -debugstate | -timeout time ]
| -modify profile_name [-includeunset] [-includetrace]
| -getstate [ -module module_name ]
| -active [profile_name]
| -describe [profile_name] ] ]
Parameters
Table 4-10 tfactl dbglevel Command Parameters
Parameter | Description |
---|---|
|
Specify the name of the profile. |
|
Displays the list of active profiles. |
|
Sets the trace or log levels for the profile specified. |
|
Unsets the trace or log levels for the profile specified. |
|
Displays the trace or log entries for the profile specified. |
|
Creates a profile. |
|
Drops the profile specified. |
|
Modifies the profile specified. |
|
Describes the profiles specified. |
|
Lists all the available profiles. |
|
Lists all the discovered Oracle Clusterware modules. |
|
Lists all the components associated with the Oracle Clusterware module. |
|
Lists all the discovered Oracle Clusterware resources. |
|
Displays the current trace or log levels for the Oracle Clusterware components or resources. |
|
Specify the Oracle Clusterware module. |
|
Specify the dependencies to consider, start, or stop dependencies, or both. |
|
Specify the type of dependencies to be consider. |
|
Generates a System State Dump for all the available levels. |
|
Adds or modifies an unset value for the Oracle Clusterware components or resources. |
|
Adds or modifies a trace value for the Oracle Clusterware components. |
WARNING:
Set the profiles only at the direction of Oracle Support.Parent topic: Changing Oracle Grid Infrastructure Trace Levels
4.3.9 Performing Custom Collections
Use the custom collection options to change the diagnostic collections from the default.
- Adjusting the Diagnostic Data Collection Period
Oracle Trace File Analyzer trims and collects any important logs updated in the past one hour. - Collecting for Specific Events
Perform default diagnostic collection or choose an event from the list of recent incidents to collect diagnostic data for that event alone. - Excluding Large Files from Diagnostic Collection
Prevent excessively large files from delaying or stalling collections. - Collecting from Specific Nodes
- Collecting from Specific Components
- Collecting from Specific Directories
- Changing the Collection Name
- Preventing Copying Zip Files and Trimming Files
- Performing Silent Collection
- Collecting Core Files
- Collecting Incident Packaging Service (IPS) Packages
Incident Packaging Service packages details of problems stored by Oracle Database in ADR for later diagnosis.
Parent topic: Using On-Demand Diagnostic Collections
4.3.9.1 Adjusting the Diagnostic Data Collection Period
Oracle Trace File Analyzer trims and collects any important logs updated in the past one hour.
If you know that you only want logs for a smaller window, then you can cut this collection period. Cutting the collection period helps you make collections as small and quick as possible.
There are four different ways you can specify the period for collection:
Table 4-11 Ways to Specify the Collection Period
Command | Description |
---|---|
|
Collects since the previous n hours or days.
|
|
Collects from the date and optionally time specified. Valid date and time formats:
|
|
Collects between the date and optionally time specified. Valid date and time formats:
|
|
Collects for the specified date. Valid date formats:
|
Parent topic: Performing Custom Collections
4.3.9.2 Collecting for Specific Events
Perform default diagnostic collection or choose an event from the list of recent incidents to collect diagnostic data for that event alone.
Choose to run:
- A diagnostic collection for a specific recent event
- A default time range diagnostic collection
To collect for specific events:
Parent topic: Performing Custom Collections
4.3.9.3 Excluding Large Files from Diagnostic Collection
Prevent excessively large files from delaying or stalling collections.
Run the tfactl set maxfilecollectionsize
for the diagnostic collection command to consider only the last 200 KB for the files that are larger than the size specified.
Parent topic: Performing Custom Collections
4.3.9.4 Collecting from Specific Nodes
To collect from specific nodes:
Related Topics
Parent topic: Performing Custom Collections
4.3.9.5 Collecting from Specific Components
To collect from specific components:
Related Topics
Parent topic: Performing Custom Collections
4.3.9.6 Collecting from Specific Directories
Oracle Trace File Analyzer discovers all Oracle diagnostics and collects relevant files based on the type and last time updated.
If you want to collect other files, then you can specify extra directories. Oracle Trace File Analyzer collects only the files updated in the relevant time range (one hour by default).
You can configure collection of all files irrespective of the time last updated. Configure on a directory by directory basis using the -collectall
option.
To collect from specific directories:
Related Topics
Parent topic: Performing Custom Collections
4.3.9.7 Changing the Collection Name
Oracle Trace File Analyzer zips collections and puts the zip files in the repository directory using the following naming format:
repository/collection_date_time/node_all/node.tfa_date_time.zip
You must only change the name of the zipped files using the following options. Manually changing the file name prevents you from using collections with various Oracle Support self-service tools.
To change the collection name:
Related Topics
Parent topic: Performing Custom Collections
4.3.9.8 Preventing Copying Zip Files and Trimming Files
By default, Oracle Trace File Analyzer Collector:
-
Copies back all zip files from remote notes to the initiating node
-
Trims files around the relevant time
To prevent copying zip files and trimming files:
Related Topics
Parent topic: Performing Custom Collections
4.3.9.11 Collecting Incident Packaging Service (IPS) Packages
Incident Packaging Service packages details of problems stored by Oracle Database in ADR for later diagnosis.
Syntax
Oracle Trace File Analyzer runs IPS to query and collect these packages.
tfactl ips option
Table 4-13 tfactl ips Command Parameters
Command | Description |
---|---|
|
Runs the IPS. |
|
Shows all IPS incidents. |
|
Shows all IPS problems. |
|
Shows all IPS Packages. |
|
Shows all available |
|
Performs an IPS collection following prompts. You can use all the standard |
|
Performs an IPS collection in silent mode. |
|
Collects ADR details about a specific incident id. |
|
Collect ADR details about a specific problem id. |
You can change the contents of the IPS package. Use the following options:
-
Start the collection.
-
Suspend the collection using the
-manageips
option.For example:
$ tfactl diagcollect -ips -incident incident_id -manageips -node local
-
Find the suspended collection using the
print suspendedips
option.For example:
$ tfactl print suspendedips
-
Manipulate the package.
-
Resume the collection using the
-resumeips
option.For example:
$ tfactl diagcollect -resumeips collection_id
Related Topics
Parent topic: Performing Custom Collections
4.3.10 Limit the Maximum Amount of Memory Used by Oracle Trace File Analyzer
You can now limit the amount of memory used by Oracle Trace File Analyzer.
Note:
This feature is available only on Linux and only when Autonomous Health Framework is
installed using a full installation by the root
user.
Memory can be limited between 150 MB and 2GB or 25% of system memory, whichever is lower. By default, memory limits are enabled and set to the maximum.
- When Oracle Trace File Analyzer is performing automatic diagnostic collections,
for example, when Oracle Trace File Analyzer detects an
ORA-600
error has occurred and collects diagnostics for it. - When running on-demand collections, for example, if you run an SRDC collection at the request of support.
- During any other Oracle Trace File Analyzer analysis such as using the
tfactl analyze
command to search logs for recent errors.
Memory can be limited at either the system level using ahfctl
setresourcelimit -resource kmem
or combined system and swap memory using
ahfctl setresourcelimit -resource swmem
For example:
ahfctl setresourcelimit -resource kmem -value 1024
ahfctl setresourcelimit -resource swmem -value 2048
Parent topic: Using On-Demand Diagnostic Collections
4.3.11 Limit Oracle Trace File Analyzer's CPU Usage
On Linux the CPU usage of Oracle Trace File Analyzer can be limited with the
command ahfctl setresourcelimit [-value value]
For example to limit Oracle Trace File Analyzer to a maximum of 50% of a single CPU
use: ahfctl setresourcelimit -value 0.5
CPU resource limits for Oracle Trace File Analyzer can be set between a minimum of 0.5 and maximum of 4 or 75% of available CPUs, whichever is lower. By default, the Oracle Trace File Analyzer CPU limit is set to the maximum.