This section helps you manage Oracle Trace File Analyzer daemon, diagnostic collections, and the collection repository.
print command to query the status or configuration.init on UNIX systems or init/upstart/systemd on Linux, or Microsoft Windows uses a Windows Service so that Oracle Trace File Analyzer starts automatically whenever a node starts.root or sudo access to tfactl to add hosts to Oracle Trace File Analyzer configuration.Use the print command to query the status or configuration.
Table 7-1 Configuration Listing and Descriptions
| Configuration Listing | Default Value | Description |
|---|---|---|
|
Automatic diagnostic collection |
ON |
Triggers a collection if a significant problem occurs. Possible values:
|
|
Trimming of files during diagnostic collection |
ON |
Trims the log files to only entries within the time range of the collection. Possible values:
|
|
Repository maximum size in MB |
Smaller of either 10GB or 50% of free space in the file system. |
The largest size the repository can be. |
|
Trace Level |
1 |
Increases the level of verbosity. Possible values:
A value of 1 results in the least amount of trace. A value of 4 results in the most amount of trace. Oracle recommends changing the trace level value only at the request of Oracle Support. |
|
Automatic Purging |
ON |
Purges collections when: Free space in the repository falls below 1GB. Or Before closing the repository. Purging removes collections from largest size through to smallest. Purging continues until the repository has enough space to open. |
|
Minimum Age of Collections to Purge (Hours) |
12 |
The least number of hours to keep a collection, after which it is eligible for purging. |
|
Minimum Space free to enable Alert Log Scan (MB) |
500 |
Suspends log scanning if free space in the |
Example 7-1 Print Configuration
$ tfactl print config .------------------------------------------------------------------------. | node1 | +-----------------------------------------------------------+------------+ | Configuration Parameter | Value | +-----------------------------------------------------------+------------+ | TFA Version |12.2.1.0.0 | | Java Version | 1.8 | | Public IP Network | true | | Automatic Diagnostic Collection | true | | Alert Log Scan | true | | Disk Usage Monitor | true | | Managelogs Auto Purge | false | | Trimming of files during diagcollection | true | | Inventory Trace level | 1 | | Collection Trace level | 1 | | Scan Trace level | 1 | | Other Trace level | 1 | | Repository current size (MB) | 447 | | Repository maximum size (MB) | 10240 | | Max Size of TFA Log (MB) | 50 | | Max Number of TFA Logs | 10 | | Max Size of Core File (MB) | 20 | | Max Collection Size of Core Files (MB) | 200 | | Minimum Free Space to enable Alert Log Scan (MB) | 500 | | Time interval between consecutive Disk Usage Snapshot(minutes) | 60 | | Time interval between consecutive Managelogs Auto Purge(minutes)| 60 | | Logs older than the time period will be auto purged(days[d]|hours[h])|30d| | Automatic Purging | true | | Age of Purging Collections (Hours) | 12 | | TFA IPS Pool Size | 5 | '-----------------------------------------------------------+------------'
Related Topics
Parent topic: Managing and Configuring Oracle Trace File Analyzer
Oracle Trace File Analyzer runs from init on UNIX systems or init/upstart/systemd on Linux, or Microsoft Windows uses a Windows Service so that Oracle Trace File Analyzer starts automatically whenever a node starts.
To manage Oracle Trace File Analyzer daemon:
init control file /etc/init.d/init.tfa is platform dependant.Parent topic: Managing and Configuring Oracle Trace File Analyzer
Oracle Trace File Analyzer stores all diagnostic collections in the repository.
The repository size is the maximum space Oracle Trace File Analyzer is able to use on disk to store collections.
Parent topic: Managing and Configuring Oracle Trace File Analyzer
Oracle Trace File Analyzer closes the repository, if:
Free space in TFA_HOME is less than 100 MB, also stops indexing
Free space in ORACLE_BASE is less than 100 MB, also stops indexing
Free space in the repository is less than 1 GB
Current size of the repository is greater than the repository max size (reposizeMB)
The Oracle Trace File Analyzer daemon monitors and automatically purges the repository when the free space falls below 1 GB or before closing the repository. Purging removes collections from largest size through to smallest until the repository has enough space to open.
Oracle Trace File Analyzer automatically purges only the collections that are older than minagetopurge. By default, minagetopurge is 12 hours.
To purge the repository automatically
Related Topics
Parent topic: Managing the Repository
To purge the repository manually:
Related Topics
Parent topic: Managing the Repository
Manage directories configured in Oracle Trace File Analyzer and diagnostic collections.
trimfiles, maxcorefilesize, maxcorecollectionsize, and diagcollect -nocores to reduce the size of collections.Parent topic: Managing and Configuring Oracle Trace File Analyzer
Add directories to the Oracle Trace File Analyzer configuration to include the directories in diagnostic collections.
Oracle Trace File Analyzer then stores diagnostic collection metadata about the:
Directory
Subdirectories
Files in the directory and all sub directories
All Oracle Trace File Analyzer users can add directories they have read access to.
To manage directories:
Related Topics
Parent topic: Managing Collections
Use the Oracle Trace File Analyzer configuration options trimfiles, maxcorefilesize, maxcorecollectionsize, and diagcollect -nocores to reduce the size of collections.
To manage the size of collections:
Related Topics
Parent topic: Managing Collections
You must have root or sudo access to tfactl to add hosts to Oracle Trace File Analyzer configuration.
To add, remove, and replace SSL certificates:
Parent topic: Managing and Configuring Oracle Trace File Analyzer
The Oracle Trace File Analyzer daemons in a cluster communicate securely over ports 5000 to 5005.
If the port range is not available on your system, then replace it with the ports available on your system.
To change the ports:
Parent topic: Managing and Configuring Oracle Trace File Analyzer
View and restrict SSL/TLS protocols. Configure Oracle Trace File Analyzer to use self-signed or CA-signed certificates.
Java keytool to replace self-signed SSL certificates with personal self-signed certificates.Java keytool and openssl to replace self-signed SSL certificates with the Certificate Authority (CA) signed certificates.Parent topic: Managing and Configuring Oracle Trace File Analyzer
The Oracle Trace File Analyzer daemons in a cluster communicate securely using the SSL/TLS protocols.
The SSL protocols available for use by Oracle Trace File Analyzer are:
TLSv1.2
TLCv1.1
TLSv1
Oracle Trace File Analyzer always restricts use of older the protocols SSLv3 and SSLv2Hello.
To view and restrict protocols:
Parent topic: Configuring SSL and SSL Certificates
Use Java keytool to replace self-signed SSL certificates with personal self-signed certificates.
To configure Oracle Trace File Analyzer to use self-signed certificates:
Parent topic: Configuring SSL and SSL Certificates
Use Java keytool and openssl to replace self-signed SSL certificates with the Certificate Authority (CA) signed certificates.
To configure Oracle Trace File Analyzer to use CA-signed certificates:
Parent topic: Configuring SSL and SSL Certificates
The cipher suite is a set of cryptographic algorithms used by the TLS/SSL protocols to create keys and encrypt data.
Oracle Trace File Analyzer supports any of the cipher suites used by JRE 1.8.
The default cipher suite used is TLS_RSA_WITH_AES_128_CBC_SHA256.
Parent topic: Configuring SSL and SSL Certificates
Oracle Trace File Analyzer includes REST support allowing invocation and query over HTTPS.
Syntax
To facilitate this REST support Oracle REST Data Services (ORDS) is included within the install.
tfactl rest [-status|-start|-stop|-uninstall] [-dir] [-port] [-user] [-debug [-level]]
Note:
You can run the REST command only as root user.
Parameters
Table 7-2 REST Command Parameters
| Parameter | Description |
|---|---|
|
|
Prints the current status. |
|
|
Starts Oracle Trace File Analyzer REST services if not already running. |
|
|
Stops Oracle Trace File Analyzer REST services if running. |
|
|
Removes the Oracle Trace File Analyzer REST configuration. |
|
|
The directory to use to store the Oracle Trace File Analyzer REST configuration details. Defaults to the users home directory. |
|
|
The port to run ORDS on. Defaults to 9090. |
|
|
The user to start ORDS as. Defaults to the GRID owner. |
|
|
Enables debug. |
|
|
The level of debug to use, where available levels are:
|
https://host:port/ords/api
https://host:port/ords/tfactl/print/status
Print API
Table 7-3 Print API
| API | Method | Output | Description |
|---|---|---|---|
|
|
|
[ {
"status" : "CheckOK",
"hostname" : "myhost",
"pid" : 73637,
"port" : 9090,
"version" : "18.1.0.0.0",
"buildId" : "18100020180109014331",
"inventoryStatus" : "COMPLETE"
} ]
|
|
|
|
|
[ {
"hostname" : "myhost"
} ]
|
|
|
|
|
[ {
"actionName" : "Run inventory",
"hostname" : "Requested in all nodes",
"client" : "tfactl",
"startTime" : "Jan 09 07:50:26 PST",
"endTime" : "Jan 09 07:50:29 PST",
"status" : "COMPLETE",
"comments" : null
} ]
|
|
|
|
|
[ {
"hostname" : "myhost",
"directory" : "/scratch/smith/view_storage/smith_tfa_latest/oracle/log/tfa/repository",
"status" : "OPEN",
"maxSizeMB" : 10240,
"currentSizeMB" : 13,
"freeSpaceMB" : 10227
} ]
|
|
|
|
|
[ {
"id" : "20171010115528myhost",
"type" : "Manual Collection",
"requestUser" : "smith",
"nodeList" : "[]",
"masterHost" : "myhost",
"startTime" : "Mon Oct 09 23:55:32 PDT 2017",
"endTime" : "Tue Oct 10 11:55:32 PDT 2017",
"tag" : "/scratch/smith/view_storage/smith_tfa_latest/oracle/log/tfa/repository/tfa_11",
"zipFileName" : "myhost.tfa_Tue_Oct_10_11_55_28_PDT_2017.zip",
"componentList" : "[emagent, crsclient, oms, dbwlm,emplugins, cfgtools, afd, wls]",
"zipFileSize" : 3055,
"collectionTime" : 16,
"events" : null
}]
|
|
|
|
|
{
"id" : "20171011044112myhost",
"type" : "Manual Collection",
"requestUser" : "smith",
"nodeList" : "[]",
"masterHost" : "myhost",
"startTime" : "null",
"endTime" : "Wed Oct 11 04:41:14 PDT 2017",
"tag" : "/scratch/smith/view_storage/smith_tfa_latest/oracle/log/tfa/repository/TFA_T1",
"zipFileName" : "myhost.TFA_T1.zip",
"componentList" : "[]",
"zipFileSize" : 0,
"collectionTime" : 0,
"events" : null
}
|
|
|
|
|
[ {
"hostname" : "myhost",
"tfaVersion" : "18.1.0.0.0",
"javaVersion" : "1.8",
"inventoryTraceLevel" : 1,
"collectionTraceLevel" : 1,
"scanTraceLevel" : 1,
"otherTraceLevel" : 3,
"currentSizeMB" : 13,
"maxSizeMB" : 10240,
"maxLogSize" : 50,
"maxLogCount" : 10,
"maxCoreFileSize" : 50,
"maxCoreCollectionSize" : 500,
"minSpaceForRTScan" : 500,
"diskUsageMoninterInterval" : 60,
"manageLogsAutoPurgeInterval" : 60,
"manageLogsAutoPurgePolicyAge" : "30d",
"minFileAgeToPurge" : 12,
"language" : "en",
"encoding" : "UTF-8",
"country" : "US",
"alertLogLevel" : "ALL",
"userLogLevel" : "ALL",
"baseLogPath" : "ERROR",
"tfaIpsPoolSize" : 5,
"autoPurge" : true,
"publicIp" : false,
"fireZipsInRT" : true,
"rtscan" : true,
"diskUsageMonOn" : true,
"manageLogsAutoPurgeOn" : false,
"trimmingOn" : true
} ]
|
|
|
|
|
{
"hostname" : "myhost",
"available" : [ "TLSv1.2" ],
"restricted" : [ "SSLv3", "SSLv2Hello", "TLSv1", "TLSv1.1" ]
}
|
|
|
|
|
[ {
"hostname" : "myhost",
"directory" : "/oem/app/oracle/product/emagent/agent_inst/install/logs",
"components" : [ "EMPLUGINS" ],
"permission" : "public",
"owner" : "root",
"collectionPolicy" : "exclusions",
"collectAll" : false
}, {
"hostname" : "myhost",
"directory" : "/oem/app/oracle/product/emagent/agent_inst/sysman/log",
"components" : [ "EMAGENT" ],
"permission" : "public",
"owner" : "root",
"collectionPolicy" : "exclusions",
"collectAll" : false
} ]
|
|
Diagcollect API
Table 7-4 Diagcollect API
| API Type | Method | Input | Output | Description |
|---|---|---|---|---|
|
|
|
{
"collectionId" : "20180111011121slc12ekf",
"zipName" : "TFA_DEF_ZIP_20180111011121",
"tagName" : "TFA_DEF_TAG_20180111011121"
}
|
Oracle Trace File Analyzer default collection for last 12 hours for all components. |
|
{
"components": "-database -asm -tns -crs -acfs -install -cfgtools -os",
"timePeriod": "-since n[d|h] | -last n[d|h] | -for date |
-from date -to date",
"tagName": "crs_crash_collection",
"nodeList": "node1,node2",
"options": "-nocopy | -notrim | -silent | -nocores |
-collectalldirs | -collectdir dir1,dir2..."
}
|
{
"collectionId" : "20180111011121slc12ekf",
"zipName" : "TFA_DEF_ZIP_20180111011121",
"tagName" : "TFA_DEF_TAG_20180111011121"
}
|
Oracle Trace File Analyzer diagcollection with input JSON Data as parameters. |
Download API
Table 7-5 Download API
| API Type | Method | Input | Output | Description |
|---|---|---|---|---|
|
|
|
Collection ID |
Collection ZIP File. |
Download Collection ZIP. |
Parent topic: Managing and Configuring Oracle Trace File Analyzer
Oracle Trace File Analyzer REST uses first-party cookie-based authentication (basic authentication).
The Oracle Trace File Analyzer REST application is able to authenticate and authorize itself to the RESTful API using the same cookie session that the web application is using. The first party application has full access to the RESTful API.
tfaadmin and tfarest users.
Use tfarest user for REST calls
Use tfaadmin for making REST calls and to manage the REST service, for example, changing the logging level
# ./tfactl rest -start Configuring TFA REST Services using ORDS : This might take couple of minutes. Please be patient. Adding Dependency Jars to ORDS Adding users to ORDS : Enter a password for user tfaadmin: Confirm password for user tfaadmin: Enter a password for user tfarest: Confirm password for user tfarest: Starting TFA REST Services Successfully started TFA REST Services [PID : 32650] URL : https://myserver:9090/ords/tfactl/print/status
https://host_name:9090/ords/tfactl/print/status
You are presented with a 401 message, which includes a sign in link. Click the link, sign in with tfarest credentials you just created, and you will be directed to REST output.
Alternatively, you can also specify the credentials in a curl command.
# curl -k --user tfarest:mypassword https://myserver:9090/ords/tfactl/print/status
[ {
"status" : "CheckOK",
"hostname" : "myserver",
"pid" : 2430,
"port" : 5000,
"version" : "18.2.0.0.0",
"buildId" : "18200020180501035221",
"inventoryStatus" : "COMPLETE"
} ]
Parent topic: Managing and Configuring Oracle Trace File Analyzer
Configure Oracle Trace File Analyzer to send an email to the registered email address after an automatic collection completes.
To configure email notification details:
Example 7-2 tfactl set smtp
# /u01/app/11.2.0.4/grid/bin/tfactl set smtp .---------------------------. | SMTP Server Configuration | +---------------+-----------+ | Parameter | Value | +---------------+-----------+ | smtp.auth | false | | smtp.from | tfa | | smtp.user | - | | smtp.cc | - | | smtp.port | 25 | | smtp.bcc | - | | smtp.password | ******* | | smtp.host | localhost | | smtp.to | - | | smtp.debug | true | | smtp.ssl | true | '---------------+-----------' Enter the SMTP property you want to update : smtp.host Enter value for smtp.host : myhost.domain.com SMTP Property smtp.host updated with myhost.domain.com Do you want to continue ? [Y]|N : N #
Parent topic: Managing and Configuring Oracle Trace File Analyzer