-
Notifications
You must be signed in to change notification settings - Fork 97
Expand file tree
/
Copy pathLoggerPro.pas
More file actions
2570 lines (2167 loc) · 85.9 KB
/
LoggerPro.pas
File metadata and controls
2570 lines (2167 loc) · 85.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// *************************************************************************** }
//
// LoggerPro
//
// Copyright (c) 2010-2026 Daniele Teti
//
// https://github.com/danieleteti/loggerpro
//
// ***************************************************************************
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ***************************************************************************
unit LoggerPro;
{$SCOPEDENUMS ON}
interface
uses
System.Generics.Collections,
System.Classes,
System.Rtti,
ThreadSafeQueueU, System.SysUtils;
const
DEFAULT_LOG_TAG = 'main';
{$I loggerprobuildconsts.inc}
var
DefaultLoggerProMainQueueSize: Cardinal = 50000;
DefaultLoggerProAppenderQueueSize: Cardinal = 50000;
type
TLogType = (Debug = 0, Info, Warning, Error, Fatal);
TLogErrorReason = (QueueFull);
TLogErrorAction = (SkipNewest, DiscardOlder);
TLogExtendedInfo = (EIUserName, EIComputerName, EIProcessName, EIProcessID, EIDeviceID { mobile });
TLoggerProExtendedInfo = set of TLogExtendedInfo;
{ @abstract(Time rotation intervals for file appenders)
Used by WriteToFile.WithInterval() and WriteToTimeRotatingFile. }
TTimeRotationInterval = (
None, // No time-based rotation (size only)
Hourly, // Rotate every hour: app.2025120312.log
Daily, // Rotate every day: app.20251203.log
Weekly, // Rotate every week: app.2025W49.log
Monthly // Rotate every month: app.202512.log
);
{ @abstract(Represents a key-value pair for structured logging context) }
LogParam = record
Key: string;
Value: TValue;
class function S(const AKey: string; const AValue: string): LogParam; static; inline;
class function I(const AKey: string; const AValue: Integer): LogParam; static; inline;
class function B(const AKey: string; const AValue: Boolean): LogParam; static; inline;
class function F(const AKey: string; const AValue: Double): LogParam; static; inline;
class function D(const AKey: string; const AValue: TDateTime): LogParam; static; inline;
class function FmtS(const AKey: string; const AFormat: string; const AArgs: array of const): LogParam; static;
class function V(const AKey: string; const AValue: TValue): LogParam; static;
end;
LogParams = TArray<LogParam>;
{ @abstract(Function type for pluggable stack trace formatters)
Assign a function to extract stack traces using JCL, madExcept, EurekaLog, or
any other library. If no formatter is set, exception logging will only
include the exception class name and message.
Example with JCL:
@longcode(#
Log := LoggerProBuilder
.WithStackTraceFormatter(
function(E: Exception): string
begin
Result := JclLastExceptStackListToString;
end)
.WriteToConsole.Done
.Build;
#) }
TStackTraceFormatter = TFunc<Exception, string>;
{ @abstract(Represent the single log item)
Each call to some kind of log method is wrapped in a @link(TLogItem)
instance and passed down the layour of LoggerPro. }
TLogItem = class sealed
private
FType: TLogType;
FMessage: string;
FTag: string;
FTimeStamp: TDateTime;
FThreadID: TThreadID;
FContext: LogParams;
FPreRenderedContext: string;
function GetLogTypeAsString: string;
public
constructor Create(const aType: TLogType; const aMessage: string; const aTag: string); overload;
constructor Create(const aType: TLogType; const aMessage: string; const aTag: string; const aTimeStamp: TDateTime;
const aThreadID: TThreadID); overload;
constructor Create(const aType: TLogType; const aMessage: string; const aTag: string;
const aContext: LogParams); overload;
constructor Create(const aType: TLogType; const aMessage: string; const aTag: string; const aTimeStamp: TDateTime;
const aThreadID: TThreadID; const aContext: LogParams); overload;
function Clone: TLogItem;
{ @abstract(The type of the log)
Log can be one of the following types:
@unorderedlist(
@item(DEBUG)
@item(INFO)
@item(WARNING)
@item(ERROR)
@item(FATAL)
) }
property LogType: TLogType read FType;
{ @abstract(The text of the log message) }
property LogMessage: string read FMessage;
{ @abstract(The tag of the log message) }
property LogTag: string read FTag;
{ @abstract(The timestamp when the @link(TLogItem) is generated) }
property TimeStamp: TDateTime read FTimeStamp;
{ @abstract(The IDof the thread which generated the log item) }
property ThreadID: TThreadID read FThreadID;
{ @abstract(The type of the log converted in string) }
property LogTypeAsString: string read GetLogTypeAsString;
{ @abstract(The structured context key-value pairs) }
property Context: LogParams read FContext;
{ @abstract(Pre-rendered context string for fixed context optimization) }
property PreRenderedContext: string read FPreRenderedContext write FPreRenderedContext;
{ @abstract(Returns true if the log item has context data) }
function HasContext: Boolean; inline;
end;
ILogItemRenderer = interface
['{CBD22D22-C387-4A97-AD5D-4945B812FDB0}']
procedure Setup;
procedure TearDown;
function RenderLogItem(const aLogItem: TLogItem): String;
end;
TLoggerProAppenderErrorEvent = reference to procedure(const AppenderClassName: string; const aFailedLogItem: TLogItem;
const Reason: TLogErrorReason; var Action: TLogErrorAction);
TLoggerProEventsHandler = class sealed
public
OnAppenderError: TLoggerProAppenderErrorEvent;
end;
{ @abstract(Interface implemented by all the classes used as appenders) }
ILogAppender = interface
['{58AFB557-C594-4A4B-8DC9-0F13B37F60CB}']
{ @abstract(This method is internally called by LoggerPro to initialize the appender) }
procedure Setup;
{ @abstract(This method is called at each log item represented by @link(TLogItem))
The appender should be as-fast-as-it-can to handle the message, however
each appender runs in a separated thread. }
procedure WriteLog(const aLogItem: TLogItem);
{ @abstract(This method is internally called by LoggerPro to deinitialize the appender) }
procedure TearDown;
{ @abstract(Enable or disable the log appender) }
procedure SetEnabled(const Value: Boolean);
{ @abstract(Returns if the logappender is currently enabled or not) }
function IsEnabled: Boolean;
{ @abstract(Set a custom log level for this appender. This value must be lower than the global LogWriter log level. }
procedure SetLogLevel(const Value: TLogType);
{ @abstract(Get the loglevel for the appender. }
function GetLogLevel: TLogType;
{ @abstract(If the appender is disabled, this method is called at each new
logitem. This method should not raise exceptions and should try to restart the appender
at specified time and only if some appropriate seconds/miutes are elapsed between the
LastErrorTimestamp. }
procedure TryToRestart(var Restarted: Boolean);
procedure SetLastErrorTimeStamp(const LastErrorTimeStamp: TDateTime);
function GetLastErrorTimeStamp: TDateTime;
property LastErrorTimeStamp: TDateTime read GetLastErrorTimeStamp write SetLastErrorTimeStamp;
end;
ELoggerPro = class(Exception)
end;
TAppenderQueue = class(TThreadSafeQueue<TLogItem>)
end;
ICustomLogWriter = interface
['{8BC2F462-E2A3-4117-BE1F-03EB31997BB4}']
function GetAppendersClassNames: TArray<string>;
function GetAppenders(const aIndex: Integer): ILogAppender;
property Appenders[const aIndex: Integer]: ILogAppender read GetAppenders;
procedure AddAppender(const aAppenders: ILogAppender);
procedure DelAppender(const aAppenders: ILogAppender);
function AppendersCount(): Integer;
// Base logging method
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string); overload;
// Enqueue a pre-built log item (for internal use with pre-rendered context)
procedure EnqueueLogItem(const aLogItem: TLogItem);
end;
ILogWriter = interface(ICustomLogWriter)
['{A717A040-4493-458F-91B2-6F6E2AFB496F}']
{ Logging methods without tag - uses default tag }
procedure Debug(const aMessage: string); overload;
procedure Info(const aMessage: string); overload;
procedure Warn(const aMessage: string); overload;
procedure Error(const aMessage: string); overload;
procedure Fatal(const aMessage: string); overload;
{ Logging methods with explicit tag }
procedure Debug(const aMessage: string; const aTag: string); overload;
procedure Debug(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Debug(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Info(const aMessage: string; const aTag: string); overload;
procedure Info(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Info(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Warn(const aMessage: string; const aTag: string); overload;
procedure Warn(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Warn(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Error(const aMessage: string; const aTag: string); overload;
procedure Error(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Error(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Fatal(const aMessage: string; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
{ Exception logging - logs exception with optional stack trace if provider is set }
procedure LogException(const E: Exception); overload;
procedure LogException(const E: Exception; const aMessage: string); overload;
procedure LogException(const E: Exception; const aMessage: string; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aParams: array of const; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
{ @abstract(Returns a new ILogWriter with bound context. Thread-safe - creates a new instance.) }
function WithProperty(const aKey: string; const aValue: string): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Integer): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Boolean): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Double): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TDateTime): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TValue): ILogWriter; overload;
function WithPropertyFmt(const aKey: string; const aFormat: string; const aArgs: array of const): ILogWriter;
{ @abstract(Returns a new ILogWriter with a custom default tag. Thread-safe - creates a new instance.) }
function WithDefaultTag(const aTag: string): ILogWriter;
{ @abstract(Returns a new ILogWriter with a default context. All log calls will include this context.) }
function WithDefaultContext(const aContext: array of LogParam): ILogWriter;
procedure Disable;
procedure Enable;
{ @abstract(Forces flush and shutdown of the logger thread, regardless of reference count.
After calling Shutdown, any logging attempt will be silently ignored (Release) or Assert (Debug).
Use this in finalization to ensure all logs are written before the application exits.) }
procedure Shutdown;
end;
TLogAppenderList = TList<ILogAppender>;
TAppenderThread = class(TThread)
private
FLogAppender: ILogAppender;
FAppenderQueue: TAppenderQueue;
FFailing: Boolean;
procedure SetFailing(const Value: Boolean);
protected
procedure Execute; override;
type
TAppenderStatus = (BeforeSetup, Running, WaitAfterFail, ToRestart, BeforeTearDown);
public
constructor Create(aLogAppender: ILogAppender; aAppenderQueue: TAppenderQueue);
property Failing: Boolean read FFailing write SetFailing;
end;
TLoggerThread = class(TThread)
private type
TAppenderAdapter = class
private
FAppenderQueue: TAppenderQueue;
FAppenderThread: TAppenderThread;
FLogAppender: ILogAppender;
FFailsCount: Cardinal;
public
constructor Create(aAppender: ILogAppender); virtual;
destructor Destroy; override;
function EnqueueLog(const aLogItem: TLogItem): Boolean;
property Queue: TAppenderQueue read FAppenderQueue;
property FailsCount: Cardinal read FFailsCount;
function GetLogLevel: TLogType;
procedure Terminate;
end;
TAppenderAdapterList = class(TObjectList<TAppenderAdapter>)
public
constructor Create;
end;
private
FQueue: TThreadSafeQueue<TLogItem>;
FAppenders: TLogAppenderList;
FEventsHandlers: TLoggerProEventsHandler;
FAppendersDecorators: TObjectList<TAppenderAdapter>;
function BuildAppenderAdapters: TAppenderAdapterList;
procedure DispatchLogItem(const aLogItem: TLogItem);
procedure DoOnAppenderError(const FailAppenderClassName: string; const aFailedLogItem: TLogItem; const aReason: TLogErrorReason;
var aAction: TLogErrorAction);
procedure SetEventsHandlers(const Value: TLoggerProEventsHandler);
protected
procedure Execute; override;
procedure DoTerminate; override;
public
constructor Create(aAppenders: TLogAppenderList);
destructor Destroy; override;
property EventsHandlers: TLoggerProEventsHandler read FEventsHandlers write SetEventsHandlers;
property LogWriterQueue: TThreadSafeQueue < TLogItem > read FQueue;
end;
TLoggerProInterfacedObject = class(TInterfacedObject)
protected
function _AddRef: Integer; stdcall;
function _Release: Integer; stdcall;
end;
TCustomLogWriter = class(TLoggerProInterfacedObject, ICustomLogWriter)
strict private
FLoggerThread: TLoggerThread;
FLogAppenders: TLogAppenderList;
FFreeAllowed: Boolean;
FLogLevel: TLogType;
FLock: TObject;
FShuttingDown: Boolean;
FStackTraceFormatter: TStackTraceFormatter;
function GetAppendersClassNames: TArray<string>;
protected
FEnabled: Boolean;
procedure Initialize(const aEventsHandler: TLoggerProEventsHandler);
function FormatExceptionMessage(const E: Exception; const aMessage: string): string;
public
constructor Create(const aLogLevel: TLogType = TLogType.Debug); overload;
constructor Create(const aLogAppenders: TLogAppenderList; const aLogLevel: TLogType = TLogType.Debug); overload;
destructor Destroy; override;
function GetAppenders(const aIndex: Integer): ILogAppender;
procedure AddAppender(const aAppender: ILogAppender);
procedure DelAppender(const aAppender: ILogAppender);
function AppendersCount(): Integer;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string; const aContext: LogParams); overload;
procedure EnqueueLogItem(const aLogItem: TLogItem);
procedure Disable; virtual;
procedure Enable; virtual;
procedure Shutdown; virtual;
property StackTraceFormatter: TStackTraceFormatter read FStackTraceFormatter write FStackTraceFormatter;
property MinimumLevel: TLogType read FLogLevel write FLogLevel;
end;
TLogWriter = class(TCustomLogWriter, ILogWriter)
public
{ Logging methods without tag - uses DEFAULT_LOG_TAG }
procedure Debug(const aMessage: string); overload;
procedure Info(const aMessage: string); overload;
procedure Warn(const aMessage: string); overload;
procedure Error(const aMessage: string); overload;
procedure Fatal(const aMessage: string); overload;
{ Logging methods with explicit tag }
procedure Debug(const aMessage: string; const aTag: string); overload;
procedure Debug(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Debug(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Info(const aMessage: string; const aTag: string); overload;
procedure Info(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Info(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Warn(const aMessage: string; const aTag: string); overload;
procedure Warn(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Warn(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Error(const aMessage: string; const aTag: string); overload;
procedure Error(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Error(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Fatal(const aMessage: string; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure LogException(const E: Exception); overload;
procedure LogException(const E: Exception; const aMessage: string); overload;
procedure LogException(const E: Exception; const aMessage: string; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aParams: array of const; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
function WithProperty(const aKey: string; const aValue: string): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Integer): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Boolean): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Double): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TDateTime): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TValue): ILogWriter; overload;
function WithPropertyFmt(const aKey: string; const aFormat: string; const aArgs: array of const): ILogWriter;
function WithDefaultTag(const aTag: string): ILogWriter;
function WithDefaultContext(const aContext: array of LogParam): ILogWriter;
end;
{ @abstract(Wrapper for ILogWriter with bound context) }
TLogWriterWithContext = class(TInterfacedObject, ILogWriter)
private
FInner: ILogWriter;
FContext: LogParams;
FPreRenderedContext: string;
function MergeContext(const aContext: array of LogParam): LogParams;
class function RenderContextToString(const AContext: LogParams): string; static;
public
constructor Create(const AInner: ILogWriter; const AContext: LogParams);
// ICustomLogWriter
function GetAppendersClassNames: TArray<string>;
function GetAppenders(const aIndex: Integer): ILogAppender;
procedure AddAppender(const aAppenders: ILogAppender);
procedure DelAppender(const aAppenders: ILogAppender);
function AppendersCount(): Integer;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string); overload;
procedure EnqueueLogItem(const aLogItem: TLogItem);
// ILogWriter - without tag (uses DEFAULT_LOG_TAG)
procedure Debug(const aMessage: string); overload;
procedure Info(const aMessage: string); overload;
procedure Warn(const aMessage: string); overload;
procedure Error(const aMessage: string); overload;
procedure Fatal(const aMessage: string); overload;
// ILogWriter - with explicit tag
procedure Debug(const aMessage: string; const aTag: string); overload;
procedure Debug(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Debug(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Info(const aMessage: string; const aTag: string); overload;
procedure Info(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Info(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Warn(const aMessage: string; const aTag: string); overload;
procedure Warn(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Warn(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Error(const aMessage: string; const aTag: string); overload;
procedure Error(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Error(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Fatal(const aMessage: string; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure LogException(const E: Exception); overload;
procedure LogException(const E: Exception; const aMessage: string); overload;
procedure LogException(const E: Exception; const aMessage: string; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aParams: array of const; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
function WithProperty(const aKey: string; const aValue: string): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Integer): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Boolean): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Double): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TDateTime): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TValue): ILogWriter; overload;
function WithPropertyFmt(const aKey: string; const aFormat: string; const aArgs: array of const): ILogWriter;
function WithDefaultTag(const aTag: string): ILogWriter;
function WithDefaultContext(const aContext: array of LogParam): ILogWriter;
procedure Disable;
procedure Enable;
procedure Shutdown;
end;
{ @abstract(Wrapper for ILogWriter with custom default tag) }
TLogWriterWithDefaultTag = class(TInterfacedObject, ILogWriter)
private
FInner: ILogWriter;
FDefaultTag: string;
public
constructor Create(const AInner: ILogWriter; const ADefaultTag: string);
// ICustomLogWriter
function GetAppendersClassNames: TArray<string>;
function GetAppenders(const aIndex: Integer): ILogAppender;
procedure AddAppender(const aAppenders: ILogAppender);
procedure DelAppender(const aAppenders: ILogAppender);
function AppendersCount(): Integer;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string); overload;
procedure EnqueueLogItem(const aLogItem: TLogItem);
// ILogWriter - without tag (uses FDefaultTag)
procedure Debug(const aMessage: string); overload;
procedure Info(const aMessage: string); overload;
procedure Warn(const aMessage: string); overload;
procedure Error(const aMessage: string); overload;
procedure Fatal(const aMessage: string); overload;
// ILogWriter - with explicit tag
procedure Debug(const aMessage: string; const aTag: string); overload;
procedure Debug(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Debug(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Info(const aMessage: string; const aTag: string); overload;
procedure Info(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Info(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Warn(const aMessage: string; const aTag: string); overload;
procedure Warn(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Warn(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Error(const aMessage: string; const aTag: string); overload;
procedure Error(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Error(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Fatal(const aMessage: string; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure LogException(const E: Exception); overload;
procedure LogException(const E: Exception; const aMessage: string); overload;
procedure LogException(const E: Exception; const aMessage: string; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aParams: array of const; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
function WithProperty(const aKey: string; const aValue: string): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Integer): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Boolean): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Double): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TDateTime): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TValue): ILogWriter; overload;
function WithPropertyFmt(const aKey: string; const aFormat: string; const aArgs: array of const): ILogWriter;
function WithDefaultTag(const aTag: string): ILogWriter;
function WithDefaultContext(const aContext: array of LogParam): ILogWriter;
procedure Disable;
procedure Enable;
procedure Shutdown;
end;
{ @abstract(Wrapper for ILogWriter with default context) }
TLogWriterWithDefaultContext = class(TInterfacedObject, ILogWriter)
private
FInner: ILogWriter;
FDefaultContext: LogParams;
function MergeContext(const aContext: array of LogParam): LogParams;
public
constructor Create(const AInner: ILogWriter; const ADefaultContext: array of LogParam);
// ICustomLogWriter
function GetAppendersClassNames: TArray<string>;
function GetAppenders(const aIndex: Integer): ILogAppender;
procedure AddAppender(const aAppenders: ILogAppender);
procedure DelAppender(const aAppenders: ILogAppender);
function AppendersCount(): Integer;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string); overload;
procedure EnqueueLogItem(const aLogItem: TLogItem);
// Senza tag (usa tag predefinito 'main')
procedure Debug(const aMessage: string); overload;
procedure Info(const aMessage: string); overload;
procedure Warn(const aMessage: string); overload;
procedure Error(const aMessage: string); overload;
procedure Fatal(const aMessage: string); overload;
// Con tag esplicito
procedure Debug(const aMessage: string; const aTag: string); overload;
procedure Debug(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Debug(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Info(const aMessage: string; const aTag: string); overload;
procedure Info(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Info(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Warn(const aMessage: string; const aTag: string); overload;
procedure Warn(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Warn(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Error(const aMessage: string; const aTag: string); overload;
procedure Error(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Error(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure Fatal(const aMessage: string; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aParams: array of TVarRec; const aTag: string); overload;
procedure Fatal(const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
procedure LogException(const E: Exception); overload;
procedure LogException(const E: Exception; const aMessage: string); overload;
procedure LogException(const E: Exception; const aMessage: string; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aParams: array of const; const aTag: string); overload;
procedure Log(const aType: TLogType; const aMessage: string; const aTag: string; const aContext: array of LogParam); overload;
function WithProperty(const aKey: string; const aValue: string): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Integer): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Boolean): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: Double): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TDateTime): ILogWriter; overload;
function WithProperty(const aKey: string; const aValue: TValue): ILogWriter; overload;
function WithPropertyFmt(const aKey: string; const aFormat: string; const aArgs: array of const): ILogWriter;
function WithDefaultTag(const aTag: string): ILogWriter;
function WithDefaultContext(const aContext: array of LogParam): ILogWriter;
procedure Disable;
procedure Enable;
procedure Shutdown;
end;
TOnAppenderLogRow = reference to procedure(const LogItem: TLogItem; out LogRow: string);
TLoggerProAppenderBase = class abstract(TInterfacedObject, ILogAppender)
private
FLogLevel: TLogType;
FEnabled: Boolean;
FLastErrorTimeStamp: TDateTime;
FFormatSettings: TFormatSettings;
protected
FOnLogRow: TOnAppenderLogRow;
FLogItemRenderer: ILogItemRenderer;
property FormatSettings: TFormatSettings read FFormatSettings;
property LogItemRenderer: ILogItemRenderer read FLogItemRenderer;
public
constructor Create(ALogItemRenderer: ILogItemRenderer); overload; virtual;
constructor Create; overload; virtual;
procedure Setup; virtual;
function FormatLog(const ALogItem: TLogItem): string; virtual;
procedure WriteLog(const aLogItem: TLogItem); virtual; abstract;
procedure TearDown; virtual;
procedure TryToRestart(var Restarted: Boolean); virtual;
procedure SetLogLevel(const Value: TLogType);
function GetLogLevel: TLogType; inline;
procedure SetLastErrorTimeStamp(const Value: TDateTime);
function GetLastErrorTimeStamp: TDateTime;
procedure SetEnabled(const Value: Boolean);
function IsEnabled: Boolean;
property LogLevel: TLogType read GetLogLevel write SetLogLevel;
property Enabled: Boolean read IsEnabled write SetEnabled;
property OnLogRow: TOnAppenderLogRow read FOnLogRow write FOnLogRow;
end;
{ @abstract(Builds a new ILogWriter instance. Call this global function to start logging like a pro.)
Here's a sample unit that you can use in your code
@longcode(#
unit LoggerProConfig;
interface
uses
LoggerPro;
function Log: ILogWriter;
implementation
uses
LoggerPro.FileAppender;
var
_Log: ILogWriter;
function Log: ILogWriter;
begin
Result := _Log;
end;
initialization
//If you need other appenders, feel free to add them here in the array
_Log := BuildLogWriter([TLoggerProFileAppender.Create(10, 5)]);
end.
#)
Add this unit to your project, then when you need to use the logger, include
the unit and call one of the followings:
@unorderedlist(
@item(Log.Debug('This is a debug message', 'tag1'))
@item(Log.Info('This is an information message', 'tag1'))
@item(Log.Warn('This is a warning message', 'tag1'))
@item(Log.Error('This is an error message', 'tag1'))
@item(Log.Fatal('This is a fatal message', 'tag1'))
)
}
TLogItemRenderer = class abstract(TInterfacedObject, ILogItemRenderer)
protected
procedure Setup; virtual;
procedure TearDown; virtual;
function RenderLogItem(const aLogItem: TLogItem): String; virtual;abstract;
public
class function GetDefaultLogItemRenderer: ILogItemRenderer;
end;
TLogItemRendererClass = class of TLogItemRenderer;
function GetDefaultFormatSettings: TFormatSettings;
function StringToLogType(const aLogType: string): TLogType;
function BuildLogWriter(aAppenders: array of ILogAppender; aEventsHandlers: TLoggerProEventsHandler = nil;
aLogLevel: TLogType = TLogType.Debug): ILogWriter; overload;
function BuildLogWriter(aAppenders: array of ILogAppender; aEventsHandlers: TLoggerProEventsHandler;
aLogLevels: TArray<TLogType>): ILogWriter; overload;
function LogLayoutByPlaceHoldersToLogLayoutByIndexes(const LogLayoutByPlaceHolders: String; const UseZeroBasedIncrementalIndexes: Boolean): String;
implementation
uses
System.Types,
System.TypInfo,
LoggerPro.FileAppender,
System.SyncObjs,
System.DateUtils,
System.IOUtils,
LoggerPro.Renderers;
function GetDefaultFormatSettings: TFormatSettings;
begin
Result.DateSeparator := '-';
Result.TimeSeparator := ':';
Result.DecimalSeparator := '.';
Result.ShortDateFormat := 'YYYY-MM-DD HH:NN:SS:ZZZ';
Result.ShortTimeFormat := 'HH:NN:SS';
end;
{ LogParam }
class function LogParam.S(const AKey: string; const AValue: string): LogParam;
begin
Result.Key := AKey;
Result.Value := TValue.From<string>(AValue);
end;
class function LogParam.I(const AKey: string; const AValue: Integer): LogParam;
begin
Result.Key := AKey;
Result.Value := TValue.From<Integer>(AValue);
end;
class function LogParam.B(const AKey: string; const AValue: Boolean): LogParam;
begin
Result.Key := AKey;
Result.Value := TValue.From<Boolean>(AValue);
end;
class function LogParam.F(const AKey: string; const AValue: Double): LogParam;
begin
Result.Key := AKey;
Result.Value := TValue.From<Double>(AValue);
end;
class function LogParam.D(const AKey: string; const AValue: TDateTime): LogParam;
begin
Result.Key := AKey;
Result.Value := TValue.From<TDateTime>(AValue);
end;
class function LogParam.FmtS(const AKey: string; const AFormat: string; const AArgs: array of const): LogParam;
begin
Result.Key := AKey;
Result.Value := TValue.From<string>(Format(AFormat, AArgs));
end;
class function LogParam.V(const AKey: string; const AValue: TValue): LogParam;
begin
Result.Key := AKey;
Result.Value := AValue;
end;
function LogLayoutByPlaceHoldersToLogLayoutByIndexes(const LogLayoutByPlaceHolders: String; const UseZeroBasedIncrementalIndexes: Boolean): String;
var
PlaceHolders, PlaceHolderWidthsAndPaddings: TArray<string>;
I: Integer;
lIdx: Integer;
begin
if LogLayoutByPlaceHolders.Contains('%s') or LogLayoutByPlaceHolders.Contains('%d') then
begin
Exit(LogLayoutByPlaceHolders); //there aren't placeholders
end;
// Format specifiers have the following form:
// "%" [index ":"] ["-"] [width] ["." proc] type
//Format params by index are:
// 0: timestamp
// 1: threadid
// 2: loglevel
// 3: message
// 4: tag
SetLength(PlaceHolders, 5);
PlaceHolders[0] := 'timestamp';
PlaceHolders[1] := 'threadid';
PlaceHolders[2] := 'loglevel';
PlaceHolders[3] := 'message';
PlaceHolders[4] := 'tag';
//DEFAULT_LOG_FORMAT = '%0:s [TID %1:-8d][%2:-10s] %3:s [%4:s]';
SetLength(PlaceHolderWidthsAndPaddings, Length(PlaceHolders));
PlaceHolderWidthsAndPaddings[0] := '';
PlaceHolderWidthsAndPaddings[1] := '8';
PlaceHolderWidthsAndPaddings[2] := '-7';
PlaceHolderWidthsAndPaddings[3] := '';
PlaceHolderWidthsAndPaddings[4] := '';
Result := LogLayoutByPlaceHolders;
if UseZeroBasedIncrementalIndexes then
begin
lIdx := 0;
for I := 0 to High(PlaceHolders) do
begin
if Result.Contains('{' + PlaceHolders[I] + '}') then
begin
Result := Result.Replace(
'{' + PlaceHolders[I] + '}',
'%' + IntToStr(lIdx) + ':' + PlaceHolderWidthsAndPaddings[I] + 's');
Inc(lIdx);
end;
end;
end
else
begin
for I := 0 to High(PlaceHolders) do
begin
Result := Result.Replace(
'{' + PlaceHolders[I] + '}',
'%' + IntToStr(I) + ':' + PlaceHolderWidthsAndPaddings[I] + 's');
end;
end;
end;
function StringToLogType(const aLogType: string): TLogType;
var
lLogType: string;
begin
lLogType := LowerCase(Trim(aLogType));
if lLogType = 'debug' then
Exit(TLogType.Debug);
if lLogType = 'info' then
Exit(TLogType.Info);
if lLogType = 'warning' then
Exit(TLogType.Warning);
if lLogType = 'error' then
Exit(TLogType.Error);
if lLogType = 'fatal' then
Exit(TLogType.Fatal);
raise ELoggerPro.CreateFmt('Invalid LogType: %s', [aLogType]);
end;
function BuildLogWriter(aAppenders: array of ILogAppender; aEventsHandlers: TLoggerProEventsHandler; aLogLevel: TLogType): ILogWriter;
var
lLogLevelsArray: TArray<TLogType>;
I: Integer;
begin
SetLength(lLogLevelsArray, length(aAppenders));
for I := 0 to Length(lLogLevelsArray) - 1 do
begin
lLogLevelsArray[I] := aLogLevel;
end;
Result := BuildLogWriter(aAppenders, aEventsHandlers, lLogLevelsArray);
end;
function BuildLogWriter(aAppenders: array of ILogAppender; aEventsHandlers: TLoggerProEventsHandler; aLogLevels: TArray<TLogType>): ILogWriter;
var
lLogAppenders: TLogAppenderList;
lLowestLogLevel: TLogType;
I: Integer;
begin
lLowestLogLevel := TLogType.Fatal;
if Length(aAppenders) <> Length(aLogLevels) then
begin
raise ELoggerPro.Create('LogLevels.Count <> Appenders.Count');
end;
lLogAppenders := TLogAppenderList.Create;
for I := 0 to Length(aAppenders) - 1 do
begin
lLogAppenders.Add(aAppenders[I]);
aAppenders[I].SetLogLevel(aLogLevels[I]);
if aLogLevels[I] < lLowestLogLevel then
begin
lLowestLogLevel := aLogLevels[I];
end;
end;
Result := TLogWriter.Create(lLogAppenders, lLowestLogLevel);
TLogWriter(Result).Initialize(aEventsHandlers);
end;
{ TLogger.TCustomLogWriter }
function TCustomLogWriter.AppendersCount: Integer;
begin
TMonitor.Enter(FLock);
try
Result := Self.FLogAppenders.Count;
finally
TMonitor.Exit(FLock);
end;
end;
constructor TCustomLogWriter.Create(const aLogAppenders: TLogAppenderList; const aLogLevel: TLogType = TLogType.Debug);
begin
inherited Create;
FLock := TObject.Create;
FFreeAllowed := False;
FShuttingDown := False;
FLogAppenders := aLogAppenders;
FLogLevel := aLogLevel;
FEnabled := True;
end;
constructor TCustomLogWriter.Create(const aLogLevel: TLogType = TLogType.Debug);
begin
Create(TLogAppenderList.Create, aLogLevel);
end;
destructor TCustomLogWriter.Destroy;
begin
// Call Shutdown if not already called (idempotent)
Shutdown;
// Free resources
FLoggerThread.Free;
FLogAppenders.Free;
FLock.Free;
inherited Destroy;
end;
function TCustomLogWriter.GetAppenders(const aIndex: Integer): ILogAppender;
begin
TMonitor.Enter(FLock);
try
Result := Self.FLogAppenders[aIndex];
finally
TMonitor.Exit(FLock);
end;
end;
procedure TCustomLogWriter.AddAppender(const aAppender: ILogAppender);
begin
TMonitor.Enter(FLock);
try
Self.FLogAppenders.Add(aAppender);
if Assigned(Self.FLoggerThread.FAppendersDecorators) then
Self.FLoggerThread.FAppendersDecorators.Add(TLoggerThread.TAppenderAdapter.Create(aAppender));
finally
TMonitor.Exit(FLock);
end;
end;
procedure TCustomLogWriter.DelAppender(const aAppender: ILogAppender);
var
i: Integer;
begin
TMonitor.Enter(FLock);
try
i := Self.FLoggerThread.FAppenders.IndexOf(aAppender);
if i >= 0 then
Self.FLoggerThread.FAppenders.Delete(i);
i := Self.FLogAppenders.IndexOf(aAppender);
if i >= 0 then
Self.FLogAppenders.Delete(i);
if Assigned(Self.FLoggerThread.FAppendersDecorators) then
for i := Self.FLoggerThread.FAppendersDecorators.Count - 1 downto 0 do
if Self.FLoggerThread.FAppendersDecorators[i].FLogAppender = aAppender then
Self.FLoggerThread.FAppendersDecorators.Delete(i);
finally
TMonitor.Exit(FLock);
end;