New Logging API

March 16, 2025

+ 12

Couchbase Lite 3.2.2 introduces a new Logging API.

Upgrading to the New CBL Logging API

Use of the deprecated and new Logging API at the same time is not supported.

You can find information about the new Couchbase Lite Logging API introduced in Couchbase Lite 3.2.2.

For information about the now deprecated earlier version of the Logging API, see Using Logs for Troubleshooting.

LogSinks

Couchbase Lite 3.2.2 introduces a new Logging API. The new Logging API has the following benefits:

Log sinks are now thread safe, removing risk of inconsistent states during initialization.
Simplified API and reduced implementation complexity.

The new logging API retains many of the core concepts of the previous API.

The first thing to note is that the three destinations for logs have been renamed as LogSinks, in keeping with common source/sink terminology.

The FileLogSink, the ConsoleLogSink and the CustomLogSink are all to be installed in an instance of LogSinks.

Only ConsoleLogSink is enabled for all logging domains at the warning level by default. To enable a specific type of log sink, create a log sink object of that type, set its minimum log level and domains, and assign it to LogSinks. To disable a log sink, set it to null or use a log sink with LogLevel.NONE.

Couchbase still logs its messages in a handful of named domains and at common log levels: LogLevel.DEBUG the most verbose, and LogLevel.ERROR only for serious failures.

Accessing LogSinks depends on the platform. In Java, use the method LogSinks.get() to obtain an instance. In Swift, Objective-C, .NET, and C, LogSinks provides only static methods, without a singleton instance.

The biggest difference between the new and the old API is that LogSinks are immutable: you set the level and domain at which they log in their constructors. For example, you can only change the level at which the ConsoleLogSink forwards messages to the console by installing a new one created for the new log level.

Log output is split into the following streams:

Logging to the Couchbase File Log

Each log level writes to a separate file and there is a single retention policy for all files
Logging to the Console

You can independently configure and control console logs, which provides a convenient method of accessing diagnostic information during debugging scenarios.

With console logging, you can fine-tune diagnostic output to suit specific debug scenarios, without interfering with any logging required by Couchbase Support for the investigation of issues.
Using a Custom Logger

For greater flexibility you can implement a custom logging class.

Logging to the Console

The changes necessary convert the installation of a console logger from the old to the new API are minimal. Create an instance of ConsoleLogSink initialized with the desired log level and domains and install it.

Old API

csharp
ViewCopy
    Database.Log.Console.Domains = LogDomain.All; (1)
    Database.Log.Console.Level = LogLevel.Verbose; (2)
Database.Log.Console.Level = LogLevel.Verbose;

New API

csharp
ViewCopy
LogSinks.Console = new ConsoleLogSink(LogLevel.Verbose);

Logging to the Couchbase File Log

The changes necessary to convert the installation of a file logger are also similar. Instead of configuring a FileLogger using a LogFileConfiguration, create a new FileLogSink with the desired properties and install it.

setRotateCount from the old API is slightly different from setMaxKeptFiles. setMaxKeptFiles is the maximum number of log files that will exist at any time and is the count of rotated files (setRotateCount) plus one.

Old API

csharp
ViewCopy
            var tempFolder = Path.Combine(Service.GetInstance<IDefaultDirectoryResolver>().DefaultDirectory(), "cbllog");
            var config = new LogFileConfiguration(tempFolder) (1)
            {
                MaxRotateCount = 5, (2)
                MaxSize = 10240, (3)
                UsePlaintext = false  (4)
            };
            Database.Log.File.Config = config; // Apply configuration
            Database.Log.File.Level = LogLevel.Info; (5)
        Database.Log.File.Config = new LogFileConfiguration("path/to/log/directory")
        {
            MaxRotateCount = 2, // Save 3 log files (i.e. 2 rotated and 1 current)
            MaxSize = 1024 * 512, // 512KB per file, then rotated
        };

        Database.Log.File.Level = LogLevel.Verbose;

New API

csharp
ViewCopy
LogSinks.File = new FileLogSink(LogLevel.Verbose, "path/to/log/directory")
{
    MaxKeptFiles = 3, // Save 3 log files (i.e. 2 rotated and 1 current)
    MaxSize = 1024 * 512, // 512KB per file, then rotated
};

Using a Custom Logger

Installing a custom log sink with the new API is also streamlined: create an instance of your custom sink, and to install it use LogSinks.get().setCustom in Java, or the appropriate static method in Swift, Objective-C, .NET, and C.

As with the other log sinks, you will have to specify the level and domain at which Couchbase logs are forwarded to your custom sink at its creation.

Your custom log sink code will have to change as well. For .NET, the most significant change is that instead of implementing the Logger interface, a custom log sink must extend the BaseLogSink class.

The BaseLogSink class does not have a no-args constructor: you must specify at least the level at which Couchbase logs will be forwarded to the logger.

A second important change is that your logger will receive only logs at the level and domain for which it is initialized. There is no need to record or filter the logs forwarded to the protected writeLog method which replaces the public log method from the old API.

Related to this last point, the Couchbase Loggers, now LogSinks are meant to support logging by the Couchbase Lite platform. They were never meant as a general framework for logging.

With the new API, customer code can no longer log, directly, to any of the Couchbase log sinks. The Console and File log sinks cannot be subclassed and do not publish methods that allow writing logs. If you need to log to the console for example, you’ll have to create your own way of doing so.

Old API Implementing The Custom Logger Interface

csharp
ViewCopy
    class LogTestLogger : ILogger
    {
        public LogLevel Level { get; set; }

        public void Reset()
        {
        }

        public void Log(LogLevel level, LogDomain domain, string message)
        {
            // handle the message, for example piping it to
            // a third party framework
        }
    }

Old API Enable Custom Logger

csharp
ViewCopy
 Database.Log.Custom = new LogTestLogger(); (1)

 // You can also specify the level of logging the logger receives
 Database.Log.Custom = new LogTestLogger { Level = LogLevel.Warning };

New API

csharp
ViewCopy
LogSinks.Custom = new MyCoolLogSink(LogLevel.Verbose);