Log files

This topic provides an overview of log files in OTCAD.

Log files

Database administrators can collect diagnostic information about a database in log files. The customer support team might request users to share these log files when resolving a case. To collect data from all system tables, you must have superuser privilege; otherwise, the log files collect data only from the system tables that you have privileges to access.

Collecting diagnostics

The diagnostics tool scrutinize collects a broad range of information from a Vertica cluster. It also supports a range of options that let you control the amount and type of data that is collected. Collected data can include but is not limited to:

  • Host diagnostics and configuration data
  • Run-time state (number of nodes up or down)
  • Log files from the installation process, the database, and the administration tools
  • Error messages
  • Database design
  • System table information, such as system, resources, workload, and performance
  • Catalog metadata, such as system configuration parameters
  • Backup information

View log file information

You can view information about the log files available in the system. To view log file details:

  1. In the Settings page, select Log files. The Log files page lists the following information:
    • Log name - Diagnostic information about the database cluster.
    • File type - The log file type. In this release, it is Scrutinize.
    • Created at - The date and timestamp at which the log file is created.
    • Created by - The user ID of the person who created the log file.
    • Status - The current status of the log file.
    • Last updated - The date and timestamp at which the log file was last updated.
    • Actions - Options to download, share, and delete the log file.

Create a log file

Only superusers can create log files.

  1. In the Settings page, select Log files.
  2. Click +Create log file. The file type appears as Scrutinizer Log. You cannot edit the file type.
  3. Set the start date and time.
    • In the Start date (UTC) field, click the calendar icon.
    • Select the required start date.
    • Specify the start time in UTC.
    • Ensure the selected start date and time accurately reflect when log collection should begin.
  4. Set the end date and time.
    • In the End date (UTC) field, click the calendar icon.
    • Select the required end date.
    • Specify the end time in UTC.
    • Ensure the selected end date and time accurately reflect when log collection should stop.
  5. Click Create. The log file is created.
  6. The status of the log file changes from Initiated to In progress and then to either Completed or Failed.
  7. To cancel the creation of a log file, select the log file displayed in the Initiated state and do the following:
    • Hover over the Actions column.
    • Choose ⋮.
    • Click Cancel. The status of the log files changes to Cancelled.

Download a log file

You can download the log files available in your system for your reference.

  1. In the Settings page, select Log files.
  2. Hover over the Actions column.
  3. Choose ⋮ and click Download. The log file is downloaded to a local drive in your system.

Share a log file with customer support

You can share log files with the customer support team for help with troubleshooting any issues in the database. There are 2 ways in which you can share log files with the customer support team.

  • Upload the scrutinizer log files in the support case. <--or-->
  • Share the log file from OTCAD.

To share a log file with customer support:

  1. In the Settings page, select Log files.
  2. Hover over the Actions column.
  3. Choose ⋮ and click Share. The Share Log file screen appears.
  4. In the Case ID field, enter the case ID that is generated from the customer support ticket that you raised to report issues in the database.
  5. Click Share. You receive an acknowledgement through email. You will also receive the vAdvisor Report in a separate email.

Delete a log file

You can delete log files that are no longer needed. To delete a log file:

  1. In the Settings page, select Log files.
  2. Hover over the Actions column.
  3. Choose ⋮ and click Delete. The log file is deleted.