CSC307 Lecture 10

Introduction to Software Engineering
Logging Process
(202407)

In this lecture, we focus on logging practices and exemplify using SLF4J Logback. We cover configuring logging, understanding severity levels, and best practices for application maintenance. Further, we explore cloud-based log management with BetterStack and revisit Maven for project setup and dependency management.

Source code available at https://github.com/CSC3100/Tool-Logging/

Transcript

1. Dr. Javier Gonzalez-Sanchez javiergs@calpoly.edu www.javiergs.info o ffi ce: 14 -227 CSC 307 Introduction to Software Engineering Lecture 10. Logging Process
2. Problem 9
3. Problem 10
4. Bad Idea System.out.println 11 Messages
5. Logging • Recording events, a ctions, or mess a ges th a t occur during the execution of a progr a m. • Proper logging is essenti a l for m a int a ining a nd troubleshooting a pplic a tions e ff ectively throughout their lifecycle. 12
6. Good Idea 13 message 01 message 02 message 03 message 04 message 05
7. SLF4J Logback • St a nds for Simple Logging F a c a de for J a v a • It provides a uni f ied interf a ce for logging oper a tions, a llowing developers to write logging code without binding their a pplic a tion to a speci f ic logging implement a tion. • We need to t a lk a bout the F a c a de P a ttern 14
8. Getting Started
9. SLF4J Logback | Add the dependency 16 https://github.com/CSC3100/Tool-Logging
10. SLF4J Logback | Logging 17 https://github.com/CSC3100/Tool-Logging
11. SLF4J Logback | Logging 18 https://github.com/CSC3100/Tool-Logging
12. Severity Level 19 TRACE DEBUG INFO WARN ERROR Severity
13. We want this 20 message 01 message 02 message 03 message 04 message 05 trace() debug() info () warn () error() Logger 20
14. Maven File and Directories 21
15. Resources Folder • The resources folder in a M a ven project stores non-source-code f iles th a t your a pplic a tion needs, such a s con f igur a tion f iles, property f iles, im a ges, a nd other resources. • These f iles a re included in the f in a l build output a nd a v a il a ble on the cl a ssp a th a t runtime. 22
16. src/main/resources/logback.xml • logb a ck.xml is a con f igur a tion f ile for SLF4J Logb a ck. • It de f ines how logging should be h a ndled, including log levels, a ppenders (where logs a re written), a nd log form a ts. • When your a pplic a tion st a rts, SLF4J Logb a ck a utom a tic a lly looks for this con f igur a tion f ile. 23
17. ConsoleAppender 24 message 01 message 02 message 03 message 04 message 05 trace() debug() info () warn () error() Logger 24 Appender
18. src/main/resources/logback.xml 25 https://github.com/CSC3100/Tool-Logging
19. SLF4J Logback | Logging 26
20. ConsoleAppender 27 message 01 message 02 message 03 message 04 message 05 trace() debug() info () warn () error() Logger 27 Appender
21. Encoder
22. Logstash Logback Encoder | POM.xml • Let’s use a nother libr a ry to t a ke a dv a nt a ge of extr a encoders • form a t Spring Boot logs in JSON form a t 29 https://github.com/CSC3100/Tool-Logging
23. src/main/resources/logback.xml 30 https://github.com/CSC3100/Tool-Logging
24. SLF4J Logback | Logging 31
25. FileAppender
26. Next 33 trace() debug() info () warn () error() message 01 message 02 message 03 message 04 message 05 Logger Appender Appender
27. src/main/resources/logback.xml 34 https://github.com/CSC3100/Tool-Logging
28. SLF4J Logback | Logging 35
29. Cloud-Based Log Management
30. Next 37 trace() debug() info () warn () error() message 01 message 02 message 03 message 04 message 05 Logger Appender
31. Cloud-Base Log Management • Cloud-b a sed log m a n a gement refers to the pr a ctice of collecting, storing, a n a lyzing, a nd m a n a ging log d a t a using cloud services. • This a ppro a ch lever a ges cloud computing to h a ndle the v a st a mounts of log d a t a 38
32. betterstack.com/logs 39
33. We need keys 40 String key = "XYZabc123259#$%#$Fcaskjhdux_2342445Calp";
34. betterstack.com/logs 41
35. betterstack.com/logs 42 WE6x9ya1dfMwRTouP9DEBmg
36. HttpAppender Our very own creation Just for fun
37. SLF4J Logback | Add the dependency 44 Just for JSON Support https://github.com/CSC3100/Tool-Logging
38. src/main/resources/logback.xml 45 WE6x9ya1dfMwRTouP9DEB https://github.com/CSC3100/Tool-Logging
39. javiergs.HttpAppender (Part 1/4) 46 https://github.com/CSC3100/Tool-Logging
40. javiergs.HttpAppender (Part 2/4) 47 https://github.com/CSC3100/Tool-Logging
41. javiergs.HttpAppender (Part 3/4) 48 https://github.com/CSC3100/Tool-Logging
42. javiergs.HttpAppender (Part 4/4) 49 https://github.com/CSC3100/Tool-Logging
43. logs.betterstack.com 50
44. Full Solution 51 trace() debug() info () warn () error() message 01 message 02 message 03 message 04 message 05 Logger Appender Appender Appender
45. Questions 52
46. CSC 307 Introduction to Software Engineering Javier Gonzalez-Sanchez, Ph.D. javiergs@calpoly.edu Summer 2024 Copyright. These slides can only be used as study material for the class CSC307 at Cal Poly. They cannot be distributed or used for another purpose.