[#BloombergLP-ball-LogFileCleanerUtil]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::LogFileCleanerUtil
:relfileprefix: ../../
:mrdocs:

This utility class provides functions for converting log file patterns and for cleaning up log files based on a configuration.

== Synopsis

Declared in `<ball_logfilecleanerutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct LogFileCleanerUtil;
----

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/LogFileCleanerUtil/enableLogFileCleanup.adoc[`enableLogFileCleanup`] 
| Immediately call `balb::FileCleanerUtil::removeFiles` with the specified `config` and then install an `t_OBSERVER::OnFileRotationCallback` function into the specified `observer` that invokes `removeFiles` synchronously on every log file rotation. The (template parameter) `t_OBSERVER` type must provide concrete implementation of the `ball::Observer` protocol, have a `setOnFileRotationCallback` method (see `ball_fileobserver`, `ball_fileobserver2`, and `ball_asyncfileobserver`), and define an `OnFileRotationCallback` type alias. This method overrides the file rotation callback currently installed in the observer (if any).
| xref:BloombergLP/ball/LogFileCleanerUtil/logPatternToFilePattern.adoc[`logPatternToFilePattern`] 
| Substitute all occurrences of valid `%`‐escape sequences in the specified `logPattern` with `*` and load the specified `filePattern` with the resulting string. This utility function converts the log patterns used by various file observers and supplied to their `enableFileLogging` method (see `ball_fileobserver`, `ball_fileobserver2`, and `ball_asyncfileobserver`) to the file pattern used by various utility functions to find the related file(s) on the filesystem (see `balb_filecleanerutil` and `balb_filecleanerconfiguration`).
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#