CleanroomLogger

CleanroomLogger provides an extensible Swift-based logging API that is simple, lightweight and performant.

The API provided by CleanroomLogger is designed to be readily understood by anyone familiar with packages such as CocoaLumberjack and log4j.

CleanroomLogger is part of the Cleanroom Project from Gilt Tech.

This is the master branch. It uses Swift 4.0 and requires Xcode 9.0 to compile.

Branch	Build status
master

• Key Benefits of CleanroomLogger
• Adding CleanroomLogger to your project
• Using CleanroomLogger
  • Enabling logging
  • Logging Examples
• CleanroomLogger In Depth
  • Configuring CleanroomLogger
  • Customized Log Formatting
  • API Documentation
• Design Philosophy
• Architectural Overview

You don’t have to choose between smooth scrolling and collecting meaningful log information. CleanroomLogger does very little work on the calling thread, so it can get back to business ASAP.

CleanroomLogger takes advantage of Apple’s new Unified Logging System (aka “OSLog” or “os_log”) when running on iOS 10.0, macOS 10.12, tvOS 10.0, watchOS 3.0 or higher.

On systems where OSLog isn’t available, CleanroomLogger gracefully falls back to other standard output mechanisms, automatically.

Good documentation is critical to the usefulness of any open-source framework. In addition to the extensive high-level documentation you’ll find below, the CleanroomLogger API itself is 100% documented.

Messages are assigned one of five severity levels: the most severe is error, followed by warning, info, debug and verbose, the least severe. Knowing a message’s severity lets you perform additional filtering; for example, to minimize the overhead of logging in App Store binaries, you could choose to log only warnings and errors in release builds.

Quickly spot problems at runtime in the Xcode console, where log messages are color coded by severity:

◽️ Verbose messages are tagged with a small gray square — easy to ignore
◾️ Debug messages have a black square; easier to spot, but still de-emphasized
🔷 Info messages add a splash of color in the form of a blue diamond
🔶 Warnings are highlighted with a fire-orange diamond
❌ Error messages stand out with a big red X — hard to miss!

Support for standard UNIX output streams is built-in. Use StandardOutputLogRecorder and StandardErrorLogRecorder to direct output to stdout and stderr, respectively.

Or, use the StandardStreamsLogRecorder to send verbose, debug and info messages to stdout while warnings and errors go to stderr.

When Xcode 8 was introduced, the console pane got a lot more chatty. This was due to the replacement of the ASL facility with OSLog. To silence the extra chatter, developers discovered that setting the OS_ACTIVITY_MODE environment variable to “disable” would revert to the old logging behavior. It turns out that this silences OSLog altogether, so no output is sent to the console pane. CleanroomLogger notices when the setting is present, and echoes messages to stdout or stderr in addition to logging them through the os_log() function.

If you’re just using print() or NSLog() everywhere, it can sometimes be difficult to figure out what code is responsible for which log messages. By default, CleanroomLogger outputs the source file and line responsible for issuing each log message, so you can go straight to the source:

🔶 AppleTart.framework didn’t load due to running on iOS 8 (AppleTartShim.swift:19)
◾️ Uploaded tapstream batch (TapstreamTracker.swift:166)
◽️ Presenting AccountNavigationController from SaleListingController (BackstopDeepLinkNavigator.swift:174)
🔷 Successfully navigated to .account for URL: gilt://account (DeepLinkConsoleOutput.swift:104)
❌ Unrecognized URL: CountrySelector (GiltOnTheGoDeepLinkRouter.swift:100)

CleanroomLogger provides simple file-based logging support as well as a self-pruning rotating log directory implementation.

Developers often use logging to perform tracing. Rather than writing lots of different log messages to figure out what your program is doing at runtime, just sprinkle your source with Log.debug?.trace() and Log.verbose?.trace() calls, and you’ll see exactly what lines your code hits, when, and on what thread, as well as the signature of the executing function:

2017-01-05 13:46:16.681 -05:00 | 0001AEC4 ◾️ —> StoreDataTransaction.swift:42 - executeTransaction()
2017-01-05 13:46:16.683 -05:00 | 00071095 ◾️ —> LegacyStoresDeepLinking.swift:210 - viewControllerForRouter(_:destination:)
2017-01-05 13:46:16.683 -05:00 | 0001AEC4 ◽️ —> StoreDataTransaction.swift:97 - executeTransaction(completion:)
2017-01-05 13:46:16.684 -05:00 | 00071095 ◾️ —> ContainerViewController.swift:132 - setContentViewController(_:animated:completion:)
2017-01-05 13:46:16.684 -05:00 | 00071095 ◾️ —> DefaultBackstopDeepLinkNavigator.swift:53 - navigate(to:via:using:viewController:displayOptions:completion:)
2017-01-05 13:46:16.687 -05:00 | 00071095 ◽️ —> ViewControllerBase.swift:79 - viewWillAppear

CleanroomLogger ships with two general-purpose log formatters: the ReadableLogFormatter is handy for human consumption, while the ParsableLogFormatter is useful for machine processing. Both can be customized via the initializer.

A formatter constructed using ReadableLogFormatter() yields log output that looks like:

2017-01-06 02:06:53.679 -05:00 | Debug   | 001BEF88 | DeepLinkRouterImpl.swift:132 - displayOptions(for:via:displaying:)
2017-01-06 02:06:53.682 -05:00 | Verbose | 001BEF88 | UIWindowViewControllerExtension.swift:133 - rootTabBarController: nil
2017-01-06 02:06:53.683 -05:00 | Info    | 001BEF88 | DeepLinkConsoleOutput.swift:104 - Successfully navigated to storeSale for URL: gilt://sale/women/winter-skin-rescue
2017-01-06 02:07:01.761 -05:00 | Error   | 001BEF88 | Checkout.swift:302 - The user transaction failed
2017-01-06 02:07:02.397 -05:00 | Warning | 001BEF88 | MemoryCache.swift:233 - Caching is temporarily disabled due to a recent memory warning

When the same log messages are handled by a formatter constructed using ParsableLogFormatter(), the timestamp is output in UNIX format, tab is used as the field delimiter, and the severity is indicated numerically:

1483686413.67946	2	001BEF88	DeepLinkRouterImpl.swift:132 - displayOptions(for:via:displaying:)
1483686413.68170	1	001BEF88	UIWindowViewControllerExtension.swift:133 - rootTabBarController: nil
1483686413.68342	3	001BEF88	DeepLinkConsoleOutput.swift:104 - Successfully navigated to storeSale for URL: gilt://sale/women/winter-skin-rescue
1483686421.76101	5	001BEF88	Checkout.swift:302 - The user transaction failed
1483686422.39651	4	001BEF88	MemoryCache.swift:233 - Caching is temporarily disabled due to a recent memory warning

If the built-in formatters don’t fit the bill, you can use the FieldBasedLogFormatter to assemble just about any kind of log format possible.

Let’s say you wanted a log formatter with the timestamp in ISO 8601 date format, a tab character, the source file and line number of the call site, followed by the severity as an uppercase string right-justified in a 8-character field, then a colon and a space, and finally the log entry’s payload. You could do this by constructing a FieldBasedLogFormatter as follows:

FieldBasedLogFormatter(fields: [
	.timestamp(.custom("yyyy-MM-dd'T'HH:mm:ss.SSSZ")),
	.delimiter(.tab),
	.callSite,
	.severity(.custom(textRepresentation: .uppercase, truncateAtWidth: nil, padToWidth: 8, rightAlign: true)),
	.literal(": "),
	.payload])

The resulting output would look like:

2017-01-08T12:55:17.905-0500	DeepLinkRouterImpl.swift:207        DEBUG: destinationForURL
2017-01-08T12:55:20.716-0500	DefaultDeepLinkRouter.swift:95       INFO: Attempting navigation to storeSale
2017-01-08T12:55:21.995-0500	LegacyUserEnvironment.swift:109		ERROR: Can’t fetch user profile without user guid
2017-01-08T12:55:25.960-0500	DeepLinkConsoleOutput.swift:104	  WARNING: Can’t find storeProduct for URL
2017-01-08T12:55:33.457-0500	ProductViewController.swift:92    VERBOSE: deinit

