Function configure_logging

couchbase/logic/logging_config.py:181–223

Configure the Python SDK to route C++ logs through Python's logging system. This is the programmatic alternative to using PYCBC_LOG_LEVEL environment variable. It allows integration with your application's existing logging configuration. Note: This configures C++ SDK logs only. Py

(name, level=logging.INFO, parent_logger=None)

def configure_logging(name, level=logging.INFO, parent_logger=None):
    """
    Configure the Python SDK to route C++ logs through Python's logging system.

    This is the programmatic alternative to using PYCBC_LOG_LEVEL environment variable.
    It allows integration with your application's existing logging configuration.

    Note: This configures C++ SDK logs only. Python-side SDK components (threshold
    logging, metrics, transactions) use separate loggers under the 'couchbase' hierarchy.

    To also capture threshold logging reports and other Python SDK logs, configure
    the 'couchbase' logger:

    Example:
        import logging
        from couchbase import configure_logging

        # Configure C++ logs to route through Python
        configure_logging('my_app', level=logging.DEBUG)

        # Also capture Python SDK logs (threshold, metrics, transactions, etc.)
        couchbase_logger = logging.getLogger('couchbase')
        couchbase_logger.addHandler(your_handler)
        couchbase_logger.setLevel(logging.INFO)

    Args:
        name: Name for the logger
        level: Python logging level (default: logging.INFO)
        parent_logger: Optional parent logger

    Raises:
        RuntimeError: If PYCBC_LOG_LEVEL environment variable is already set.
                     Cannot use both configuration methods simultaneously.
    """
    if parent_logger:
        name = f'{parent_logger.name}.{name}'
    logger = logging.getLogger(name)
    if _PYCBC_LOGGER.is_console_logger() or _PYCBC_LOGGER.is_file_logger():
        raise RuntimeError(('Cannot create logger.  Another logger has already been '
                            'initialized. Make sure the PYCBC_LOG_LEVEL and PYCBC_LOG_FILE env '
                            'variable are not set if using configure_logging.'))
    _PYCBC_LOGGER.configure_logging_sink(logger, level)
    logger.debug(get_metadata(as_str=True))


def enable_protocol_logger_to_save_network_traffic_to_file(filename: str) -> None: