// removed jquery ui css and js

Download Logs

Overview

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 Log Collector component.
  • Follow the port dependencies identified in Phase 2: Configure Network RulesLog Collector Firewall Rules.
  • Configure the Log Collector'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 

      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)

        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:

    If you do not configure the Log Collector 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 Log Collector, 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 ELK Wizard.

  •  Change Credentials in the CCM Wizard

    Configure CCM Wizard Properties

    To configure the CCM wizard properties, follow this procedure.

    1. Invoke the CCM wizard as a root user (see Virtual Appliance Process > Cloud-Specific Setup Details for a sample setup).

      CCM Wizard Path
      /usr/local/cliqr/bin/ccm_config_wizard.sh
    2. Configure the server properties.

      Write this down for future reference!

      Write down the Field details in a printed version of the Installation Approach > Your Notes section for later use.

      Wizard Menu

      Field

      Description

      Server_info (Required)Public DNSDNS (or IP address) of the CCM – Used by the CCO VM to communicate with the CCM VM.
      Monitor URL

      Monitor VM's complete URL. For example, https://<MON IP address>:8443.

      • Requires HTTPS protocol.
      • Used by the CCM VM to retrieve the health status from the Monitor VM.
      Enter DB ParametersIP or Hostname

      DNS or IP of the database.

      DB Username and Password

      The following credentials are pre-populated:

      Default username = cliqr (cannot be changed)

      Default password = cliqr (must be changed)

      Be sure to change the default password immediately after your first login. See PostgreSQL Password for additional context.

      Enter Log Collector ParametersELK Host

      Specify the IP address for the Log Collector host.

      Elasticsearch PortDisplays 8881 by default.
      Kibana PortDisplays 8882 by default.
      ELK UserThe default ELK Username = logreader.
      ELK PasswordThe default ELK Password is re@d0nly (zero between d and n) (change this password after the initial login – see Download Log File for additional context).
      Host IdentifierA Unique ID for the server – be sure to prefix the unique identifier with CCM_ for example, CCM_1
      If not set, the CloudCenter platform uses the CCM server date.
      Host Identifier List

      Only applies to environments using the HA mode – provide a list of comma separated unique host identifiers for all Log Collector hosts in a HA setup = for example, CCM_1,CCM_2,myCCM.

      In an environment operating in HA mode, if you have two CCM instances with unique IDs configured as CCM_1,CCM_2 in their respective server.properties file, then this property should state CCM_1,CCM_2 in both CCM instances. Each CCM must be aware of the unique ID of the other CCM(s) when in HA mode.

    3. Exit the CCM configuration wizard.

    4. Select Yes, to restart the CCM server and corresponding CloudCenter services.

    You have successfully installed the CCM instance! You can now proceed to the next step:

    • Configure the Log Collector details in the CCM wizard's Enter Log Collector Parameters menu.

    • If you are installing the ESB component – see ESB Installation

  •  Change Credentials in the ELK Wizard

    Install the Log Collector Using Appliances (Required)

    The Elasticsearch, Logstash, and Kibana, collectively referred to as the ELK stack, are installed by default when you install the Log Collector server. To be able to Download Log Files, be sure to install this component!

    Configure Log Collector Wizard Properties

    The Log Collector is a required CloudCenter component!

    1. Configure the Log Collector information in the CCM wizard. See Configure CCM Wizard Properties for additional context.

      Write this down for future reference!

      Write down the Field details in a printed version of the Installation Approach > Your Notes section for later use.
      Wizard MenuFieldNotes
      ELK_LoginELK UserThe default Username for the ELK host is logreader.
      ELK PasswordThe default ELK Password is re@d0nly (zero between d and n) (change this password after the initial login – see Download Log Files for additional context).
      Config_CertsCerts Zip PathProvide the path for the certs.zip file. The default path is /tmp/certs.zip.
    2. Verify your changes and Exit the CCM wizard.

    You have successfully configured the Log Collector instance! You can now proceed to the Per CloudCenter Region Installation section and install the CloudCenter components for each Cloud.

    Verify that you have configured the ELK stack details in the CCM (Required) and the CCO (Required) servers.

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
© 2017-2018 Cisco Systems, Inc. All rights reserved