CleanroomLogger exposes three primary extension points for implementing your own custom logic:

• LogRecorders are used to record formatted log messages. Typically, this involves writing the message to a stream or data store of some kind. You can provide your own LogRecorder implementations to utilize facilities not natively supported by CleanroomLogger: to store messages in a database table or send them to a remote HTTP endpoint, for example.
• LogFormatters are used to generate text representations of each LogEntry to be recorded.
• LogFilters get a chance to inspect—and potentially reject—a LogEntry before it is passed to a LogRecorder.

CleanroomLogger is distributed under the MIT license.

CleanroomLogger is provided for your use—free-of-charge—on an as-is basis. We make no guarantees, promises or apologies. Caveat developer.

The simplest way to integrate CleanroomLogger is with the Carthage dependency manager.

First, add this line to your Cartfile:

github "emaloney/CleanroomLogger" ~> 6.0.0

Then, use the carthage command to update your dependencies.

Finally, you’ll need to integrate CleanroomLogger into your project in order to use the API it provides.

Once successfully integrated, just add the following statement to any Swift file where you want to use CleanroomLogger:

import CleanroomLogger

See the Integration document for additional details on integrating CleanroomLogger into your project.

The main public API for CleanroomLogger is provided by Log.

Log maintains five static read-only LogChannel properties that correspond to one of five severity levels indicating the importance of messages sent through that channel. When sending a message, you would select a severity appropriate for that message, and use the corresponding channel:

• Log.error — The highest severity; something has gone wrong and a fatal error may be imminent
• Log.warning — Something appears amiss and might bear looking into before a larger problem arises
• Log.info — Something notable happened, but it isn’t anything to worry about
• Log.debug — Used for debugging and diagnostic information (not intended for use in production code)
• Log.verbose - The lowest severity; used for detailed or frequently occurring debugging and diagnostic information (not intended for use in production code)

Each of these LogChannels provide three functions to record log messages:

• trace() — This function records a log message with program execution trace information including the source code filename, line number and name of the calling function.
• message(String) — This function records the log message passed to it.
• value(Any?) — This function attempts to record a log message containing a string representation of the optional Any value passed to it.

By default, logging is disabled, meaning that none of the Log’s channels have been populated. As a result, they have nil values and any attempts to perform logging will silently fail.

In order to use CleanroomLogger, you must explicitly enable logging, which is done by calling one of the Log.enable() functions.

Ideally, logging is enabled at the first possible point in the application’s launch cycle. Otherwise, critical log messages may be missed during launch because the logger wasn’t yet initialized.

The best place to put the call to Log.enable() is at the first line of your app delegate’s init().

If you’d rather not do that for some reason, the next best place to put it is in the application(_:willFinishLaunchingWithOptions:) function of your app delegate. You’ll notice that we’re specifically recommending the will function, not the typical did, because the former is called earlier in the application’s launch cycle.

Note: During the running lifetime of an application process, only the first call to Log.enable() function will have any effect. All subsequent calls are ignored silently. You can also prevent CleanroomLogger from being enabled altogether by calling Log.neverEnable().

To record items in the log, simply select the appropriate channel and call the appropriate function.

Here are a few examples:

Let’s say your application just finished launching. This is a significant event, but it isn’t an error. You also might want to see this information in production app logs. Therefore, you decide the appropriate LogSeverity is .info and you select the corresponding LogChannel, which is Log.info. Then, to log a message, just call the channel’s message() function:

Log.info?.message("The application has finished launching.")

If you’re working on some code and you’re curious about the order of execution, you can sprinkle some trace() calls around.

This function outputs the filename, line number and name of the calling function.

For example, if you put the following code on line 364 of a file called ModularTable.swift in a function with the signature tableView(_:cellForRowAt:):

