debug_collect

This job retuns log events about debug information that fits the search parameter values.

Mandatory Parameters

There are no mandatory parameters.

Optional Parameters

Parameter name Data type Description
debug_info list Any combination of of following: EXAClusterOS logs, EXAStorage metadata, or Coredumps.
exasolution_logs list All databases or any specific database name listed. If no databases are listed, all will be included.
exasolution_log_type list Any combination of the following: SQL processes, Server processes, or Session <id>. If no log types are listed, all will be included.
start_date string Starts the log at the exact date using the following format: yyyy-mm-dd.
end_date string Ends the log at the exact date using the following format: yyyy-mm-dd.
backtraces list A comma seperated list of backtraces to be collected. The list can include: EXASolution server processes, EXASolution SQL processes, EXAClusterOS processes, or ETL JDBC Jobs.
no_open_files boolean If true, includes only archived files. Valid values are: True or False.
only_open_files boolean If true, includes only active files. Valid values are: True or False.
nodes list A comma seperated list of node IDs in this cluster to include in the log. If no node IDs are listed, the log will include all nodes in that current cluster.
outfile string Location to store debug information. For example, remote:VolumeName,RemoteVolumePath.
timeout integer Sets maximal duration in seconds for collecting debug information. The default is 1800 seconds (10 minutes).

Substitute Parameters

There are no substitute parameters.

Allowed Users

The following users are allowed to run this job:

  • root

Allowed Groups

The following groups are allowed to run this job:

  • root
  • exaadm
  • exadbadm

Examples

The following examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.