BloombergLP::ball::FileObserver2

Name

Description

Observer

This class provides a protocol for receiving and processing log record output.

Name

Description

LogRecordFunctor

LogRecordFunctor is an alias for the type of the functor used for formatting log records to a stream.

OnFileRotationCallback

OnFileRotationCallback is an alias for a user‐supplied callback function that is invoked after the file observer attempts to rotate its log file. The callback takes two arguments: (1) an integer status value where 0 indicates a new log file was successfully created and a non‐zero value indicates an error occurred during rotation, and (2) a string that provides the name of the rotated log file if the rotation was successful. E.g.: ` void onLogFileRotation(int rotationStatus, const bsl::string& rotatedLogFileName); `

RecordFormatter

RecordFormatter is an alias for the type of the functor used for formatting log records to a stream.

Name

Description

FileObserver2 [constructor]

Create a file observer with file logging initially disabled. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used. Note that isPublishInLocalTimeEnabled returns false following construction indicating that the timestamp attribute of published records will be written in UTC time (see enablePublishInLocalTime). Also note that a default record format is in effect for file logging (see setLogFileFunctor).

~FileObserver2 [destructor] [virtual]

Close the log file of this file observer if file logging is enabled, and destroy this file observer.

disableFileLogging

Disable file logging for this file observer. This method has no effect if file logging is not enabled. Note that records subsequently received through the publish method will be dropped until file logging is re‐enabled.

disableLifetimeRotation

Disable log file rotation based on a periodic time interval for this file observer. This method has no effect if rotation‐on‐time‐interval is not enabled.

disablePublishInLocalTime

Disable publishing of the timestamp attribute of records in local time by this file observer; henceforth, timestamps will be in UTC time. This method has no effect if publishing in local time is not enabled. Note that this method also affects log filenames (see {Log Filename Patterns}).

disableSizeRotation

Disable log file rotation based on log file size for this file observer. This method has no effect if rotation‐on‐size is not enabled.

disableTimeIntervalRotation

Disable log file rotation based on a periodic time interval for this file observer. This method has no effect if rotation‐on‐time‐interval is not enabled.

enableFileLogging

enableFileLogging overloads

enablePublishInLocalTime

Enable publishing of the timestamp attribute of records in local time by this file observer. This method has no effect if publishing in local time is already enabled. Note that this method also affects log filenames (see {Log Filename Patterns}).

forceRotation

Forcefully perform a log file rotation by this file observer. Close the current log file, rename the log file if necessary, and open a new log file. This method has no effect if file logging is not enabled. See {Rotated File Naming} for details on filenames of rotated log files.

getFormat

Return the format config of the last successful setFormat call.

isFileLoggingEnabled

isFileLoggingEnabled overloads

isPublishInLocalTimeEnabled

Return true if this file observer writes the timestamp attribute of records that it publishes in local time, and false otherwise (in which case timestamps are written in UTC time). Note that the value returned by this method also affects log filenames (see {Log Filename Patterns}).

isSuppressUniqueFileNameOnRotation

Return true if the log filename uniqueness check on rotation is suppressed, and false otherwise.

localTimeOffset

Return the difference between the local time and UTC time in effect when this file observer was constructed. Note that this value remains unchanged during the lifetime of this object and therefore may become incorrect when the difference between the local time and UTC time changes (e.g., when transitioning into or out of daylight savings time).

publish

publish overloads

releaseRecords [virtual]

Discard any shared references to Record objects that were supplied to the publish method, and are held by this observer. Note that this operation should be called if resources underlying the previously provided shared pointers must be released.

rotateOnLifetime

Set this file observer to perform a periodic log file rotation at multiples of the specified timeInterval. This rule replaces any rotation‐on‐time‐interval rule currently in effect. The behavior is undefined unless 0 < timeInterval.totalMilliseconds().

rotateOnSize

Set this file observer to perform log file rotation when the size of the file exceeds the specified size (in kilobytes). This rule replaces any rotation‐on‐size rule currently in effect. The behavior is undefined unless size > 0.

rotateOnTimeInterval

rotateOnTimeInterval overloads

rotationLifetime

Return the lifetime of the log file that will trigger a file rotation by this file observer if rotation‐on‐lifetime is in effect, and a 0 time interval otherwise.

rotationSize

Return the size (in kilobytes) of the log file that will trigger a file rotation by this file observer if rotation‐on‐size is in effect, and 0 otherwise.

setFormat

Set the formatting functor used when writing records to the log file of this file observer to a log file functor created according to the specified, possibly URI‐like scheme tagged, format. Return zero if the setup with the specified arguments was successful and also save the format to be later retrievable using getFormat. Otherwise (if no matching scheme could be found or the configuration is invalid) return a non‐zero value and do not change the log record formatter used by this object. Note that a default format ("n%d %p:%t %s %f:%l %c %m %un") is in effect until this method or setLogFileFunctor is called. Also, notice that the observer emits newline characters at the beginning and at the end of a log record by default, so the user needs to add them explicitly to (text) format strings to preserve that behavior.

setLogFileFunctor

Set the formatting functor used when writing records to the log file of this file observer to the specified logFileFunctor. Note that a default format ("n%d %p:%t %s %f:%l %c %m %un") is in effect until this method or setFormat is called. Also, notice that the observer emits newline characters at the beginning and at the end of a log record by default, so the user needs to add them explicitly to (text) format strings to preserve that behavior. Note that this method exists for backwards compatibility and new code is highly encouraged to make use of setFormat with the URI‐scheme‐like tags to create different formatters. (Currently string and JSON output format is supported.)

setOnFileRotationCallback

Set the specified onRotationCallback to be invoked after each time this file observer attempts to perform a log file rotation. The behavior is undefined if the supplied function calls either setOnFileRotationCallback, forceRotation, or publish on this file observer (i.e., the supplied callback should not attempt to write to the ball log).

suppressUniqueFileNameOnRotation

Suppress generating a unique log file name upon rotation if the specified suppress is true, and generate a unique filename otherwise. See {Rotated File Naming} for details.

operator BloombergLP::bslmf::NestedTraitDeclaration<FileObserver2, UsesBslmaAllocator>

Declare that this type uses a bslma allocator.