Log.debug?.trace()

Assuming logging is enabled for the .debug severity, the following message would be logged when that line gets executed:

ModularTable.swift:364 — tableView(_:cellForRowAt:)

The value() function can be used for outputting information about a specific value. The function takes an argument of type Any? and is intended to accept any valid runtime value.

For example, you might want to output the IndexPath value passed to your UITableViewDataSource’s tableView(_:cellForRowAt:) function:

Log.verbose?.value(indexPath)

This would result in output looking like:

= IndexPath: [0, 2]

The function also handles optionals:

var str: String?
Log.verbose?.value(str)

The output for this would be:

= nil

This section delves into the particulars of configuring and customizing CleanroomLogger to suit your needs.

CleanroomLogger is configured when one of the Log.enable() function variants is called. Configuration can occur at most once within the lifetime of the running process. And once set, the configuration can’t be changed; it’s immutable.

The LogConfiguration protocol represents the mechanism by which CleanroomLogger can be configured. LogConfigurations allow encapsulating related settings and behavior within a single entity, and CleanroomLogger can be configured with multiple LogConfiguration instances to allow combining behaviors.

Each LogConfiguration specifies:

• The minimumSeverity, a LogSeverity value that determines which log entries get recorded. Any LogEntry with a severity less than the configuration’s mimimumSeverity will not be passed along to any LogRecorders specified by that configuration.
• An array of LogFilters. Each LogFilter is given a chance to cause a given log entry to be ignored.
• A synchronousMode property, which determines whether synchronous logging should be used when processing log entries for the given configuration. This feature is intended to be used during debugging and is not recommended for production code.
• Zero or more contained LogConfigurations. For organizational purposes, each LogConfiguration can in turn contain additional LogConfigurations. The hierarchy is not meaningful, however, and is flattened at configuration time.
• An array of LogRecorders that will be used to write log entries to the underlying logging facility. If a configuration has no LogRecorders, it is assumed to be a container of other LogConfigurations only, and is ignored when the configuration hierarchy is flattened.

When CleanroomLogger receives a request to log something, zero or more LogConfigurations are selected to handle the request:

1. The severity of the incoming LogEntry is compared against the minimumSeverity of each LogConfiguration. Any LogConfiguration whose minimumSeverity is equal to or less than the severity of the LogEntry is selected for further consideration.
2. The LogEntry is then passed sequentially to the shouldRecord(entry:) function of each of the LogConfiguration’s filters. If any LogFilter returns false, the associated configuration will not be selected to record that log entry.

Ideally suited for live viewing during development, the XcodeLogConfiguration examines the runtime environment to optimize CleanroomLogger for use within Xcode.

XcodeLogConfiguration takes into account:

• Whether the new Unified Logging System (also known as “OSLog”) is available; it is only present as of iOS 10.0, macOS 10.12, tvOS 10.0, and watchOS 3.0. By default, logging falls back to stdout and stderr if Unified Logging is unavailable.

• The value of the OS_ACTIVITY_MODE environment variable; when it is set to “disable”, attempts to log via OSLog are silently ignored. In such cases, log output is echoed to stdout and stderr to ensure that messages are visible in Xcode.

• The severity of the message. For UNIX-friendly behavior, .verbose, .debug and .info messages are directed to the stdout stream of the running process, while .warning and .error messages are sent to stderr.

When using the Unified Logging System, messages in the Xcode console appear prefixed with an informational header that looks like:

2017-01-04 22:56:47.448224 Gilt[5031:89847] [CleanroomLogger]	
2017-01-04 22:56:47.448718 Gilt[5031:89847] [CleanroomLogger]	
2017-01-04 22:56:47.449487 Gilt[5031:89847] [CleanroomLogger]	
2017-01-04 22:56:47.450127 Gilt[5031:89847] [CleanroomLogger]	
2017-01-04 22:56:47.450722 Gilt[5031:89847] [CleanroomLogger]	

