Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Logging

  • how-to
March 16, 2025
+ 12
Logging with the Python SDK.

The Python SDK allows logging via the standard logging module.

Enabling Logging

Python Logging Module
python
ViewCopy
import logging
import traceback
from datetime import timedelta

import couchbase
from couchbase.auth import PasswordAuthenticator
from couchbase.cluster import Cluster
from couchbase.diagnostics import ServiceType
from couchbase.exceptions import CouchbaseException
from couchbase.options import ClusterOptions, WaitUntilReadyOptions

# output log messages to example.log
logging.basicConfig(filename='example.log',
                    filemode='w', 
                    level=logging.DEBUG,
                    format='%(levelname)s::%(asctime)s::%(message)s',
                    datefmt='%Y-%m-%d %H:%M:%S')

logger = logging.getLogger()
couchbase.configure_logging(logger.name, level=logger.level) (1)

cluster = Cluster('couchbase://your-ip',
                  ClusterOptions(PasswordAuthenticator("Administrator", "password")))

cluster.wait_until_ready(timedelta(seconds=3),
                         WaitUntilReadyOptions(service_types=[ServiceType.KeyValue, ServiceType.Query]))

logger.info('Cluster ready.')

bucket = cluster.bucket("travel-sample")
coll = bucket.scope('inventory').collection('airline')
try:
    coll.get('not-a-key')
except CouchbaseException:
    logger.error(traceback.format_exc())

Environmental Settings

Only one logger can be created. Either use PYCBC_LOG_LEVEL to create a console logger or configure_logging as mentioned above.

In the command line environment, the PYCBC_LOG_LEVEL variable is set as follows:

GNU/Linux and Mac
console
Copy
export PYCBC_LOG_LEVEL=<log-level>
Windows
console
Copy
set PYCBC_LOG_LEVEL=<log-level>

Where <log-level> is either error, warn, info, or debug.

Log Levels

You can increase the log level for greater verbosity (more information) in the logs:

  • off — disables all logging, which is normally set by default.

  • critical — important functionality not working.

  • error — error messages.

  • warn — error notifications.

  • info — useful notices, not often.

  • debug — diagnostic information, required to investigate problems.

Log Redaction

Redacting logs is a two-stage process. If you want to redact client logs (for example before handing them off to the Couchbase Support team) you first need to enable log redaction in your application. This is done through the ClusterOptions, setting log_redaction to True.

Once the SDK writes the logs with the tags to a file, you can then use the cblogredaction tool to obfuscate the log.