Comprehensive Logging with mORMot 2 on Delphi and FPC

The logging feature of mORMot is worth investigating for any Delphi or FPC project, even if you do not need any other part of the library. This session will present what makes mORMot unique in the modern object Pascal scene.

Hands-On

How to use only some part of the mORMot 2 toolbox
General best-practices about logging
Server-side logging particularities
A cross-compiler and cross-platform journey

1. Comprehensive Logging
with mORMot 2
The more logs…
the better

2. Welcome
Arnaud Bouchez
•Open Source Founder
• mORMot 1, mORMot 2, SynPDF, dmustache
•Modern Object Pascal
Delphi and FPC -Embarcadero MVP
•Synopse Tranquil IT
https://synopse.info https://tranquil.it

3. Welcome
Arnaud Bouchez
•Open Source Founder
• mORMot 1, mORMot 2, SynPDF, dmustache
•Modern Object Pascal
Delphi and FPC -Embarcadero MVP
•Synopse Tranquil IT
https://synopse.info https://tranquil.it

4. Comprehensive Logging

5. Comprehensive Logging
with mORMot 2

6. Hands On
•Use only some part of mORMot 2
•General best-practices about logging
•Server-side logging particularities
•A cross-compiler/platform journey

7. Today’s Special
•TSynLogclass or instance
•The LogViewertool
•Advanced features
•Logging with love

8. Today’s Special
•TSynLogclass or instance
•The LogViewertool
•Advanced features
•Logging with love
Showing actual code

9. Today’s Special
•TSynLogclass or instance
•The LogViewertool
•Advanced features
•Logging with love

10. mORMot Logs

11. mORMot Logs
•Application Logs
•HTTP Logs
•SOA Audit Trail

12. mORMot Logs
•Application Logs
•HTTP Logs
•SOA Audit Trail
calls into SQlite3 DB

13. mORMot Logs
•Application Logs
•HTTP Logs

14. mORMot Logs
•Application Logs
plain UTF-8 text format
•HTTP Logs
“combined” format

15. mORMot Logs
•Application Logs
TSynLog
•HTTP Logs
THttpLogger

16. mORMot Logs
•Application Logs
TSynLog

17. TSynLog
•Class-driven
(not Instance-driven)
•Several families
(each with its own children)

18. TSynLog
•Class-driven
(not Instance-driven)
•Several families
(each with its own loggers)

19. TSynLogSub-Classes

20. TSynLogSub-Classes
TMySynLog= class(TSynLog)
•Its own TMySynLog.Family
•Its own log file(s) on disk

21. TSynLog
•TSynLog.Family
Per-class settings
•TSynLog.Add
Logger instance

22. TSynLog.Family
TSynLogFamily.Level
asetof levels
not a single level

23. TSynLog.Family
Most common app logging:
TRACE,DEBUG,INFO,WARN,ERROR

24. TSynLog.Family
Most common app logging:
TRACE,DEBUG,INFO,WARN,ERROR
less critical …… most critical

25. TSynLog.Family
Most common app logging:
TRACE,DEBUG,INFO,WARN,ERROR
most verbose …… less verbose

26. TSynLog.Family.Level
TSynLogLevels= set of TSynLogLevel;

27. TSynLog.Family.Level
TSynLogLevel= (sllNone, sllInfo, sllDebug, sllTrace,
sllWarning, sllError, sllEnter, sllLeave, sllLastError,
sllException, sllExceptionOS, sllMemory,
sllStackTrace, sllFail, sllSQL, sllCache, sllResult,
sllDB, sllHTTP, sllClient, sllServer, sllServiceCall,
sllServiceReturn, sllUserAuth, sllCustom1,
sllCustom2, sllCustom3, sllCustom4, sllNewRun,
sllDDDError, sllDDDInfo, sllMonitoring);

28. App logic Levels
TSynLogLevel= (sllNone, sllInfo, sllDebug, sllTrace,
sllWarning, sllError, sllEnter, sllLeave, sllLastError,
sllException, sllExceptionOS, sllMemory,
sllStackTrace, sllFail, sllSQL, sllCache, sllResult,
sllDB, sllHTTP, sllClient, sllServer, sllServiceCall,
sllServiceReturn, sllUserAuth, sllCustom1,
sllCustom2, sllCustom3, sllCustom4, sllNewRun,
sllDDDError, sllDDDInfo, sllMonitoring);