This header is not added by CleanroomLogger; it is added as a result of using OSLog within Xcode. It shows the timestamp of the log entry, followed by the process name, the process ID, the calling thread ID, and the logging system name.

To ensure consistent output across platforms, the XcodeLogConfiguration will mimic this header even when logging to stdout and stderr. You can disable this behavior by passing false as the mimicOSLogOutput argument. When disabled, a more concise header is used, showing just the timestamp and the calling thread ID:

2017-01-04 23:46:17.225 -05:00 | 00071095
2017-01-04 23:46:17.227 -05:00 | 00071095
2017-01-04 23:46:17.227 -05:00 | 000716CA
2017-01-04 23:46:17.228 -05:00 | 000716CA
2017-01-04 23:46:17.258 -05:00 | 00071095

To make it easier to quickly identify important log messages at runtime, the XcodeLogConfiguration makes use of the XcodeLogFormatter, which embeds a color-coded representation of each message’s severity:

◽️ Verbose messages are tagged with a small gray square — easy to ignore
◾️ Debug messages have a black square; easier to spot, but still de-emphasized
🔷 Info messages add a splash of color in the form of a blue diamond
🔶 Warnings are highlighted with a fire-orange diamond
❌ Error messages stand out with a big red X — hard to miss!

The simplest way to enable CleanroomLogger using the XcodeLogConfiguration is by calling:

Log.enable()

Thanks to the magic of default parameter values, this is equivalent to the following Log.enable() call:

Log.enable(minimumSeverity: .info,
                 debugMode: false,
          verboseDebugMode: false,
            stdStreamsMode: .useAsFallback,
          mimicOSLogOutput: true,
              showCallSite: true,
                   filters: [])

This configures CleanroomLogger using an XcodeLogConfiguration with default settings.

Note: If either debugMode or verboseDebugMode is true, the XcodeLogConfiguration will be used in synchronousMode, which is not recommended for production code.

The call above is also equivalent to:

Log.enable(configuration: XcodeLogConfiguration())

The RotatingLogFileConfiguration can be used to maintain a directory of log files that are rotated daily.

Warning: The RotatingLogFileRecorder created by the RotatingLogFileConfiguration assumes full control over the log directory. Any file not recognized as an active log file will be deleted during the automatic pruning process, which may occur at any time. This means if you’re not careful about the directoryPath you pass, you may lose valuable data!

At a minimum, the RotatingLogFileConfiguration requires you to specify the minimumSeverity for logging, the number of days to keep log files, and a directory in which to store those files:

// logDir is a String holding the filesystem path to the log directory
let rotatingConf = RotatingLogFileConfiguration(minimumSeverity: .info,
                                                     daysToKeep: 7,
                                                  directoryPath: logDir)

Log.enable(configuration: rotatingConf)

The code above would record any log entry with a severity of .info or higher in a file that would be kept for at least 7 days before being pruned. This particular configuration uses the ReadableLogFormatter to format log entries.

The RotatingLogFileConfiguration can also be used to specify synchronousMode, a set of LogFilters to apply, and one or more custom LogFormatters.

CleanroomLogger also supports multiple configurations, allowing different logging behaviors to be in use simultaneously.

Whenever a message is logged, every LogConfiguration is consulted separately and given a chance to process the message. By supplying a minimumSeverity and unique set of LogFilters, each configuration can specify its own logic for screening out unwanted messages. Surviving messages are then passed to the configuration’s LogFormatters, each in turn, until one returns a non-nil string. That string—the formatted log message—is ultimately passed to one or more LogRecorders for writing to some underlying logging facility.

Note that each configuration is a self-contained, stand-alone entity. None of the settings, behaviors or actions of a given LogConfiguration will affect any other.

For an example of how this works, imagine adding a debug mode XcodeLogConfiguration to the rotatingConf declared above. You could do this by writing:

Log.enable(configuration: [XcodeLogConfiguration(debugMode: true), rotatingConf])

