ال logs من أساسيات شغلنا كمبرمجين بل تكاد تكون جزء يومي ولكنها من أهم الأمثلة على قاعدة "السهل الممتنع". فنعم كل المبرمجين بيستخدموها من أول الطلبة لل principles engineers لكن عدد قليل جدًا اللي قادر يوظفها ويكتبها بشكل فعّال.
فورقة وقلم وتعالوا نشوف ازاي نكتب logs حلوة 😌
أولاً لازم نعرف أننا بنتعامل يوميًا مع نوعين من الـ Logs:
ال Infrastructure logs ودي اللي بينتجها ال server or operating system or network devices
ال Application code logs ودا اللي هنتكلم عليه دايمًا لأنه كمبرمج بكتبه بشكل شبه يومي وأنا أول واحد ينتفع أو يٌضر بيه.
أهداف كتابة ال Logs
💡
الهدف الأساسي لأي logs إنها تدينا Better observability أو رؤية أفضل على النظام بشكل عام وتمكنا من مراقبة ال events و المشاكل المهمة وتجميع معلومات عنها وبالتالي حلها أو تحسين أداء النظام.
ودا بنلجأ له لما بنشغل ال service علي آل production environment وقتها مش بنقدر نعملها debug وبالتالي متقدرش تتبع مسار البيانات وهي دخلت في انهي سيناريو داخل الكود وانهي لاء , وكذلك مش كل الناس عندها صلاحية دخول لل Codebase زي ال Tech support engineers مثلاً, في الحالات دي بيكون اعتمادنا على الـ logs -وأشياء أخري- عشان نقدر نتتبع رحلة البيانات داخل ال service ونستخدمها عشان نحل مشكلة أو سيناريو غير متوقع أو نحسن من ال service وأدائها.
فقبل ما أكتب أي Log line لازم أجاوب على السؤال: هل كتابة ال log line دا هتديني رؤية أفضل على سلوك التطبيق أو النظام؟
How to Write Better Logs
ما هي الـ Events التي يجب تسجيلها في ال Logs؟
ال application logs بنستخدمها عشان نتابع أداء النظام بشكل عام, ولكن أكيد هنكون مهتمين أكثر بأننا نعمل log لو حصل مشكلة فلذلك أغلب ال log lines بتكون مرتبطة ب Error من نوع ما, لكن كذلك بنستخدمها لتسجيل معلومات عشان نتأكد أن البيانات عدت بمراحل معينة من ال Processing
ودي قائمة بأمثلة عن ال events اللي من المفيد نعملها logging:
Application errors
Input and output validation failures
Authentication successes and failures
Authorization failures
Session management failures
Monitoring and performance improvement
Security and auditing
ما هي البيانات التي يجب كتابتها عن الـ Events التي نسجلها؟
