Package
ConsoleLogger
A
SwiftLog LogHandler implementation for customizable logging to a console.Overview
ConsoleLogger is a flexible logging backend for console applications, allowing developers to customize log output with various fragments, including timestamps, log levels, and source locations.
Topics
Essentials
- Getting Started with ConsoleLoggerCustomize your logging output in Swift console applications using
ConsoleLogger, a flexibleSwiftLogbackend. ConsoleLoggerOutputs logs to console via aLoggerFragmentpipeline.
Logger Fragments
LoggerFragmentA fragment of a log message.LoggerFragmentBuilderA result builder for creating logger fragments in a declarative way.FragmentOutputThe output of aLoggerFragment, including some intermediary state used for things like deduplicating separators.IfMaxLevelFragmentMake the current fragment conditional, only calling itsoutputmethod if the record’sloggerLevelismaxLevelor lowerAndFragmentCombine the current fragment with another, which will be written after the current fragment finishes.OptionalFragmentA fragment that conditionally includes another fragment.ArrayFragmentA fragment that combines multiple fragments of the same type.LabelFragmentWrites the label of the logger, and requests a separator for the next fragment.LevelFragmentWrites the level of the logged message, and requests a separator for the next fragment.LiteralFragmentWrites the given text to the output.SeparatorFragmentSpacedFragmentA fragment that wraps another fragment, automatically separating its components with spaces.MessageFragmentWrites the logged message to the output, and requests a separator for the next fragment.MetadataFragmentWrites the combined metadata to the output, and requests a separator for the next fragment only if the metadata was not empty.SourceLocationFragmentWrites the file location of the logged message, including the line.LoggerSourceFragmentWrites the source of the logged message.TimestampSourceA protocol to allow mocking the timestamp for testsSystemTimestampSourceThe defaultTimestampSource, which gets the time from the system.TimestampFragmentWrites a formatted timestamp based on the time obtained from theTimestampSource.DefaultLoggerFragmentTypeThe type of the defaultLoggerFragment.TimestampDefaultLoggerFragmentTypeThe type of the defaultLoggerFragmentwith a timestamp.
Miscellaneous
LogRecordInformation about a specific log message, including information from the logger the message was logged to.ConsoleLoggerPrinterDefines a printer used by aConsoleLoggerto output log messages.DefaultConsoleLoggerPrinterThe defaultConsoleLoggerPrinterthat prints to standard output.