Table of Contents
- Title and Copyright Information
- Preface
- Changes in this Release for Oracle Autonomous Health Framework Checks and Diagnostics User's Guide 20.4
-
Changes in this Release for Oracle
Autonomous Health Framework Checks and Diagnostics User's Guide 20.2
- Resource Savings Through Fewer Repeat Collections for Similar Issues
- Limit Oracle Trace File Analyzer's CPU Usage
- Easier to Upload Diagnostic Collections
- Latest Most Secure Python Stack
- Run All Database Server Compliance Checks Without Needing root Password
- Integration of Oracle DBSAT into Oracle Autonomous Health Framework
- Integration of AutoUpgrade utility into Oracle Autonomous Health Framework
-
Changes in this Release for Oracle
Autonomous Health Framework Checks and Diagnostics User's Guide 20.1.1
- Installing Oracle Autonomous Health Framework on Microsoft Windows
- Oracle ORAchk or Oracle EXAchk Scheduler is Now Run by the Oracle Trace File Analyzer Daemon
- Oracle ORAchk or Oracle EXAchk is Now Run on Remote Compute Nodes Using the Oracle Trace File Analyzer Socket
- New Command to Exclude Cluster Verification Utility (CVU) Compliance Checks
- Setting the Language for Oracle ORAchk and Oracle EXAchk Screen Output, Report, and the Logs
-
1
Getting Started with Oracle Trace
File Analyzer, Oracle ORAchk, and Oracle EXAchk
- 1.1 About Oracle Autonomous Health Framework
- 1.2 Supported Platforms
- 1.3 Scope of Oracle Stack Supported
-
1.4
Compliance Framework (Oracle ORAchk and Oracle EXAchk) Prerequisites
- 1.4.1 SSH Connectivity and Access
- 1.4.2 Handling of Root Passwords
- 1.4.3 Deciding Which User Should Run Oracle ORAchk and Oracle EXAchk
- 1.4.4 Data Entry Terminal Considerations
- 1.4.5 Running Oracle EXAchk on Oracle Exadata and Zero Data Loss Recovery Appliance
- 1.4.6 Running Oracle Autonomous Health Framework in Non-English Environments
- 1.5 Oracle Trace File Analyzer Prerequisites
- 1.6 Installing and Upgrading Oracle Autonomous Health Framework
- 1.7 Understanding the Directory Structure
- 1.8 Configuring Oracle Trace File Analyzer and Oracle ORAchk/Oracle EXAchk to Use the Same Notification Addresses
- 1.9 Oracle Trace File Analyzer Command-Line and Shell Options
-
2
Compliance Checking with Oracle ORAchk and Oracle EXAchk
-
2.1
Getting Started with Running
Compliance Checks
- 2.1.1 Running Oracle ORAchk or Oracle EXAchk as a Non-Root User
- 2.1.2 Non-Root Users Running Root Privileged Checks on Database Servers
- 2.1.3 Automatic Compliance Checking
- 2.1.4 Email Notification and Report Overview
- 2.1.5 Recommended On-Demand Usage
- 2.1.6 Running Compliance Checks on a Remote Node
- 2.1.7 Creating, Modifying, and Deleting User-Defined Profiles
- 2.1.8 Sanitizing Sensitive Information in the Diagnostic Collections
- 2.1.9 Problem Repair Automation Options
- 2.1.10 Integration of Oracle DBSAT into Oracle Autonomous Health Framework
- 2.1.11 Integration of AutoUpgrade utility into Oracle Autonomous Health Framework
- 2.2 Running Compliance Checks Automatically
- 2.3 Running Compliance Checks On-Demand
- 2.4 Running Compliance Checks in Silent Mode
-
2.5
Understanding and Managing Reports and Output
- 2.5.1 Temporary Files and Directories
- 2.5.2 Output Files and Directories
-
2.5.3
HTML Report Output
- 2.5.3.1 System Health Score and Summary
- 2.5.3.2 HTML Report Table of Contents and Features
- 2.5.3.3 HTML Report Findings
- 2.5.3.4 Maximum Availability Architecture (MAA) Scorecard
- 2.5.3.5 Findings Needing Further Review
- 2.5.3.6 Platinum Certification
- 2.5.3.7 Viewing Clusterwide Linux Operating System Compliance Check (VMPScan)
- 2.5.3.8 "Systemwide Automatic Service Request (ASR) healthcheck" Section
- 2.5.3.9 File Attribute Changes
- 2.5.3.10 Skipped Checks
- 2.5.3.11 Component Elapsed Times
- 2.5.3.12 Top 10 Time Consuming Checks
- 2.5.3.13 How to Find a Check ID
- 2.5.3.14 How to Remove Checks from an Existing HTML Report
- 2.5.4 Tagging Reports
-
2.5.5
Tracking File Attribute Changes and Comparing Snapshots
- 2.5.5.1 Using the File Attribute Check With the Daemon
- 2.5.5.2 Taking File Attribute Snapshots
- 2.5.5.3 Including Directories to Check
- 2.5.5.4 Excluding Directories from Checks
- 2.5.5.5 Rechecking Changes
- 2.5.5.6 Designating a Snapshot As a Baseline
- 2.5.5.7 Restricting System Checks
- 2.5.5.8 Removing Snapshots
- 2.5.6 Comparing Two Reports
- 2.5.7 Merging Reports
- 2.5.8 Maintaining Temporary Files and Directories
- 2.5.9 Consuming Multiple Results in Other Tools
-
2.6
Running Subsets of Checks
- 2.6.1 Upgrade Readiness Mode (Oracle Clusterware and Oracle Database Upgrade Checks)
- 2.6.2 Running Checks on Subsets of the Oracle Stack
- 2.6.3 Using Profiles with Oracle Autonomous Health Framework
- 2.6.4 Excluding Individual Checks
- 2.6.5 Running Individual Checks
- 2.6.6 Finding Which Checks Require Privileged Users
- 2.6.7 Option to Run Only the Failed Checks
-
2.7
Understanding Oracle EXAchk specifics for Oracle Exadata and Zero Data Loss Recovery Appliance
- 2.7.1 Installation Requirements for Running Oracle EXAhk on Oracle Exadata and Zero Data Loss Recovery Appliance
-
2.7.2
Using Oracle EXAchk on Oracle
Exadata and Zero Data Loss Recovery Appliance
- 2.7.2.1 Database Default Access on the Client Interface
- 2.7.2.2 Virtualization Considerations
- 2.7.2.3 Running Serial Data Collection
- 2.7.2.4 Using the root User ID in Asymmetric and Role Separated Environments
- 2.7.2.5 Environment Variables for Specifying a Different User Than root
- 2.7.2.6 Oracle EXAchk InfiniBand Switch Processing
- 2.7.3 Troubleshooting Oracle EXAchk on Oracle Exadata and Zero Data Loss Recovery Appliance
- 2.8 Integrating Compliance Check Results with Other Tools
- 2.9 Using Oracle ORAchk to Confirm System Readiness for Implementing Application Continuity
- 2.10 Running Oracle ZFS Storage Appliance Compliance Checks
- 2.11 Using Oracle EXAchk on Oracle Big Data Appliance
-
2.1
Getting Started with Running
Compliance Checks
-
3
Oracle Health Check Collections Manager for Oracle Application Express 5.0+
- 3.1 Scope and Supported Platforms
- 3.2 Prerequisites
- 3.3 Installation
- 3.4 Upgrading Oracle Health Check Collections Manager Application
-
3.5
Getting Started
- 3.5.1 Incident Ticket System Lookup Lists and Seed Data
- 3.5.2 Access Control System
- 3.5.3 Oracle Health Check Collections Manager Application Administration
- 3.5.4 Selectively Capturing Users During Login
- 3.5.5 Configuring Email Notification System
- 3.5.6 Bulk Mapping Systems to Business Units
- 3.5.7 Purging Old Collections
- 3.6 Oracle Health Check Collections Manager Application Features
- 3.7 Viewing and Reattempting Failed Uploads
- 3.8 Oracle Health Check Collections Manager Application Uninstallation
- 3.9 Troubleshooting Oracle Health Check Collections Manager
-
4
Oracle Health Check Collections Manager for Oracle Application Express 4.2
- 4.1 Installation
- 4.2 Upgrading Oracle Health Check Collections Manager Application
-
4.3
Getting Started
- 4.3.1 Incident Ticket System Lookup Lists and Seed Data
- 4.3.2 Access Control System
- 4.3.3 Oracle Health Check Collections Manager Application Administration
- 4.3.4 Selectively Capturing Users During Login
- 4.3.5 Configuring Email Notification System
- 4.3.6 Bulk Mapping Systems to Business Units
- 4.3.7 Adjusting or Disabling Old Collections Purging
- 4.4 Oracle Health Check Collections Manager Application Features
- 4.5 Viewing and Reattempting Failed Uploads
- 4.6 Oracle Health Check Collections Manager Application Uninstallation
- 4.7 Troubleshooting Oracle Health Check Collections Manager
- 5 Using Automatic Diagnostic Collections
-
6
Using On-Demand Diagnostic Collections
- 6.1 Collecting Diagnostics and Analyzing Logs On-Demand
- 6.2 Viewing System and Cluster Summary
- 6.3 Investigating Logs for Errors
- 6.4 Analyzing Logs Using the Oracle Database Support Tools
- 6.5 Searching Oracle Trace File Analyzer Metadata
- 6.6 Oracle Trace File Analyzer Service Request Data Collections (SRDCs)
- 6.7 Diagnostic Upload
- 6.8 Changing Oracle Grid Infrastructure Trace Levels
-
6.9
Performing Custom Collections
- 6.9.1 Adjusting the Diagnostic Data Collection Period
- 6.9.2 Collecting for Specific Events
- 6.9.3 Excluding Large Files from Diagnostic Collection
- 6.9.4 Collecting from Specific Nodes
- 6.9.5 Collecting from Specific Components
- 6.9.6 Collecting from Specific Directories
- 6.9.7 Changing the Collection Name
- 6.9.8 Preventing Copying Zip Files and Trimming Files
- 6.9.9 Performing Silent Collection
- 6.9.10 Collecting Core Files
- 6.9.11 Collecting Incident Packaging Service (IPS) Packages
-
7
Using REST Service
- 7.1 Configuring REST Service Using ORDS
- 7.2 Configuring REST Service Using Apache Tomcat
- 7.3 REST Service print API
- 7.4 REST Service diagcollect API
- 7.5 REST Service download API
- 7.6 REST Service run API
- 7.7 REST Service user API
-
7.8
Configuring Oracle REST Data Services (ORDS)
-
7.8.1
Using Oracle Autonomous Health Framework Compliance Over REST
- 7.8.1.1 check
- 7.8.1.2 checktfafaileduploads
- 7.8.1.3 checktfaupload
- 7.8.1.4 download
- 7.8.1.5 getinfo
- 7.8.1.6 gettfaupload
- 7.8.1.7 listcollections
- 7.8.1.8 profile
- 7.8.1.9 showrepair
- 7.8.1.10 start_client
- 7.8.1.11 start_client
- 7.8.1.12 start_client
- 7.8.1.13 status
- 7.8.1.14 unsettfaupload
- 7.8.1.15 uploadtfafailed
- 7.8.1.16 version
- 7.8.2 Configuring REST Using the Included ORDS
- 7.8.3 Configuring REST Using an Existing ORDS Installation
-
7.8.1
Using Oracle Autonomous Health Framework Compliance Over REST
-
8
Managing and Configuring Oracle
Trace File Analyzer
- 8.1 Querying Oracle Trace File Analyzer Status and Configuration
- 8.2 Managing the Oracle Trace File Analyzer Daemon
- 8.3 Managing the Repository
- 8.4 Managing Collections
- 8.5 Configuring the Host
- 8.6 Configuring the Ports
- 8.7 Configuring SSL and SSL Certificates
- 8.8 Configuring Email Notification Details
- 8.9 Managing the Index
- 9 Managing Oracle Database and Oracle Grid Infrastructure Logs
- 10 Uninstalling Oracle Autonomous Health Framework
-
11
Troubleshooting Oracle Trace File Analyzer
- 11.1 Cluster Nodes are Not Showing As One Cluster When Viewed by Running the tfactl status Command
- 11.2 Oracle Trace File Analyzer is Not Starting and the init.tfa script is Missing After Reboot
- 11.3 Error Message Similar to "Can't locate **** in @inc (@inc contains:....)"
- 11.4 Non-Release Update Revisions (RURs) Oracle Trace File Analyzer Patching Fails on Remote Nodes
- 11.5 Non-Root Access is Not Enabled After Installation
- 11.6 TFA_HOME and Repository Locations are Moved After Patching or Upgrade
- 11.7 Oracle Trace File Analyzer Fails with TFA-00103 After Applying the July 2015 Release Update Revision (RUR) or Later
- 11.8 OSWatcher Parameters are Different After a Reboot or Otherwise Unexpectedly Different
- 11.9 Oracle Trace File Analyzer Installation or Oracle Trace File Analyzer Discovery (tfactl rediscover) Fails on Linux 7
- 11.10 OSWatcher Analyzer Fails When OSWatcher is Not Running from the TFA_HOME
- 11.11 Oracle Trace File Analyzer Fails to Start with com.sleepycat.je.EnvironmentLockedException Java Exception
- 11.12 Oracle Trace File Analyzer Startup Fails When Solution-Soft Time Machine Software is Installed, but Not Running on the System
- 11.13 Non-privileged User is Not Able to Run tfactl Commands
- 11.14 Oracle Trace File Analyzer Daemon is Not Starting or Not Running?
-
12
Troubleshooting Compliance Framework (Oracle ORAchk and Oracle EXAchk)
- 12.1 How to Troubleshoot Oracle ORAchk and Oracle EXAchk Issues
- 12.2 How to Capture Debug Output
-
12.3
Error Messages or Unexpected Output
- 12.3.1 Data Entry Terminal Considerations
- 12.3.2 Tool Runs without Producing Files
- 12.3.3 Messages similar to “line ****: **** Killed $perl_cmd 2>> $ERRFIL?”
- 12.3.4 Messages similar to “RC-001- Unable to read driver files”
- 12.3.5 Messages similar to “There are prompts in user profile on [hostname] which will cause issues in [tool] successful execution”
- 12.3.6 Problems Related to Remote Login
- 12.3.7 Other Error Messages in orachk_error.log or exachk_error.log
- 12.3.8 Space available on {node_name} at {path} is {x} MB and required space is 500 MB
- 12.3.9 Running ORAchk on Microsoft Windows Throws '{oratab}' is empty Error
- 12.4 Operating System Is Not Discovered Correctly
-
12.5
Oracle Clusterware or Oracle Database is not Detected or Connected Issues
- 12.5.1 Oracle Clusterware Software is Installed, but Cannot be Found
- 12.5.2 Oracle Database Software Is Installed, but Cannot Be Found
- 12.5.3 Oracle Database Software Is Installed, but Version cannot Be Found
- 12.5.4 Oracle ASM Software is Installed, but Cannot be Found
- 12.5.5 Oracle Database Discovery Issues on Oracle Real Application Clusters (Oracle RAC) Systems
- 12.5.6 Oracle Database Login Problems
- 12.6 Remote Login Problems
- 12.7 Permission Problems
- 12.8 Slow Performance, Skipped Checks, and Timeouts
- 12.9 Running Compliance Checks on a Subset of Oracle Home and Oracle Databases
- 12.10 SSH Connection Timeout
- 13 Behavior Changes, Deprecated and Desupported Features
- A Running the Installer Script
-
B
Running Oracle Trace File Analyzer
Administration Commands
- B.1 tfactl access
- B.2 tfactl availability
- B.3 tfactl blackout
- B.4 tfactl cell
- B.5 tfactl checkupload
- B.6 tfactl diagnosetfa
- B.7 tfactl disable
- B.8 tfactl enable
- B.9 tfactl get
- B.10 tfactl floodcontrol
- B.11 tfactl getresourcelimit
- B.12 tfactl getupload
- B.13 tfactl host
- B.14 tfactl import
- B.15 tfactl print
- B.16 tfactl rest
- B.17 tfactl restrictprotocol
- B.18 tfactl sendmail
- B.19 tfactl set
- B.20 tfactl setresourcelimit
- B.21 tfactl setupload
- B.22 tfactl showrepo
- B.23 tfactl start
- B.24 tfactl startahf
- B.25 tfactl status
- B.26 tfactl statusahf
- B.27 tfactl stop
- B.28 tfactl stopahf
- B.29 tfactl syncnodes
- B.30 tfactl uninstall
- B.31 tfactl upload
- B.32 tfactl unsetresourcelimit
- B.33 tfactl unsetupload
- B.34 tfactl version
- C Running Oracle Trace File Analyzer Summary and Analysis Commands
-
D
Running Oracle Trace File Analyzer Diagnostic
Collection Commands
- D.1 tfactl collection
- D.2 tfactl dbglevel
- D.3 tfactl diagcollect
- D.4 tfactl diagcollect -srdc
- D.5 tfactl directory
-
D.6
tfactl ips
- D.6.1 tfactl ips ADD
- D.6.2 tfactl ips ADD FILE
- D.6.3 tfactl ips ADD NEW INCIDENTS
- D.6.4 tfactl ips CHECK REMOTE KEYS
- D.6.5 tfactl ips COPY IN FILE
- D.6.6 tfactl ips COPY OUT FILE
- D.6.7 tfactl ips CREATE PACKAGE
- D.6.8 tfactl ips DELETE PACKAGE
- D.6.9 tfactl ips FINALIZE PACKAGE
- D.6.10 tfactl ips GENERATE PACKAGE
- D.6.11 tfactl ips GET MANIFEST
- D.6.12 tfactl ips GET METADATA
- D.6.13 tfactl ips GET REMOTE KEYS
- D.6.14 tfactl ips PACK
- D.6.15 tfactl ips REMOVE
- D.6.16 tfactl ips REMOVE FILE
- D.6.17 tfactl ips SET CONFIGURATION
- D.6.18 tfactl ips SHOW CONFIGURATION
- D.6.19 tfactl ips SHOW FILES
- D.6.20 tfactl ips SHOW INCIDENTS
- D.6.21 tfactl ips SHOW PROBLEMS
- D.6.22 tfactl ips SHOW PACKAGE
- D.6.23 tfactl ips UNPACK FILE
- D.6.24 tfactl ips UNPACK PACKAGE
- D.6.25 tfactl ips USE REMOTE KEYS
- D.7 tfactl managelogs
- D.8 tfactl purge
-
E
Compliance Framework (Oracle ORAchk and Oracle EXAchk) Command-Line Options
- E.1 Compliance Framework (Oracle ORAchk and Oracle EXAchk) Command-Line Options
- E.2 Running Generic Compliance Framework (Oracle ORAchk and Oracle EXAchk) Commands
- E.3 Controlling the Scope of Checks
- E.4 Managing the Report Output
- E.5 Uploading Results to Database
- E.6 Controlling the Behavior of the Daemon
- E.7 Tracking File Attribute Differences
- E.8 Running Oracle Health Check Collections Manager Commands
- E.9 Command-Line Options to Generate Password Protected Collection zip Files
- E.10 Applying Patch Between Releases
- E.11 Caching Discovery Data
- E.12 Configuring REST
- E.13 Running Cluster Verification Utility (CVU) Compliance Checks
- E.14 Running Auto Start
- E.15 Application Continuity Command-Line Options
- E.16 ZFS Storage Appliance Options