/*Here i feel is the placement of version dropdown*/

Download Logs

Overview

Effective CloudCenter 4.7.0, the CloudCenter platform administrators can configure the ability to download consolidated log files for the CloudCenter platform for subsequent troubleshooting purposes.

  • Identifies issues that span multiple the CCM and CCO servers without having to login to those systems. The default time range includes the last 3 days. To configure the time range, configure the ccm.log.lastNDays=3 property in the CCM server.properties file.

Requirements

To download CloudCenter log files, adhere to these requirements:

  • Install the Health Monitor component.
  • Follow the port dependencies identified in Phase 2: Configure Network Rules > Monitor Firewall Rules.
  • Configure the ELK stack's port and IP credentials by using the CCM Properties wizard and the CCO Properties wizard.
  • Users with the following permissions can download log files:

    ServerAPI Permissions
    CCMOnly root admin
    CCOAny tenant admin with the following permissions:
    • Has access to the cloud region
    • Has a user cloud account configured on the CCO

Download CCM Logs

Once you meet the tasks listed in the Requirements section above, follow this procedure to download the CCM logs:

  1. Access the CCM UI > Admin tab using administrator credentials. The Admin Dashboard displays.
  2. In the Tenant Information section, under Logs, you have two options:
    1. Download CloudCenter CCM Logs: When you click this link, the CCM log file is downloaded and saved using the following syntax: CCM_UTCtimestamp.txt
      For example: CCM_2016-11-29_08_20_12.738_UTC.txt 

      Icon

      If your deployment uses the HA mode, each log statement is prepended with the unique host ID that is issued when you create an instance.


    2. View logs on Kibana: When you click this link, you see the Kibana popup prompting you for credentials.

      1. Enter the following default credentials:
        • Username = logreader
        • Password = re@d0nly (zero between d and n)
        Icon

        Be sure to change the email address and password for the admin account after your first login. See the Change Default ELK Credentials section below for additional context.

      2. Once you enter the credentials, you see the Kibana page – first time users see the Configure an index pattern page, click Create:
      3. In the next screen, enter the job name or job ID in the search bar.

        For example: If the job name at the time of submission is ELKTest and the child job name is AppServer that uses the ID 9 and 10 respectively, then the search pattern can be:
        DeploymentJobName="ELKTest" OR DeploymentJobName="AppServer" OR DeploymentJobId="9" OR DeploymentJobId="10"

Download CCO Logs

Once you meet the tasks listed in the Requirements section above, follow this procedure to download the CCO logs:

  1. Access the CCM UI > Admin > Clouds > Configure Clouds > Region tab using administrator credentials – just as you would to Register the CCO with the CCM. The corresponding cloud region page displays.

  2. Click the Download Logs link as displayed in the following image:

    Icon

    If you do not configure the ELK stack to enable log file download, the link changes to a grey Download Logs text with a mouseover display of Configure ELK stack to enable download of logs as displayed in the following image:

    Once you configure the ELK stack, the grey text changes to a clickable Download Logs link.

    When you click the Download logs link, the CCO log file is downloaded and saved using the following syntax: CCO_cloud_region_name_timestamp.txt
    For example:
    amazon_cloud_US West (Northern California)_2016-12-16 09_48_37_UTC.txt

Changing Default ELK Credentials and Configuring Log Files

Be sure to change the email address and password for the account after your first login. You can change the ELK password when configuring the log file download using one of two wizards – the CCM Wizard or the Monitor Wizard.

  •  Change Credentials in the CCM Wizard

    Unable to render {include} The included page could not be found.

  •  Change Credentials in the Monitor Wizard

    Unable to render {include} The included page could not be found.

Searching within the Log File

You can search within each downloaded log file based on the DeploymentJobName or DeploymentJobID to retrieve information about a particular deployment. For example, you can search for:

  • DeploymentJobName=Testing
  • DeploymentJobID=12
  • No labels