29. OS Errors Levels
TSynLogLevel= (sllNone, sllInfo, sllDebug, sllTrace,
sllWarning, sllError, sllEnter, sllLeave, sllLastError,
sllException, sllExceptionOS,sllMemory,
sllStackTrace, sllFail, sllSQL, sllCache, sllResult,
sllDB, sllHTTP, sllClient, sllServer, sllServiceCall,
sllServiceReturn, sllUserAuth, sllCustom1,
sllCustom2, sllCustom3, sllCustom4, sllNewRun,
sllDDDError, sllDDDInfo, sllMonitoring);

30. Advanced Levels
TSynLogLevel= (sllNone, sllInfo, sllDebug, sllTrace,
sllWarning, sllError, sllEnter, sllLeave, sllLastError,
sllException, sllExceptionOS, sllMemory,
sllStackTrace, sllFail, sllSQL, sllCache, sllResult,
sllDB, sllHTTP, sllClient, sllServer, sllServiceCall,
sllServiceReturn, sllUserAuth, sllCustom1,
sllCustom2, sllCustom3, sllCustom4, sllNewRun,
sllDDDError, sllDDDInfo, sllMonitoring);

31. Toolbox Levels
TSynLogLevel= (sllNone, sllInfo, sllDebug, sllTrace,
sllWarning, sllError, sllEnter, sllLeave, sllLastError,
sllException, sllExceptionOS, sllMemory,
sllStackTrace, sllFail, sllSQL, sllCache, sllResult,
sllDB, sllHTTP, sllClient, sllServer, sllServiceCall,
sllServiceReturn, sllUserAuth, sllCustom1,
sllCustom2, sllCustom3, sllCustom4, sllNewRun,
sllDDDError, sllDDDInfo, sllMonitoring);

32. Custom Levels
TSynLogLevel= (sllNone, sllInfo, sllDebug, sllTrace,
sllWarning, sllError, sllEnter, sllLeave, sllLastError,
sllException, sllExceptionOS, sllMemory,
sllStackTrace, sllFail, sllSQL, sllCache, sllResult,
sllDB, sllHTTP, sllClient, sllServer, sllServiceCall,
sllServiceReturn, sllUserAuth, sllCustom1,
sllCustom2, sllCustom3, sllCustom4, sllNewRun,
sllDDDError, sllDDDInfo, sllMonitoring);

33. Profiling Levels
TSynLogLevel= (sllNone, sllInfo, sllDebug, sllTrace,
sllWarning, sllError, sllEnter, sllLeave, sllLastError,
sllException, sllExceptionOS, sllMemory,
sllStackTrace, sllFail, sllSQL, sllCache, sllResult,
sllDB, sllHTTP, sllClient, sllServer, sllServiceCall,
sllServiceReturn, sllUserAuth, sllCustom1,
sllCustom2, sllCustom3, sllCustom4, sllNewRun,
sllDDDError, sllDDDInfo, sllMonitoring);

34. TSynLog.Family
TSynLogFamily.Level
a setof levels
to rule them all

35. TSynLog.Add
TSynLoginstance
•Map a log file on disk
•Host of the Log() methods

36. TSynLog.Log()
TSynLog.Log() overloads
•Thread-safe and very efficient
•UTF-8/JSON serialization
•Formatting with % place holder

37. TSynLog.Log()
TSynLog.Log() overloads
•Thread-safe and very efficient
•UTF-8/JSON serialization
•Formatting with % place holder
(not %s %d with runtime errors)

38. TSynLog.Log()
procedure TSomeClass.SomeMethod(a: integer);
begin
TSynLog.Add.Log(sllTrace,'SomeMethoda=%',[a],self);
// do some stuff
if error <> '' then
TSynLog.Add.Log(sllError, 'SomeMethodfailed as %',
[error], self);
end;

39. TSynLog.Log()
procedure TSomeClass.SomeMethod(a: variant);
begin
try
// do some stuff
except
on E: Exception do
TSynLog.Add.Log(sllError, 'SomeMethod(%) raised %',
[a, E], self);
end;

40. ISynLog
TSynLog.Enter/EnterLocal
•Return an ISynLoginstance
•Simple Method profiling
•Regular ISynLog.Add() methods

41. ISynLog
procedure TSomeClass.DoIt(param: TSomeObject)
varlog: ISynLog; // local variable
begin
log := TSynLog.Enter(self, 'DoIt');
// do some stuff
if Assigned(log) then// may be nil if no sllEnter
log.Log(sllInfo, 'DoItcalled as %', [param], self);
end; // when log is out-of-scope, log the method leaving

