Logger module of the StormByte suite. More...
Classes | |
| class | Exception |
| Root exception for Logger. More... | |
| class | ThrottleError |
| Thrown when a throttle rule is invalid. More... | |
| class | Log |
| Public streaming facade for the StormByte logger. More... | |
| struct | ThrottleSpec |
| Immutable rule description used by Log::Throttle. More... | |
| struct | GroupManip |
| Labels the current logging line with a producer group. More... | |
| struct | ComponentManip |
| Selects the sticky component for the current thread. More... | |
| struct | ResetComponentManip |
| Clears the component associated with the current thread. More... | |
| struct | PopComponentManip |
| Pops one segment from the current thread's component stack. More... | |
| struct | FormatManip |
| Temporarily replaces the logger format and saves the previous one. More... | |
| struct | PopFormatManip |
| Restores the most recently saved logger format. More... | |
| struct | ColorManip |
| Temporarily selects a configured or explicit content color. More... | |
| struct | NoColorManip |
| Disables color for subsequent content until changed. More... | |
| struct | RedactManip |
| Stateful redaction manipulator. More... | |
| struct | HexManip |
| Dump subsequent payloads as hex bytes until nohex. More... | |
| struct | NoHexManip |
| Disable hex dumps and restore default payload formatting. More... | |
| class | ThreadedLog |
| Thread-safe logging facade. More... | |
Concepts | |
| concept | LogPointer |
| Pointer-like owner of Log or a derived logger. | |
Typedefs | |
| using | SinkWrite = void (*)(void* context, const char* data, std::size_t size) |
| Caller-side write of raw bytes into the sink. | |
| using | SinkManip = void (*)(void* context, std::ostream& (*manip)(std::ostream&)) |
| Caller-side application of an std::ostream manipulator. | |
| using | SinkFunction = StormByte::Safe::Function<void(const StormByte::Safe::String&)> |
| Typed text callback whose context is released in its creator module. | |
Enumerations | |
| enum class | ThrottlePolicy : unsigned char { Drop , Sample , Window } |
| Count policy applied before the optional rate bucket. More... | |
| enum class | Color : unsigned char { Default , Black , Red , Green , Yellow , Blue , Magenta , Cyan , Gray , White , BrightBlack , BrightRed , BrightGreen , BrightYellow , BrightBlue , BrightMagenta , BrightCyan , BrightWhite } |
| ANSI foreground colors supported by the logger. More... | |
| enum class | Level : unsigned short { LowLevel = 0 , Debug , Warning , Notice , Info , Error , Fatal } |
| Severity levels used by the logger. More... | |
Functions | |
| void | OStreamWrite (void *context, const char *data, std::size_t size) |
| Write raw bytes into an std::ostream owned by the caller. | |
| void | OStreamManip (void *context, std::ostream &(*manip)(std::ostream &)) |
| Apply an std::ostream manipulator in the caller's module. | |
| template<typename Ptr, typename T> requires LogPointer<Ptr> | |
| Ptr & | operator<< (Ptr &logger, const T &value) noexcept |
| Stream a value into a smart pointer to Log or a derived logger. | |
| template<typename Ptr> requires LogPointer<Ptr> | |
| Ptr & | operator<< (Ptr &logger, const Level &level) noexcept |
| Stream a Level into a smart pointer to Log or a derived logger. | |
| template<typename Ptr> requires LogPointer<Ptr> | |
| Ptr & | operator<< (Ptr &logger, std::ostream &(*manip)(std::ostream &)) noexcept |
| Stream a stream manipulator into a smart pointer to Log or a derived logger. | |
| GroupManip | group (const char *name) |
| Set the producer group for the current line. | |
| GroupManip | group (std::string_view name) |
| Set the producer group from a view. | |
| GroupManip | group (const StormByte::Safe::String &name) |
| Set the producer group from an owned string. | |
| ComponentManip | component (const char *name) |
| Select the component associated with subsequent log lines on this thread. | |
| ComponentManip | component (std::string_view name) |
| Select the component from a view. | |
| ComponentManip | component (const StormByte::Safe::String &name) |
| Select the component from an owned string. | |
| FormatManip | push_format (const char *format) |
| Save the current format and activate a temporary format. | |
| FormatManip | push_format (std::string_view format) |
| Save the current format and activate a temporary format from a view. | |
| FormatManip | push_format (const StormByte::Safe::String &format) |
| Save the current format and activate a temporary format from an owned string. | |
| constexpr RedactManip | redact_first (std::size_t n) noexcept |
Build a manipulator that keeps the first n characters visible. | |
| Log & | humanreadable_number (Log &log) |
| Enable human-readable formatting for numeric values. | |
| Log & | humanreadable_bytes (Log &log) |
| Enable human-readable formatting for byte counts. | |
| Log & | nohumanreadable (Log &log) |
| Disable human-readable formatting (raw numbers). | |
| Log & | noredact (Log &log) |
| Disable redaction until the next redact / redact(n) / redact_first(n). | |
| static constexpr const char * | LevelToString (const Level &l) noexcept |
| Convert a Level to a short name. | |
Variables | |
| constexpr ResetComponentManip | reset_component {} |
| Clear the current thread's component. | |
| constexpr PopComponentManip | pop_component {} |
| Pop one component segment from the current thread's stack. | |
| constexpr PopFormatManip | pop_format {} |
| Restore the most recently saved format, or do nothing if empty. | |
| const ColorManip | color {} |
| Restore the configured color for the current level. | |
| constexpr NoColorManip | nocolor {} |
| Disable color for subsequent content in the current line. | |
| constexpr RedactManip | redact {} |
| Full redaction manipulator (mask everything). | |
| constexpr HexManip | hex {} |
| Enable hex dumps with 16 bytes per row. | |
| constexpr NoHexManip | nohex {} |
| Disable hex dumps for subsequent payloads. | |
| using StormByte::Logger::SinkFunction = StormByte::Safe::Function<void(const StormByte::Safe::String&)> |
Typed text callback whose context is released in its creator module.
| using StormByte::Logger::SinkManip = void (*)(void* context, std::ostream& (*manip)(std::ostream&)) |
Caller-side application of an std::ostream manipulator.
Used for std::endl and any other stream manipulator. The call happens in the module that owns the stream.
| using StormByte::Logger::SinkWrite = void (*)(void* context, const char* data, std::size_t size) |
Caller-side write of raw bytes into the sink.
The function runs in the module that created the logger, not in this DLL.
|
strong |
ANSI foreground colors supported by the logger.
Default emits no ANSI sequence and leaves the terminal color unchanged.
|
strong |
Severity levels used by the logger.
Ordered from least to most severe. Used both as the print floor and as the level of the current message. Warning, Error and Fatal are always emitted regardless of the configured print floor.
| Enumerator | |
|---|---|
| LowLevel | Verbose diagnostics. |
| Debug | Debug information. |
| Warning | Recoverable problems. |
| Notice | Significant normal events. |
| Info | Informational messages. |
| Error | Error conditions. |
| Fatal | Unrecoverable errors. |
|
strong |
|
inline |
Select the component associated with subsequent log lines on this thread.
| name | Component name; empty selects the root component. |
|
inline |
Select the component from an owned string.
| name | Component name already owned by Base. |
|
inline |
Select the component from a view.
| name | Component name viewed in the caller; copied into an owned String. |
|
inline |
Set the producer group for the current line.
| name | Group name, or empty text to clear the group. |
|
inline |
Set the producer group from an owned string.
| name | Group name already owned by Base. |
|
inline |
Set the producer group from a view.
| name | Group name viewed in the caller; copied into an owned String. |
|
staticconstexprnoexcept |
|
noexcept |
Stream a Level into a smart pointer to Log or a derived logger.
| Ptr | std::shared_ptr, std::unique_ptr, StormByte::Safe::Shared or StormByte::Safe::Unique whose element type derives from Log. |
| logger | Smart pointer to the logger. An empty owner is a no-op. |
| level | Level to set. |
|
noexcept |
Stream a value into a smart pointer to Log or a derived logger.
| Ptr | std::shared_ptr, std::unique_ptr, StormByte::Safe::Shared or StormByte::Safe::Unique whose element type derives from Log. |
| T | Value type. |
| logger | Smart pointer to the logger. An empty owner is a no-op. |
| value | Value to stream. |
|
noexcept |
Stream a stream manipulator into a smart pointer to Log or a derived logger.
A dedicated overload so overloaded manipulators such as std::endl can be resolved.
| Ptr | std::shared_ptr, std::unique_ptr, StormByte::Safe::Shared or StormByte::Safe::Unique whose element type derives from Log. |
| logger | Smart pointer to the logger. An empty owner is a no-op. |
| manip | Stream manipulator. |
|
inline |
Apply an std::ostream manipulator in the caller's module.
| context | Address of the caller's std::ostream. |
| manip | Manipulator, for example std::endl. |
|
inline |
Write raw bytes into an std::ostream owned by the caller.
Instantiated in the caller's module. The DLL only stores the function pointer.
| context | Address of the caller's std::ostream. |
| data | Bytes to write. |
| size | Number of bytes. |
|
inline |
Save the current format and activate a temporary format.
| format | Format to activate until pop_format is streamed. |
|
inline |
Save the current format and activate a temporary format from an owned string.
| format | Format already owned by Base. |
|
inline |
Save the current format and activate a temporary format from a view.
| format | Format viewed in the caller; copied into an owned String. |
|
constexprnoexcept |
Build a manipulator that keeps the first n characters visible.
| n | Number of leading characters to keep unmasked. |
|
inline |
Restore the configured color for the current level.
|
inlineconstexpr |
Enable hex dumps with 16 bytes per row.
|
inlineconstexpr |
Disable color for subsequent content in the current line.
|
inlineconstexpr |
Disable hex dumps for subsequent payloads.
|
inlineconstexpr |
Pop one component segment from the current thread's stack.
|
inlineconstexpr |
Restore the most recently saved format, or do nothing if empty.
|
inlineconstexpr |
Full redaction manipulator (mask everything).
|
inlineconstexpr |
Clear the current thread's component.