DBAAS Tooling: Using dbaascli to Collect Cloud Tooling Logs and Perform a Cloud Tooling Health Check

Using the dbaascli diag command allows you to collect domU dbaas tooling logs for Exadata Cloud Service and Exadata Cloud@Customer systems. You can use these logs to troubleshoot issues related to dbaas tooling.

Starting with DBaaS Tools Cloud Tooling RPM 21.2.1, you can use the diag command to collect dbaastools logs and perform a health check on all nodes in an Exadata cluster.

Note

  • dbaascli diag commands must be run as the root user
  • Running the dbaascli diag collect command on a single node will collect log data for all nodes
  • We recommend running the commands documented in this topic using the nohup option for long-running commands. Redirect the command output to a location you can monitor.

For information on updating Exadata Cloud Tooling, see How to upgrade DBAAS Cloud Tooling using dbaascli (Doc ID 2350471.1).

Syntax for Collecting Tooling Log Data

The dbaascli dbaascli diag collect command uses the syntax shown below to collect tooling log data:

dbaascli diag collect [parameters]
Parameter Description Required Accepted Values Default Values
--help Access help for the command. No not applicable none
--destLocation The domU directory location to store collected logs. No A valid full path location present on all nodes in the cluster.

If parameter is not specified, system collects log files as follows:

System collects logs at /var/opt/oracle/dbaas_acfs.

If that location cannot be used, system collects logs at /u02.

Command output displays which directory location is being used to collect logs.

--dbNames The dbName value of the database for which you want to collect logs. Currently, only one dbName can be specified per command. No A valid dbName value for the system. none
--startTime The start time for log collection. Requires the use of the --endTime parameter. No Format: YYYY-MM-DDTHH24:MM:SS. Must be used together with the --endTime parameter. If parameter is not specified, system sets start time as 24 hours prior to the current system time.
--endTime The start time for log collection. Requires the use of the --startTime parameter. No Format: YYYY-MM-DDTHH24:MM:SS. Must be used together with the --startTime parameter. If parameter is not specified, system sets end time as current system time.
--nodes A comma-separated list of nodes to collect logs. No

Format:

node1,node2

If parameter is not specified, system collects logs for all nodes in the cluster.

--components A list of components for log collection. No

One of:

db|gi|os|dbaastools|all

If parameter is not specified, logs are collected for dbaastools.
--objectStoreBucketUri An Object Storage service pre-authenticated request (PAR) URL used to upload collected logs. Logs are collected from domU. See Using Pre-Authenticated Requests for more information. No URL that has been pre-authenticated. none
Example: Log collection for all databases
[root@exampleOracleDB ~]# dbaascli diag collect
DBAAS CLI version MAIN
Executing command diag collect
dbaascli diag collect called without component
INFO: Starting diag collect
INFO: Collected diag logs at: /var/opt/oracle/dbaas_acfs/diag_cloudlogs_20210322-2130.tar.gz
Example: Log collection for a specified database
[root@exampleOracleDB ~]# dbaascli diag collect --dbNames myOracleDatabase19cName
DBAAS CLI version MAIN
Executing command diag collect --dbNames myOracleDatabase19cName
dbaascli diag collect called without component
INFO: Starting diag collect
INFO: Collected diag logs at: /var/opt/oracle/dbaas_acfs/diag_cloudlogs_20210322-2128.tar.gz
Example: Log collection to a specified domU directory
[root@exampleOracleDB ~]# dbaascli diag collect --destLocation /tmp/test/
DBAAS CLI version MAIN
Executing command diag collect --destLocation /tmp/test
dbaascli diag collect called without component
INFO: Starting diag collect
INFO: Collected diag logs at: /tmp/test/diag_cloudlogs_20210322-1731.tar.gz
Example: Log collection for a specified timeframe
[root@exampleOracleDB ~]# dbaascli diag collect --startTime 2021-03-19T10:00:00 --endTime 2021-03-20T10:00:00
DBAAS CLI version MAIN
Executing command diag collect --startTime 2021-03-19T10:00:00 --endTime 2021-03-20T10:00:00
dbaascli diag collect called without component
INFO: Starting diag collect
INFO: Collected diag logs at: /var/opt/oracle/dbaas_acfs/diag_cloudlogs_20210322-2245.tar.gz
Example: Log collection for specific nodes
[root@exampleOracleDB ~]# dbaascli diag collect --nodes rbcl1,rbcl2
DBAAS CLI version MAIN
Executing command diag collect --nodes rbcl1,rbcl2
dbaascli diag collect called without component
INFO: Starting diag collect
INFO: Collected diag logs at: /var/opt/oracle/dbaas_acfs/diag_cloudlogs_20210421-1848.tar.gz
Example: Log collection for specific components
[root@exampleOracleDB ~]# dbaascli diag collect --components dbaastools
DBAAS CLI version MAIN
Executing command diag collect --components dbaastools
dbaascli diag collect called with component dbaastools
INFO: Starting diag collect
INFO: Collected diag logs at: /var/opt/oracle/dbaas_acfs/diag_cloudlogs_20210421-1851.tar.gz
Example: Saving collected logs to Object Storage using a PAR URL
[root@exampleOracleDB ~]# dbaascli diag collect --objectStoreBucketUri https://objectstorage.us-phoenix-1.oraclecloud.com/p/t0Z-kRV5pSmFzqnf-y5XhaAbM4LS82epeBnulKnCr31IeHVjxI9tOkntLF2kq7fP/n/MyNamespace/b/MyParBucket/o/
DBAAS CLI version MAIN
Executing command diag collect --objectStoreBucketUri https://objectstorage.us-phoenix-1.oraclecloud.com/p/t0Z-kRV5pSmFzqnf-y5XhaAbM4LS82epeBnulKnCr31IeHVjxI9tOkntLF2kq7fP/n/MyNamespace/b/MyParBucket/o/
dbaascli diag collect called without component
INFO: Starting diag collect
INFO: Collected diag logs at: https://objectstorage.us-phoenix-1.oraclecloud.com/p/t0Z-kRV5pSmFzqnf-y5XhaAbM4LS82epeBnulKnCr31IeHVjxI9tOkntLF2kq7fP/n/MyNamespace/b/MyNamespace/o/diag_cloudlogs_20210421-1839.tar.gz
Example: Log collection using nohup mode
[root@exampleOracleDB ~]# nohup dbaascli diag collect > /tmp/nohup.out 2>&1 &

