ApiCollectDiagnosticDataArguments Data Model

Arguments used for the collectDiagnosticData command.

Properties
name data type description
bundleSizeBytes number The maximum approximate bundle size of the output file. Defaults to 0.
startTime string This parameter is ignored between CM 4.5 and CM 5.7 versions. For versions from CM 4.5 to CM 5.7, use endTime and bundleSizeBytes instead. For CM 5.7+ versions, startTime is an optional parameter that is with endTime and bundleSizeBytes. This was introduced to perform diagnostic data estimation and collection of global diagnostics data for a certain time range. The start time (in ISO 8601 format) of the period to collection statistics for.
endTime string The end time (in ISO 8601 format) of the period to collection statistics for.
includeInfoLog boolean This parameter is ignored as of CM 4.5. INFO logs are always collected. Whether to include INFO level logs. WARN, ERROR, and FATAL level logs are always included.
ticketNumber string The support ticket number to attach to this data collection.
comments string Comments to include with this data collection.
clusterName string Name of the cluster to collect. If null, collects from all clusters.
enableMonitorMetricsCollection boolean Flag to enable collection of metrics for chart display.
roles array of string List of roles for which to get logs and metrics. If set, this restricts the roles for log and metrics collection to the list specified. If empty, the default is to get logs for all roles (in the selected cluster, if one is selected). Introduced in API v10 of the API.

Example

{
  "bundleSizeBytes" : 12345,
  "startTime" : "...",
  "endTime" : "...",
  "ticketNumber" : "...",
  "comments" : "...",
  "clusterName" : "...",
  "enableMonitorMetricsCollection" : true,
  "roles" : [ "...", "..." ]
}