In this example, both the XcodeLogConfiguration and the RotatingLogFileConfiguration will be consulted as each logging call occurs. Because the XcodeLogConfiguration is declared with debugMode: true, it will operate in synchronousMode while rotatingConf will operate asynchronously.

Further, the XcodeLogConfiguration will result in messages being logged via the Unified Logging System (if available) and/or the running process’s stdout and stderr streams. The RotatingLogFileConfiguration, on the other hand, results in messages being written to a file.

Finally, each configuration results in a different message format being used.

Although you can provide your own implementation of the LogConfiguration protocol, it may be simpler to create a BasicLogConfiguration instance and pass the relevant parameters to the initializer.

You can also subclass BasicLogConfiguration if you’d like to encapsulate your configuration further.

Let’s say you want configure CleanroomLogger to:

1. Print .verbose, .debug and .info messages to stdout while directing .warning and .error messages to stderr
2. Mirror all messages to OSLog, if it is available on the runtime platform
3. Create a rotating log file directory at the path /tmp/CleanroomLogger to store .info, .warning and .error messages for up to 15 days

Further, you want the log entries for each to be formatted differently:

1. An XcodeLogFormatter for stdout and stderr
2. A ReadableLogFormatter for OSLog
3. A ParsableLogFormatter for the log files

To configure CleanroomLogger to do all this, you could write:

var configs = [LogConfiguration]()

// create a recorder for logging to stdout & stderr
// and add a configuration that references it
let stderr = StandardStreamsLogRecorder(formatters: [XcodeLogFormatter()])
configs.append(BasicLogConfiguration(recorders: [stderr]))

// create a recorder for logging via OSLog (if possible)
// and add a configuration that references it
if let osLog = OSLogRecorder(formatters: [ReadableLogFormatter()]) {
	// the OSLogRecorder initializer will fail if running on 
	// a platform that doesn’t support the os_log() function
	configs.append(BasicLogConfiguration(recorders: [osLog]))
}

// create a configuration for a 15-day rotating log directory
let fileCfg = RotatingLogFileConfiguration(minimumSeverity: .info,
												daysToKeep: 15,
											 directoryPath: "/tmp/CleanroomLogger",
												formatters: [ParsableLogFormatter()])

// crash if the log directory doesn’t exist yet & can’t be created
try! fileCfg.createLogDirectory()

configs.append(fileCfg)

// enable logging using the LogRecorders created above
Log.enable(configuration: configs)

The LogFormatter protocol is consulted when attempting to convert a LogEntry into a string.

CleanroomLogger ships with several high-level LogFormatter implementations for specific purposes:

• XcodeLogFormatter — Optimized for live viewing of a log stream in Xcode. Used by the XcodeLogConfiguration by default.
• ParsableLogFormatter — Ideal for logs intended to be ingested for parsing by other processes.
• ReadableLogFormatter — Ideal for logs intended to be read by humans.

The latter two LogFormatters are both subclasses of StandardLogFormatter, which provides a basic mechanism for customizing the behavior of formatting.

You can also assemble an entirely custom formatter quite easily using the FieldBasedLogFormatter, which lets you mix and match Fields to roll your own formatter.

For detailed information on using CleanroomLogger, API documentation is available.

The application developer should be in full control of logging process-wide. As with any code that executes, there’s an expense to logging, and the application developer should get to decide how to handle the tradeoff between the utility of collecting logs and the expense of collecting them at a given level of detail.

CleanroomLogger’s configuration can only be set once during an application’s lifecycle; after that, the configuration becomes immutable. Any third-party frameworks using CleanroomLogger will be limited to what is explicitly allowed by the application developer. Therefore, embedded code using CleanroomLogger is inherently well behaved.

We believe so strongly in this philosophy that we even built a feature for developers that never want CleanroomLogger used within their applications. That’s right, we created a way for developers to avoid using our project altogether. So if you need to include a third-party library that uses CleanroomLogger but you don’t want to incur any logging overhead, just call Log.neverEnable() instead of Log.enable(). CleanroomLogger will be disabled entirely.

