collect-datalake-diagnostics¶
- subtitle
Start DataLake diagnostics collection
- version
0.9.121
Description¶
Start Datalake diagnostics collection
Synopsis¶
collect-datalake-diagnostics
--crn <value>
--destination <value>
--description <value>
[--case-number <value>]
[--labels <value>]
[--start-date <value>]
[--end-date <value>]
[--additional-logs <value>]
[--hosts <value>]
[--host-groups <value>]
[--exclude-hosts <value>]
[--skip-unresponsive-hosts | --no-skip-unresponsive-hosts]
[--include-nginx-report | --no-include-nginx-report]
[--include-salt-logs | --no-include-salt-logs]
[--include-sar-output | --no-include-sar-output]
[--update-package | --no-update-package]
[--storage-validation | --no-storage-validation]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--crn
(string)
CRN of the Datalake cluster.
--destination
(string)
Destination of the diagnostics collection (Support, Own cloud storage, Engineering or collect only on the nodes)
Possible values:
SUPPORT
CLOUD_STORAGE
ENG
LOCAL
--description
(string)
Additional information / title for the diagnostics collection.
--case-number
(string)
Optional support case number in case of SUPPORT destination, otherwise only act as additional data.
--labels
(array)
Array of labels that can filter logs that are collected during diagnostics collection.
Syntax:
"string" "string" ...
--start-date
(datetime)
Date timestamp - collect files only for diagnostics that has higher last modified timestamp value than this.
--end-date
(datetime)
Date timestamp - collect files only for diagnostics that has lower created timestamp value than this.
--additional-logs
(array)
Array of log descriptors that should be additionally collected during diagnostics collection.
Shorthand Syntax:
path=string,label=string ... (separate items with spaces)
JSON Syntax:
[
{
"path": "string",
"label": "string"
}
...
]
--hosts
(array)
Array of host names (fqdn), collection will run only on the dedicated hosts.
Syntax:
"string" "string" ...
--host-groups
(array)
Array of host groups, collection will run only on the dedicated hosts that belongs to these host groups.
Syntax:
"string" "string" ...
--exclude-hosts
(array)
Array of host names (fqdn or IP address), collection will not run on the excluded hosts.
Syntax:
"string" "string" ...
--skip-unresponsive-hosts
| --no-skip-unresponsive-hosts
(boolean)
Skip unhealthy hosts from the diagnostics collection.
--include-nginx-report
| --no-include-nginx-report
(boolean)
Include Nginx report generated by GoAccess (if available).
--include-salt-logs
| --no-include-salt-logs
(boolean)
Include salt minion/master/api system logs in the diagnostics collection.
--include-sar-output
| --no-include-sar-output
(boolean)
Include SAR (System Activity Report) generated outputs in the diagnostics collection (if available).
--update-package
| --no-update-package
(boolean)
If enabled, required package (cdp-telemetry) will be upgraded or installed on the nodes. (useful if package is not installed or needs to be upgraded) Network is required for this operation.
--storage-validation
| --no-storage-validation
(boolean)
Enable/disable node level storage validation (can be disabled for example, if you have too many hosts and do not want to do too much parallel writes to s3/abfs)
--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¶
Form Factors¶
public