After running the command, monitor /tmp/nohup.out for completion.

Example: Using --help to access inline documentation for the collection of tooling log data
[root@exampleOracleDB ~]# dbaascli diag collect --help
DBAAS CLI version MAIN
Executing command diag collect --help
    diag collect - collect.
        [--destLocation - Location on domU to collect logs. Default : /var/opt/oracle/dbaas_acfs ]
        [--startTime - startTime for log collection. Ex : YYYY-MM-DDTHH24:MM:SS]
        [--dbNames - dbName for which to collect logs. Only one dbName can be specified]
        [--endTime - endTime for log collection. Ex : YYYY-MM-DDTHH24:MM:SS]

Syntax for Performing a Health Check

The dbaascli dbaascli diag healthcheck command uses the syntax shown below to perform a health check on all system nodes:

dbaascli diag healthcheck [parameters]
Parameter Description Required Accepted Values Default Values
--help Access help for the command. No not applicable none
--destLocation The domU directory location to store collected log information. No A valid full path location present on all nodes in the cluster.

If parameter is not specified, system collects log files as follows:

System collects logs at /var/opt/oracle/dbaas_acfs.

If that location cannot be used, system collects logs at /u02.

Command output displays which directory location is being used to collect logs.

--nodes A comma-separated list of nodes to collect logs. No

Format:

node1,node2

If parameter is not specified, system collects logs for all nodes in the cluster.

--objectStoreBucketUri An Object Storage service pre-authenticated request (PAR) URL used to upload collected logs. Logs are collected from domU. See Using Pre-Authenticated Requests for more information. No URL must be pre-authenticated. none
Example: Health check information
[root@exampleOracleDB ~]# dbaascli diag healthcheck                
DBAAS CLI version MAIN
Executing command diag healthcheck
INFO: Starting diag healthcheck
INFO: Collected diag logs at: /var/opt/oracle/dbaas_acfs/diag_cloudlogs_20210322-2246.tar.gz
Example: Saving health check information to a specified domU directory
[root@exampleOracleDB ~]# dbaascli diag healthcheck --destLocation /tmp/test
DBAAS CLI version MAIN
Executing command diag healthcheck --destLocation /tmp/test
INFO: Starting diag healthcheck
INFO: Collected diag logs at: /tmp/test/diag_cloudlogs_20210322-2250.tar.gz
Example: Health check information for specific nodes
[root@exampleOracleDB ~]# dbaascli diag healthcheck --nodes rbcl1,rbcl2                   
DBAAS CLI version MAIN
Executing command diag healthcheck --nodes rbcl1,rbcl2
INFO: Starting diag healthcheck
INFO: Collected diag logs at: /var/opt/oracle/dbaas_acfs/diag_cloudlogs_20210421-1915.tar.gz
Example: Saving health check information to Object Storage using a PAR URL
[root@exampleOracleDB ~]# dbaascli diag healthcheck --objectStoreBucketUri https://objectstorage.us-phoenix-1.oraclecloud.com/p/t0Z-kRV5pSmFzqnf-y5XhaAbM4LS82epeBnulKnCr31IeHVjxI9tOkntLF2kq7fP/n/MyNamespace/b/MyParBucket/o/
DBAAS CLI version MAIN
Executing command diag healthcheck --objectStoreBucketUri https://objectstorage.us-phoenix-1.oraclecloud.com/p/t0Z-kRV5pSmFzqnf-y5XhaAbM4LS82epeBnulKnCr31IeHVjxI9tOkntLF2kq7fP/n/MyNamespace/b/MyParBucket/o/
INFO: Collected diag logs at: https://objectstorage.us-phoenix-1.oraclecloud.com/p/t0Z-kRV5pSmFzqnf-y5XhaAbM4LS82epeBnulKnCr31IeHVjxI9tOkntLF2kq7fP/n/MyNamespace/b/MyParBucket/o/diag_cloudlogs_20210421-1839.tar.gz
Example: Using --help to access inline documentation for the health check command
[root@exampleOracleDB ~]# dbaascli diag healthcheck --help
DBAAS CLI version MAIN
Executing command diag healthcheck --help
    diag healthcheck - healthcheck.
        [--destLocation - Location on domU to collect logs. Default : /var/opt/oracle/dbaas_acfs ]