ספרים
C#
פרק 5. פרקטיקות קידוד טובות
לוגים

C#:
לוגים

איך לעשות:

ב-C#, ניתן להשתמש במרחב השמות הקיים System.Diagnostics או בספריות צד שלישי כמו NLog או log4net. הנה דוגמה מהירה שמשתמשת בממשק ILogger שזמין ב-.NET Core:

using Microsoft.Extensions.Logging;
using System;

public class Program
{
    public static void Main()
    {
        using var loggerFactory = LoggerFactory.Create(builder => {
            builder.AddConsole();
        });

        ILogger logger = loggerFactory.CreateLogger<Program>();

        logger.LogInformation("זהו הודעת מידע.");
        logger.LogWarning("זהו הודעת אזהרה.");
        logger.LogError("זהו הודעת שגיאה.");
    }
}

פלט לדוגמה:

info: Program[0]
      זהו הודעת מידע.
warn: Program[0]
      זהו הודעת אזהרה.
fail: Program[0]
      זהו הודעת שגיאה.

עיון מעמיק

היסטוריית הרישום בפיתוח תוכנה היא כמעט כמו התכנות עצמה; התפתחה מפקודות הדפסה פשוטות למערכות מתוחכמות וניתנות לתצורה. במקור, רישום נעשה על ידי כתיבה לקבצים או לקונסול, אך זה התרחב לכלול עוד מבנים מורכבים כמו מערכות אגרגציה של לוגים ופלטפורמות ניתוח מבוזרות (כמו ערכת ELK או Jaeger).

חלופות לשיטת הרישום המובנית ב-.NET כוללות ספריות צד שלישי:

  • NLog: גמישה וקלה להגדרה, עם הרבה תכונות למסלול, פורמט וסינון של לוגים.
  • log4net: הושרא מספריה log4j של Java, ניתנת לתצורה גבוהה מתוך XML ותומכת במגוון מאגרי לוגים.

כאשר מדובר בפרטי היישום, בחירת מופשט הרישום שלך (כמו Microsoft.Extensions.Logging) וספק הרישום הבסיסי שלו יכולה להשפיע משמעותית על ביצועי האפליקציה והאמינות שלה. חשוב מאוד לקבוע בצורה נכונה את רמות הרישום ולוודא שכתיבת הלוגים אינה הופכת לנקודת חנק.

כמו כן, רישום מובנה - שבו אתה מתעד לא רק מחרוזות אלא זוגות מפתח-ערך או מופעים - מאפשר לקבל לוגים יותר מדויקים ושימושיים, שקל יותר לברר ולנתח.

ראה גם

טיפול בשגיאותסידור קוד לתוך פונקציות