[DOC] Insufficient description of evs.debug_log_mask and evs.info_log_mask

[Przemek]

Currently our documentation (https://www.percona.com/doc/percona-xtradb-cluster/5.6/wsrep-provider-index.html) has:

variable evs.debug_log_mask
Command Line: Yes
Config File: Yes
Scope: Global
Dynamic: Yes
Default Value: 0x1
This variable is used for EVS (Extended Virtual Synchrony) debugging. It can be used only when wsrep_debug is set to ON

and

variable evs.info_log_mask
Command Line: No
Config File: Yes
Scope: Global
Dynamic: No
Default Value: 0
This variable is used for controlling the extra EVS info logging.

But id doesn't say what kind of information can we expect to see logged when using higher values and what values are supported.
Also, is it related anyhow with "debug" wsrep_provider option?

Btw, we can see some more information in the code:

gcomm/src/gcomm/conf.hpp :

        /*!
         * @brief EVS debug log mask ("evs.debug_log_mask")
         *
         * This mask controls what debug information is printed in the logs
         * if debug logging is turned on. Mask value is bitwise-or
         * from values gcomm::evs::Proto::DebugFlags. By default only
         * state information is printed.
         */
        static std::string const EvsDebugLogMask;

        /*!
         * @brief EVS info log mask ("evs.info_log_mask")
         *
         * This mask controls what info log is printed in the logs.
         * Mask value is bitwise-or from values gcomm::evs::Proto::InfoFlags.
         */
        static std::string const EvsInfoLogMask;

gcomm/src/evs_proto.hpp :

    /*!
     * @brief Flags controlling what debug information is logged if
     * debug logging is turned on.
     */
    enum DebugFlags
    {
        D_STATE = 1 << 0, /*!< State changes */
        D_TIMERS = 1 << 1, /*!< Timer handling */
        D_CONSENSUS = 1 << 2, /*!< Consensus protocol */
        D_USER_MSGS = 1 << 3, /*!< User messages */
        D_DELEGATE_MSGS = 1 << 4, /*!< Delegate messages */
        D_GAP_MSGS = 1 << 5, /*!< Gap messages */
        D_JOIN_MSGS = 1 << 6, /*!< Join messages */
        D_INSTALL_MSGS = 1 << 7, /*!< Install messages */
        D_LEAVE_MSGS = 1 << 8, /*!< Leave messages */
        D_FOREIGN_MSGS = 1 << 9, /*!< Foreing messages */
        D_RETRANS = 1 << 10, /*!< Retransmitted/recovered messages */
        D_DELIVERY = 1 << 11 /*!< Message delivery */
    };

    /*!
     * @brief Flags controlling what info log is printed in logs.
     */
    enum InfoFlags
    {
        I_VIEWS = 1 << 0, /*!< View changes */
        I_STATE = 1 << 1, /*!< State change information */
        I_STATISTICS = 1 << 2, /*!< Statistics */
        I_PROFILING = 1 << 3 /*!< Profiling information */
    };

[Alexey Zhebel (alexey-zhebel)]

Will be tracked as part of https://jira.percona.com/browse/DOC-564

[Shahriyar Rzayev (rzayev-sehriyar)]

Percona now uses JIRA for bug reports so this bug report is migrated to: https://jira.percona.com/browse/PXC-1884