Logging Best Practices - Avoid the rinse repeat CI/CD Process
•
0 likes•40 views
Most of us treat logging as an afterthought. It's just adding a log as you need it. This is a very callous approach for a tool that’s effectively our first line of defense against bugs in production. Good logs can mean the difference between solving a bug quickly and going bankrupt with over spending. They can mean the difference between spending weeks in CI/CD rinse, repeat hell, or hitting the solution right away. In this session, we will discuss my suggestions for logging best practices. How your team should align on a standard for “good logging” in a “do this” and “don’t do that” style. These are suggestions, not rules! We discuss the logic underlying every suggestion and decide whether we wish to apply it. My goal is that developers would take this guideline and make it their own. Embed it in your organization. Make changes to the document so it will fit your culture. Consistency within the development team and the code review process means the difference between actionable logs and an unreadable mess.
Recommended
Recommended
More Related Content
More from Shai Almog
More from Shai Almog (9)
Recently uploaded
Recently uploaded (20)
Logging Best Practices - Avoid the rinse repeat CI/CD Process
- 1. Logging Best Practices Avoid the rainforest killing rinse repeat CI/CD Process Shai Almog @debugagent
- 4. Act 1: What’s the Problem? Shai Almog @debugagent
- 6. “Debugging is like being the detective in a crime movie where you are also the murderer.” – Filipe Fortes Shai Almog @debugagent
- 9. Logging can solve the mystery Shai Almog @debugagent
- 11. Logging is a team effort Shai Almog @debugagent
- 13. Bad Logging Is Murder! Shai Almog @debugagent
- 18. ✓ Increases Costs Shai Almog @debugagent Overlogging
- 19. ✓ Increases Costs ✓ Kills Performance Shai Almog @debugagent Overlogging
- 20. ✓ Increases Costs ✓ Kills Performance ✓ Kills readability Shai Almog @debugagent Overlogging
- 21. ✓ Increases Costs ✓ Kills Performance ✓ Kills readability ✓ Destroys the Environment Shai Almog @debugagent Overlogging
- 25. ✓ Slow fixes, lost revenue Shai Almog @debugagent Insufficient Logging
- 26. ✓ Slow fixes, lost revenue ✓ CI/CD cycle of death! Shai Almog @debugagent Insufficient Logging
- 28. Solution - Company Standard Shai Almog @debugagent https://talktotheduck.dev/logging
- 30. Suggestions - not RULES! Shai Almog @debugagent https://talktotheduck.dev/logging
- 32. Act 2: Basics Shai Almog @debugagent https://talktotheduck.dev/logging
- 34. Don’t Roll Out Your Own! Shai Almog @debugagent https://xkcd.com/927/ https://talktotheduck.dev/logging
- 36. Keep the Log Message Short Shai Almog @debugagent https://talktotheduck.dev/logging
- 38. Logs MUST be Unique Shai Almog @debugagent https://talktotheduck.dev/logging
- 40. Avoid Logs in a Loop Shai Almog @debugagent https://talktotheduck.dev/logging
- 42. Don't Log Lists or Arrays Shai Almog @debugagent https://talktotheduck.dev/logging
- 44. Shai Almog @debugagent Log Stuff you Already "Have" https://talktotheduck.dev/logging
- 46. Callback interfaces still suck! Shai Almog @debugagent https://talktotheduck.dev/logging
- 48. Don't Log Stuff that’s Already There Shai Almog @debugagent https://talktotheduck.dev/logging
- 50. Focus on Method Exit Shai Almog @debugagent https://talktotheduck.dev/logging
- 52. Act 3: Culture Shai Almog @debugagent https://talktotheduck.dev/logging
- 54. Read the Log File Shai Almog @debugagent https://talktotheduck.dev/logging
- 56. Clearly Define the Logging Levels Shai Almog @debugagent https://talktotheduck.dev/logging
- 57. Clearly Define the Logging Levels https://talktotheduck.dev/logging
- 58. ✓ Errors - Something failed ✓ Warnings - Failure, but it wasn't critical ✓ Info - Interesting stuff ✓ Debug - Probably redundant, but I’m not sure Clearly Define the Logging Levels https://talktotheduck.dev/logging
- 60. Don't Integration Test Log Values Shai Almog @debugagent https://talktotheduck.dev/logging
- 62. Don't Double Log e.g. Errors! Shai Almog @debugagent https://talktotheduck.dev/logging
- 64. Log Less, Augment Later Shai Almog @debugagent https://talktotheduck.dev/logging
- 70. Act 4: Security Shai Almog @debugagent https://talktotheduck.dev/logging
- 72. Don't Log Unsanitized User Data Shai Almog @debugagent https://talktotheduck.dev/logging
- 74. Use PII Reduction Shai Almog @debugagent https://talktotheduck.dev/logging
- 76. Act 5: MDC Shai Almog @debugagent https://talktotheduck.dev/logging
- 78. Don’t Crowd the MDC Shai Almog @debugagent https://talktotheduck.dev/logging
- 80. Handle Everything in One Class Shai Almog @debugagent https://talktotheduck.dev/logging
- 82. Plan for Failure e.g. Thread Pool Shai Almog @debugagent https://talktotheduck.dev/logging
- 84. Act 6: OPS Shai Almog @debugagent https://talktotheduck.dev/logging
- 88. LogLevel = Warnings Shai Almog @debugagent https://talktotheduck.dev/logging
- 90. Don't Log Differently in Testing Shai Almog @debugagent https://talktotheduck.dev/logging
- 93. ✓ We need to define a log standard Shai Almog @debugagent Summary https://talktotheduck.dev/logging
- 94. ✓ We need to define a log standard ✓ Logs should be readable and minimal Shai Almog @debugagent Summary https://talktotheduck.dev/logging
- 95. Questions? Shai Almog Developer Advocate @ Lightrun twitter.com/debugagent talktotheduck.dev github.com/shai-almog shaia@lightrun.com https://talktotheduck.dev/logging