Usage options

ccm report [--help|-h ]
    [--hours <hours> | --days <days> | --from <iso-8601> --to <iso-8601>]
    [--local]
    [--remote-server "<FQDN/IP> [-p <port>] -u <username> -d <directory path>"]
    [–-target <"instanceId -n <namespace> [any list of target options here]">]
    [--filter <"[-p <product>] [-r <release>] [-c <component> ] [-s <service>] [-o 
      <pod>]">]
    [--skip <"[ccm] [infra] [app]">
    [--fileIntegrity (only collects file integrity logs; no other reports are collected)
    This option is only valid by itself or with the --remote-server option]

Time constraint options

When no time options are specified, ccm report collects a subset of available log files on Cluster Control Manager and nodes in the cluster. It also collects seven days of logs from applications. You can increase or decrease the logs from applications by specifying time constraints:

• --hours <hours> option specifies the number of hours of application logs to collect. For example, ccm report --hours 3 collects application logs from the past three hours. This option cannot be combined with any other time constraint options.

• --days <days> option specifies how many days of application logs to collect. For example, ccm report --days 2 collects application logs from the past two days. This option cannot be combined with any other time constraint options.

• --from and --to options specify a range of application logs to collect. For example, ccm report --from 2020-05-04T20:40:03 --to 2020-05-04T21:40:03 collects one hour's worth of application logs for the specified date. Use --from and --to together and do not combine them with the --hours or --days options.

All system logs are collected regardless of the time constraints specified in the command.

Local option

Run ccm report --local to upload the collected artifacts to the local directory at /var/avaya/artifactCache/cspLogs/ccmReport-<ccm server name>-<date>.tgz.

Remote server option

The --remote-server option replaces the --sftp-destination option.

The --remote-server option automatically uploads collected artifacts to a remote SFTP server. When Cluster Control Manager collects an artifact, that artifact is uploaded to the remote server and deleted from Cluster Control Manager. This option is useful when a lot of logs need to be collected and there is insufficient disk space on Cluster Control Manager. The --remote-server option must include the following:

• FQDN or IP address of the remote server

• Port number if you are not using the default port 22

• User name and password for the remote server

• Base directory path to the remote server

The following is an example of this command:

ccm report --remote-server "10.10.5.7 -u bruce -d /home/bruce/system1/"

In this example:

• No port is specified, so the default SSH port 22 is used.

• The report is transferred to /home/bruce/system1/ccmReport-<ccm server name>-<date>/

When you run this command, you are prompted for a password. If your credentials are invalid, the command exits with an error message.

For information about obtaining the .tar log files, see Obtaining .tar log files.

Target option

The --target option enables the invocation of product-specific scripts. These scripts collect additional information that is not retrieved through the general ccm report command. For example, a custom script might collect database information for a product. When you specify the --target option, no other application logs are downloaded to the applicationLogs/ directory.

The --target option must include the instance ID. For example, ocra. It can also include:

• -n <namespace>, which is used if the instance ID is not deployed in the default namespace. For example, if the instance ID is deployed in the acme namespace, the command requires n acme.

• A list of options passed directly to the custom script, which are not used by the ccm report command.

For example, ccm report --target "ocra -n acme -o option1 option2 option3" invokes the ocra script in the acme namespace with three options.

Elasticsearch logs

Elasticsearch data is gathered when you run ccm report without the --target option. This data is placed in the applicationLogs/* directory. For information about uploading these logs to view in Kibana or another Elasticsearch server, see Viewing application logs in an Elasticsearch server.

Filter option

By default, ccm report collects log files for all applications running in the cluster. To reduce time and disk space consumption, you can use the --filter option to specify a specific application or group of applications from the collection. You cannot combine the --filter option with --target.

When using --filter, include one or more of the following options within double quotes:

• -p <product>: Replace <product> with the product name. Examples of product names are CommonServices, Analytics, or mstr.

• -r <release>: Replace <release> with the release name or instance ID. Release examples are CommonServices, orca, or mstr.

• -c <component>: Replace <component> with the component or chart name. Examples of components are eventing-kafka-1.2.100001090700, istio-1.5.1010100011030005, orca-5.1.56, or mstr-0.1.216.

  Only use -c with the -p or -r options.

• -s <service>: Replace <service> with the service name. Examples of service names are istio-ingressgateway, orca-redis, or mstr-web.

• -o <pod>: Replace <pod> with the pod ID. Pod examples are orca-redis-server-1 or cert-manager-certmgmt-service-c5899b664-g8qjm.

ccm report --filter -p <product> -c <component>, -s <service1>, -s <service2>

Skip option

By default, ccm report collects log files on cluster infrastructure and application logs by running applications within the cluster. Use the --skip option to skip one or more log areas. When using --skip, include one or more of the following options within double quotes:

• ccm: To skip Cluster Control Manager logs.

• infra: To skip logs for nodes in the cluster.

• app: To skip application logs.

If you include two of these options, add a space between them.

ccm report --skip "infra app"

File integrity logs

When file integrity validation is enabled, run ccm report --fileIntegrity to collect AIDE logs.