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 

      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 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

    Configure CCM Wizard Properties

    To configure the CCM wizard properties, follow this procedure.

      1. SSH into the CCM instance as a CentOS user.
      2. Run the following command:

        sudo -i
    1. Invoke the CCM wizard.

      CCM Wizard Path
      /usr/local/cliqr/bin/ccm_config_wizard.sh

       

      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

      Mail

      The SMTP server details to send mail notifications. If you retain the default settings, the SMTP sever details are not configured.

      SMTP Host

      smtp.gmail.com

      SMTP PortDefaults to 465
      SMTP Auth

      Boolean setting

      • True = Authentication is required for the SMTP server.
      • False = Authentication is not required for the SMTP server.

      Mail_User

      The mail authentication and configuration details to send mail notifications. If you retain the default settings, the mail functionality is not be configured and emails are not sent.

      Mail User

      Your email address for the SMTP server

      Password

      The password to log into the SMTP server

      From User

      The email address (no reply) to initiate emails from the CCM server

      Display NameThe name to be displayed when you initiate emails from the CCM server
      Server_info (Required)Public DNS

      DNS (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.

      Hazelcast IP

      Private IP address of the CCM VM – Used internally by the CloudCenter platform. Required for HA Mode.

      External URL

      The CloudCenter External URL for the CCM server. Required for HA Mode.

      Config_App_Logo

      Used by the application profile templates.

      DB Password

      CCM NON-HA appliance mode derives this information automatically from the PostgreSQL database.

      CCM HA appliance mode does not have this information as the database and the CCM must both be configured to communicate with each other. As such, you must explicitly configure the application profile templates location in the database by providing the database information.

      The default DB password = cliqr

       

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

      ESB_Info
      Required only if you installed Enterprise Service Bus (ESB), an optional component that is not installed in CloudCenter appliances by default.
      Rabbit Host

      The IP address or the hostname of the ESB AMQP server.

      Rabbit Port5671
      Management Server AddressThe IP address or the hostname of the CCM server.
      Notification Server AddressThe IP address or the hostname of the Notification server (ideally, the same as the CCM server).
      Trust Store PasswordThe trust store password for the ESB instance.
      Key Store PasswordThe key store password for the ESB instance.

      Network

       

      Hostname

      The CCM server's hostname – use the default if you are not making any changes.

      DBIP or Hostname

      DNS or IP of the database:

      • Local host: Default, does not include the flyway migrate configuration
      • Remote host, includes the flyway migrate configuration – see the last bullet in this row.
      Username

      Authenticated username for the database (either local or remote).

      Password

      Authenticated password for the database (either local or remote).

      Flyway Migrate

      Optional. Remote Host Configure the CCM to a remote database by providing the IP address of the remote database. When you provide the IP address, you see an additional screen to configure the flyway migrate process.

      • Yes: Flyway migration takes place.
      • No: Only the configuration files are updated.

      DB configuration is required for standalone database deployments.

      ELK_InfoELK Host

      Specify the IP address for the ELK host (Monitor VM).

      Elasticsearch PortDisplays 8881 by default.
      Logstash PortDisplays 4560 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
      Host Identifier List

      Only applies to environments using the HA mode – provide a list of comma separated unique host identifiers for all ELK/Monitor 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.

      Config_Certs – Custom Certs MenuGenerate Certs
      • CloudCenter ID: A customer-assigned unique alphanumeric string to identify this CloudCenter deployment.
      • Company Name: The name of the company for which this certificate is being generated.
      Update CertsCerts Zip Path: Provide the path for the certs.zip file. The default path is /tmp/certs.zip.
    2. Exit the CCM configuration wizard.

    3. Select Yes, to restart the Tomcat service for the changes to take effect.

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

    • If you are installing a Health Monitor component – see Health Monitor Installation

  •  Change Credentials in the Monitor Wizard

    Install Monitor Using Appliances (Required)                             

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

    Configure Monitor Wizard Properties

    The Monitor is a required CloudCenter component!

     

      1. SSH into the MONITOR instance as a centos user.
      2. Run the following command:

        sudo -i
    1. Invoke the wizard.

      Monitor Wizard Path
      /usr/local/cliqr/bin/monitor_config_wizard.sh
    2. Configure the properties for the Monitor instance.

      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
      CCM_InfoMonitor ID

      A unique (alphanumeric) identifier used for the health check instance.

      CCM Hostname/URL (Required)
      • CCM_IP or 
      • CCM_SA_IP or
      • CCM_LB_IP
      Monitor UserThe User ID configured on the CCM server to enable health check for cloud  regions.
      • To perform a health check on all activated cloud regions, set this value as 2 (2 is the CloudCenter’s root administrator’s User ID).
      • To perform a health check on specific cloud regions, create and activate a new user with those specific regions and use that user’s User ID as value for this property. To get the User ID, use the v1 User Management APIs.
      ELK_LoginELK UserThe default Username for the ELK/Monitor 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.
    3. Verify your changes and Exit the Monitor configuration wizard.

    4. Select Yes, to restart the Tomcat service for the changes to take effect.

    You have successfully configured the Monitor 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 and Monitor 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