CBLLogFileConfiguration Struct Reference

The properties for configuring logging to files. More...

#include <cbl/CBLLog.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	maxRotateCount
	Max number of older log files to keep (in addition to current one.) The default is kCBLDefaultLogFileMaxRotateCount. 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.) Plaintext logging is slower and bigger. More...

Detailed Description

The properties for configuring logging to files.

Warning

usePlaintext results in significantly larger log files and higher CPU usage that may slow down your app; we recommend turning it off in production.

Field Documentation

directory

FLString CBLLogFileConfiguration::directory

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

level

CBLLogLevel CBLLogFileConfiguration::level

The minimum level of message to write (Required).

maxRotateCount

uint32_t CBLLogFileConfiguration::maxRotateCount

Max number of older log files to keep (in addition to current one.) The default is kCBLDefaultLogFileMaxRotateCount.

maxSize

size_t CBLLogFileConfiguration::maxSize

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

The default is kCBLDefaultLogFileMaxSize.

usePlaintext

bool CBLLogFileConfiguration::usePlaintext

Whether or not to log in plaintext (as opposed to binary.) Plaintext logging is slower and bigger.

The default is kCBLDefaultLogFileUsePlainText.

---

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

• include/cbl/CBLLog.h