Couchbase Lite C
Couchbase Lite C API
Data Fields
CBLFileLogSink Struct Reference

File log sink configuration for logging to files. More...

#include <cbl/CBLLogSinks.h>

Data Fields

CBLLogLevel level
 The minimum level of message to write (Required). More...
 
FLString directory
 The directory where log files will be created (Required). More...
 
uint32_t maxKeptFiles
 The maximum number of files to save per log level. More...
 
size_t maxSize
 The size in bytes at which a file will be rotated out (best effort). More...
 
bool usePlaintext
 Whether or not to log in plaintext as opposed to binary. More...
 

Detailed Description

File log sink configuration for logging to files.

Field Documentation

◆ directory

FLString CBLFileLogSink::directory

The directory where log files will be created (Required).

◆ level

CBLLogLevel CBLFileLogSink::level

The minimum level of message to write (Required).

◆ maxKeptFiles

uint32_t CBLFileLogSink::maxKeptFiles

The maximum number of files to save per log level.

The default is kCBLDefaultFileLogSinkMaxKeptFiles.

◆ maxSize

size_t CBLFileLogSink::maxSize

The size in bytes at which a file will be rotated out (best effort).

The default is kCBLDefaultFileLogSinkMaxSize.

◆ usePlaintext

bool CBLFileLogSink::usePlaintext

Whether or not to log in plaintext as opposed to binary.

Plaintext logging is slower and bigger. The default is kCBLDefaultFileLogSinkUsePlaintext.


The documentation for this struct was generated from the following file: