C# अनुप्रयोगों में लॉगिंग: .NET विकास के सर्वोत्तम अभ्यास

C# अनुप्रयोगों में लॉगिंग: सर्वोत्तम अभ्यास

लॉगिंग केवल फ़ाइल में संदेश लिखना नहीं है। आधुनिक .NET अनुप्रयोगों में, यह निगरानी, डिबगिंग और ऑडिट के लिए एक महत्वपूर्ण उपकरण है। उचित रूप से कॉन्फ़िगर की गई लॉगिंग आपको विफलताओं के कारणों को जल्दी से खोजने, प्रदर्शन का विश्लेषण करने और सुरक्षा आवश्यकताओं के अनुपालन को सुनिश्चित करने की अनुमति देती है। इस लेख में, हम C# में लॉगिंग के सर्वोत्तम अभ्यासों पर चर्चा करेंगे जो आपको डायग्नोस्टिक जानकारी एकत्र करने के लिए एक मजबूत प्रणाली बनाने में मदद करेंगे।

लॉगिंग लाइब्रेरी का चयन: Serilog बनाम NLog बनाम बिल्ट-इन ILogger

.NET में कई लोकप्रिय समाधान हैं। आइए उनकी ताकत और कमजोरियों पर नज़र डालें।

• Microsoft.Extensions.Logging (ILogger) — बिल्ट-इन एब्सट्रैक्ट इंटरफ़ेस। सरल प्रोजेक्ट्स के लिए उपयुक्त। यह आउट-ऑफ-द-बॉक्स संरचित लॉगिंग का समर्थन नहीं करता है।
• Serilog — लोकप्रियता में अग्रणी। सेटअप में सरलता, संरचित लॉग के लिए मजबूत समर्थन और sinks (डेटा रिसीवर) का व्यापक सेट इसकी विशेषता है।
• NLog — XML या कोड के माध्यम से लचीले कॉन्फ़िगरेशन वाला एक परिपक्व फ्रेमवर्क। लीगेसी सिस्टम और जटिल रूटिंग परिदृश्यों के लिए उपयुक्त।

नए प्रोजेक्ट के लिए Serilog की सिफारिश की जाती है। यह ILogger के साथ आसानी से एकीकृत होता है और एक संक्षिप्त API प्रदान करता है। कनेक्शन का उदाहरण:

// स्थापना: dotnet add package Serilog.AspNetCoreusing Serilog;

Log.Logger = new LoggerConfiguration()    .MinimumLevel.Information()    .WriteTo.Console()    .WriteTo.File("logs/app-.log", rollingInterval: RollingInterval.Day)    .CreateLogger();

var builder = WebApplication.CreateBuilder(args);builder.Host.UseSerilog(); // मानक लॉगर का प्रतिस्थापन

लॉगिंग स्तरों का सही उपयोग

सभी संदेशों को एक स्तर पर न मिलाएं। निम्नलिखित ग्रेडेशन का उपयोग करें:

• Trace (0) — डिबगिंग के लिए अत्यधिक विस्तृत जानकारी। प्रत्येक फ़ंक्शन के निष्पादन विवरण शामिल करता है। केवल dev-वातावरण में शामिल करें।
• Debug (1) — डेवलपर के लिए उपयोगी डेटा: वेरिएबल मान, विधियों के निष्पादन परिणाम।
• Information (2) — व्यावसायिक घटनाएँ: "उपयोगकर्ता ने सिस्टम में प्रवेश किया", "ऑर्डर बनाया गया"। केवल प्रोग्रामर के लिए ही नहीं, बल्कि समझने योग्य होना चाहिए।
• Warning (3) — विसंगतियाँ जो कार्य को बाधित नहीं करतीं: निष्पादन समय से अधिक, कनेक्शन के पुन: प्रयास।
• Error (4) — अपवाद और विफलताएँ जिनमें हस्तक्षेप की आवश्यकता है। हमेशा पूर्ण कॉल स्टैक लॉग करें।
• Critical (5) — घातक त्रुटियाँ: DB से कनेक्शन का नुकसान, मेमोरी ओवरफ्लो। तत्काल सूचना की आवश्यकता है।

कंट्रोलर में सही लॉगिंग का उदाहरण:

[ApiController][Route("api/orders")]public class OrdersController : ControllerBase{    private readonly ILogger<OrdersController> _logger;

    public OrdersController(ILogger<OrdersController> logger)    {        _logger = logger;    }

    [HttpPost]    public IActionResult CreateOrder(OrderDto order)    {        _logger.LogInformation("उपयोगकर्ता {UserId} के लिए ऑर्डर {OrderId} बनाया जा रहा है",             order.Id, order.UserId);                try        {            // व्यावसायिक तर्क            _logger.LogInformation("ऑर्डर {OrderId} सफलतापूर्वक बनाया गया", order.Id);            return Ok();        }        catch (Exception ex)        {            _logger.LogError(ex, "ऑर्डर {OrderId} बनाते समय त्रुटि", order.Id);            return StatusCode(500);        }    }}

संरचित लॉगिंग और संदर्भ

लॉग में स्ट्रिंग संयोजन से बचें। Log.Information("User: " + user.Name) के बजाय पैरामीटर वाले टेम्पलेट का उपयोग करें:

_logger.LogInformation("उपयोगकर्ता {UserName} ने निष्पादित किया