42. ISynLog
procedure TSomeClass.DoIt(param: TSomeObject)
varlog: ISynLog;
begin
TSynLog.EnterLocal(log, self, 'DoIt'); // slightly faster
// do some stuff
if Assigned(log) then// may be nil if no sllEnter
log.Log(sllInfo, 'DoItcalled as %', [param], self);
end; // when log is out-of-scope, log the method leaving

43. ISynLog
procedure TSomeClass.DoIt(param: TSomeObject)
begin
TSynLog.Enter(self, 'DoIt');// returns an ISynLog
// do some stuff
end; // when ISynLogis out-of-scope, log the method leaving

44. ISynLog
procedure TSomeClass.DoIt(param: TSomeObject)
begin
TSynLog.Enter(self, 'DoIt');
// do some stuff
end; // when ISynLogis out-of-scope, log the method leaving

45. ISynLog
procedure TSomeClass.DoIt(param: TSomeObject)
begin
TSynLog.Enter(self, 'DoIt');
// do some stuff
end; // ISYNLOG RELEASED NOW
WARNING: SCOPE IS AT METHOD ENDINGWITH OLDDELPHI

46. ISynLog
procedure TSomeClass.DoIt(param: TSomeObject)
begin
TSynLog.Enter(self, 'DoIt');
// ISYNLOG RELEASED NOW
// do some stuff
end;
WARNING: SCOPE IS ASAP/LOCALWITH FPCOR LATESTDELPHI

47. ISynLog
procedure TSomeClass.DoIt(param: TSomeObject)
varlog: ISynLog; // use local varon modern Delphi or FPC
begin
TSynLog.EnterLocal(log, self, 'DoIt');
// do some stuff
if Assigned(log) then// may be nil if no sllEnter
log.Log(sllInfo, 'DoItcalled as %', [param], self);
end; // when log is out-of-scope, log the method leaving

48. TSynLogClass or Instance
SHOW ME THE CODE !

49. Today’s Special
•TSynLogclass or instance
•The LogViewertool
•Advanced features
•Logging with love

50. LogViewer

51. LogViewer
•VCL/LCL Open Source Tool

52. LogViewer
•VCL/LCL Open Source Tool
•Map the file in memory

53. LogViewer
•VCL/LCL Open Source Tool
•Map the file in memory
•Index/search/filter/view

54. LogViewer
•VCL/LCL Open Source Tool
•Map the file in memory
•Index/search/filter/view
•Thread oriented

55. LogViewer
SHOW ME THE CODE !
SHOW ME THE TOOL !

56. Today’s Special
•TSynLogclass or instance
•The LogViewertool
•Advanced features
•Logging with love

57. Advanced Features

58. Advanced Features
•Integrated in whole Framework
•Optimized Generation
•TSynLogFamilyproperties
•Cross-OS and Cross-Compiler

59. Advanced Features
•Integrated in whole Framework
•Network/socket/http process
•REST/SOA calls
•Database queries (SQL/NoSQL)

60. Advanced Features
•Integrated in whole Framework
•Network/socket/http process
•REST/SOA calls
•Database queries (SQL/NoSQL)
BUILT-IN !

61. Advanced Features
Optimized Generation
•Full rewrite in latest mORMot 2
•No transient memory allocation
•Validated on production servers

62. Advanced Features
Optimized Generation
•TSynLogThreadInfo
•Buffered output
•Fast UTF-8/JSON serialization
•“Fake” ISynLog

63. Advanced Features
TSynLogFamilyproperties
•Log File Content
•Log File Lifetime

64. Log File Content
•HighResolutionTimestamp
•PerThreadLog
•BufferSize
•LevelSysInfo
•AutoFlushTimeOut

65. Log File Lifetime
•Log Rotation
•Log Archival
•Console Logging
•Remote Logging

66. Advanced Features
Cross-OS and Cross-Compiler
•Efficient OS API calls
•Delphi and FPC
•Leverage mormot.core.os/rtti

67. Advanced Features
SHOW ME THE CODE !

68. Today’s Special
•TSynLogclass or instance
•The LogViewertool
•Advanced features
•Logging with love

69. Logging For You

70. Logging For You
•Exception logging

71. Logging For You
•Exception logging
•Production profiling

72. Logging For You
•Exception logging
•Production profiling
•Low performance overhead

73. Logging For You
•Exception logging
•Production profiling
•Low performance overhead
•Built-in SOA and DB integration

74. Today’s Special
•TSynLogclass or instance
•The LogViewertool
•Advanced features
•Logging with love

75. To Visit the marmots
https://cauterets.site

76. Questions?