Respect for the calling thread. Functions like print() and NSLog() can do a lot of work on the calling thread, and when used from the main thread, that can lead to lower frame rates and choppy scrolling.

When CleanroomLogger is asked to log something, it is immediately handed off to an asynchronous background queue for further dispatching, letting the calling thread get back to work as quickly as possible. Each LogRecorder also maintains its own asynchronous background queue used to format log messages and write them to the underlying storage facility. This design ensures that if one recorder gets bogged down, it won’t block the processing of log messages by any other recorder.

Avoid needless code execution. The logging API provided by CleanroomLogger takes advantage of Swift short-circuiting to avoid executing code when it is known that no messages of a given severity will ever be logged.

For example, in production code with .info as the minimum LogSeverity, messages with a severity of .verbose or .debug will always be ignored. In such a case, Log.debug and Log.verbose would be nil, allowing efficient short-circuiting of any code attempting to use these inactive log channels. Code like Log.verbose?.trace() and Log.debug?.message("Loading URL: \(url)") would effectively become no-ops at runtime. Debug logging adds zero overhead to your production builds, so don’t be shy about taking advantage of it.

CleanroomLogger is designed to avoid performing formatting or logging work on the calling thread, making use of Grand Central Dispatch (GCD) queues for efficient processing.

In terms of threads of execution, each request to log anything can go through three main phases of processing:

1. On the calling thread:

2. Caller attempts to issue a log request by calling a logging function (eg., message(), trace() or value()) of the appropriate LogChannel maintained by Log. - If there is no LogChannel for the given severity of the log message (because CleanroomLogger hasn’t yet been enabled() or it is not configured to log at that severity), Swift short-circuiting prevents further execution. This makes it possible to leave debug logging calls in place when shipping production code without affecting performance.

3. If a LogChannel does exist, it creates an immutable LogEntry struct to represent the thing being logged.

4. The LogEntry is then passed to the LogReceptacle associated with the LogChannel.

5. Based on the severity of the LogEntry, the LogReceptacle selects one or more LogConfigurations to use for recording the message. Among other things, these configurations determine whether further processing proceeds synchronously or asynchronously when passed to the underlying LogReceptacle’s GCD queue. (Synchronous processing is useful during debugging, but is not recommended for general production code.)

6. On the LogReceptacle queue:

7. The LogEntry is passed through zero or more LogFilters that are given a chance to prevent further processing of the LogEntry. If any filter indicates that LogEntry should not be recorded, processing stops.

8. The LogConfiguration is used to determine which LogRecorders (if any) will be used to record the LogEntry.

9. For each LogRecorder instance specified by the configuration, the LogEntry is then dispatched to the GCD queue provided by the LogRecorder.

10. On each LogRecorder queue:

11. The LogEntry is passed sequentially to each LogFormatter provided by the LogRecorder, giving the formatters a chance to create the formatted message for the LogEntry. - If no LogFormatter returns a string representation of LogEntry, further processing stops and nothing is recorded. - If any LogFormatter returns a non-nil value to represent the formatted message of the LogEntry, that string is then passed to the LogRecorder for final logging.

The Cleanroom Project began as an experiment to re-imagine Gilt’s iOS codebase in a legacy-free, Swift-based incarnation.

Since then, we’ve expanded the Cleanroom Project to include multi-platform support. Much of our codebase now supports tvOS in addition to iOS, and our lower-level code is usable on macOS and watchOS as well.

Cleanroom Project code serves as the foundation of Gilt on TV, our tvOS app featured by Apple during the launch of the new Apple TV. And as time goes on, we'll be replacing more and more of our existing Objective-C codebase with Cleanroom implementations.

In the meantime, we’ll be tracking the latest releases of Swift & Xcode, and open-sourcing major portions of our codebase along the way.

CleanroomLogger is in active development, and we welcome your contributions.

If you’d like to contribute to this or any other Cleanroom Project repo, please read the contribution guidelines.

API documentation is generated using Realm’s jazzy project, maintained by JP Simard and Samuel E. Giddins.