Client module diagnostics

Important

All commands are executed only from superuser.

Mode superuser:

sudo -i

Services logging used by the Client module

Logging happens using logging module.

Logging produced in log file of process that uses Client:

Note

Description of the logging process provided by the OpenStack platform can be found in the corresponding section of the official documentation.

Client module debugging

There are the following solutions in case of problems in the operation of the module:

  1. Set log level to value DEBUG which will allow recording event messages in log files with maximum detail for diagnosing and solving problems.

  2. Launch the module self-diagnosis utility openstack aos tests.

    Usage example:

    openstack aos tests --names client --modules
    Modules diagnostic started.
    Running tests for: client, cloud_manager, dashboard, journal, monitor, rs_server, scheduler
    
    +---------------------+----------------------------------------------------------------------------------------------+
    | Start date and time | Thu Dec 24 17:03:55 2020 GMT                                                                 |
    +---------------------+----------------------------------------------------------------------------------------------+
    | OpenStack version   | Train (20.4.1)                                                                               |
    +---------------------+----------------------------------------------------------------------------------------------+
    | Hostname            | ana-deb10t-ovs-01.stand.loc                                                                  |
    +---------------------+----------------------------------------------------------------------------------------------+
    | Distribution        | debian 10                                                                                    |
    +---------------------+----------------------------------------------------------------------------------------------+
    | Conductor nodes     | 1                                                                                            |
    +---------------------+----------------------------------------------------------------------------------------------+
    | Compute nodes       | 2                                                                                            |
    +---------------------+----------------------------------------------------------------------------------------------+
    | Database            | b'mysql  Ver 15.1 Distrib 10.3.27-MariaDB, for debian-linux-gnu (x86_64) using readline 5.2' |
    +---------------------+----------------------------------------------------------------------------------------------+
    | Packages source     | pypi-dev.tnxos.loc                                                                           |
    +---------------------+----------------------------------------------------------------------------------------------+
    
    ======
    Client
    Version: 1.5.1.dev5 (latest: 1.5.1.dev7)
    License: This module does not require a license.
    ======
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | N | Test name                                 | Status  | Failure reason                                                                                                              |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 1 | test admin role in domain                 | OK      |                                                                                                                             |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 2 | test check openstack endpoints            | OK      |                                                                                                                             |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 3 | test installation source file             | OK      |                                                                                                                             |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 4 | test keystone ldap driver                 | SKIPPED | Path /etc/keystone/domains/ doesn't exist.                                                                                  |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 5 | test modules compatibility with openstack | OK      |                                                                                                                             |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 6 | test modules versions                     | FAIL    | Versions of the installed modules can be incompatible. You need to use the same major and minor version of the all modules. |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 7 | test nova journal middleware              | FAIL    | Failed to read config file: /etc/nova/api-paste.ini                                                                         |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 8 | test nova scheduler filter                | FAIL    | Failed to read config file: /etc/nova/nova.conf                                                                             |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    | 9 | test valid openstack version              | FAIL    | Common packages:                                                                                                            |
    |   |                                           |         | automaton==1.15.0. Required automaton>=1.17.0,<=1.17.0                                                                      |
    +---+-------------------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------+
    Ran 9 in 9.805s
    FAIL (success=4, failures=4, errors=0)
    
    ======
    TOTALS
    ======
    Ran 70 in 19.329s
    FAIL (success=4, failures=4, errors=0)
    

Note

Detailed description of the utility is available in section «Self-diagnosis utility».