create-vw-diagnostic-data-job¶

Description¶

Creates a job for the given Virtual Warehouse. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see –hive-download-options, –impala-download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see –destination). General metadata about the diagnostics will also be included as the bundle-info.json file.

Synopsis¶

  create-vw-diagnostic-data-job
--cluster-id <value>
--vw-id <value>
--destination <value>
[--start-time <value>]
[--end-time <value>]
[--case-number <value>]
[--bundle-metadata <value>]
[--force | --no-force]
[--hive-download-options <value>]
[--impala-download-options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

ID of cluster.

--vw-id (string)

ID of the Virtual Warehouse.

--destination (string)

Destination of the diagnostics collection.

Possible values:

• UPLOAD_TO_CLOUDERA

• DOWNLOAD

--start-time (datetime)

The resulting bundle will contain logs/metrics after the specified start time. If not indicated, then 30 minutes ago from now is taken as the start time.

--end-time (datetime)

The resulting bundle will contain logs/metrics before the specified end time. If not indicated, then the current time is taken as the end time.

--case-number (string)

Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data.

--bundle-metadata (map)

Additional user-defined metadata information which is attached to resulting bundle-info.json when posting the bundle.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--force | --no-force (boolean)

Forced recreation of the diagnostic job.

--hive-download-options (object)

Flags that denote which diagnostics to include for a Hive Virtual Warehouse.

includeHms -> (boolean)

Include the HMS diagnostics.

includeErrordump -> (boolean)

Include the error dump.

includeGclogs -> (boolean)

Include the Garbage collector logs.

includeHeapdump -> (boolean)

Include the heap-dump.

includeLogs -> (boolean)

Include logs.

includeComputeResourceInfo -> (boolean)

Include compute resource info.

includeKubernetesResourceInfo -> (boolean)

Include Kubernetes resource info.

Shorthand Syntax:

includeHms=boolean,includeErrordump=boolean,includeGclogs=boolean,includeHeapdump=boolean,includeLogs=boolean,includeComputeResourceInfo=boolean,includeKubernetesResourceInfo=boolean

JSON Syntax:

{
  "includeHms": true|false,
  "includeErrordump": true|false,
  "includeGclogs": true|false,
  "includeHeapdump": true|false,
  "includeLogs": true|false,
  "includeComputeResourceInfo": true|false,
  "includeKubernetesResourceInfo": true|false
}

Form Factors: public

--impala-download-options (object)

Flags that denote which diagnostics to include for an Impala Virtual Warehouse.

includeHms -> (boolean)

Include the HMS diagnostics.

includeMinidump -> (boolean)

Include the minidump.

includeProfile -> (boolean)

Include the profile.

includeSidecar -> (boolean)

Include the sidecar diagnostics.

includeWorkload -> (boolean)

Include the workload diagnostics.

includeKubernetesResourceInfo -> (boolean)

Include kubernetes resource info.

Shorthand Syntax:

includeHms=boolean,includeMinidump=boolean,includeProfile=boolean,includeSidecar=boolean,includeWorkload=boolean,includeKubernetesResourceInfo=boolean

JSON Syntax:

{
  "includeHms": true|false,
  "includeMinidump": true|false,
  "includeProfile": true|false,
  "includeSidecar": true|false,
  "includeWorkload": true|false,
  "includeKubernetesResourceInfo": true|false
}

Form Factors: public

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

id -> (string)

Identifier for each bundle collection.

status -> (string)

Status of the diagnostics collection request.

url -> (string)

This URL points to a download location if the destination is DOWNLOAD.

labels -> (map)

Additional key-value pair attributes associated with the Diagnostic Data Job.

key -> (string)

value -> (string)

Form Factors¶

public