seqeron 0.18.0
Loading...
Searching...
No Matches
Logger.hpp
Go to the documentation of this file.
1#pragma once
2
3// Structured logging: call sites report a fixed-size, allocation-free LoggerEvent to the installed
4// LoggerSink. The default sink writes it to stderr.
5
6#include <array>
7#include <cstdarg>
8#include <cstdint>
9#include <cstdio>
10
12
13// Components and anomaly classes are open: core declares its own below, and a consumer declares its own
14// alongside rather than growing core's. The Java twin is Logger.Component / Logger.EventCode.
16{
17 const char* name;
18
19 bool operator==(const Component&) const = default;
20};
21
23{
24 const char* name;
25
26 bool operator==(const EventCode&) const = default;
27};
28
29// Core's own components; a consumer opens this namespace again in its own header to add its own.
30namespace component {
31inline constexpr Component Cluster{ "Cluster" };
32inline constexpr Component ClusterStreamClient{ "ClusterStreamClient" };
33inline constexpr Component ReplayerStreamReceiver{ "ReplayerStreamReceiver" };
34} // namespace component
35
36// Core's own anomaly classes, on the same terms. Info is the generic one: a routine status line with
37// no anomaly of its own to identify.
38namespace eventCode {
39inline constexpr EventCode Info{ "Info" };
40inline constexpr EventCode QueueGap{ "QueueGap" };
41inline constexpr EventCode FirstFrameNotOne{ "FirstFrameNotOne" };
42inline constexpr EventCode SnapshotRestoreFailed{ "SnapshotRestoreFailed" };
43inline constexpr EventCode SnapshotStoreFailed{ "SnapshotStoreFailed" };
44inline constexpr EventCode ClusterSessionError{ "ClusterSessionError" };
45inline constexpr EventCode ClusterOfferFailed{ "ClusterOfferFailed" };
46inline constexpr EventCode ClusterIpcFallback{ "ClusterIpcFallback" };
47inline constexpr EventCode ClusterRedirectUnresolved{ "ClusterRedirectUnresolved" };
48inline constexpr EventCode FragmentTooShort{ "FragmentTooShort" };
49inline constexpr EventCode ArchiveConnectFailed{ "ArchiveConnectFailed" };
50inline constexpr EventCode RecoveryStalled{ "RecoveryStalled" };
51inline constexpr EventCode QueueStalled{ "QueueStalled" };
52} // namespace eventCode
53
54enum class Severity : std::uint8_t
55{
56 Info,
57 Warn,
58 Error,
59 Fault
60};
61
62// Fixed-size, no heap allocation.
64{
68 std::array<char, 256> text{};
69 std::uint8_t textLen = 0;
70};
71
73{
74 public:
75 virtual ~LoggerSink() = default;
76 virtual void record(const LoggerEvent& event) = 0;
77};
78
79// Default sink: the "[Component] message" stderr line.
80class StderrLoggerSink final : public LoggerSink
81{
82 public:
83 void record(const LoggerEvent& event) override
84 {
85 std::fprintf(stderr, "[%s] %.*s\n", event.component.name, static_cast<int>(event.textLen), event.text.data());
86 }
87};
88
89namespace Logger {
90
92{
93 static StderrLoggerSink sink;
94 return sink;
95}
96
98{
99 static LoggerSink* sink = &defaultSink();
100 return sink;
101}
102
109inline void install(LoggerSink& sink)
110{
111 installedSink() = &sink;
112}
113
114inline void reset()
115{
117}
118
119inline void vlog(const Component component, const Severity severity, const EventCode code, const char* format,
120 va_list args)
121{
122 LoggerEvent event{ .component = component, .severity = severity, .code = code };
123 const int written = std::vsnprintf(event.text.data(), event.text.size(), format, args);
124 int len = written > 0 ? written : 0;
125 if (len > static_cast<int>(event.text.size()) - 1)
126 {
127 len = static_cast<int>(event.text.size()) - 1;
128 }
129 event.textLen = static_cast<std::uint8_t>(len);
130 installedSink()->record(event);
131}
132
133inline void log(const Component component, const Severity severity, const EventCode code, const char* format, ...)
134{
135 va_list args;
136 va_start(args, format);
137 vlog(component, severity, code, format, args);
138 va_end(args);
139}
140
141inline void info(const Component component, const EventCode code, const char* format, ...)
142{
143 va_list args;
144 va_start(args, format);
145 vlog(component, Severity::Info, code, format, args);
146 va_end(args);
147}
148
149inline void info(const Component component, const char* format, ...)
150{
151 va_list args;
152 va_start(args, format);
153 vlog(component, Severity::Info, eventCode::Info, format, args);
154 va_end(args);
155}
156
157inline void warn(const Component component, const EventCode code, const char* format, ...)
158{
159 va_list args;
160 va_start(args, format);
161 vlog(component, Severity::Warn, code, format, args);
162 va_end(args);
163}
164
165inline void error(const Component component, const EventCode code, const char* format, ...)
166{
167 va_list args;
168 va_start(args, format);
169 vlog(component, Severity::Error, code, format, args);
170 va_end(args);
171}
172
173inline void fault(const Component component, const EventCode code, const char* format, ...)
174{
175 va_list args;
176 va_start(args, format);
177 vlog(component, Severity::Fault, code, format, args);
178 va_end(args);
179}
180
181} // namespace Logger
182
183} // namespace org::limitless::seqeron::util
virtual void record(const LoggerEvent &event)=0
void record(const LoggerEvent &event) override
Definition Logger.hpp:83
void error(const Component component, const EventCode code, const char *format,...)
Definition Logger.hpp:165
void install(LoggerSink &sink)
Installs the sink every subsequent log() call forwards to.
Definition Logger.hpp:109
void log(const Component component, const Severity severity, const EventCode code, const char *format,...)
Definition Logger.hpp:133
LoggerSink *& installedSink()
Definition Logger.hpp:97
void warn(const Component component, const EventCode code, const char *format,...)
Definition Logger.hpp:157
void reset()
Definition Logger.hpp:114
void vlog(const Component component, const Severity severity, const EventCode code, const char *format, va_list args)
Definition Logger.hpp:119
void info(const Component component, const EventCode code, const char *format,...)
Definition Logger.hpp:141
StderrLoggerSink & defaultSink()
Definition Logger.hpp:91
void fault(const Component component, const EventCode code, const char *format,...)
Definition Logger.hpp:173
constexpr Component ClusterStreamClient
Definition Logger.hpp:32
constexpr Component Cluster
Definition Logger.hpp:31
constexpr Component ReplayerStreamReceiver
Definition Logger.hpp:33
constexpr EventCode FragmentTooShort
Definition Logger.hpp:48
constexpr EventCode RecoveryStalled
Definition Logger.hpp:50
constexpr EventCode QueueGap
Definition Logger.hpp:40
constexpr EventCode QueueStalled
Definition Logger.hpp:51
constexpr EventCode ClusterIpcFallback
Definition Logger.hpp:46
constexpr EventCode SnapshotRestoreFailed
Definition Logger.hpp:42
constexpr EventCode Info
Definition Logger.hpp:39
constexpr EventCode ClusterRedirectUnresolved
Definition Logger.hpp:47
constexpr EventCode ClusterSessionError
Definition Logger.hpp:44
constexpr EventCode ClusterOfferFailed
Definition Logger.hpp:45
constexpr EventCode SnapshotStoreFailed
Definition Logger.hpp:43
constexpr EventCode ArchiveConnectFailed
Definition Logger.hpp:49
constexpr EventCode FirstFrameNotOne
Definition Logger.hpp:41
Definition Env.hpp:12
Severity
Definition Logger.hpp:55
bool operator==(const Component &) const =default
const char * name
Definition Logger.hpp:17
bool operator==(const EventCode &) const =default
const char * name
Definition Logger.hpp:24
EventCode code
Definition Logger.hpp:67
std::uint8_t textLen
Definition Logger.hpp:69
Severity severity
Definition Logger.hpp:66
std::array< char, 256 > text
Definition Logger.hpp:68
Component component
Definition Logger.hpp:65