Contents

• About the diagnostic suite

• Run from the command line

• Run the diagnostic suite

  • Command

  • Switches

  • Result

• Get Intelligence Center logs

  • Command

  • Switches

  • Result

• Get sosreport reports

  • Command

  • Switches

  • Result

• Get Intelligence Center health

  • Command

  • Switches

  • Result

• Get ElasticSearch configuration health

  • Command

  • Switches

  • Result

About the diagnostic suite

The eiq-platform diagnose set of commands automates running basic diagnostic tests and collecting test results to examine system-level setup and operation such as Intelligence Center configuration, database availability, and basic system health (for example: free disk space).

This diagnostic suite of commands runs the checks, collects Intelligence Center logs, and it produces a system report. Run inside venv

The eiq-platform command line utility is available in the Intelligence Center Python virtual environment: activate it and, if necessary, import the Intelligence Center environment variables.

• Open a terminal session.

• In the terminal, log in to the Intelligence Center through SSH:

  # the Intelligence Center user name must have admin access rights

  ssh ${platform_user_name}@${platform_host_name}

   

  # Or:

  ssh ${platform_user_name}@${platform_ip_address}

   

  # Example:

  ssh eldon-[email protected]

   

  # Or:

  ssh eldon-tyrell@173.237.136.98

• Obtain root-level access by running sudo -i:

  # Root-access login shell

  sudo -i

• To access resources as a different user than the currently active one, append -u:

  # Grant the currently logged in user root-level access

  sudo -i

   

  # Grant root-level access to a different user

  sudo -i -u ${user_name}

   

  # Run a command as a different user, with root-level access

  sudo -i -u ${user_name} ${command} ${options}

• Activate a Python virtual environment for the Intelligence Center:

  source /opt/eclecticiq-platform-backend/bin/activate

Run from the command line

eiq-platform diagnose is the top-level umbrella for the command set. It includes the following commands:

For further details about each command, append --help to it to view the available switches for the specific command.

Run the diagnostic suite

eiq-platform diagnose run is a diagnostic command to run basic tests on the Intelligence Center for troubleshooting purposes.

Get Intelligence Center logs

eiq-platform diagnose logs is a diagnostic command to collect Intelligence Center logs for investigation and troubleshooting purposes.

Get sosreport reports

eiq-platform diagnose report is a diagnostic command to collect sosreport reports holding diagnostic and support data for investigation and troubleshooting purposes.

Get Intelligence Center health

eiq-platform diagnose query allows selecting and running a specific custom sosreport plugin query, and it prints the output to the terminal.

Get ElasticSearch configuration health

eiq-platform diagnose elasticsearch is a diagnostic tool to obtain information about the health of your ElasticSearch configuration, especially in relation to search performance.

The tool differs from the ElasticSearch’s own diagnostic tool in that it only provides the most relevant metrics in summary form, as opposed to a wealth of data that can often be time-consuming to analyze.

ElasticSearch optimization is a complex task and this diagnostics tool does not aim to give you all the answers to your performance issues. However, it does highlight the most common causes of sub-optimal performance and suggests which ones to look at first.