scrutinize

Runs the scrutinize utility to collect diagnostic information about a database.

Runs the scrutinize utility to collect diagnostic information about a database. Vertica Support might request that you run this utility when resolving a case.

By default, diagnostics are stored in a /tmp/scrutinize/VerticaScrutinize.timestamp.tar.

For details, see Running scrutinize.

Syntax

vcluster scrutinize options

Required options

{ -c | --config } string: The path to the config file. If a configuration file is present in the default location (automatically generated by create_db), you do not need to specify this option.
Default: /opt/vertica/config/vertica_cluster.yaml

Options

--cert-file string: The absolute path to the certificate file. If you specify this option, you must also specify --key-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.

--db-user string: The username of a database user.
--exclude-active-queries: Exclude information affected by currently running queries.
--exclude-containers: Excludes information in system tables that can scale with the number of ROS containers.

{ -h | --help }: Prints help text.

--include-external-table-details: Include information about external tables. This option is computationally expensive.
--include-ros: Include information about ROS containers.
--include-udx-details: Include information describing all UDX functions. This option can be computationally expensive for Eon Mode databases.

--ipv6: Whether the hosts use IPv6 addresses. Hostnames resolve to IPv4 by default.

--key-file string: Path to the key file. If you specify this option, you must also specify --cert-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.

--log-age-hours int: The maximum age, in hours, of archived Vertica log files to collect.
Default: 24
--log-age-newest-time YYYY-MM-DD HH [+|-XX]: Timestamp of the minimum age of archived Vertica log files to collect with an optional UTC hour offset [+|-XX].
--log-age-oldest-time YYYY-MM-DD HH [+|-XX]: Timestamp of the maximum age of archived Vertica log files to collect with an optional UTC hour offset [+/-XX].

{ -l | --log-path } string: The absolute path for debug logs.
Default: /opt/vertica/log/vcluster.log

{ -p | --password } string: The database password.

--password-file string: The absolute path to a file containing the database password.
If you pass a dash(-) (that is, `--password-file -`), the password is read from STDIN.

Important
Your database password cannot include single quotes.

--read-password-from-prompt: Prompts the user to enter the password.

--skip-collect-libraries: Skips gathering linked and catalog-shared libraries.
--tarball-name string: Name of the generated .tar.
Default: VerticaScrutinize.timestamp.tar

--verbose: Shows the details of VCluster run in the console.

Examples

Runs scrutinize on all nodes in the database:

$ vcluster scrutinize --db-name vertica_db --db-user dbadmin \
  --password testpassword --config /opt/vertica/config/vertica_cluster.yaml